Compare commits

..
Author SHA1 Message Date
Billy Tat fdf8c593a5 Merge pull request #1571 from btat/vault-jwt
FAQ: update messaging around Vault support
2024-11-15 11:23:51 -08:00
Billy Tat 97a839de60 FAQ: update messaging around Vault support 2024-11-15 10:23:21 -08:00
Billy Tat a83cfba137 Merge pull request #1553 from btat/min-skill
Add minimum skills required to deploy Rancher Prime on AWS
2024-11-12 16:46:07 -08:00
Billy Tat 9943fdba52 Add minimum skills required to deploy Rancher Prime on AWS - Marketplace page 2024-11-08 16:56:08 -08:00
Billy Tat 1c24678675 Add minimum skills required to deploy Rancher Prime on AWS - Prime page 2024-11-08 16:55:36 -08:00
Billy Tat c6796e950e Merge pull request #1548 from btat/port-pr1521-disconnected-cluster-bp
Sync PR #1521 (Add disconnected cluster best practices guide) to other en/zh versions
2024-11-07 12:44:42 -08:00
Billy Tat 3f03384e89 Sync PR #1521 (Add disconnected cluster best practices guide) to other en/zh versions 2024-11-06 15:17:37 -08:00
Billy Tat f748b8a60d Merge pull request #1521 from moio/disconnected_best_practice
Add disconnected cluster best practices guide
2024-11-06 14:46:03 -08:00
Sunil Singh d238eac259 Merge pull request #1538 from sunilarjun/v2.7.17-maintenance
v2.7.17 Maintenance
2024-11-06 08:28:40 -08:00
Silvio Moioli 8c40500d9c add sidebar links
Signed-off-by: Silvio Moioli <silvio@moioli.net>
2024-11-06 09:19:01 +01:00
Silvio MoioliandBilly Tat 944ba6475d Apply suggestions from code review
Co-authored-by: Billy Tat <btat@suse.com>
2024-11-06 09:15:07 +01:00
Billy Tat a8c458035f Merge pull request #1543 from btat/link-fix
Fix broken link
2024-11-05 15:35:16 -08:00
Billy Tat 02df16cead Fix broken links 2024-11-05 14:45:36 -08:00
Sunil Singh 31cf54a2c9 Updating release date
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-11-05 09:00:40 -08:00
Sunil Singh c5e15d531a Updating the release date.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-11-04 10:24:22 -08:00
Billy Tat 653b0e899c Merge pull request #1537 from btat/seo-fixes
SEO adjustments
2024-10-31 09:49:19 -07:00
Sunil Singh 50073dc0df Adding changes to i18n docs
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-10-30 16:18:13 -07:00
Sunil Singh 388737485c Update deprecated feature table
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-10-30 16:10:15 -07:00
Sunil Singh 58fa66384a Update csp-adapter
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-10-30 16:08:53 -07:00
Sunil Singh efe824c275 Updating webhook
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-10-30 16:07:32 -07:00
Sunil Singh 46b4a79bb5 Updating versions
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-10-30 16:01:11 -07:00
Billy Tat e0f2f17dfc Merge pull request #1533 from btat/2.10-ui-redirects
[2.10] Add redirects for links in UI using old structure
2024-10-30 11:44:58 -07:00
Billy Tat aa7257c749 Add canonical link to 2.5 'Running on ARM64' page
'Latest' version of the page is intended as top search engine result
2024-10-30 10:55:28 -07:00
Billy Tat 3f8e147aed Prevent search engines from indexing archived 2.0-2.4 version 2024-10-30 10:53:35 -07:00
Billy Tat 92dff0edc1 Add redirects for links in UI using old structure 2024-10-30 10:44:05 -07:00
Billy Tat b719e8e745 Merge pull request #1531 from jbiers/encrypted-backup-docs
Improve encrypted backup docs
2024-10-30 09:07:17 -07:00
Julia Bier d5fd6d3393 update corresponding v2.10 docs 2024-10-30 11:22:45 -04:00
Julia Bier 5373c5fdd1 update corresponding v2.8 docs 2024-10-30 11:21:31 -04:00
Julia Bier a575035b08 update corresponding v2.9 docs 2024-10-30 11:21:31 -04:00
Julia Bier a6cba74050 make second example clearer 2024-10-30 11:21:31 -04:00
Julia Bier ae75fb12e2 add wildcard to example config 2024-10-30 11:21:31 -04:00
Julia Bier d3c73bc280 improve backup-restore-operator encryption docs 2024-10-30 11:21:31 -04:00
Billy Tat 01671e78bd Merge pull request #1510 from rohitsakala/intermittent-failure-to-install-neuvector-extension-in-rancher-ui
Update file size limit to 30MB
2024-10-29 15:07:17 -07:00
Billy Tat 3a58c51c4c Merge pull request #1505 from btat/2.10-preview
Add version 2.10 preview
2024-10-29 11:26:56 -07:00
Billy Tat 6256d184f1 Enclose version key in quotes. Fix 'Invalid docs option "versions": unknown versions (2.1) found' 2024-10-29 09:11:01 -07:00
Billy Tat ca135c1a65 Add version 2.10 preview 2024-10-29 09:10:58 -07:00
Billy Tat 90de481f7e Merge pull request #1530 from btat/archive-2.0-2.4
Archive 2.0-2.4 docs
2024-10-29 09:03:01 -07:00
Billy Tat c36b43f07a Remove old 2.0-2.4 redirects 2024-10-28 17:07:47 -07:00
Billy Tat de3c7be316 Use GitHub repo for 2.0-2.4 links and other refs 2024-10-28 16:47:44 -07:00
Billy Tat 4dd1a1220d Move version-2.0-2.4 to new arhived directory and don't publish. Remove sidebar entries and add 'Archived' to labels 2024-10-28 16:47:13 -07:00
Billy Tat e85c0b532f Merge pull request #1495 from celidon/patch-4
Update add-tls-secrets.md
2024-10-25 15:29:52 -07:00
Billy Tat 0673552a1b Apply 674ae23c (Fixed command to generate CA certificate...) to versioned/zh docs 2024-10-25 14:48:37 -07:00
Billy Tat e72dd4faf8 Merge pull request #1528 from btat/questions-yml-ref
(re)document questions.yaml config values
2024-10-25 14:22:02 -07:00
Billy Tat cc2957a99f Merge pull request #1526 from btat/yarn-start-mem
Set max-old-space-size for yarn start due to memory issues
2024-10-25 14:10:25 -07:00
Billy Tat 1c0e3badac (re)document questions.yaml config values
Removed in PR #865 as they weren't implemented. Implemented as of v2.8.0
2024-10-25 13:29:46 -07:00
Billy Tat 2d1f473b13 Set max-old-space-size for yarn start due to memory issues 2024-10-25 13:11:32 -07:00
Billy Tat a9463f72f3 Merge pull request #1524 from rancher/v2.9.3
Merge v2.9.3 release branch into main
2024-10-24 19:22:08 -07:00
Billy Tat 17bc799d18 Merge pull request #1523 from rancher/v2.8.9
Merge v2.8.9 release branch into main
2024-10-24 19:22:03 -07:00
Billy Tat bb9532832a Merge pull request #1522 from rancher/v2.7.16
Merge v2.7.16 release branch into main
2024-10-24 19:21:56 -07:00
Billy Tat c015335fd6 Merge pull request #1519 from btat/zh-2.9.3-release-maintenance
Apply PR#1514 to zh docs
2024-10-24 14:36:06 -07:00
Billy Tat b628e5795b Merge pull request #1518 from btat/zh-2.8.9-release-maintenance
Apply PR#1515 to zh docs
2024-10-24 14:36:03 -07:00
Billy Tat bd79ca0af6 Merge pull request #1517 from btat/zh-2.7.16-release-maintenance
Apply PR#1516 to zh docs
2024-10-24 14:36:00 -07:00
Silvio Moioli 50e5c5e752 Add disconnected cluster best practices guide
Signed-off-by: Silvio Moioli <silvio@moioli.net>
2024-10-24 13:22:42 +02:00
Billy Tat 85e9da8ebc Merge pull request #1520 from rancher/dependabot/submodules/dot-github/styles/suse-vale-styleguide-c13923f
Bump .github/styles/suse-vale-styleguide from `45136e8` to `c13923f`
2024-10-23 10:55:29 -07:00
dependabot[bot] 046978765b Bump .github/styles/suse-vale-styleguide from 45136e8 to c13923f
Bumps [.github/styles/suse-vale-styleguide](https://github.com/openSUSE/suse-vale-styleguide) from `45136e8` to `c13923f`.
- [Release notes](https://github.com/openSUSE/suse-vale-styleguide/releases)
- [Commits](https://github.com/openSUSE/suse-vale-styleguide/compare/45136e8ea14ebbe0851ae87791f068507b02d636...c13923f36932ef4eaa5e5e50ab0e5445bb0eb70b)

---
updated-dependencies:
- dependency-name: ".github/styles/suse-vale-styleguide"
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-10-23 16:45:12 +00:00
Billy Tat ea6b368ce5 Apply PR#1514 (2.9.3 release maintenace tasks) to zh docs 2024-10-22 18:58:02 -07:00
Billy Tat 833d6f0e1b Apply PR#1516 (2.7.16 release maintenace tasks) to zh docs 2024-10-22 18:55:03 -07:00
Billy Tat f4e61ac811 Apply PR#1515 (2.8.9 release maintenace tasks) to zh docs 2024-10-22 18:54:07 -07:00
Billy Tat 893acac987 Merge pull request #1514 from btat/2.9.3-release-maintenace
2.9.3 release maintenace tasks
2024-10-22 16:16:02 -07:00
Billy Tat 7c7af1349f Merge pull request #1515 from btat/2.8.9-maintenance
2.8.9 release maintenace tasks
2024-10-22 16:15:49 -07:00
Billy Tat 0af60cc5e4 Merge pull request #1516 from btat/2.7.16-maintenance
2.7.16 release maintenace tasks
2024-10-22 16:15:38 -07:00
Billy Tat f02c9fa903 [2.7.16] deprecated features table entry 2024-10-21 15:52:45 -07:00
Billy Tat 5fdee777bd [2.7.16] csp adapter table entry 2024-10-21 15:52:43 -07:00
Billy Tat f1bb58afb8 [2.7.16] webhook table entry 2024-10-21 15:52:40 -07:00
Billy Tat d1b91c66ca [2.7.16] versions table entry 2024-10-21 15:52:32 -07:00
Billy Tat 0027e75e1b [2.8.9] deprecated features table entry 2024-10-21 14:58:03 -07:00
Billy Tat 41f2fc445c [2.8.9] csp adapter table entry 2024-10-21 14:47:50 -07:00
Billy Tat 0804f66af1 [2.8.9] webhook table entry 2024-10-21 14:47:22 -07:00
Billy Tat 1307c56eb4 [2.8.9] versions table entry 2024-10-21 14:46:22 -07:00
Billy Tat f9cc03d60a [2.9.3] CNI popularity 2024-10-21 14:10:43 -07:00
Billy Tat 9446177dc4 [2.9.3] deprecated features table entry 2024-10-21 14:06:30 -07:00
Billy Tat 99800a17ef [2.9.3] csp adapter table entry 2024-10-21 14:01:23 -07:00
Billy Tat 8abdd21d8a [2.9.3] webhook table entry 2024-10-21 14:00:01 -07:00
Billy Tat c6ba83859b [2.9.3] versions table 2024-10-21 13:56:07 -07:00
Billy Tat 94b65faa44 Merge pull request #827 from eliaoggian/patch-1
Add client roles mapping section
2024-10-18 16:53:10 -07:00
Billy Tat 11d4078f46 Apply da5890332 (Add client roles mapping section) to other doc versions/languages 2024-10-18 15:08:32 -07:00
eliaoggian da58903325 Add client roles mapping section 2024-10-18 13:40:50 -07:00
Billy Tat 945315f245 Merge pull request #1513 from btat/docker-links
[SURE-9212] Use GitHub links for upstream Docker Machine docs (404s)
2024-10-18 10:07:55 -07:00
Billy Tat b4ce792df2 Use GitHub links for upstream Docker Machine docs (404s) 2024-10-17 16:41:11 -07:00
Venkata Krishna Rohit Sakala 3f7782f84f Update file size limit to 30MB 2024-10-16 08:19:00 -07:00
Billy Tat 1a843f0a4d Merge pull request #1509 from btat/disable-vale-workflow
Remove vale workflow - contains unapproved GHA
2024-10-16 07:46:36 -07:00
Billy Tat c23bc94ea0 Remove vale workflow - contains unapproved GHA 2024-10-15 16:48:28 -07:00
Billy Tat 71ac7dcbfc Merge pull request #1499 from inichols/patch-1
Add manage-namespaces documentation
2024-10-15 15:30:48 -07:00
Billy Tat bda113856e Merge pull request #1306 from sunilarjun/windows_clusters
Windows Clusters Page Refresh - RKE2 Instructions
2024-10-15 14:02:38 -07:00
Billy Tat 277b580982 Port 93710057 (Add manage-namespaces documentation) to other en/zh 2.7-2.9 2024-10-15 13:53:49 -07:00
Billy Tat 344d8a459e Merge pull request #1503 from sunilarjun/fix-spelling
Fix Spelling Error
2024-10-15 13:23:46 -07:00
Sunil Singh a38f3e99fe Fixing spelling error
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-10-15 08:56:00 -07:00
Sunil Singh 67d40678bd Merge pull request #1502 from sharuzzaman/patch-1
fix minor typo in aws.md
2024-10-15 08:45:32 -07:00
Sharuzzaman Ahmat Raslan 55134189c4 fix minor typo in aws.md
fix minor typo for "requirements"
2024-10-15 17:45:31 +08:00
Sunil Singh ffe10f7547 Rephrasing sentence with repeated words
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-10-14 11:52:08 -07:00
Sunil Singh a490c41345 Adding update to v2.9
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-10-14 11:45:38 -07:00
Sunil Singh 7550ebdc0d Merge branch 'rancher:main' into windows_clusters 2024-10-14 10:30:42 -07:00
Sunil Singh 1a616407fb Merge pull request #1500 from rancher/dependabot/submodules/dot-github/styles/suse-vale-styleguide-45136e8
Bump .github/styles/suse-vale-styleguide from `f773efe` to `45136e8`
2024-10-11 10:09:10 -07:00
dependabot[bot] 5c65a6af95 Bump .github/styles/suse-vale-styleguide from f773efe to 45136e8
Bumps [.github/styles/suse-vale-styleguide](https://github.com/openSUSE/suse-vale-styleguide) from `f773efe` to `45136e8`.
- [Release notes](https://github.com/openSUSE/suse-vale-styleguide/releases)
- [Commits](https://github.com/openSUSE/suse-vale-styleguide/compare/f773efe265a8aa99ee6f9ebd0decd28ec23dc161...45136e8ea14ebbe0851ae87791f068507b02d636)

---
updated-dependencies:
- dependency-name: ".github/styles/suse-vale-styleguide"
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-10-11 16:15:23 +00:00
Ian 937100578f Add manage-namespaces documentation
https://github.com/rancher/webhook/blob/release/v0.4/docs.md#project-annotation
2024-10-10 12:23:48 -04:00
Billy Tat 20d079f793 Merge pull request #1498 from btat/support-matrix-link
Add missing support matrix links 2.9.2, 2.8.8, 2.8.6, 2.7.15
2024-10-09 12:48:43 -07:00
Billy Tat fc3da395f2 Merge pull request #1496 from btat/2.9-ui-redirects
Add redirects used in dashboard#12040
2024-10-09 12:48:34 -07:00
Billy Tat 6304229950 Add missing support matrix links 2.9.2, 2.8.8, 2.8.6, 2.7.15
- Fix incorrect syntax on 2.9.1, 2.8.7 links
- Move 2.6.x under EOL
2024-10-08 13:27:42 -07:00
Billy Tat c633a956f0 Add redirects used in dashboard#12040 2024-10-03 14:11:47 -07:00
Tony Hansen 674ae23ce1 Update add-tls-secrets.md
Fixed command to generate CA certificate to match working command from https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/resources/update-rancher-certificate

Old command results in failures
2024-10-03 13:40:26 -05:00
pdellamoreandGuilherme Macedo 854582ad8e Update Rancher CVE Status (#1493)
* Update Rancher CVE Status

* Update versioned docs

* Update versioned_docs/version-2.9/reference-guides/rancher-security/security-advisories-and-cves.md

---------

Co-authored-by: Guilherme Macedo <guilherme@gmacedo.com>
2024-10-01 13:32:38 -07:00
Billy Tat c58f080356 Merge pull request #1492 from martyav/fix-order-of-headings-2
Fix order of headings 2
2024-09-23 10:24:47 -07:00
martyav 6c694a48fb merge conflicts 2024-09-23 12:12:01 -04:00
martyav 05367ada1f fixed neuvector.overview.md 2024-09-23 12:05:04 -04:00
Billy Tat cefe2dede2 Merge pull request #1491 from btat/misc-fixes
Misc fixes
2024-09-23 09:04:47 -07:00
martyav 064f8d154e fixed monitoring-and-alerting.md 2024-09-23 12:01:43 -04:00
martyav 0e6787fb1a fixed longhorn/overview.md 2024-09-23 11:51:37 -04:00
martyav 7ed34be460 fixed taints-and-tolerations.md 2024-09-23 11:32:45 -04:00
martyav 0a583cfd96 fix logging-helm-chart-options.md 2024-09-23 11:25:29 -04:00
martyav d30297a7ec fix logging-architecture.md 2024-09-23 11:22:53 -04:00
martyav 25ca84160c fix harvester/overview.md 2024-09-23 11:20:06 -04:00
martyav e56ee25390 fix custom-benchmark.md 2024-09-23 11:17:40 -04:00
martyav 1b842c7a60 fixed cis-scans/configuration-reference.md 2024-09-23 10:54:45 -04:00
martyav 3c7ae53ca7 fixed supportconfig.md 2024-09-23 10:48:45 -04:00
martyav e0a8ee2fec Revert "fixed http-proxy-configuration.md"
This reverts commit e0b46a9019.
2024-09-23 10:38:57 -04:00
martyav a6415414bc Revert "fixed prometheus-operator.md again -- broken admonition in adoc version of file due to ':::note Important:' syntax"
This reverts commit 870c79d7f4.
2024-09-23 10:38:18 -04:00
Billy Tat 7d05add335 Filepath not needed for link to section on same page 2024-09-22 15:37:25 -07:00
Billy Tat 616971b754 Incorrect link location 2024-09-22 13:51:49 -07:00
Billy Tat a852001c41 Replace roundabout link path 2024-09-22 10:52:51 -07:00
Billy Tat 65012c0616 Link to correct file instead of self-reference 2024-09-22 10:46:27 -07:00
Billy Tat efd2bd289e Incorrect/self-referencing link 2024-09-22 10:17:26 -07:00
Billy Tat 2b36bf35c1 Fix indentation: causing triple backtick to render in codeblock 2024-09-20 15:48:20 -07:00
Billy Tat 4a06d3b5fb Remove self-reference in link 2024-09-20 15:35:44 -07:00
Billy Tat 7040fd6ef6 Use filepath syntax for link 2024-09-20 15:27:20 -07:00
Billy Tat f5b5da0e71 Use consistent Q/A syntax 2024-09-20 15:23:39 -07:00
Billy Tat 03c7c1e64b Merge pull request #1490 from btat/ui-experimental-sidebar
Add missing sidebar entry for ui server side pagination
2024-09-20 11:28:31 -07:00
Billy Tat bf56b00211 Add missing sidebar entry for ui server side pagination 2024-09-20 10:42:40 -07:00
Billy Tat 50ca0545e3 Merge release/v2.8.8 into main (#1479)
* 2.8.8 versions table entry

* 2.8.8 webhook table entry

* 2.8.8 csp adapter entry

* 2.8.8 deprecated features entry
2024-09-20 12:39:28 -04:00
Billy TatandSunil Singh 9fd45993e4 Merge release/v2.9.2 into main (#1482)
* 2.9.2 versions table entry

* 2.9.2 webhook table entry

* 2.9.2 csp adapter table entry

* 2.9.2 deprecated features table entry

* Typo

Co-authored-by: Sunil Singh <sunil.singh@suse.com>

---------

Co-authored-by: Sunil Singh <sunil.singh@suse.com>
2024-09-20 12:39:10 -04:00
martyav 4bf87b13c4 fixed air-gapped-upgrades.md 2024-09-20 11:24:20 -04:00
martyav e0b46a9019 fixed http-proxy-configuration.md 2024-09-20 11:21:27 -04:00
martyav 870c79d7f4 fixed prometheus-operator.md again -- broken admonition in adoc version of file due to ':::note Important:' syntax 2024-09-20 11:13:15 -04:00
Billy Tat 56b73b0135 Merge pull request #1487 from btat/zh-latest-header-levels
zh/latest fix header levels
2024-09-19 13:01:47 -07:00
martyav 8d94b3ce83 fixed node-template-configuration/digital-ocean.md 2024-09-19 15:31:56 -04:00
martyav 07b62b0443 fixed gke-private-clusters.md 2024-09-19 15:25:43 -04:00
martyav 49156a110c fixed dynamically-provision-new-storage,md 2024-09-19 15:16:57 -04:00
martyav ac7f517184 fixed set-up-existing-storage.md 2024-09-19 15:16:46 -04:00
martyav b978a56e85 fixed advanced-options.md 2024-09-19 15:16:32 -04:00
martyav 9bd7ddaf83 fixed prometheus-federator.md 2024-09-19 15:16:19 -04:00
martyav eac601179f fixed add-users-to-projects 2024-09-19 15:16:07 -04:00
Billy Tat dc2b84900b zh/latest fix header levels 2024-09-19 12:05:51 -07:00
Billy Tat a0739d3569 Merge pull request #1488 from btat/zh-2.8-header-levels
zh/2.8 fix header levels
2024-09-19 11:41:34 -07:00
martyav 21ec1b7320 fixed other-troubleshooting-tips/registered-clusters.md 2024-09-19 12:41:31 -04:00
martyav 9c3281e07e fixed user-id-tracking-in-audit-logs.md 2024-09-19 12:27:48 -04:00
martyav cc9e0ea135 fixed other-troubleshooting-tips/networking.md 2024-09-19 12:25:02 -04:00
Billy Tat 058e12628e Merge branch 'main' into zh-2.8-header-levels 2024-09-18 22:58:39 -07:00
Billy Tat 8c8ec320c2 zh/2.8 fix header levels 2024-09-18 22:56:44 -07:00
Billy Tat 52906fbd36 Merge pull request #1486 from btat/zh-2.8-links-pages-for-subheaders
zh/2.8: fix links related to old pages-for-subheaders dir and files
2024-09-18 17:07:31 -07:00
Billy Tat 9b42a00a10 Merge pull request #1484 from btat/zh-latest-links-pages-for-subheaders
zh latest: fix links related to old pages-for-subheaders dir and files
2024-09-18 15:48:17 -07:00
Billy TatandMarty Hernandez Avedon ae79d901c3 Update i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md
Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>
2024-09-18 14:42:59 -07:00
Marty Hernandez Avedon c869ea69ac Fix order of headings (#1465)
* Fix 'title out of sequence' errors

fixed Dockershim.md

* fixed deprecated-features.md

* fixed install-and-configure-kubectl.md

* fixed rancher-is-no-longer-needed.md

* fixed security.md

* fixed technical-items.md + spacing, duplicate section, admonitions

* fixed telemetry.md

* fixed upgrades.md

* fixed upgrade-kubernetes-without-upgrading-rancher.md

* fixed air-gapped-upgrades.md

* fixed dockershim.md

* fixed docker-install-commands.md

* fixed install-kubernetes.md

* fixed infrastructure-private-registry.md

* fixed install-rancher-ha

* fixed manage-namespaces and tune-etcd-for-large-installs.md

* fixed cis-scans/configuration-reference.md

* fixed custom-benchmark.md

* fixed supportconfig.md

* fixed harvester/overview.md

* fixed logging-architecture.md

* fixed logging-helm-chart-options.md + rm'd unnecessary annotation title

* fixed taints-and-tolerances.md

* fixed longhorn/overview.md

* fixed neuvector/overview.md

* fixed monitoring-and-alerting

* fixed rancher-cli.md

* fixed cluster-configuration.md

* fixed monitoring-v2-configuration/examples.md

* fixed servicemonitors-and-podmonitors.md

* fixed other-troubleshooting-tips/dns.md
2024-09-18 14:02:55 -04:00
Billy Tat 02db87e946 zh/2.8: fix links related to old pages-for-subheaders dir and files 2024-09-17 22:38:48 -07:00
Billy Tat 662154b2f3 zh latest: fix links related to old pages-for-subheaders dir and files 2024-09-17 21:58:47 -07:00
Billy Tat 9d5db0e3d0 Fix zh/2.8 links 2024-09-17 15:39:45 -07:00
martyav e6ffc6456c fixed other-troubleshooting-tips/rancher-ha.md 2024-09-17 17:31:27 -04:00
martyav 4a6721f6ab fixed expired-webhook-certificate-rotation.md 2024-09-17 16:30:17 -04:00
martyav 40901b29f7 fixed rancher-security.md 2024-09-17 16:25:05 -04:00
martyav 3552897924 fixed kubernetes-security-best-practices.md 2024-09-17 16:18:39 -04:00
martyav 7920b689cc Fix order of headings part 2 - next 30 commits
fixed communicating-with-downstream-user-clusters.md
2024-09-17 16:15:24 -04:00
Billy Tat 9f8e1a7a53 Merge pull request #1483 from btat/zh-latest-links
Fix zh/latest links
2024-09-17 11:31:25 -07:00
Billy Tat 32ca0e3ce4 Fix zh/latest links 2024-09-17 08:10:18 -07:00
Billy Tat 07ce57faea Merge pull request #1480 from rancher/revert-1478-cni-pop
Revert "2.8.8/2.9.2 update cni stats"
2024-09-16 18:59:06 -07:00
Billy Tat 0f91ef8082 Revert "2.8.8/2.9.2 update cni stats" 2024-09-16 16:37:07 -07:00
Billy Tat 13de70b576 Merge pull request #1478 from btat/cni-pop
2.8.8/2.9.2 update cni stats
2024-09-16 16:26:19 -07:00
Billy Tat 7d5124973e Merge pull request #1469 from btat/support-matrix-links
Add 2.8.7 and 2.9.1 support matrix links
2024-09-16 16:16:06 -07:00
Billy Tat 3686c39346 2.8.8/2.9.2 update cni stats 2024-09-16 14:40:42 -07:00
Billy Tat 44510920e7 Add 2.8.7 and 2.9.1 support matrix links 2024-09-16 14:19:50 -07:00
Sunil Singh 85a88fcafb Merge pull request #1468 from rancher/dependabot/submodules/dot-github/styles/suse-vale-styleguide-f773efe
Bump .github/styles/suse-vale-styleguide from `1701ad8` to `f773efe`
2024-09-16 10:11:26 -07:00
Dharmit ShahandMarty Hernandez Avedon 86a9be9d39 Add Telegram receiver docs (#1408)
* Add Telegram receiver docs

Signed-off-by: Dharmit Shah <dharmit.shah@suse.com>

* Apply suggestions from martyav's review

Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>

* Undo removal of SMS receiver documentation

Signed-off-by: Dharmit Shah <dharmit.shah@suse.com>

* Apply suggestions from martyav's second review

Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>

* Apply suggestions from martyav's third review

Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>

* versioned for v2.9

* versioned for v2.8 + rm outdated comment

---------

Signed-off-by: Dharmit Shah <dharmit.shah@suse.com>
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-09-16 13:07:24 -04:00
Yiannis Triantafyllopoulos 785d49c44d docs: Add missing EKS permission (#1467) 2024-09-16 13:07:00 -04:00
dependabot[bot] c5d8c4ff54 Bump .github/styles/suse-vale-styleguide from 1701ad8 to f773efe
Bumps [.github/styles/suse-vale-styleguide](https://github.com/openSUSE/suse-vale-styleguide) from `1701ad8` to `f773efe`.
- [Release notes](https://github.com/openSUSE/suse-vale-styleguide/releases)
- [Commits](https://github.com/openSUSE/suse-vale-styleguide/compare/1701ad82d0da679f2e8943c877722923adb2411b...f773efe265a8aa99ee6f9ebd0decd28ec23dc161)

---
updated-dependencies:
- dependency-name: ".github/styles/suse-vale-styleguide"
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-09-16 16:14:38 +00:00
Yiannis Triantafyllopoulos 554e0d338c docs: Add EBS CSI Driver permissions to 2.9 (#1454)
* docs: Add EBS CSI Driver permissions to 2.9

* docs: Adjust wording and keep 2.9 and latest in sync
2024-09-13 15:38:35 -04:00
Artem Sadovskyi ed271e1eb1 Fixing an ordered list in Setting up Infrastructure for a High Availability RKE2 Kubernetes Cluster doc (#1461)
* docs: typo in order

* docs: mirroring the changes in `/versioned_docs/version-2.9`
2024-09-13 14:36:20 -04:00
Billy Tat d89af44ad3 Merge pull request #1459 from kourosh7/main
Update rollbacks.md
2024-09-10 14:00:27 -07:00
Kourosh Maneshni 79f1c8db65 Update rollbacks.md
remove extra text
2024-09-10 13:22:36 -07:00
Billy Tat 3562f042a9 Merge pull request #1457 from sunilarjun/capi-update
Updating CAPI Page
2024-09-10 13:16:17 -07:00
Kourosh Maneshni f96b09c6fd Update rollbacks.md
remove unnecessary path in section `Step 2`
2024-09-10 13:03:51 -07:00
Sunil Singh c507ddc1be Updating the phrasing to with link to concept definition in Kubernetes docs. The CAPI Operator is not a Rancher Extension currently.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-09-10 09:30:41 -07:00
gunamata 10197cb117 Merge pull request #1450 from gunamata/suse-observability-overview
Added a intro page for SUSE Observability
2024-08-29 15:05:12 -07:00
Gunasekhar Matamalam 3b62acfa4c Minor change based on the PR review feedback
Signed-off-by: Gunasekhar Matamalam <gunasekhar.matamalam@suse.com>
2024-08-29 08:36:24 -07:00
gunamataandMarty Hernandez Avedon e19ebe2165 Update docs/integrations-in-rancher/suse-observability/suse-observability.md
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-08-29 08:31:47 -07:00
Gunasekhar Matamalam 6afb686967 Added a intro page for SUSE Observability
Signed-off-by: Gunasekhar Matamalam <gunasekhar.matamalam@suse.com>
2024-08-28 14:31:35 -07:00
Billy Tat 9cb79db3db Merge pull request #1385 from mallardduck/bro-docs-fix
[2.9.1][2.8-Next1] Add info about Private Registry Credentials covering backup labels
2024-08-26 16:37:52 -07:00
Billy Tat 3d868453d3 Merge pull request #1446 from rancher/release/v2.8
Merge release/v2.8 into main
2024-08-26 16:36:13 -07:00
Billy Tat ac40bb0ea1 Merge pull request #1433 from martyav/2.8.7-versions-table
[v2.8.7] Update versions table
2024-08-26 09:19:26 -07:00
Billy Tat 1b61165bfd Merge pull request #1435 from martyav/2.8.7-rancher-webhook
[v2.8.7] Update Webhook Table
2024-08-26 09:17:50 -07:00
Billy Tat 6b5c953747 Merge pull request #1438 from martyav/2.8.7-csp-table
[v2.8.7] Update CSP Adapter Table
2024-08-26 09:15:46 -07:00
Billy Tat e317ba5076 Merge pull request #1440 from martyav/2.8.7-deprecations-table
[v2.8.7] Update Deprecations Table
2024-08-26 09:01:58 -07:00
ea245e3f5b [v2.8.7] Update from main to keep working branch PRs less messy to review (#1443)
* Use crds.enabled to install cert-manager

Signed-off-by: Dharmit Shah <dharmit.shah@suse.com>

* versioned

* reverted changes to earliest versions and slightly modified comment

* spacing issue

---------

Signed-off-by: Dharmit Shah <dharmit.shah@suse.com>
Co-authored-by: Dharmit Shah <dharmit.shah@suse.com>
Co-authored-by: Billy Tat <btat@suse.com>
2024-08-26 10:03:09 -04:00
martyav 8040234882 [v2.8.7] Update Deprecations Table 2024-08-26 08:08:51 -04:00
martyav 7d51fdb720 [v2.8.7] Update CSP Adapter Table 2024-08-26 07:31:00 -04:00
martyav 8d50cb4cb8 [v2.8.7] Update Webhook Table 2024-08-26 06:47:17 -04:00
martyav 304fbc7944 Update versions table - v2.8.7 2024-08-26 06:28:32 -04:00
Dan Pock 011085ac2d Sync versioned docs pages 2024-07-19 20:05:09 -04:00
DanandMarty Hernandez Avedon 6fd409221d Update docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry.md
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-07-19 15:06:43 -04:00
DanandMarty Hernandez Avedon 1e93509c84 Update docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry.md
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-07-19 13:32:39 -04:00
DanandMarty Hernandez Avedon 0ca00b121d Update docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry.md
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-07-19 13:32:10 -04:00
DanandMarty Hernandez Avedon 9ae6f022fc Update docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry.md
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-07-19 13:27:30 -04:00
DanandMarty Hernandez Avedon ee9876f04a Update versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry.md
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-07-19 13:27:23 -04:00
DanandMarty Hernandez Avedon 45bf343dba Update versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry.md
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-07-19 13:26:45 -04:00
DanandMarty Hernandez Avedon 38a442100c Update versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry.md
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-07-19 13:26:26 -04:00
DanandMarty Hernandez Avedon 6112a7b128 Update versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry.md
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-07-19 13:25:49 -04:00
Dan Pock bee7f2e892 Clarify the backup in question is BRO 2024-07-18 12:37:18 -04:00
Dan Pock bd87f0973b Add info about Private Registry Credentials covering backup labels 2024-07-18 11:32:44 -04:00
Sunil Singh 1c6891d6c4 Applying phrasing updates after review.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-06-24 16:08:56 -06:00
Sunil Singh df0a01ef27 Updating after review and clarification from support on CNI use/k8s versioning.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-06-04 15:18:07 -07:00
Sunil Singh 81cc1f2175 Updating across versions after review.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-05-28 09:28:16 -07:00
Sunil Singh 79b33ad924 Syncing versions
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-05-24 16:06:31 -07:00
Sunil Singh 436651447d Updating Add Nodes to the Cluster section with updated UI instructions on registering master and worker nodes for Linux/Windows. Added note for Windows worker that Linux etcd, controlplane, and worker roles must be active to display Windows worker registration command.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-05-24 13:37:59 -07:00
Sunil Singh 4ccdc3817d Updating section Create the Cluster... with removing changed UI items in Rancher and rephrasing steps with new UI fields.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-05-22 14:37:16 -07:00
Sunil Singh 2543c1baf8 Updating with Calico/Flannel CNI support and updating UI command.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-05-22 13:23:15 -07:00
Sunil Singh 74c17ebeee Updating initial section with removal of RKE1 instructions and requirements, and rephrasing with RKE2 terminology and support matrix.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-05-22 13:05:57 -07:00
2473 changed files with 146667 additions and 13163 deletions
-61
View File
@@ -1,61 +0,0 @@
# This action gets all changed markdown files in /docs and /versioned_docs using tj-actions/changed-files@v42
# It compares new commits in the PR with the base commit (github.event.pull_request.base.sha)
# It checks if no markdown files are changed
# It shows a count of markdown files and lists all changed markdown files
# It uses Vale (https://vale.sh/docs/vale-cli/installation/) to provide feedback base off the SUSE Style Guide / OpenSUSE style rules (https://github.com/openSUSE/suse-vale-styleguide)
name: Style check
on:
pull_request:
paths-ignore:
- '**/README.md'
jobs:
vale-lint:
name: runner / vale
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
continue-on-error: true
with:
fetch-depth: 0 # OR "2" -> To retrieve the preceding commit.
submodules: true
- name: Get all changed markdown files
continue-on-error: true
id: changed-markdown-files
uses: tj-actions/changed-files@v42
with:
# Avoid using single or double quotes for multiline patterns
files: |
docs/**
versioned_docs/**
separator: ","
base_sha: ${{ github.event.pull_request.base.sha }}
env:
ALL_CHANGED_FILES: ${{ 0 }}
- name: No files changed?
continue-on-error: true
if: steps.changed-markdown-files.outputs.any_changed == 'false'
run: |
echo "No files changed"
echo "ALL_CHANGED_FILES=$ALL_CHANGED_FILES" >> $GITHUB_ENV
- name: List all changed files markdown files
continue-on-error: true
if: steps.changed-markdown-files.outputs.any_changed == 'true'
env:
ALL_CHANGED_FILES: ${{ steps.changed-markdown-files.outputs.all_changed_files }}
ALL_CHANGED_FILES_COUNT: ${{ steps.changed-markdown-files.outputs.all_changed_files_count }}
SHA: ${{ github.head_ref }}
HEAD: ${{ github.base_ref }}
run: |
echo "Total Files Changed:" ${ALL_CHANGED_FILES_COUNT}
echo ${ALL_CHANGED_FILES}
echo "ALL_CHANGED_FILES=$ALL_CHANGED_FILES" >> $GITHUB_ENV
- uses: errata-ai/vale-action@v2.1.0
continue-on-error: true
if: steps.changed-markdown-files.outputs.any_changed == 'true'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
separator: ", "
files: ${{ env.ALL_CHANGED_FILES }}
@@ -8,11 +8,11 @@ title: Installing and Configuring kubectl
`kubectl` is a CLI utility for running commands against Kubernetes clusters. It's required for many maintenance and administrative tasks in Rancher 2.x.
### Installation
## Installation
See [kubectl Installation](https://kubernetes.io/docs/tasks/tools/install-kubectl/) for installation on your operating system.
### Configuration
## Configuration
When you create a Kubernetes cluster with RKE, RKE creates a `kube_config_rancher-cluster.yml` in the local directory that contains credentials to connect to your new cluster with tools like `kubectl` or `helm`.
@@ -9,11 +9,11 @@ title: Rancher is No Longer Needed
This page is intended to answer questions about what happens if you don't want Rancher anymore, if you don't want a cluster to be managed by Rancher anymore, or if the Rancher server is deleted.
### If the Rancher server is deleted, what happens to the workloads in my downstream clusters?
## If the Rancher server is deleted, what happens to the workloads in my downstream clusters?
If Rancher is ever deleted or unrecoverable, all workloads in the downstream Kubernetes clusters managed by Rancher will continue to function as normal.
### If the Rancher server is deleted, how do I access my downstream clusters?
## If the Rancher server is deleted, how do I access my downstream clusters?
The capability to access a downstream cluster without Rancher depends on the type of cluster and the way that the cluster was created. To summarize:
@@ -21,7 +21,7 @@ The capability to access a downstream cluster without Rancher depends on the typ
- **Hosted Kubernetes clusters:** If you created the cluster in a cloud-hosted Kubernetes provider such as EKS, GKE, or AKS, you can continue to manage the cluster using your provider's cloud credentials.
- **RKE clusters:** To access an [RKE cluster,](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md) the cluster must have the [authorized cluster endpoint](../reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters.md#4-authorized-cluster-endpoint) enabled, and you must have already downloaded the cluster's kubeconfig file from the Rancher UI. (The authorized cluster endpoint is enabled by default for RKE clusters.) With this endpoint, you can access your cluster with kubectl directly instead of communicating through the Rancher server's [authentication proxy.](../reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters.md#1-the-authentication-proxy) For instructions on how to configure kubectl to use the authorized cluster endpoint, refer to the section about directly accessing clusters with [kubectl and the kubeconfig file.](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#authenticating-directly-with-a-downstream-cluster) These clusters will use a snapshot of the authentication as it was configured when Rancher was removed.
### What if I don't want Rancher anymore?
## What if I don't want Rancher anymore?
If you [installed Rancher on a Kubernetes cluster,](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md) remove Rancher by using the [System Tools](../reference-guides/system-tools.md) with the `remove` subcommand.
@@ -29,7 +29,7 @@ If you installed Rancher with Docker, you can uninstall Rancher by removing the
Imported clusters will not be affected by Rancher being removed. For other types of clusters, refer to the section on [accessing downstream clusters when Rancher is removed.](#if-the-rancher-server-is-deleted-how-do-i-access-my-downstream-clusters)
### What if I don't want my imported cluster managed by Rancher?
## What if I don't want my imported cluster managed by Rancher?
If an imported cluster is deleted from the Rancher UI, the cluster is detached from Rancher, leaving it intact and accessible by the same methods that were used to access it before it was imported into Rancher.
@@ -41,7 +41,7 @@ To detach the cluster,
**Result:** The imported cluster is detached from Rancher and functions normally outside of Rancher.
### What if I don't want my RKE cluster or hosted Kubernetes cluster managed by Rancher?
## What if I don't want my RKE cluster or hosted Kubernetes cluster managed by Rancher?
At this time, there is no functionality to detach these clusters from Rancher. In this context, "detach" is defined as the ability to remove Rancher components from the cluster and manage access to the cluster independently of Rancher.
@@ -6,12 +6,10 @@ title: Security FAQ
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/faq/security"/>
</head>
**Is there a Hardening Guide?**
## Is there a Hardening Guide?
The Hardening Guide is now located in the main [Security](../reference-guides/rancher-security/rancher-security.md) section.
<br/>
**What are the results of Rancher's Kubernetes cluster when it is CIS benchmarked?**
## What are the results of Rancher's Kubernetes cluster when it is CIS benchmarked?
We have run the CIS Kubernetes benchmark against a hardened Rancher Kubernetes cluster. The results of that assessment can be found in the main [Security](../reference-guides/rancher-security/rancher-security.md) section.
@@ -6,9 +6,10 @@ title: Technical FAQ
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/faq/technical-items"/>
</head>
### How can I reset the administrator password?
## How can I reset the administrator password?
Docker install:
Docker Install:
```
$ docker exec -ti <container_id> reset-password
New password for default administrator (user-xxxxx):
@@ -16,6 +17,7 @@ New password for default administrator (user-xxxxx):
```
Kubernetes install (Helm):
```
$ KUBECONFIG=./kube_config_rancher-cluster.yml
$ kubectl --kubeconfig $KUBECONFIG -n cattle-system exec $(kubectl --kubeconfig $KUBECONFIG -n cattle-system get pods -l app=rancher | grep '1/1' | head -1 | awk '{ print $1 }') -- reset-password
@@ -23,11 +25,14 @@ New password for default administrator (user-xxxxx):
<new_password>
```
> #### **Important: RKE add-on install is only supported up to Rancher v2.0.8**
>
>If you are currently using the RKE add-on install method, see [Migrating from a Kubernetes Install with an RKE Add-on](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/migrating-from-rke-add-on.md) for details on how to start using the Helm chart.
### RKE add-on install (only supported up to Rancher v2.0.8)
:::tip
> If you are currently using the RKE add-on install method, see [Migrating from a Kubernetes Install with an RKE Add-on](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/migrating-from-rke-add-on.md) for details on how to start using the Helm chart.
:::
Kubernetes install (RKE add-on):
```
$ KUBECONFIG=./kube_config_rancher-cluster.yml
$ kubectl --kubeconfig $KUBECONFIG exec -n cattle-system $(kubectl --kubeconfig $KUBECONFIG get pods -n cattle-system -o json | jq -r '.items[] | select(.spec.containers[].name=="cattle-server") | .metadata.name') -- reset-password
@@ -35,8 +40,10 @@ New password for default administrator (user-xxxxx):
<new_password>
```
### I deleted/deactivated the last admin, how can I fix it?
Docker Install:
## I deleted/deactivated the last admin, how can I fix it?
Docker install:
```
$ docker exec -ti <container_id> ensure-default-admin
New default administrator (user-xxxxx)
@@ -52,44 +59,32 @@ New password for default administrator (user-xxxxx):
<new_password>
```
> #### **Important: RKE add-on install is only supported up to Rancher v2.0.8**
>
>If you are currently using the RKE add-on install method, see [Migrating from a Kubernetes Install with an RKE Add-on](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/migrating-from-rke-add-on.md) for details on how to start using the Helm chart.
Kubernetes install (RKE add-on):
```
$ KUBECONFIG=./kube_config_rancher-cluster.yml
$ kubectl --kubeconfig $KUBECONFIG exec -n cattle-system $(kubectl --kubeconfig $KUBECONFIG get pods -n cattle-system -o json | jq -r '.items[] | select(.spec.containers[].name=="cattle-server") | .metadata.name') -- ensure-default-admin
New password for default admin user (user-xxxxx):
<new_password>
```
### How can I enable debug logging?
## How can I enable debug logging?
See [Troubleshooting: Logging](../troubleshooting/other-troubleshooting-tips/logging.md)
### My ClusterIP does not respond to ping
## My ClusterIP does not respond to ping
ClusterIP is a virtual IP, which will not respond to ping. Best way to test if the ClusterIP is configured correctly, is by using `curl` to access the IP and port to see if it responds.
### Where can I manage Node Templates?
## Where can I manage Node Templates?
Node Templates can be accessed by opening your account menu (top right) and selecting `Node Templates`.
### Why is my Layer-4 Load Balancer in `Pending` state?
## Why is my Layer-4 Load Balancer in `Pending` state?
The Layer-4 Load Balancer is created as `type: LoadBalancer`. In Kubernetes, this needs a cloud provider or controller that can satisfy these requests, otherwise these will be in `Pending` state forever. More information can be found on [Cloud Providers](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/set-up-cloud-providers.md) or [Create External Load Balancer](https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/)
### Where is the state of Rancher stored?
## Where is the state of Rancher stored?
- Docker Install: in the embedded etcd of the `rancher/rancher` container, located at `/var/lib/rancher`.
- Kubernetes install: in the etcd of the RKE cluster created to run Rancher.
### How are the supported Docker versions determined?
## How are the supported Docker versions determined?
We follow the validated Docker versions for upstream Kubernetes releases. The validated versions can be found under [External Dependencies](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.10.md#external-dependencies) in the Kubernetes release CHANGELOG.md.
### How can I access nodes created by Rancher?
## How can I access nodes created by Rancher?
SSH keys to access the nodes created by Rancher can be downloaded via the **Nodes** view. Choose the node which you want to access and click on the vertical &#8942; button at the end of the row, and choose **Download Keys** as shown in the picture below.
@@ -101,14 +96,14 @@ Unzip the downloaded zip file, and use the file `id_rsa` to connect to you host.
$ ssh -i id_rsa user@ip_of_node
```
### How can I automate task X in Rancher?
## How can I automate task X in Rancher?
The UI consists of static files, and works based on responses of the API. That means every action/task that you can execute in the UI, can be automated via the API. There are 2 ways to do this:
* Visit `https://your_rancher_ip/v3` and browse the API options.
* Capture the API calls when using the UI (Most commonly used for this is [Chrome Developer Tools](https://developers.google.com/web/tools/chrome-devtools/#network) but you can use anything you like)
### The IP address of a node changed, how can I recover?
## The IP address of a node changed, how can I recover?
A node is required to have a static IP configured (or a reserved IP via DHCP). If the IP of a node has changed, you will have to remove it from the cluster and readd it. After it is removed, Rancher will update the cluster to the correct state. If the cluster is no longer in `Provisioning` state, the node is removed from the cluster.
@@ -116,15 +111,17 @@ When the IP address of the node changed, Rancher lost connection to the node, so
When the node is removed from the cluster, and the node is cleaned, you can readd the node to the cluster.
### How can I add more arguments/binds/environment variables to Kubernetes components in a Rancher Launched Kubernetes cluster?
## How can I add more arguments/binds/environment variables to Kubernetes components in a Rancher Launched Kubernetes cluster?
You can add more arguments/binds/environment variables via the [Config File](../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#cluster-config-file) option in Cluster Options. For more information, see the [Extra Args, Extra Binds, and Extra Environment Variables](https://rancher.com/docs/rke/latest/en/config-options/services/services-extras/) in the RKE documentation or browse the [Example Cluster.ymls](https://rancher.com/docs/rke/latest/en/example-yamls/).
### How do I check if my certificate chain is valid?
## How do I check if my certificate chain is valid?
Use the `openssl verify` command to validate your certificate chain:
>**Note:** Configure `SSL_CERT_DIR` and `SSL_CERT_FILE` to a dummy location to make sure the OS installed certificates are not used when verifying manually.
:::tip
Configure `SSL_CERT_DIR` and `SSL_CERT_FILE` to a dummy location to make sure the OS installed certificates are not used when verifying manually.
:::
```
SSL_CERT_DIR=/dummy SSL_CERT_FILE=/dummy openssl verify -CAfile ca.pem rancher.yourdomain.com.pem
@@ -157,7 +154,7 @@ subject= /C=GB/ST=England/O=Alice Ltd/CN=rancher.yourdomain.com
issuer= /C=GB/ST=England/O=Alice Ltd/CN=Alice Intermediate CA
```
### How do I check `Common Name` and `Subject Alternative Names` in my server certificate?
## How do I check `Common Name` and `Subject Alternative Names` in my server certificate?
Although technically an entry in `Subject Alternative Names` is required, having the hostname in both `Common Name` and as entry in `Subject Alternative Names` gives you maximum compatibility with older browser/applications.
@@ -175,7 +172,7 @@ openssl x509 -noout -in cert.pem -text | grep DNS
DNS:rancher.my.org
```
### Why does it take 5+ minutes for a pod to be rescheduled when a node has failed?
## Why does it take 5+ minutes for a pod to be rescheduled when a node has failed?
This is due to a combination of the following default Kubernetes settings:
@@ -194,6 +191,6 @@ In Kubernetes v1.13, the `TaintBasedEvictions` feature is enabled by default. Se
* `default-not-ready-toleration-seconds`: Indicates the tolerationSeconds of the toleration for notReady:NoExecute that is added by default to every pod that does not already have such a toleration.
* `default-unreachable-toleration-seconds`: Indicates the tolerationSeconds of the toleration for unreachable:NoExecute that is added by default to every pod that does not already have such a toleration.
### Can I use keyboard shortcuts in the UI?
## Can I use keyboard shortcuts in the UI?
Yes, most parts of the UI can be reached using keyboard shortcuts. For an overview of the available shortcuts, press `?` anywhere in the UI.
@@ -6,11 +6,11 @@ title: Telemetry FAQ
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/faq/telemetry"/>
</head>
### What is Telemetry?
## What is Telemetry?
Telemetry collects aggregate information about the size of Rancher installations, versions of components used, and which features are used. This information is used by Rancher Labs to help make the product better and is not shared with third-parties.
### What information is collected?
## What information is collected?
No specific identifying information like usernames, passwords, or the names or addresses of user resources will ever be collected.
@@ -24,12 +24,12 @@ The primary things collected include:
- The image name & version of Rancher that is running.
- A unique randomly-generated identifier for this installation.
### Can I see the information that is being sent?
## Can I see the information that is being sent?
If Telemetry is enabled, you can go to `https://<your rancher server>/v1-telemetry` in your installation to see the current data.
If Telemetry is not enabled, the process that collects the data is not running, so there is nothing being collected to look at.
### How do I turn it on or off?
## How do I turn it on or off?
After initial setup, an administrator can go to the `Settings` page in the `Global` section of the UI and click Edit to change the `telemetry-opt` setting to either `in` or `out`.
@@ -6,7 +6,7 @@ When running larger Rancher installations with 15 or more clusters it is recomme
The etcd data set is automatically cleaned up on a five minute interval by Kubernetes. There are situations, e.g. deployment thrashing, where enough events could be written to etcd and deleted before garbage collection occurs and cleans things up causing the keyspace to fill up. If you see `mvcc: database space exceeded` errors, in the etcd logs or Kubernetes API server logs, you should consider increasing the keyspace size. This can be accomplished by setting the [quota-backend-bytes](https://etcd.io/docs/v3.3/op-guide/maintenance/#space-quota) setting on the etcd servers.
### Example: This snippet of the RKE cluster.yml file increases the keyspace size to 5GB
## Example: This Snippet of the RKE Cluster.yml file Increases the Keyspace Size to 5GB
```yaml
# RKE cluster.yml
@@ -17,7 +17,7 @@ services:
quota-backend-bytes: 5368709120
```
## Scaling etcd disk performance
## Scaling etcd Disk Performance
You can follow the recommendations from [the etcd docs](https://etcd.io/docs/v3.3/tuning/#disk) on how to tune the disk priority on the host.
@@ -108,7 +108,6 @@ You'll use the backup as a restoration point if something goes wrong during upgr
> **Note:** If you want to switch to a different Helm chart repository, please follow the [steps on how to switch repositories](../../resources/choose-a-rancher-version.md#switching-to-a-different-helm-chart-repository). If you switch repositories, make sure to list the repositories again before continuing onto Step 3 to ensure you have the correct one added.
1. Fetch the latest chart to install Rancher from the Helm chart repository.
This command will pull down the latest charts and save it in the current directory as a `.tgz` file.
@@ -188,7 +187,6 @@ If you are currently running the cert-manager whose version is older than v0.11,
--set hostname=rancher.my.org
```
</TabItem>
<TabItem value="Kubernetes Air Gap Upgrade">
@@ -203,7 +201,6 @@ Placeholder | Description
`<REGISTRY.YOURDOMAIN.COM:PORT>` | The DNS name for your private registry.
`<CERTMANAGER_VERSION>` | Cert-manager version running on k8s cluster.
### Option A: Default Self-signed Certificate
```plain
@@ -23,7 +23,7 @@ We recommend setting up the following infrastructure for a high-availability ins
- **A DNS record** to map a URL to the load balancer. This will become the Rancher server URL, and downstream Kubernetes clusters will need to reach it.
- **A private Docker registry** to distribute Docker images to your machines.
### 1. Set up Linux Nodes
## 1. Set up Linux Nodes
These hosts will be disconnected from the internet, but require being able to connect with your private registry.
@@ -31,7 +31,7 @@ Make sure that your nodes fulfill the general installation requirements for [OS,
For an example of one way to set up Linux nodes, refer to this [tutorial](../../../../how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2.md) for setting up nodes as instances in Amazon EC2.
### 2. Set up External Datastore
## 2. Set up External Datastore
The ability to run Kubernetes using a datastore other than etcd sets K3s apart from other Kubernetes distributions. This feature provides flexibility to Kubernetes operators. The available options allow you to select a datastore that best fits your use case.
@@ -47,7 +47,7 @@ For an example of one way to set up the database, refer to this [tutorial](../..
For the complete list of options that are available for configuring a K3s cluster datastore, refer to the [K3s documentation.](https://rancher.com/docs/k3s/latest/en/installation/datastore/)
### 3. Set up the Load Balancer
## 3. Set up the Load Balancer
You will also need to set up a load balancer to direct traffic to the Rancher replica on both nodes. That will prevent an outage of any single node from taking down communications to the Rancher management server.
@@ -67,7 +67,7 @@ For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to
> **Important:**
> Do not use this load balancer (i.e, the `local` cluster Ingress) to load balance applications other than Rancher following installation. Sharing this Ingress with other applications may result in websocket errors to Rancher following Ingress configuration reloads for other apps. We recommend dedicating the `local` cluster to Rancher and no other applications.
### 4. Set up the DNS Record
## 4. Set up the DNS Record
Once you have set up your load balancer, you will need to create a DNS record to send traffic to this load balancer.
@@ -77,7 +77,7 @@ You will need to specify this hostname in a later step when you install Rancher,
For a how-to guide for setting up a DNS record to route domain traffic to an Amazon ELB load balancer, refer to the [official AWS documentation.](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-elb-load-balancer)
### 5. Set up a Private Docker Registry
## 5. Set up a Private Docker Registry
Rancher supports air gap installs using a private registry. You must have your own private registry or other means of distributing Docker images to your machines.
@@ -97,13 +97,13 @@ To install the Rancher management server on a high-availability RKE cluster, we
These nodes must be in the same region/data center. You may place these servers in separate availability zones.
### Why three nodes?
## Why Three Nodes?
In an RKE cluster, Rancher server data is stored on etcd. This etcd database runs on all three nodes.
The etcd database requires an odd number of nodes so that it can always elect a leader with a majority of the etcd cluster. If the etcd database cannot elect a leader, etcd can suffer from [split brain](https://www.quora.com/What-is-split-brain-in-distributed-systems), requiring the cluster to be restored from backup. If one of the three etcd nodes fails, the two remaining nodes can elect a leader because they have the majority of the total number of etcd nodes.
### 1. Set up Linux Nodes
## 1. Set up Linux Nodes
These hosts will be disconnected from the internet, but require being able to connect with your private registry.
@@ -111,7 +111,7 @@ Make sure that your nodes fulfill the general installation requirements for [OS,
For an example of one way to set up Linux nodes, refer to this [tutorial](../../../../how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2.md) for setting up nodes as instances in Amazon EC2.
### 2. Set up the Load Balancer
## 2. Set up the Load Balancer
You will also need to set up a load balancer to direct traffic to the Rancher replica on both nodes. That will prevent an outage of any single node from taking down communications to the Rancher management server.
@@ -131,7 +131,7 @@ For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to
> **Important:**
> Do not use this load balancer (i.e, the `local` cluster Ingress) to load balance applications other than Rancher following installation. Sharing this Ingress with other applications may result in websocket errors to Rancher following Ingress configuration reloads for other apps. We recommend dedicating the `local` cluster to Rancher and no other applications.
### 3. Set up the DNS Record
## 3. Set up the DNS Record
Once you have set up your load balancer, you will need to create a DNS record to send traffic to this load balancer.
@@ -141,7 +141,7 @@ You will need to specify this hostname in a later step when you install Rancher,
For a how-to guide for setting up a DNS record to route domain traffic to an Amazon ELB load balancer, refer to the [official AWS documentation.](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-elb-load-balancer)
### 4. Set up a Private Docker Registry
## 4. Set up a Private Docker Registry
Rancher supports air gap installs using a secure Docker private registry. You must have your own private registry or other means of distributing Docker images to your machines.
@@ -157,7 +157,7 @@ If you need help with creating a private registry, please refer to the [official
>
> For Rancher v2.0-v2.4, there is no migration path from a Docker installation to a high-availability installation. Therefore, you may want to use a Kubernetes installation from the start.
### 1. Set up a Linux Node
## 1. Set up a Linux Node
This host will be disconnected from the Internet, but needs to be able to connect to your private registry.
@@ -165,7 +165,7 @@ Make sure that your node fulfills the general installation requirements for [OS,
For an example of one way to set up Linux nodes, refer to this [tutorial](../../../../how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2.md) for setting up nodes as instances in Amazon EC2.
### 2. Set up a Private Docker Registry
## 2. Set up a Private Docker Registry
Rancher supports air gap installs using a Docker private registry on your bastion server. You must have your own private registry or other means of distributing Docker images to your machines.
@@ -174,4 +174,4 @@ If you need help with creating a private registry, please refer to the [official
</TabItem>
</Tabs>
### [Next: Collect and Publish Images to your Private Registry](publish-images.md)
## [Next: Collect and Publish Images to your Private Registry](publish-images.md)
@@ -21,14 +21,15 @@ The steps to set up an air-gapped Kubernetes cluster on RKE or K3s are shown bel
In this guide, we are assuming you have created your nodes in your air gapped environment and have a secure Docker private registry on your bastion server.
### Installation Outline
## Installation Outline
1. [Prepare Images Directory](#1-prepare-images-directory)
2. [Create Registry YAML](#2-create-registry-yaml)
3. [Install K3s](#3-install-k3s)
4. [Save and Start Using the kubeconfig File](#4-save-and-start-using-the-kubeconfig-file)
### 1. Prepare Images Directory
## 1. Prepare Images Directory
Obtain the images tar file for your architecture from the [releases](https://github.com/rancher/k3s/releases) page for the version of K3s you will be running.
Place the tar file in the `images` directory before starting K3s on each node, for example:
@@ -38,7 +39,8 @@ sudo mkdir -p /var/lib/rancher/k3s/agent/images/
sudo cp ./k3s-airgap-images-$ARCH.tar /var/lib/rancher/k3s/agent/images/
```
### 2. Create Registry YAML
## 2. Create Registry YAML
Create the registries.yaml file at `/etc/rancher/k3s/registries.yaml`. This will tell K3s the necessary details to connect to your private registry.
The registries.yaml file should look like this before plugging in the necessary information:
@@ -64,7 +66,7 @@ Note, at this time only secure registries are supported with K3s (SSL with custo
For more information on private registries configuration file for K3s, refer to the [K3s documentation.](https://rancher.com/docs/k3s/latest/en/installation/private-registry/)
### 3. Install K3s
## 3. Install K3s
Rancher needs to be installed on a supported Kubernetes version. To find out which versions of Kubernetes are supported for your Rancher version, refer to the [support maintenance terms.](https://rancher.com/support-maintenance-terms/)
@@ -93,7 +95,7 @@ The node-token is on the server at `/var/lib/rancher/k3s/server/node-token`
>**Note:** K3s additionally provides a `--resolv-conf` flag for kubelets, which may help with configuring DNS in air-gap networks.
### 4. Save and Start Using the kubeconfig File
## 4. Save and Start Using the kubeconfig File
When you installed K3s on each Rancher server node, a `kubeconfig` file was created on the node at `/etc/rancher/k3s/k3s.yaml`. This file contains credentials for full access to the cluster, and you should save this file in a secure location.
@@ -133,7 +135,7 @@ kubectl --kubeconfig ~/.kube/config/k3s.yaml get pods --all-namespaces
For more information about the `kubeconfig` file, refer to the [K3s documentation](https://rancher.com/docs/k3s/latest/en/cluster-access/) or the [official Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) about organizing cluster access using `kubeconfig` files.
### Note on Upgrading
## Note on Upgrading
Upgrading an air-gap environment can be accomplished in the following manner:
@@ -146,11 +148,11 @@ Upgrading an air-gap environment can be accomplished in the following manner:
We will create a Kubernetes cluster using Rancher Kubernetes Engine (RKE). Before being able to start your Kubernetes cluster, you’ll need to install RKE and create a RKE config file.
### 1. Install RKE
## 1. Install RKE
Install RKE by following the instructions in the [RKE documentation.](https://rancher.com/docs/rke/latest/en/installation/)
### 2. Create an RKE Config File
## 2. Create an RKE Config File
From a system that can access ports 22/TCP and 6443/TCP on the Linux host node(s) that you set up in a previous step, use the sample below to create a new file named `rancher-cluster.yml`.
@@ -197,7 +199,7 @@ private_registries:
is_default: true
```
### 3. Run RKE
## 3. Run RKE
After configuring `rancher-cluster.yml`, bring up your Kubernetes cluster:
@@ -205,7 +207,7 @@ After configuring `rancher-cluster.yml`, bring up your Kubernetes cluster:
rke up --config ./rancher-cluster.yml
```
### 4. Save Your Files
## 4. Save Your Files
> **Important**
> The files mentioned below are needed to maintain, troubleshoot and upgrade your cluster.
@@ -221,8 +223,8 @@ Save a copy of the following files in a secure location:
> **Note:** The "rancher-cluster" parts of the two latter file names are dependent on how you name the RKE cluster configuration file.
### Issues or errors?
## Issues or Errors?
See the [Troubleshooting](../../install-upgrade-on-a-kubernetes-cluster/troubleshooting.md) page.
### [Next: Install Rancher](install-rancher-ha.md)
## [Next: Install Rancher](install-rancher-ha.md)
@@ -182,7 +182,7 @@ Use `kubectl` to create namespaces and apply the rendered manifests.
If you choose to use self-signed certificates in [2. Choose your SSL Configuration](#2-choose-your-ssl-configuration), install cert-manager.
### For Self-Signed Certificate Installs, Install Cert-manager
### For Self-Signed Certificate Installs, Install cert-manager
<details id="install-cert-manager">
<summary>Click to expand</summary>
@@ -219,7 +219,7 @@ kubectl -n cattle-system apply -R -f ./rancher
> **Note:** If you don't intend to send telemetry data, opt out [telemetry](../../../../faq/telemetry.md) during the initial login. Leaving this active in an air-gapped environment can cause issues if the sockets cannot be opened successfully.
## 5. For Rancher versions before v2.3.0, Configure System Charts
## 5. For Rancher Versions Before v2.3.0, Configure System Charts
If you are installing Rancher versions before v2.3.0, you will not be able to use the packaged system charts. Since the Rancher system charts are hosted in GitHub, an air gapped installation will not be able to access these charts. Therefore, you must [configure the Rancher system charts](../../resources/local-system-charts.md).

Some files were not shown because too many files have changed in this diff Show More