Compare commits

...
Author SHA1 Message Date
Sunil Singh 83d2550b95 Merge pull request #1803 from rancher/v2.9.10
Merge release branch v2.9.10 into main
2025-05-22 16:48:41 -07:00
Sunil Singh 0797ee6e1d Merge pull request #1804 from rancher/v2.10.6
Merge release branch v2.10.6 into main
2025-05-22 16:48:14 -07:00
Sunil Singh d985c93a8a Merge pull request #1805 from rancher/v2.11.2
Merge release branch v2.11.2 main
2025-05-22 16:48:00 -07:00
Sunil Singh fd49c58acd Merge pull request #1809 from sunilarjun/v2.9.10-date
Updating Release Date v2.9.10
2025-05-22 16:08:59 -07:00
Sunil Singh 38483158da Merge pull request #1808 from sunilarjun/v2.10.6-date
Updating Release Date v2.10.6
2025-05-22 16:08:50 -07:00
Sunil Singh a9905c266f Merge pull request #1807 from sunilarjun/v2.11.2-date
Updating Release Date v2.11.2
2025-05-22 16:08:39 -07:00
Sunil Singh b68517fd26 Updating release date v2.9.10
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-05-21 15:57:53 -07:00
Sunil Singh 4315dc06ff Updating release date v2.10.6
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-05-21 15:55:05 -07:00
Sunil Singh 7a97968cd0 Updating release date v2.11.2
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-05-21 15:46:22 -07:00
Billy Tat af02485a69 Merge pull request #1802 from sunilarjun/update-codeowners
Updating CODEOWNERS file - @pmkovar
2025-05-20 15:51:52 -07:00
Billy Tat 4fc8fbae90 Merge pull request #1799 from pmkovar/v2.11.2-maintenance
[v2.11.2] Maintenance tasks
2025-05-20 15:20:49 -07:00
Billy Tat ebd37e8cbe Merge pull request #1800 from pmkovar/v2.10.6-maintenance
[v2.10.6] Maintenance tasks
2025-05-20 15:20:42 -07:00
Billy Tat f27c1c985d Merge pull request #1801 from pmkovar/v2.9.10-maintenance
[v2.9.10] Maintenance tasks
2025-05-20 15:20:38 -07:00
Sunil Singh cc307bb6b7 Keeping list alphabetized
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-05-20 15:16:03 -07:00
Sunil Singh 728f51e7bb Updating CODEOWNERS file - @pmkovar
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-05-20 15:01:52 -07:00
Sunil Singh 56e0c55c1a Adding updates to Zh files and standardizing v2.10 webhook table syntax
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-05-20 13:40:43 -07:00
Sunil Singh 5672c6549d Adding updates to Zh files
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-05-20 13:25:40 -07:00
Petr Kovar ee701a969e [v2.11.2] Fix Webhook version 2025-05-20 19:12:46 +02:00
Petr Kovar 8386ff12bc [v2.9.10] Maintenance tasks
Helps #1781.
2025-05-20 14:27:40 +02:00
Petr Kovar cae834df4e [v2.10.6] Maintenance tasks
Helps #1782.
2025-05-20 14:10:27 +02:00
Petr Kovar b21e5fd961 [v2.11.2] Maintenance tasks
Helps #1783.
2025-05-20 13:40:16 +02:00
Billy Tat 3bca8e71ea Merge pull request #1786 from AngeloCicero/patch-1
fix: Misspelling
2025-05-16 21:09:45 -07:00
Angelo Cicero 655b2ba1d1 fix: Misspelling 2025-05-16 22:24:41 -04:00
Angelo Cicero c89f4b3f10 fix: Misspelling 2025-05-16 22:24:16 -04:00
Angelo Cicero 497cef1e93 fix: Misspelling 2025-05-16 22:23:41 -04:00
Angelo Cicero f199f99255 fix: Misspelling 2025-05-16 22:22:46 -04:00
Billy Tat 3cc383f156 Merge pull request #1375 from rancher/Tejeev-patch-1
Update clean-cluster-nodes.md to point to RKE2 specific docs
2025-05-16 16:36:18 -07:00
Billy Tat 8ef2e36b90 Fix spacing so note renders and apply to other versions 2025-05-16 15:46:37 -07:00
Marty Hernandez Avedon 8105e75263 Update docs/how-to-guides/new-user-guides/manage-clusters/clean-cluster-nodes.md 2025-05-16 15:42:52 -07:00
Tejeev c295a4205d Update clean-cluster-nodes.md to point to RKE2 specific docs
When cleaning nodes for re-use which were deployed manually with RKE2, the process differs slightly.  This is more important in reverse so I'm editing that doc as well.  I think there's like a note callout or something that might be better?
2025-05-16 15:42:50 -07:00
Billy Tat 0e193241ca Merge pull request #1777 from btat/growpart-p2
Apply PR #1584 (Clarify dependency) to v2.11
2025-05-16 13:39:11 -07:00
Billy Tat d3f64dcfdb Merge pull request #1772 from burnedoutman/patch-6
Fix comma in authorized-cluster-endpoint.md
2025-05-15 17:56:28 -07:00
Billy Tat b6a6b2adaf Merge pull request #1760 from burnedoutman/patch-5
Remove double word in back-up-restore-usage-guide.md
2025-05-15 17:12:33 -07:00
Billy Tat b3836c4ada Merge pull request #1759 from burnedoutman/patch-4
Fix typo in ingress-configuration.md
2025-05-15 17:04:04 -07:00
Billy Tat 06e275454b Merge pull request #1757 from burnedoutman/patch-2
Fix whitespace in authentication-permissions-and-global-configuration.md
2025-05-15 16:57:35 -07:00
Billy Tat 253d460bfb Merge pull request #1756 from burnedoutman/patch-1
Fix whitespace in upgrades.md
2025-05-15 16:50:36 -07:00
Billy Tat f3111278ef Apply 9f472265 (Fix comma in authorized-cluster-endpoint.md) to other versions 2025-05-15 16:48:59 -07:00
Billy Tat b37e22ad80 Apply 2bfa05732 (Remove double word in back-up-restore-usage-guide.md) to other versions 2025-05-15 16:36:23 -07:00
Billy Tat e0fa8ecc6d Apply 072d66f1 (fix word in ingress-configuration.md) to other versions 2025-05-15 16:26:55 -07:00
Billy Tat ab23b32b02 Apply 32acfa94 (Fix whitespace in authentication-permissions-and-global-configuration.md) to other versions 2025-05-15 16:05:06 -07:00
Billy Tat 01711c8029 Apply 13e57364 (fix whitespace) to other versions (en/zh) 2025-05-15 15:43:14 -07:00
Billy Tat c87821fd68 Merge pull request #1525 from weyfonk/document-user-search-behaviour
Clarify how user search works
2025-05-14 17:20:13 -07:00
Billy Tat 979f656768 Apply 5ddddd1a...42143c42 (Clarify how user search works) to other versions 2025-05-14 16:40:22 -07:00
Billy Tat 915ef93dd1 Merge pull request #1639 from axeal/patch-1
Add kubectl image for air-gapped environments
2025-05-14 16:13:27 -07:00
Corentin Néau 42143c423c Improve formatting
This applies suggestions from code review.
2025-05-14 15:56:48 -07:00
Corentin Néau a55b901d08 Fix notes formatting
This improves formatting of notes on searching users, by making them
appear in notes blocks.
2025-05-14 15:56:46 -07:00
Corentin Néau d37b9fed51 Mention that search is prefix-based
This explains the difference that it makes as opposed to substring-based
search.
2025-05-14 15:56:44 -07:00
Corentin Néau 5ddddd1a81 Clarify how user search works
This adds a few points which should shed light on how to search users
using a drop-down list in Rancher, whether to add users to clusters or
to projects.
2025-05-14 15:56:40 -07:00
Billy Tat c9b95f1a9f Apply 3bed7afb (Add kubectl image for air-gapped environments...) to other versions 2025-05-14 15:13:02 -07:00
Alex Seymour 3bed7afb65 Add kubectl image for air-gapped environments
Add global.kubectl.repository value for air-gapped environments
2025-05-14 14:08:01 -07:00
Angelo Cicero 97fd27bc08 fix: Misspelling 2025-05-14 14:34:23 -04:00
Billy Tat f4cf47d332 Merge pull request #1778 from kakabisht/fix-Noteheading-Vagrant
Fixing a wrong Note header in Vagrant
2025-05-07 09:36:35 -07:00
hridyesh bisht 44e21d18a4 Merge branch 'main' into fix-Noteheading-Vagrant 2025-05-07 20:24:47 +05:30
hridyesh bisht 996e6d360c Merge branch 'fix-Noteheading-Vagrant' of https://github.com/kakabisht/rancher-docs into fix-Noteheading-Vagrant 2025-05-07 20:24:24 +05:30
hridyesh bisht 7d280c143e Fixing zh translations as well 2025-05-07 20:24:11 +05:30
Billy Tat 5f389f4374 Merge pull request #1779 from btat/keycloak-typo
Fix typo. Missing word
2025-05-01 14:52:13 -07:00
Billy Tat 9659b80d6b Fix typo. Missing word 2025-05-01 13:44:52 -07:00
hridyesh bisht 00374743ab Merge branch 'main' into fix-Noteheading-Vagrant 2025-04-30 16:33:56 +05:30
hridyesh bisht aa28932257 Fixing a wrong Note header in Vagrant 2025-04-30 16:32:14 +05:30
Billy Tat 035ea0ef5d Merge pull request #1637 from mkrutov/mkr_cli
Update wording for navigation "about" item
2025-04-29 17:14:45 -07:00
Billy Tat 282376c40f Apply 3860d52f (About -> version number) w/ fixed format/grammar to other versions and zh files 2025-04-29 16:30:39 -07:00
Mikhail Krutov 3860d52f9e About -> version number 2025-04-29 16:01:12 -07:00
Billy Tat f606f278c2 Apply PR #1584 ( Update create-a-vm-template.md) to v2.11 2025-04-29 15:59:04 -07:00
Billy Tat 4ca5f3752d Merge pull request #1584 from aseques/patch-1
Update create-a-vm-template.md
2025-04-29 14:56:52 -07:00
Billy Tat 8930cf92b3 Apply aac1fc2e (Clarify a dpendency that's part of another package) to other versions 2025-04-29 14:15:01 -07:00
Sunil Singh 1c5be0c836 Merge pull request #1774 from sunilarjun/cve-pages-update-april-2025
Add April 2025 Release CVE's
2025-04-25 11:54:00 -07:00
Sunil Singh 43f4f2380b Updating after review from release notes
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-04-25 10:08:37 -07:00
Sunil Singh 32ca20ee68 Adding the April 2025 CVEs for this release cycle.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-04-25 08:32:43 -07:00
Lucas SaintarborandBilly Tat 1d3f2985b4 Merge release branch v2.11.1 into main (#1753)
* v2.11.1 Maintenance Items (#1748)

* [v2.11.1] version update

* [v2.11.1] webhook update

* [v2.11.1] webhook update

* [v2.11.1] deprecated features update

* [v2.11.1] CSP adapter update

* Fix date typo in deprecated features table

* [2.11.1] CNI community popularity table

* [v2.11.1] (zh) webhook update

* [v2.11.1] (zh) CSP adapter update

* [v2.11.1] (zh) deprecated features update

* [2.11.1] Update date and sync to zh

Also remove duplicate file

---------

Co-authored-by: Billy Tat <btat@suse.com>
2025-04-24 17:04:36 -07:00
Lucas SaintarborandBilly Tat b75ebcef2f Merge release branch v2.10.5 into main (#1752)
* v2.10.5 Maintenance Items (#1747)

* [v2.10.5] version update

* [v2.10.5] webhook update

* [v2.10.5] deprecated features update

* [v2.10.5] CSP adapter update

* [2.10.5] Update date and sync to zh

---------

Co-authored-by: Billy Tat <btat@suse.com>
2025-04-24 17:04:16 -07:00
Lucas SaintarborandBilly Tat 4971ece6b5 Merge release branch v2.9.9 into main (#1751)
* v2.9.9 Maintenance Items (#1749)

* [v2.9.9] version update

* [v2.9.9] webhook update

* [v2.9.9] deprecated features update

* [v2.9.9] CSP adapter update

* [2.9.9] Update date and sync to zh

---------

Co-authored-by: Billy Tat <btat@suse.com>
2025-04-24 17:03:32 -07:00
Lucas SaintarborandBilly Tat e455586ff9 Merge release branch v2.8.15 into main (#1750)
* v2.8.15 Maintenance Items (#1746)

* [v2.8.15] version update

* [v2.8.15] webhook update

* [v2.8.15] deprecated features update

* [v2.8.15] CSP adapter update

* [2.8.15] Update date and sync to zh

---------

Co-authored-by: Billy Tat <btat@suse.com>
2025-04-24 17:03:17 -07:00
burnedoutman 9f47226500 Update authorized-cluster-endpoint.md
fix comma
2025-04-24 18:43:24 +03:00
Billy Tat 3c5f4ccc77 Merge pull request #1754 from Tejeev/patch-3
Update networking.md
2025-04-23 16:24:41 -07:00
Billy Tat 3fa65a6033 Apply a64e5988 (Just a slightly better way to keep the container up) to other instances 2025-04-23 15:19:06 -07:00
Billy Tat bca3170dce Merge pull request #1762 from btat/istio-deprecation
Extend Istio deprecation warning to all subpages
2025-04-23 08:51:03 -07:00
Billy Tat bae87275b8 Merge pull request #1693 from Tejeev/patch-1
Update servicemonitors-and-podmonitors.md
2025-04-22 17:08:56 -07:00
Billy Tat f6cfb24eb3 Apply 5d519406 (Update servicemonitors and podmonitors spec links) to all instances 2025-04-22 16:21:54 -07:00
Billy Tat 05b45ea361 Extend Istio deprecation warning to all subpages 2025-04-21 17:09:02 -07:00
Sunil Singh c23d741a25 Merge pull request #1755 from sunilarjun/register-existing-cluster-page-edit
Port Product PR #238 (Editing Register Existing Cluster Version Callout)
2025-04-21 08:38:27 -07:00
burnedoutman 2bfa05732f Update back-up-restore-usage-guide.md
remove doubled word
2025-04-21 17:35:32 +03:00
burnedoutman 072d66f1cf Update ingress-configuration.md
fix word
2025-04-21 16:49:16 +03:00
burnedoutman 32acfa94fd Update authentication-permissions-and-global-configuration.md
fix whitespace
2025-04-21 13:54:43 +03:00
burnedoutman 13e57364ab Update upgrades.md
fix whitespace
2025-04-21 12:23:52 +03:00
Sunil Singh 23ca4b35bb Removing version callout as applicable to all v2.11 versions.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-04-18 13:08:57 -07:00
Tejeev a64e5988d5 Update networking.md
Just a slightly better way to keep the container up
2025-04-18 04:51:27 -06:00
Billy Tat 9ac71edd37 Merge pull request #1744 from btat/oci-experimental-removal
Remove experimental banner for OCI p2
2025-04-14 17:00:17 -07:00
Billy Tat 4849f46664 Remove experimental banner for OCI p2 2025-04-14 14:24:49 -07:00
Billy Tat abefa0bf59 Merge pull request #1738 from btat/fix-links
Fix external links
2025-04-11 11:28:08 -07:00
Billy Tat dff5fab800 Merge pull request #1737 from btat/2.11-banner
2.11: Remove banner with incorrect release status
2025-04-10 09:37:28 -07:00
Billy TatandSunil Singh 894c506a5f Update docusaurus.config.js
Co-authored-by: Sunil Singh <sunil.singh@suse.com>
2025-04-10 08:50:21 -07:00
Billy Tat 5f578d70d7 2.11: Remove banner with incorrect release status 2025-04-10 07:07:46 -07:00
Billy Tat 8baef95292 Fix external links 2025-04-10 07:06:16 -07:00
Billy Tat 48013d15cc Merge pull request #1734 from btat/v2.8-archive-notice
Add archive notice to v2.8
2025-04-07 08:48:13 -07:00
Billy Tat ba89f6bff0 Add archive notice to v2.8 2025-04-04 17:02:05 -07:00
Lucas Saintarbor bd71b780b6 Add March 2025 release CVEs and advisories (#1732)
* Update CVE page for March 2025 release

* Update zh CVE page for March 2025 release
2025-04-01 14:45:37 -07:00
Sunil Singh baf9710b62 Merge pull request #1726 from rancher/v2.8.14
Merge release branch v2.8.14 into main
2025-03-31 16:54:11 -07:00
Sunil Singh ff784f2d74 Merge pull request #1725 from rancher/v2.9.8
Merge release branch v2.9.8 into main
2025-03-31 16:54:00 -07:00
Sunil Singh 7e003c84bc Merge pull request #1724 from rancher/v2.10.4
Merge release branch v2.10.4 into main
2025-03-31 16:53:46 -07:00
Sunil Singh f6446459c2 Merge pull request #1723 from rancher/v2.11.0
Merge release branch v2.11.0 into main
2025-03-31 16:53:20 -07:00
Sunil Singh bd4bd46ffb Merge pull request #1730 from sunilarjun/v2.8.14-maintenance
[2.8.14] Updating Deprecated Features Date
2025-03-31 09:01:05 -07:00
Sunil Singh 77b026618c Merge pull request #1729 from sunilarjun/v2.9.8-maintenance
[2.9.8] Updating Deprecated Features Date
2025-03-31 09:00:52 -07:00
Sunil Singh ebf7a0931f Merge pull request #1728 from sunilarjun/v2.10.4-maintenance
[2.10.4] Updating Deprecated Features Date
2025-03-31 09:00:36 -07:00
Sunil Singh 76e2de984c Merge pull request #1727 from sunilarjun/v2.11.0-maintenance
[2.11.0] Updating Deprecated Features Date
2025-03-31 09:00:24 -07:00
Sunil Singh fa0ebe0596 [2.8.14] Updating Deprecated Features Date
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-31 08:45:02 -07:00
Sunil Singh c241877eec [2.9.8] Updating Deprecated Features Date
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-31 08:43:35 -07:00
Sunil Singh 769c692792 [2.10.4] Updating Deprecated Features Date
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-31 08:41:22 -07:00
Sunil Singh 8db890f12e [2.11.0] Updating Deprecated Features Date
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-31 08:38:56 -07:00
Sunil Singh 012bf9af13 Merge pull request #1722 from sunilarjun/v2.8.14-maintenance
[2.8.14] Updating Deprecated Features Date
2025-03-28 15:00:40 -07:00
Sunil Singh 8837aa2565 Merge pull request #1721 from sunilarjun/v2.9.8-maintenance
[2.9.8] Updating Deprecated Features Date
2025-03-28 15:00:24 -07:00
Billy Tat 17d11822c8 Merge pull request #1720 from sunilarjun/v2.10.4-maintenance
[2.10.4] Updating Deprecated Features Date
2025-03-27 11:35:47 -07:00
Billy Tat a15f568e4a Merge pull request #1719 from sunilarjun/v2.11.0-maintenance
[2.11.0] Updating Deprecated Features Date
2025-03-27 11:35:29 -07:00
Sunil Singh b041b54ca9 [2.8.14] Updating deprecated features date field.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-27 10:57:46 -07:00
Sunil Singh 1045a6bbbf [2.9.8] Updating deprecated features date field.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-27 10:56:40 -07:00
Sunil Singh 007ccb7050 [2.10.4] Updating deprecated features date field.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-27 10:37:09 -07:00
Sunil Singh 84995b6b4d [2.11.0] Updating deprecated features date field.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-27 10:32:57 -07:00
Billy Tat cf0d726935 Merge pull request #1717 from pedromfcarvalho/local-fixup
Document workaround for migrating across distributions
2025-03-27 09:01:31 -07:00
Pedro Franco de Carvalho 94ccdfbf63 Better wording 2025-03-26 15:45:49 -03:00
Pedro Franco de Carvalho 371275ee24 Emphasize workaround applies to any two distros 2025-03-26 15:41:11 -03:00
Pedro Franco de CarvalhoandBilly Tat bb190560b5 Update versioned_docs/version-2.11/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md
Co-authored-by: Billy Tat <btat@suse.com>
2025-03-26 15:10:56 -03:00
Pedro Franco de CarvalhoandBilly Tat 1748e5b6f3 Update versioned_docs/version-2.10/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md
Co-authored-by: Billy Tat <btat@suse.com>
2025-03-26 15:10:49 -03:00
Pedro Franco de CarvalhoandBilly Tat 5e2157add8 Update docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md
Co-authored-by: Billy Tat <btat@suse.com>
2025-03-26 15:10:41 -03:00
Billy Tat 31c29541a9 Merge pull request #1702 from HarrisonWAffel/2.11-pc-pdb
New feature in 2.11: cluster agent scheduling customization
2025-03-24 15:19:30 -07:00
Billy Tat 7453e0a3a2 Merge pull request #1713 from sunilarjun/v2.11.0-maintenance
v2.11.0 Maintenance Items
2025-03-24 15:13:01 -07:00
Pedro Franco de Carvalho 58ee12d367 Document workaround for migrating across distributions
Migrating rancher across different Kubernetes distributions causes the local
cluster object not to specify the correct distribution and driver.

This commit adds a workaround to be applied after restoration for a migration
and before bringing Rancher up, so that the local cluster will have the
correct data for the new distribution it runs on.
2025-03-24 17:01:42 -03:00
Harrison Affel 5bb67118ca Add documentation for 2.11 scheduling customization feature 2025-03-24 10:12:58 -04:00
Billy Tat efbb0bf99b Merge pull request #1714 from sunilarjun/v2.10.4-maintenance
v2.10.4 Maintenance Items
2025-03-21 16:39:06 -07:00
Sunil Singh 3a051ce759 Updating webhook after review
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 16:09:51 -07:00
Sunil Singh b4f93428f1 Updating webhook and versions after review.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 15:57:04 -07:00
Billy Tat d43ef027ef Merge pull request #1715 from sunilarjun/v2.9.8-maintenance
v2.9.8 Maintenance Items
2025-03-21 15:12:04 -07:00
Billy Tat 1fc5b9f561 Merge pull request #1716 from sunilarjun/v2.8.14-maintenance
v2.8.14 Maintenance Items
2025-03-21 15:10:11 -07:00
Sunil Singh 8861ed72f4 [2.8.14] deprecated features update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 11:07:41 -07:00
Sunil Singh 0499d43c5e [2.8.14] CSP adapter update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 11:06:56 -07:00
Sunil Singh b000e9331b [2.8.14] webhook update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 11:06:14 -07:00
Sunil Singh fa85adb908 [2.8.14] versions update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 11:05:06 -07:00
Sunil Singh 27e459d758 [2.9.8] deprecated features update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 11:03:20 -07:00
Sunil Singh be60da5c47 [2.9.8] CSP adapter update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 11:02:30 -07:00
Sunil Singh 91d08e44c1 [2.9.8] webhook update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 11:01:34 -07:00
Sunil Singh da61624d84 [2.9.8] versions update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 11:00:08 -07:00
Sunil Singh b56e9e9728 [2.10.4] deprecated features update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 10:57:10 -07:00
Sunil Singh 2bf036b61e [2.10.4] CSP adapter update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 10:55:37 -07:00
Sunil Singh 02a5539358 [2.10.4] webhook update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 10:54:26 -07:00
Sunil Singh d061a7e869 [2.10.4] versions update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 10:52:28 -07:00
Sunil Singh 22f8ded140 [2.11.0] CNI update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 10:33:33 -07:00
Sunil Singh b51410aabe [2.11.0] deprecated features update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 10:29:30 -07:00
Sunil Singh c9ec3422b1 [2.11.0] CSP adapter update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 10:26:56 -07:00
Sunil Singh fb653154e7 [2.11.0] webhook update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 10:17:56 -07:00
Sunil Singh bfccf4adbf [2.11.0] versions update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-21 10:14:37 -07:00
Billy Tat 359425ec6c Merge pull request #1704 from rancher/issue-1632
[v2.11] Policy Exemption User Note
2025-03-19 15:15:52 -07:00
Sunil Singh 844ee18464 Merge pull request #1710 from tomleb/extension-apiserver
Document extension APIserver
2025-03-19 13:52:38 -07:00
Billy Tat 03e291d56c Merge pull request #1712 from sunilarjun/v2.11-RKE1-EOL-warning
[v2.11] RKE1 EOL Warning Banner
2025-03-19 13:28:41 -07:00
Tom Lebreux 5a8a96fc0a Fix link reference 2025-03-19 16:02:08 -04:00
Billy Tat 47c4e4c093 Merge pull request #1649 from JonCrowther/aggregated-cluster-roles-feature-flag
[v2.11] Add documentation for aggregated clusterroles
2025-03-19 13:00:45 -07:00
Tom Lebreux d43f53d0fa Document extension API server for 2.11 2025-03-19 15:14:30 -04:00
Tom Lebreux 1bf1ac8ba3 Apply feedback 2025-03-19 15:09:50 -04:00
Jonathan Crowther d55be97e14 Added versioned docs and sidebar 2025-03-19 09:46:07 -04:00
Jonathan Crowther 81c14ffd09 Fix some wording 2025-03-19 09:41:58 -04:00
Jonathan Crowther d0a35e1a3e Missing quote 2025-03-19 09:41:58 -04:00
Jonathan Crowther 826ae8e86c Add documentation for aggregated clusterroles 2025-03-19 09:41:58 -04:00
Sunil Singh d77072be9d Adding EOL warning message tag to relevant RKE1 pages across versions/i18n folders.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-18 15:32:05 -07:00
Sunil Singh 919ad43458 Adding partial file for RKE1 EOL warning message.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-18 15:15:58 -07:00
Sunil Singh b93f050ea7 Merge pull request #1711 from rancher/main
Syncing Main Branch into v2.11.0 Branch
2025-03-17 17:21:29 -07:00
Billy Tat d97217c6f6 Merge pull request #1708 from btat/2.11-restricted-admin-refs
Remove restricted admin references
2025-03-17 13:12:34 -07:00
Tom Lebreux 1391623ae5 Document extension APIserver 2025-03-17 13:18:11 -04:00
Sunil Singh 7fbb1248a2 Merge pull request #1699 from jiaqiluo/211-imported-cluster-version-mgmt
New feature in 2.11: imported cluster version management
2025-03-14 16:56:56 -07:00
Jiaqi Luo 6916290155 new feature in 2.11: imported cluster version management 2025-03-14 16:09:53 -07:00
Billy Tat b5c2511793 Remove restricted admin references 2025-03-13 14:34:42 -07:00
Sunil Singh f7f3bbd5ab Adding note to PSA template on users handling policy exemptions, tied to Rancher docs issue 1632.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-11 16:32:48 -07:00
Sunil Singh af896b7aba Merge pull request #1700 from sunilarjun/fix-azure-YAML
Fixing Tab Indent - Azure Cloud Provider Page
2025-03-07 16:00:51 -08:00
Sunil Singh 31f1c92397 Editing step 4 tab indent as text was being included in code block incorrectly.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-07 14:43:37 -08:00
Billy Tat 2d34a1e59f Merge pull request #1593 from rohitsakala/remove-experimental-flag-for-oci-feature
Remove experimental banner for OCI
2025-03-06 12:42:49 -08:00
Billy Tat 1edd657336 Merge pull request #1698 from rancher/main
Sync changes from main to v2.11.0
2025-03-06 12:40:16 -08:00
Billy Tat edbc6eb35e Apply dc05dfb5 (Remove experimental banner for OCI) to version-2.11 2025-03-06 11:38:11 -08:00
Venkata Krishna Rohit Sakala dc05dfb53f Remove experimental banner for OCI 2025-03-06 11:37:04 -08:00
Billy Tat 0156c64962 Merge pull request #1697 from rancher/dependabot/submodules/dot-github/styles/suse-vale-styleguide-f288d28
Bump .github/styles/suse-vale-styleguide from `a0d8a04` to `f288d28`
2025-03-06 09:43:43 -08:00
dependabot[bot] c48166e40d Bump .github/styles/suse-vale-styleguide from a0d8a04 to f288d28
Bumps [.github/styles/suse-vale-styleguide](https://github.com/openSUSE/suse-vale-styleguide) from `a0d8a04` to `f288d28`.
- [Release notes](https://github.com/openSUSE/suse-vale-styleguide/releases)
- [Commits](https://github.com/openSUSE/suse-vale-styleguide/compare/a0d8a04abd0679fb7208b76bda95aee9caf884ca...f288d286db3b7c65e02cb6635d0c048f0f7a88fa)

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

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-06 16:37:53 +00:00
Billy Tat 17e4d800bf Merge pull request #1694 from rancher/dependabot/submodules/dot-github/styles/suse-vale-styleguide-a0d8a04
Bump .github/styles/suse-vale-styleguide from `1d1d8c5` to `a0d8a04`
2025-03-05 14:34:14 -08:00
Billy Tat 35a2186904 Merge pull request #1696 from diogoasouza/fix-broken-link
fix broken link to rancher forums
2025-03-05 14:33:57 -08:00
Diogo Souza e5beb733e3 fix broken link to rancher forums 2025-03-05 18:47:45 -03:00
Billy Tat 71f2167a3f Merge pull request #1695 from LucasSaintarbor/add-note-adding-users-to-clusters
Sync PR #157 from Product docs
2025-03-05 13:46:38 -08:00
LucasSaintarbor 3901b2a9d9 Add note about cluster membership limitations to intro 2025-03-05 12:59:26 -08:00
dependabot[bot] cf7dfbcd78 Bump .github/styles/suse-vale-styleguide from 1d1d8c5 to a0d8a04
Bumps [.github/styles/suse-vale-styleguide](https://github.com/openSUSE/suse-vale-styleguide) from `1d1d8c5` to `a0d8a04`.
- [Release notes](https://github.com/openSUSE/suse-vale-styleguide/releases)
- [Commits](https://github.com/openSUSE/suse-vale-styleguide/compare/1d1d8c53eeb4117bf024df38d6ee24f140b74e01...a0d8a04abd0679fb7208b76bda95aee9caf884ca)

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

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-05 17:12:37 +00:00
Tejeev 5d5194065f Update servicemonitors-and-podmonitors.md
Updated spec links
2025-03-05 03:05:59 -07:00
Sunil Singh b3d1e0176a Merge pull request #1692 from rancher/revert-1653-main
Revert "docs: add auth-user-session-idle-ttl-minutes setting"
2025-03-04 10:10:13 -08:00
Billy Tat e2bba9b3e1 Merge pull request #1691 from rancher/dependabot/submodules/dot-github/styles/suse-vale-styleguide-1d1d8c5
Bump .github/styles/suse-vale-styleguide from `4a53783` to `1d1d8c5`
2025-03-04 09:41:56 -08:00
Billy Tat f0fbf6609e Merge pull request #1687 from btat/fix-links-archived-docs
Fix broken links
2025-03-04 09:41:25 -08:00
Sunil Singh d946eb97c5 Revert "docs: add auth-user-session-idle-ttl-minutes setting"
This reverts commit 0d84fe35ac.
2025-03-04 09:05:49 -08:00
Sunil Singh 94763d89fd Revert "Update docs/api/api-tokens.md"
This reverts commit d4a7f7023a.
2025-03-04 09:05:49 -08:00
Sunil Singh 4cc1d07215 Revert "update versioned_docs"
This reverts commit 16fa2b39ae.
2025-03-04 09:05:49 -08:00
dependabot[bot] e5153269f6 Bump .github/styles/suse-vale-styleguide from 4a53783 to 1d1d8c5
Bumps [.github/styles/suse-vale-styleguide](https://github.com/openSUSE/suse-vale-styleguide) from `4a53783` to `1d1d8c5`.
- [Release notes](https://github.com/openSUSE/suse-vale-styleguide/releases)
- [Commits](https://github.com/openSUSE/suse-vale-styleguide/compare/4a53783d19350e32e7c7a2afef78c9e2d24c0287...1d1d8c53eeb4117bf024df38d6ee24f140b74e01)

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

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-04 16:43:03 +00:00
Sunil Singh 480418ff93 Merge pull request #1635 from sunilarjun/issue-1611
Update Authentication Configuration Page - Local Rancher Admin Note
2025-03-03 16:17:05 -08:00
Billy Tat 9280cb7902 Merge pull request #1545 from kinarashah/azdocs2
update correct location for azure's cloud controller manager manifest
2025-03-03 15:12:50 -08:00
Billy Tat 2eb6c8b388 Apply 5d982da5 (update correct location for azure's cloud controller manager manifest) plus formatting fixes to other versions
Also sync outdated zh page
2025-03-03 14:03:21 -08:00
Billy Tat 06b70dfb46 Merge branch 'main' into azdocs2 2025-03-03 13:32:41 -08:00
Billy Tat b00f9baf7e Merge pull request #1688 from rancher/dependabot/submodules/dot-github/styles/suse-vale-styleguide-4a53783
Bump .github/styles/suse-vale-styleguide from `e83b279` to `4a53783`
2025-03-03 13:17:57 -08:00
Sunil Singh 0d34121f0a Rebased and added update to v2.11 docs.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-03 10:48:38 -08:00
Sunil Singh fd4f97a1cd Updating after review.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-03 10:40:12 -08:00
Sunil Singh 116d1daa3d Updating note entry on authentication config page to include information regarding external authentication configuration and the resource access scope of the relative local Rancher admin user.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-03-03 10:40:06 -08:00
dependabot[bot] 59a5b3e27e Bump .github/styles/suse-vale-styleguide from e83b279 to 4a53783
Bumps [.github/styles/suse-vale-styleguide](https://github.com/openSUSE/suse-vale-styleguide) from `e83b279` to `4a53783`.
- [Release notes](https://github.com/openSUSE/suse-vale-styleguide/releases)
- [Commits](https://github.com/openSUSE/suse-vale-styleguide/compare/e83b27903567c8cc69fc6a73617b05b0f7603000...4a53783d19350e32e7c7a2afef78c9e2d24c0287)

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

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-03 16:15:41 +00:00
Sunil Singh 7f2a75afb4 Merge pull request #1686 from sunilarjun/update-preview-unreleased
Update Docs Preview Naming
2025-02-28 16:46:56 -08:00
Billy Tat b4b98a1e10 Fix broken links 2025-02-28 16:10:35 -08:00
Sunil Singh a36fc63f6e Update naming from (Preview) to (Unreleased) for docs preview versions.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-02-28 16:00:08 -08:00
Billy Tat 7c7b8bd70e Merge pull request #1684 from rancher/dependabot/submodules/dot-github/styles/suse-vale-styleguide-e83b279
Bump .github/styles/suse-vale-styleguide from `419bd8a` to `e83b279`
2025-02-28 09:21:05 -08:00
dependabot[bot] 53be000d06 Bump .github/styles/suse-vale-styleguide from 419bd8a to e83b279
Bumps [.github/styles/suse-vale-styleguide](https://github.com/openSUSE/suse-vale-styleguide) from `419bd8a` to `e83b279`.
- [Release notes](https://github.com/openSUSE/suse-vale-styleguide/releases)
- [Commits](https://github.com/openSUSE/suse-vale-styleguide/compare/419bd8a09a06aefdc13142cd5c7794d190e64218...e83b27903567c8cc69fc6a73617b05b0f7603000)

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

Signed-off-by: dependabot[bot] <support@github.com>
2025-02-28 16:25:44 +00:00
Alessio Greggi 16fa2b39ae update versioned_docs
Signed-off-by: Alessio Greggi <alessio.greggi@suse.com>
2025-02-26 17:18:16 +01:00
Alessio GreggiandEnrico Candino d4a7f7023a Update docs/api/api-tokens.md
Co-authored-by: Enrico Candino <enrico.candino@gmail.com>
2025-02-26 17:18:16 +01:00
Alessio Greggi 0d84fe35ac docs: add auth-user-session-idle-ttl-minutes setting
Signed-off-by: Alessio Greggi <alessio.greggi@suse.com>
2025-02-26 17:18:16 +01:00
Diogo SouzaandLucasSaintarbor b457c9eb68 adding rancher-istio deprecation notice (#1627)
* adding rancher-istio deprecation notice

* Rebased / Added changes to v2.11 directory

---------

Co-authored-by: LucasSaintarbor <lucas.saintarbor@suse.com>
2025-02-19 11:37:20 -08:00
aseques aac1fc2ed5 Update create-a-vm-template.md
Clarify a dpendency that's part of another package
2024-12-09 09:04:12 +01:00
Kinara Shah 5d982da52a update correct location for azure's cloud controller manager manifest
remove unnecessary objects from manifest
2024-11-11 23:49:35 -08:00
594 changed files with 4211 additions and 1550 deletions
+1
View File
@@ -0,0 +1 @@
f288d286db3b7c65e02cb6635d0c048f0f7a88fa
+1 -1
View File
@@ -1 +1 @@
* @btat @LucasSaintarbor @sunilarjun
* @btat @LucasSaintarbor @pmkovar @sunilarjun
@@ -52,7 +52,7 @@ As an [administrator](../../../how-to-guides/advanced-user-guides/authentication
> | 10252 | Controlplane | Kube controller manager |
> | 2379 | Etcd | Etcd server |
> Monitoring V1 requires a Kubernetes verison less than or equal to v1.20.x. To install monitoring on Kubernetes v1.21+, you will need to [migrate to Monitoring V2.](/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/monitoring-alerting-guides/migrate-to-rancher-v2.5%2B-monitoring.md)
> Monitoring V1 requires a Kubernetes verison less than or equal to v1.20.x. To install monitoring on Kubernetes v1.21+, you will need to [migrate to Monitoring V2.](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.5/how-to-guides/advanced-user-guides/monitoring-alerting-guides/migrate-to-rancher-v2.5%2B-monitoring.md)
1. From the **Global** view, navigate to the cluster that you want to configure cluster monitoring.
@@ -121,7 +121,7 @@ To test the overlay network, you can launch the following `DaemonSet` definition
- image: alpine
imagePullPolicy: Always
name: alpine
command: ["sh", "-c", "tail -f /dev/null"]
command: ["sleep", "infinity"]
terminationMessagePath: /dev/termination-log
```
@@ -41,7 +41,7 @@ Note that upgrades _to_ or _from_ any chart in the [rancher-alpha repository](..
The upgrade instructions assume you are using Helm 3.
For migration of installs started with Helm 2, refer to the official [Helm 2 to 3 migration docs.](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/) The [Helm 2 upgrade page here](helm2.md)provides a copy of the older upgrade instructions that used Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible.
For migration of installs started with Helm 2, refer to the official [Helm 2 to 3 migration docs.](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/) The [Helm 2 upgrade page here](helm2.md) provides a copy of the older upgrade instructions that used Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible.
### For air gap installs: Populate private registry
@@ -16,12 +16,13 @@ The following steps quickly deploy a Rancher Server with a single node cluster a
- [Virtualbox](https://www.virtualbox.org): The virtual machines that Vagrant provisions need to be provisioned to VirtualBox.
- At least 4GB of free RAM.
### Note
- Vagrant will require plugins to create VirtualBox VMs. Install them with the following commands:
:::note
`vagrant plugin install vagrant-vboxmanage`
Vagrant requires plugins to create VirtualBox VMs. Install them with the following commands:
- `vagrant plugin install vagrant-vboxmanage`
- `vagrant plugin install vagrant-vbguest`
`vagrant plugin install vagrant-vbguest`
:::
## Getting Started
@@ -111,7 +111,7 @@ If you are experiencing issues while testing the connection to the Keycloak serv
When you click on **Authenticate with Keycloak**, your are not redirected to your IdP.
* Verify your Keycloak client configuration.
* Make sure `Force Post Binding` set to `OFF`.
* Make sure `Force Post Binding` is set to `OFF`.
### Forbidden message displayed after IdP login
@@ -10,7 +10,7 @@ After installation, the [system administrator](manage-role-based-access-control-
## First Log In
After you log into Rancher for the first time, Rancher will prompt you for a **Rancher Server URL**.You should set the URL to the main entry point to the Rancher Server. When a load balancer sits in front a Rancher Server cluster, the URL should resolve to the load balancer. The system will automatically try to infer the Rancher Server URL from the IP address or host name of the host running the Rancher Server. This is only correct if you are running a single node Rancher Server installation. In most cases, therefore, you need to set the Rancher Server URL to the correct value yourself.
After you log into Rancher for the first time, Rancher will prompt you for a **Rancher Server URL**. You should set the URL to the main entry point to the Rancher Server. When a load balancer sits in front a Rancher Server cluster, the URL should resolve to the load balancer. The system will automatically try to infer the Rancher Server URL from the IP address or host name of the host running the Rancher Server. This is only correct if you are running a single node Rancher Server installation. In most cases, therefore, you need to set the Rancher Server URL to the correct value yourself.
>**Important!** After you set the Rancher Server URL, we do not support updating it. Set the URL with extreme care.
@@ -38,7 +38,7 @@ These methods of communicating with downstream Kubernetes clusters are also expl
### About the kube-api-auth Authentication Webhook
The `kube-api-auth` microservice is deployed to provide the user authentication functionality for the [authorized cluster endpoint,](../../../../reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters.md#4-authorized-cluster-endpoint) which is only available for [RKE clusters.](../../../new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md) When you access the user cluster using `kubectl`, the cluster's Kubernetes API server authenticates you by using the `kube-api-auth` service as a webhook.
The `kube-api-auth` microservice is deployed to provide the user authentication functionality for the [authorized cluster endpoint](../../../../reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters.md#4-authorized-cluster-endpoint) which is only available for [RKE clusters.](../../../new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md) When you access the user cluster using `kubectl`, the cluster's Kubernetes API server authenticates you by using the `kube-api-auth` service as a webhook.
During cluster provisioning, the file `/etc/kubernetes/kube-api-authn-webhook.yaml` is deployed and `kube-apiserver` is configured with `--authentication-token-webhook-config-file=/etc/kubernetes/kube-api-authn-webhook.yaml`. This configures the `kube-apiserver` to query `http://127.0.0.1:6440/v1/authenticate` to determine authentication for bearer tokens.
@@ -100,7 +100,7 @@ If you want to check resolving of domain names on all of the hosts, execute the
- image: busybox:1.28
imagePullPolicy: Always
name: alpine
command: ["sh", "-c", "tail -f /dev/null"]
command: ["sleep", "infinity"]
terminationMessagePath: /dev/termination-log
```
@@ -43,7 +43,7 @@ To test the overlay network, you can launch the following `DaemonSet` definition
- image: rancherlabs/swiss-army-knife
imagePullPolicy: Always
name: overlaytest
command: ["sh", "-c", "tail -f /dev/null"]
command: ["sleep", "infinity"]
terminationMessagePath: /dev/termination-log
```
@@ -16,12 +16,13 @@ The following steps quickly deploy a Rancher Server with a single node cluster a
- [Virtualbox](https://www.virtualbox.org): The virtual machines that Vagrant provisions need to be provisioned to VirtualBox.
- At least 4GB of free RAM.
### Note
- Vagrant will require plugins to create VirtualBox VMs. Install them with the following commands:
:::note
`vagrant plugin install vagrant-vboxmanage`
Vagrant requires plugins to create VirtualBox VMs. Install them with the following commands:
- `vagrant plugin install vagrant-vboxmanage`
- `vagrant plugin install vagrant-vbguest`
`vagrant plugin install vagrant-vbguest`
:::
## Getting Started
@@ -164,7 +164,7 @@ If you are experiencing issues while testing the connection to the Keycloak serv
When you click on **Authenticate with Keycloak**, you are not redirected to your IdP.
* Verify your Keycloak client configuration.
* Make sure `Force Post Binding` set to `OFF`.
* Make sure `Force Post Binding` is set to `OFF`.
### Forbidden message displayed after IdP login
@@ -10,7 +10,7 @@ After installation, the [system administrator](manage-role-based-access-control-
## First Log In
After you log into Rancher for the first time, Rancher will prompt you for a **Rancher Server URL**.You should set the URL to the main entry point to the Rancher Server. When a load balancer sits in front a Rancher Server cluster, the URL should resolve to the load balancer. The system will automatically try to infer the Rancher Server URL from the IP address or host name of the host running the Rancher Server. This is only correct if you are running a single node Rancher Server installation. In most cases, therefore, you need to set the Rancher Server URL to the correct value yourself.
After you log into Rancher for the first time, Rancher will prompt you for a **Rancher Server URL**. You should set the URL to the main entry point to the Rancher Server. When a load balancer sits in front a Rancher Server cluster, the URL should resolve to the load balancer. The system will automatically try to infer the Rancher Server URL from the IP address or host name of the host running the Rancher Server. This is only correct if you are running a single node Rancher Server installation. In most cases, therefore, you need to set the Rancher Server URL to the correct value yourself.
>**Important!** After you set the Rancher Server URL, we do not support updating it. Set the URL with extreme care.
@@ -36,7 +36,7 @@ These methods of communicating with downstream Kubernetes clusters are also expl
### About the kube-api-auth Authentication Webhook
The `kube-api-auth` microservice is deployed to provide the user authentication functionality for the [authorized cluster endpoint,](../../../../reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters.md#4-authorized-cluster-endpoint) which is only available for [RKE clusters.](../../../new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md) When you access the user cluster using `kubectl`, the cluster's Kubernetes API server authenticates you by using the `kube-api-auth` service as a webhook.
The `kube-api-auth` microservice is deployed to provide the user authentication functionality for the [authorized cluster endpoint](../../../../reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters.md#4-authorized-cluster-endpoint) which is only available for [RKE clusters.](../../../new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md) When you access the user cluster using `kubectl`, the cluster's Kubernetes API server authenticates you by using the `kube-api-auth` service as a webhook.
During cluster provisioning, the file `/etc/kubernetes/kube-api-authn-webhook.yaml` is deployed and `kube-apiserver` is configured with `--authentication-token-webhook-config-file=/etc/kubernetes/kube-api-authn-webhook.yaml`. This configures the `kube-apiserver` to query `http://127.0.0.1:6440/v1/authenticate` to determine authentication for bearer tokens.
@@ -20,7 +20,7 @@ This pseudo-CRD maps to a section of the Prometheus custom resource configuratio
When a ServiceMonitor is created, the Prometheus Operator updates the Prometheus scrape configuration to include the ServiceMonitor configuration. Then Prometheus begins scraping metrics from the endpoint defined in the ServiceMonitor.
Any Services in your cluster that match the labels located within the ServiceMonitor `selector` field will be monitored based on the `endpoints` specified on the ServiceMonitor. For more information on what fields can be specified, please look at the [spec](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/api.md#servicemonitor) provided by Prometheus Operator.
Any Services in your cluster that match the labels located within the ServiceMonitor `selector` field will be monitored based on the `endpoints` specified on the ServiceMonitor. For more information on what fields can be specified, please look at the [spec](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#servicemonitor) provided by Prometheus Operator.
For more information about how ServiceMonitors work, refer to the [Prometheus Operator documentation.](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/user-guides/running-exporters.md)
@@ -30,4 +30,4 @@ This pseudo-CRD maps to a section of the Prometheus custom resource configuratio
When a PodMonitor is created, the Prometheus Operator updates the Prometheus scrape configuration to include the PodMonitor configuration. Then Prometheus begins scraping metrics from the endpoint defined in the PodMonitor.
Any Pods in your cluster that match the labels located within the PodMonitor `selector` field will be monitored based on the `podMetricsEndpoints` specified on the PodMonitor. For more information on what fields can be specified, please look at the [spec](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/api.md#podmonitorspec) provided by Prometheus Operator.
Any Pods in your cluster that match the labels located within the PodMonitor `selector` field will be monitored based on the `podMetricsEndpoints` specified on the PodMonitor. For more information on what fields can be specified, please look at the [spec](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#podmonitor) provided by Prometheus Operator.
@@ -100,7 +100,7 @@ If you want to check resolving of domain names on all of the hosts, execute the
- image: busybox:1.28
imagePullPolicy: Always
name: alpine
command: ["sh", "-c", "tail -f /dev/null"]
command: ["sleep", "infinity"]
terminationMessagePath: /dev/termination-log
```
@@ -43,7 +43,7 @@ To test the overlay network, you can launch the following `DaemonSet` definition
- image: rancherlabs/swiss-army-knife
imagePullPolicy: Always
name: overlaytest
command: ["sh", "-c", "tail -f /dev/null"]
command: ["sleep", "infinity"]
terminationMessagePath: /dev/termination-log
```
+15
View File
@@ -0,0 +1,15 @@
---
title: Extension API Server
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/api/extension-apiserver"/>
</head>
Rancher extends Kubernetes with additional APIs by registering an extension API server using the [Kubernetes API Aggregation Layer](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/apiserver-aggregation/).
## Disabling the extension API server
The [aggregation layer must be configured](https://kubernetes.io/docs/tasks/extend-kubernetes/configure-aggregation-layer/) on the local Kubernetes cluster for the `imperative-api-extension` feature to be enabled and to work correctly. The feature assumes this is configured and is enabled by default. If it is not possible to configure the aggregation layer for your local Kubernetes cluster, then you must disable the feature. The `imperative-api-extension` feature flag can be disabled by either using the [Rancher UI](../how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md#disabling-features-with-the-rancher-ui) or [Rancher API](../how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md#disabling-features-with-the-rancher-api).
It will still be possible to access the additional APIs when the feature is disabled. The additional APIs are available at `https://<rancher url>/ext` and they are compatible with the Kubernetes apiserver. This means you can use `curl` or `kubectl` to interact with the APIs.
+3 -4
View File
@@ -16,10 +16,9 @@ Rancher will publish deprecated features as part of the [release notes](https://
| Patch Version | Release Date |
|---------------|---------------|
| [2.10.3](https://github.com/rancher/rancher/releases/tag/v2.10.3) | Feb 27, 2025 |
| [2.10.2](https://github.com/rancher/rancher/releases/tag/v2.10.2) | Jan 29, 2025 |
| [2.10.1](https://github.com/rancher/rancher/releases/tag/v2.10.1) | Dec 19, 2024 |
| [2.10.0](https://github.com/rancher/rancher/releases/tag/v2.10.0) | Nov 18, 2024 |
| [2.11.2](https://github.com/rancher/rancher/releases/tag/v2.11.2) | May 22, 2025 |
| [2.11.1](https://github.com/rancher/rancher/releases/tag/v2.11.1) | Apr 24, 2025 |
| [2.11.0](https://github.com/rancher/rancher/releases/tag/v2.11.0) | Mar 31, 2025 |
## What can I expect when a feature is marked for deprecation?
@@ -35,7 +35,7 @@ The upgrade instructions assume you are using Helm 3.
<DeprecationHelm2 />
For migration of installs started with Helm 2, refer to the official [Helm 2 to 3 migration docs.](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/) The [Helm 2 upgrade page here](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/helm2.md)provides a copy of the older upgrade instructions that used Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible.
For migration of installs started with Helm 2, refer to the official [Helm 2 to 3 migration docs.](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/) The [Helm 2 upgrade page here](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/helm2.md) provides a copy of the older upgrade instructions that used Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible.
### For air-gapped installs: Populate private registry
@@ -18,8 +18,6 @@ In this section,
- **K3s (Lightweight Kubernetes)** is also a fully compliant Kubernetes distribution. It is newer than RKE, easier to use, and more lightweight, with a binary size of less than 100 MB.
- **RKE2** is a fully conformant Kubernetes distribution that focuses on security and compliance within the U.S. Federal Government sector.
Note the `restrictedAdmin` Helm chart option available for **the Rancher Server**. When this option is set to true, the initial Rancher user has restricted access to the local Kubernetes cluster to prevent privilege escalation. For more information, see the section about the [restricted-admin role.](../../how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md#restricted-admin)
## Overview of Installation Options
Rancher can be installed on these main architectures:
@@ -18,10 +18,12 @@ Some feature flags require a restart of the Rancher container. Features that req
The following is a list of feature flags available in Rancher. If you've upgraded from a previous Rancher version, you may see additional flags in the Rancher UI, such as `proxy` or `dashboard` (both [discontinued](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.5/reference-guides/installation-references/feature-flags.md)):
- `aggregated-roletemplates`: Use cluster role aggregation architecture for RoleTemplates, ProjectRoleTemplateBindings, and ClusterRoleTemplateBindings. See [Cluster Role Aggregation](../../../how-to-guides/advanced-user-guides/enable-experimental-features/cluster-role-aggregation.md) for more information.
- `clean-stale-secrets`: Removes stale secrets from the `cattle-impersonation-system` namespace. This slowly cleans up old secrets which are no longer being used by the impersonation system.
- `continuous-delivery`: Allows Fleet GitOps to be disabled separately from Fleet. See [Continuous Delivery.](../../../how-to-guides/advanced-user-guides/enable-experimental-features/continuous-delivery.md) for more information.
- `fleet`: The Rancher provisioning framework in v2.6 and later requires Fleet. The flag will be automatically enabled when you upgrade, even if you disabled this flag in an earlier version of Rancher. See [Continuous Delivery with Fleet](../../../integrations-in-rancher/fleet/fleet.md) for more information.
- `harvester`: Manages access to the Virtualization Management page, where users can navigate directly to Harvester clusters and access the Harvester UI. See [Harvester Integration Overview](../../../integrations-in-rancher/harvester/overview.md) for more information.
- `imperative-api-extension`: Enables Rancher's [extension API server](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/apiserver-aggregation/) to register new APIs to Kubernetes. This flag is enabled by default. See the [Extension API Server](../../../api/extension-apiserver.md) page for more information.
- `istio-virtual-service-ui`: Enables a [visual interface](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md) to create, read, update, and delete Istio virtual services and destination rules, which are Istio traffic management features.
- `legacy`: Enables a set of features from 2.5.x and earlier, that are slowly being phased out in favor of newer implementations. These are a mix of deprecated features as well as features that will eventually be available to newer versions. This flag is disabled by default on new Rancher installations. If you're upgrading from a previous version of Rancher, this flag is enabled.
- `managed-system-upgrade-controller`: Enables the installation of the system-upgrade-controller app in downstream RKE2/K3s clusters, currently limited to imported clusters and the local cluster, with plans to expand support to node-driver clusters.
@@ -38,12 +40,14 @@ The following table shows the availability and default values for some feature f
| Feature Flag Name | Default Value | Status | Available As Of | Additional Information |
| ----------------------------- | ------------- | ------------ | --------------- | ---------------------- |
| `aggregated-roletemplates` | `false` | Highly experimentatl | v2.11.0 | This flag value is locked on install and can't be changed. |
| `clean-stale-secrets` | `true` | GA | v2.10.2 | |
| `continuous-delivery` | `true` | GA | v2.6.0 | |
| `external-rules` | v2.7.14: `false`, v2.8.5: `true` | Removed | v2.7.14, v2.8.5 | This flag affected [external `RoleTemplate` behavior](../../../how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#external-roletemplate-behavior). It is removed in Rancher v2.9.0 and later as the behavior is enabled by default. |
| `fleet` | `true` | Can no longer be disabled | v2.6.0 | |
| `fleet` | `true` | GA | v2.5.0 | |
| `harvester` | `true` | Experimental | v2.6.1 | |
| `imperative-api-extension` | `true` | GA | v2.11.0 | |
| `legacy` | `false` for new installs, `true` for upgrades | GA | v2.6.0 | |
| `managed-system-upgrade-controller` | `true` | GA | v2.10.0 | |
| `rke1-custom-node-cleanup`| `true` | GA | v2.6.0 | |
@@ -59,7 +59,6 @@ For information on enabling experimental features, refer to [this page.](../../.
| `rancherImageTag` | same as chart version | `string` - rancher/rancher image tag |
| `replicas` | 3 | `int` - Number of Rancher server replicas. Setting to -1 will dynamically choose 1, 2, or 3 based on the number of available nodes in the cluster. |
| `resources` | {} | `map` - rancher pod resource requests & limits |
| `restrictedAdmin` | `false` | `bool` - When this option is set to `true`, the initial Rancher user has restricted access to the local Kubernetes cluster to prevent privilege escalation. For more information, see the section about the [restricted-admin role](../../../how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md#restricted-admin). |
| `systemDefaultRegistry` | "" | `string` - private registry to be used for all system container images, e.g., http://registry.example.com/ |
| `tls` | "ingress" | `string` - See [External TLS Termination](#external-tls-termination) for details. - "ingress, external" |
| `useBundledSystemChart` | `false` | `bool` - select to use the system-charts packaged with Rancher server. This option is used for air gapped installations. |
@@ -6,6 +6,8 @@ title: Upgrading Kubernetes without Upgrading Rancher
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/upgrade-kubernetes-without-upgrading-rancher"/>
</head>
<EOLRKE1Warning />
The RKE metadata feature allows you to provision clusters with new versions of Kubernetes as soon as they are released, without upgrading Rancher. This feature is useful for taking advantage of patch versions of Kubernetes, for example, if you want to upgrade to Kubernetes v1.14.7 when your Rancher server originally supported v1.14.6.
:::note
@@ -87,7 +89,7 @@ After new Kubernetes versions are loaded into the Rancher setup, additional step
To download the system images for the private registry:
1. Click **☰** in the top left corner.
1. Click **About** at the bottom of the left navigation.
1. At the bottom of the left navigation, click the Rancher version number.
1. Download the OS specific image lists for Linux or Windows.
1. Download `rancher-images.txt`.
1. Prepare the private registry using the same steps during the [air gap install](other-installation-methods/air-gapped-helm-cli-install/publish-images.md), but instead of using the `rancher-images.txt` from the releases page, use the one obtained from the previous steps.
@@ -27,15 +27,13 @@ This Quick Start Guide is divided into different tasks for easier consumption.
## Prerequisites
- An [Equinix Metal account](https://metal.equinix.com/developers/docs/accounts/users/)
- An [Equinix Metal project](https://metal.equinix.com/developers/docs/accounts/projects/)
- An [Equinix Metal account](https://deploy.equinix.com/developers/docs/metal/identity-access-management/users/)
- An [Equinix Metal project](https://deploy.equinix.com/developers/docs/metal/projects/creating-a-project/)
### 1. Provision a Equinix Metal Host
Begin deploying an Equinix Metal Host. Equinix Metal Servers can be provisioned from either the Equinix Metal console, API, or CLI. You can find instructions for each deployment type on the [Equinix Metal deployment documentation](https://metal.equinix.com/developers/docs/deploy/on-demand/). You can find additional documentation on Equinix Metal server types and prices below:
- [Equinix Metal Server Types](https://metal.equinix.com/developers/docs/servers/about/)
- [Equinix Metal Pricing](https://metal.equinix.com/developers/docs/servers/server-specs/)
Begin deploying an Equinix Metal Host. Equinix Metal Servers can be provisioned from either the Equinix Metal console, API, or CLI. You can find instructions for each deployment type on the [Equinix Metal deployment documentation](https://deploy.equinix.com/developers/docs/metal/deploy/on-demand/). You can find additional information on Equinix Metal server types in the [Equinix Metal Documentation](https://deploy.equinix.com/developers/docs/metal/hardware/standard-servers/).
:::note Notes:
@@ -20,12 +20,13 @@ The intent of these guides is to quickly launch a sandbox that you can use to ev
- [Virtualbox](https://www.virtualbox.org): The virtual machines that Vagrant provisions need to be provisioned to VirtualBox.
- At least 4GB of free RAM.
### Note
- Vagrant will require plugins to create VirtualBox VMs. Install them with the following commands:
:::note
`vagrant plugin install vagrant-vboxmanage`
Vagrant requires plugins to create VirtualBox VMs. Install them with the following commands:
- `vagrant plugin install vagrant-vboxmanage`
- `vagrant plugin install vagrant-vbguest`
`vagrant plugin install vagrant-vbguest`
:::
## Getting Started
@@ -0,0 +1,78 @@
---
title: Enabling Cluster Agent Scheduling Customization
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/enable-cluster-agent-scheduling-customization"/>
</head>
The `cattle-cluster-agent` allows enabling automatic deployment of a Priority Class and Pod Disruption Budget.
When this feature is enabled, all newly provisioned Node Driver, Custom, and Imported RKE2 and K3s clusters will automatically deploy a Priority Class and Pod Disruption Budget during the provisioning process. Existing clusters can be gradually updated with this new behavior using the [Rancher UI or by setting a specific annotation](#updating-existing-clusters) on cluster objects.
This feature is disabled by default.
## Enabling Cluster Agent Scheduling Customization
:::info
Enabling or disabling this feature only impacts new clusters. Existing downstream clusters will not be automatically updated. See [_Updating Existing Clusters_](#updating-existing-clusters).
:::
1. In the upper left corner, click **☰ > Global Settings**
1. Select **Feature Flags**
1. Find the `cluster-agent-scheduling-customization` feature and click **⋮ > Activate**
## Configuring the Global Settings
You can customize the default Priority Class (PC) and Pod Disruption Budget (PDB) by updating the `cluster-agent-default-priority-class` and `cluster-agent-default-pod-disruption-budget` global settings in the Rancher UI. Note that both the Priority Class and Pod Disruption Budget have configuration restrictions:
+ The `Value` set for the default PC cannot be less than negative 1 billion, or greater than 1 billion.
+ The `PreemptionPolicy` set for the PC must be equal to `PreemptLowerPriority` or `Never`.
+ You cannot configure the PDB `minAvailable` and `maxUnavailable` fields to both have a non-zero value.
+ The PDB `minAvailable` must either be a non-negative whole number integer, or a non-negative whole number percent (e.g. `1` or `100%`).
+ The PDB `maxUnavailable` must either be a non-negative whole number integer, or a non-negative whole number percent (e.g. `1` or `100%`).
## Updating Existing Clusters
:::info
When this feature is disabled, you cannot modify the cluster agent scheduling customization fields for existing clusters. However, you can always remove the configuration, regardless of the feature's status.
:::
After enabling this feature, you can configure scheduling customization for existing clusters in two ways:
+ **Using the Rancher UI**
+ Edit the desired cluster and navigate to the **Cluster Agent** tab within the **Cluster Configuration** section.
+ Enable the `Prevent Rancher cluster agent pod eviction` checkbox.
+ The necessary fields on the associated `clusters.provisioning.cattle.io` or `clusters.management.cattle.io` object will be automatically configured using the values set in the global settings.
+ Save the cluster.
+ **Using an annotation**
+ The `provisioning.cattle.io/enable-scheduling-customization` annotation can be used to update clusters without requiring the use of the Rancher UI. This annotation will be automatically removed from the cluster after the Priority Class and Pod Disruption Budget are configured.
+ The value of this annotation can be either `true` or `false`, to add or remove scheduling customization automatically.
+ For Node Driver Provisioned and Custom clusters, apply this annotation on the associated `clusters.provisioning.cattle.io` object.
+ For Imported clusters, apply the annotation on the associated `clusters.management.cattle.io` object.
## Applying Updated Global Settings
In order to prevent unexpected changes in scheduler behavior, Rancher does not update existing downstream clusters when the `cluster-agent-default-priority-class` and `cluster-agent-default-pod-disruption-budget` global settings are changed. There are two ways to update existing clusters to use the most recent global settings:
+ **Using the Rancher UI**
+ When configuring a cluster, an additional checkbox will be shown in the **Cluster Agent** tab within the **Cluster Configuration** section. Checking the `Apply global settings for Priority Class and Pod Disruption Budget` checkbox will automatically update the Priority Class and Pod Disruption Budget to match the global settings once the cluster is saved.
+ **Adjusting the cluster yaml**
+ You may manually adjust the relevant fields in the cluster object using `kubectl` or the Rancher UI 'Edit As Yaml' feature. Scheduling customization can be found in the `spec.ClusterAgentDeploymentCustomization.SchedulingCustomization` section of the cluster object.
+ Alternatively, the `provisioning.cattle.io/enable-scheduling-customization` annotation can be used to remove and re-add the updated scheduling customization fields set on a specific cluster.
## Downstream Objects
When this feature is enabled for a given cluster, two downstream resources will be automatically created by Rancher:
+ A Pod Disruption Budget will be automatically created in the `cattle-system` namespace, named `cattle-cluster-agent-pod-disruption-budget`.
+ A Priority Class will be automatically created, named `cattle-cluster-agent-priority-class`.
These objects are maintained by Rancher and must not be modified or deleted. The Rancher server will automatically update these objects to match the configuration set on the Cluster object and remove them when they are no longer needed.
### RBAC considerations
Before enabling this feature on a downstream cluster, cluster administrators should assess their current RBAC configuration to prevent common access to the `cattle-cluster-agent-priority-class`. In cases where external users have access to a cluster, such as when offering clusters as a service, it is recommended to limit access to the `cattle-cluster-agent-priority-class` object to prevent changes or deletion.
Similar considerations do not need to be made for the `cattle-cluster-agent-pod-disruption-budget` object, as Pod Disruption Budgets are namespaced objects. Rancher will create the `cattle-cluster-agent-pod-disruption-budget` in the privileged `cattle-system` namespace.
@@ -0,0 +1,19 @@
---
title: ClusterRole Aggregation
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/enable-experimental-features/cluster-role-aggregation"/>
</head>
:::caution
ClusterRole aggregation is a highly experimental feature that changes the RBAC architecture used for RoleTemplates, ClusterRoleTemplateBindings and ProjectRoleTemplateBindings. **It is not supported for production environments**. This feature is meant exclusively for internal testing in v2.11. It is expected to be available as a beta for users in v2.12 with a prospective GA in Rancher v2.13.
:::
ClusterRole aggregation implements RoleTemplates, ClusterRoleTemplateBindings and ProjectRoleTemplateBindings using the Kubernetes feature [Aggregated ClusterRoles](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#aggregated-clusterroles). The new architecture results in a net reduction in RBAC objects (Roles, RoleBindings, ClusterRoles and ClusterRoleBindings) both in the Rancher cluster and the downstream clusters.
| Environment Variable Key | Default Value | Description |
| --- | --- | --- |
| `aggregated-roletemplates` | `false` | [Experimental] Make RoleTemplates use aggregation for generated RBAC roles. |
The value of this feature flag is locked on installation, which shows up in the UI as a lock symbol beside the feature flag. That means the feature can only be set on the first ever installation of Rancher. After that, attempting to modify the value will be denied.
@@ -6,6 +6,14 @@ title: Enable Istio in the Cluster
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
:::note Prerequisites:
- Only a user with the `cluster-admin` [Kubernetes default role](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles) assigned can configure and install Istio in a Kubernetes cluster.
@@ -6,6 +6,14 @@ title: Enable Istio in a Namespace
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
You will need to manually enable Istio in each namespace that you want to be tracked or controlled by Istio. When Istio is enabled in a namespace, the Envoy sidecar proxy will be automatically injected into all new workloads that are deployed in the namespace.
This namespace setting will only affect new workloads in the namespace. Any preexisting workloads will need to be re-deployed to leverage the sidecar auto injection.
@@ -6,6 +6,14 @@ title: Generate and View Traffic from Istio
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
## The Kiali Traffic Graph
The Istio overview page provides a link to the Kiali dashboard. From the Kiali dashboard, you can view graphs for each namespace. The Kiali graph provides a powerful way to visualize the topology of your Istio service mesh. It shows you which services communicate with each other.
@@ -6,6 +6,14 @@ title: Istio Setup Guides
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/istio-setup-guide"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
This section describes how to enable Istio and start using it in your projects.
If you use Istio for traffic management, you will need to allow external traffic to the cluster. In that case, you will need to follow all of the steps below.
@@ -6,6 +6,14 @@ title: Set up the Istio Gateway
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
The gateway to each cluster can have its own port or load balancer, which is unrelated to a service mesh. By default, each Rancher-provisioned cluster has one NGINX ingress controller allowing traffic into the cluster.
You can use the Nginx Ingress controller with or without Istio installed. If this is the only gateway to your cluster, Istio will be able to route traffic from service to service, but Istio will not be able to receive traffic from outside the cluster.
@@ -6,6 +6,14 @@ title: Set up Istio's Components for Traffic Management
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
A central advantage of traffic management in Istio is that it allows dynamic request routing. Some common applications for dynamic request routing include canary deployments and blue/green deployments. The two key resources in Istio traffic management are *virtual services* and *destination rules*.
- [Virtual services](https://istio.io/docs/reference/config/networking/v1alpha3/virtual-service/) intercept and direct traffic to your Kubernetes services, allowing you to divide percentages of traffic from a request to different services. You can use them to define a set of routing rules to apply when a host is addressed.
@@ -6,6 +6,14 @@ title: Add Deployments and Services with the Istio Sidecar
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
:::note Prerequisite:
To enable Istio for a workload, the cluster and namespace must have the Istio app installed.
@@ -31,6 +31,14 @@ Following project creation, you can add users as project members so that they ca
1. In the **Members** tab, click **Add**.
1. Search for the user or group that you want to add to the project.
:::note Notes:
- At least 2 characters must be typed in the search box for results to appear.
- Users can be searched based on their username or display name.
- Search is prefix-based (e.g., a user named `Stan Dard` will appear when searching for `Sta`, but not when searching for `Dar`) and case-sensitive.
:::
If external authentication is configured:
- Rancher returns users from your external authentication source as you type.
@@ -63,4 +71,4 @@ Following project creation, you can add users as project members so that they ca
**Result:** The chosen users are added to the project.
- To revoke project membership, select the user and click **Delete**. This action deletes membership, not the user.
- To modify a user's roles in the project, delete them from the project, and then re-add them with modified roles.
- To modify a user's roles in the project, delete them from the project, and then re-add them with modified roles.
@@ -6,6 +6,8 @@ title: About RKE1 Templates
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates"/>
</head>
<EOLRKE1Warning />
RKE templates are designed to allow DevOps and security teams to standardize and simplify the creation of Kubernetes clusters.
RKE is the [Rancher Kubernetes Engine,](https://rancher.com/docs/rke/latest/en/) which is the tool that Rancher uses to provision Kubernetes clusters.
@@ -6,6 +6,8 @@ title: Creating and Revising RKE Templates
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/manage-rke1-templates"/>
</head>
<EOLRKE1Warning />
This section describes how to manage RKE templates and revisions. You an create, share, update, and delete templates from the **Cluster Management** view under **RKE1 Configuration > RKE Templates**.
Template updates are handled through a revision system. When template owners want to change or update a template, they create a new revision of the template. Individual revisions cannot be edited. However, if you want to prevent a revision from being used to create a new cluster, you can disable it.
@@ -43,14 +43,15 @@ In most cases, you should use an external authentication service over local auth
## Users and Groups
Rancher relies on users and groups to determine who is allowed to log in to Rancher and which resources they can access. When authenticating with an external provider, groups are provided from the external provider based on the user. These users and groups are given specific roles to resources like clusters, projects, and global DNS providers and entries. When you give access to a group, all users who are a member of that group in the authentication provider will be able to access the resource with the permissions that you've specified. For more information on roles and permissions, see [Role Based Access Control](../manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md).
:::note
Local authentication does not support creating or managing groups.
- Local authentication does not support creating or managing groups.
- After an external authentication provider is configured, note that local Rancher scoped administrative users only display resources such as users and groups that they are a member of in the respective authentication provider.
:::
Rancher relies on users and groups to determine who is allowed to log in to Rancher and which resources they can access. When authenticating with an external provider, groups are provided from the external provider based on the user. These users and groups are given specific roles to resources like clusters, projects, and global DNS providers and entries. When you give access to a group, all users who are a member of that group in the authentication provider will be able to access the resource with the permissions that you've specified. For more information on roles and permissions, see [Role Based Access Control](../manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md).
For more information, see [Users and Groups](manage-users-and-groups.md)
## Scope of Rancher Authorization
@@ -168,7 +168,7 @@ If you are experiencing issues while testing the connection to the Keycloak serv
When you click on **Authenticate with Keycloak**, you are not redirected to your IdP.
* Verify your Keycloak client configuration.
* Make sure `Force Post Binding` set to `OFF`.
* Make sure `Force Post Binding` is set to `OFF`.
### Forbidden message displayed after IdP login
@@ -10,7 +10,7 @@ After installation, the [system administrator](manage-role-based-access-control-
## First Log In
After you log into Rancher for the first time, Rancher will prompt you for a **Rancher Server URL**.You should set the URL to the main entry point to the Rancher Server. When a load balancer sits in front a Rancher Server cluster, the URL should resolve to the load balancer. The system will automatically try to infer the Rancher Server URL from the IP address or host name of the host running the Rancher Server. This is only correct if you are running a single node Rancher Server installation. In most cases, therefore, you need to set the Rancher Server URL to the correct value yourself.
After you log into Rancher for the first time, Rancher will prompt you for a **Rancher Server URL**. You should set the URL to the main entry point to the Rancher Server. When a load balancer sits in front a Rancher Server cluster, the URL should resolve to the load balancer. The system will automatically try to infer the Rancher Server URL from the IP address or host name of the host running the Rancher Server. This is only correct if you are running a single node Rancher Server installation. In most cases, therefore, you need to set the Rancher Server URL to the correct value yourself.
:::danger
@@ -90,4 +90,5 @@ The following features are available under **Global Configuration**:
- **Global DNS Entries**
- **Global DNS Providers**
As these are legacy features, please see the Rancher v2.0—v2.4 docs on [catalogs](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md), [global DNS entries](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns.md#adding-a-global-dns-entry), and [global DNS providers](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns.md#editing-a-global-dns-provider) for more details.
As these are legacy features, please see the Rancher v2.0—v2.4 docs on [catalogs](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md), [global DNS entries](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns.md#adding-a-global-dns-entry), and [global DNS providers](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns.md#editing-a-global-dns-provider) for more details.
@@ -8,12 +8,10 @@ title: Global Permissions
_Permissions_ are individual access rights that you can assign when selecting a custom permission for a user.
Global Permissions define user authorization outside the scope of any particular cluster. Out-of-the-box, there are four default global permissions: `Administrator`, `Restricted Admin`,`Standard User` and `User-base`.
Global Permissions define user authorization outside the scope of any particular cluster. Out-of-the-box, there are four default global permissions: `Administrator`, `Standard User` and `User-base`.
- **Administrator:** These users have full control over the entire Rancher system and all clusters within it.
- **Restricted Admin (Deprecated) :** These users have full control over downstream clusters, but cannot alter the local Kubernetes cluster.
- **Standard User:** These users can create new clusters and use them. Standard users can also assign other users permissions to their clusters.
- **User-Base:** User-Base users have login-access only.
@@ -286,79 +284,3 @@ To refresh group memberships,
1. Click **Refresh Group Memberships**.
**Result:** Any changes to the group members' permissions will take effect.
## Restricted Admin
:::warning Deprecated
The Restricted Admin role is deprecated, and will be removed in a future version of Rancher (2.10 or higher). You should make a custom role with the desired permissions instead of relying on this built-in role.
:::
A new `restricted-admin` role was created in Rancher v2.5 in order to prevent privilege escalation on the local Rancher server Kubernetes cluster. This role has full administrator access to all downstream clusters managed by Rancher, but it does not have permission to alter the local Kubernetes cluster.
The `restricted-admin` can create other `restricted-admin` users with an equal level of access.
A new setting was added to Rancher to set the initial bootstrapped administrator to have the `restricted-admin` role. This applies to the first user created when the Rancher server is started for the first time. If the environment variable is set, then no global administrator would be created, and it would be impossible to create the global administrator through Rancher.
To bootstrap Rancher with the `restricted-admin` as the initial user, the Rancher server should be started with the following environment variable:
```
CATTLE_RESTRICTED_DEFAULT_ADMIN=true
```
### List of `restricted-admin` Permissions
The following table lists the permissions and actions that a `restricted-admin` should have in comparison with the `Administrator` and `Standard User` roles:
| Category | Action | Global Admin | Standard User | Restricted Admin | Notes for Restricted Admin role |
| -------- | ------ | ------------ | ------------- | ---------------- | ------------------------------- |
| Local Cluster functions | Manage Local Cluster (List, Edit, Import Host) | Yes | No | No | |
| | Create Projects/namespaces | Yes | No | No | |
| | Add cluster/project members | Yes | No | No | |
| | Global DNS | Yes | No | No | |
| | Access to management cluster for CRDs and CRs | Yes | No | Yes | |
| | Save as RKE Template | Yes | No | No | |
| Security | | | | | |
| Enable auth | Configure Authentication | Yes | No | Yes | |
| Roles | Create/Assign GlobalRoles | Yes | No (Can list) | Yes | Auth webhook allows creating globalrole for perms already present |
| | Create/Assign ClusterRoles | Yes | No (Can list) | Yes | Not in local cluster |
| | Create/Assign ProjectRoles | Yes | No (Can list) | Yes | Not in local cluster |
| Users | Add User/Edit/Delete/Deactivate User | Yes | No | Yes | |
| Groups | Assign Global role to groups | Yes | No | Yes | As allowed by the webhook |
| | Refresh Groups | Yes | No | Yes | |
| PSP's | Manage PSP templates | Yes | No (Can list) | Yes | Same privileges as Global Admin for PSPs |
| Tools | | | | | |
| | Manage RKE Templates | Yes | No | Yes | |
| | Manage Global Catalogs | Yes | No | Yes | Cannot edit/delete built-in system catalog. Can manage Helm library |
| | Cluster Drivers | Yes | No | Yes | |
| | Node Drivers | Yes | No | Yes | |
| | GlobalDNS Providers | Yes | Yes (Self) | Yes | |
| | GlobalDNS Entries | Yes | Yes (Self) | Yes | |
| Settings | | | | | |
| | Manage Settings | Yes | No (Can list) | No (Can list) | |
| User | | | | | |
| | Manage API Keys | Yes (Manage all) | Yes (Manage self) | Yes (Manage self) | |
| | Manage Node Templates | Yes | Yes (Manage self) | Yes (Manage self) | Can only manage their own node templates and not those created by other users |
| | Manage Cloud Credentials | Yes | Yes (Manage self) | Yes (Manage self) | Can only manage their own cloud credentials and not those created by other users |
| Downstream Cluster | Create Cluster | Yes | Yes | Yes | |
| | Edit Cluster | Yes | Yes | Yes | |
| | Rotate Certificates | Yes | | Yes | |
| | Snapshot Now | Yes | | Yes | |
| | Restore Snapshot | Yes | | Yes | |
| | Save as RKE Template | Yes | No | Yes | |
| | Run CIS Scan | Yes | Yes | Yes | |
| | Add Members | Yes | Yes | Yes | |
| | Create Projects | Yes | Yes | Yes | |
| Feature Charts since v2.5 | | | | | |
| | Install Fleet | Yes | | Yes | Should not be able to run Fleet in local cluster |
| | Deploy EKS cluster | Yes | Yes | Yes | |
| | Deploy GKE cluster | Yes | Yes | Yes | |
| | Deploy AKS cluster | Yes | Yes | Yes | |
### Changing Global Administrators to Restricted Admins
In previous version, the docs recommended that all users should be changed over to Restricted Admin if the role was in use. Users are now encouraged to use a custom-built role using the cluster permissions feature, and migrate any current restricted admins to use that approach.
This can be done through **Security > Users** and moving any Administrator role over to Restricted Administrator.
Signed-in users can change themselves over to the `restricted-admin` if they wish, but they should only do that as the last step, otherwise they won't have the permissions to do so.
@@ -8,6 +8,10 @@ title: Pod Security Admission (PSA) Configuration Templates
[Pod Security admission (PSA)](./pod-security-standards.md) configuration templates are a Rancher custom-defined resource (CRD), available in Rancher v2.7.2 and above. The templates provide pre-defined security configurations that you can apply to a cluster:
:::info important
The policies shipped by default in Rancher aim to provide a trade-off between security and convenience. If a more strict policy configuration is needed, users are able to craft such policies themselves based on their specific requirements. In the case Rancher policies are preferred, you will need to deploy admission controllers that block the creation of any [exempted namespaces](#exempting-required-rancher-namespaces) that won't be used within your environments.
:::
- `rancher-privileged`: The most permissive configuration. It doesn't restrict the behavior of any pods. This allows for known privilege escalations. This policy has no exemptions.
- `rancher-restricted`: A heavily restricted configuration that follows current best practices for hardening pods. You must make [namespace-level exemptions](./pod-security-standards.md#rancher-on-psa-restricted-clusters) for Rancher components.
@@ -82,7 +82,7 @@ This section outlines the guidelines for the proper usage of the Rancher Backups
### Restores
- A restore refers to restoring a backup to the same cluster it was taken from. This can be with Rancher installed (**prune must be enabled**) or with it not installed (no special instructions).
- One thing to note when restoring is that you may find yourself needing to “wipe” the cluster of any Rancher resources. This can be done by deploying the [Rancher cleanup script](https://github.com/rancher/rancher-cleanup) script as a job to the cluster. This allows you to install Rancher Backups again and restore to a completely fresh cluster.
- One thing to note when restoring is that you may find yourself needing to “wipe” the cluster of any Rancher resources. This can be done by deploying the [Rancher cleanup script](https://github.com/rancher/rancher-cleanup) as a job to the cluster. This allows you to install Rancher Backups again and restore to a completely fresh cluster.
- Make sure to use kubectl to deploy the scripts.
### Migrations
@@ -52,10 +52,10 @@ Install the [`rancher-backup chart`](https://github.com/rancher/backup-restore-o
The above assumes an environment with outbound connectivity to Docker Hub.
For an **air-gapped environment**, use the following Helm value to pull the `backup-restore-operator` image from your private registry when you install the rancher-backup Helm chart.
For an **air-gapped environment**, use the following Helm values to pull the `backup-restore-operator` and `kubectl` images from your private registry when you install the rancher-backup Helm chart.
```bash
--set image.repository <registry>/rancher/backup-restore-operator
--set image.repository <registry>/rancher/backup-restore-operator --set global.kubectl.repository=<registry>/rancher/kubectl
```
:::
@@ -140,6 +140,26 @@ Install the [`rancher-backup chart`](https://github.com/rancher/backup-restore-o
1. Once the Restore resource has the status `Completed`, you can continue the cert-manager and Rancher installation.
:::note Important:
When migrating Rancher between any two different Kubernetes distributions (e.g. from K3s to RKE2), the object representing the local cluster has to be modified to allow Rancher to detect the new distribution. After the restoration is completed, and **before** bringing up Rancher on the new cluster, edit the local cluster object:
```bash
kubectl edit clusters.management.cattle.io local
```
1. Change the value of `status.driver` to `imported`.
1. Remove `status.provider`.
1. Remove the entire `status.version` map.
1. Remove the label with the key `provider.cattle.io` in `metadata.labels`.
1. Remove the annotation with the key `management.cattle.io/current-cluster-controllers-version` in `metadata.annotations`.
1. Remove the entire `spec.rke2Config` or `spec.k3sConfig` map, if present.
1. Save the changes.
Note that removing `spec.rke2Config` or `spec.k3sConfig` will erase your distribution-specific upgrade configuration for the local cluster. It can be [reconfigured](../../../getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes.md) if the new distribution is configurable for the local cluster.
:::
### 3. Install cert-manager
Follow the steps to [install cert-manager](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md#4-install-cert-manager) in the documentation about installing cert-manager on Kubernetes.
@@ -18,7 +18,7 @@ Rancher supports two different types of charts: Helm charts and Rancher charts.
### Helm Charts
Native Helm charts include an application along with other software required to run it. When deploying native Helm charts, you' can provide the chart's parameter values in a YAML editor.
Native Helm charts include an application along with other software required to run it. When deploying native Helm charts, you can provide the chart's parameter values in a YAML editor.
### Rancher Charts
@@ -164,12 +164,6 @@ spec:
### Add Custom OCI Chart Repositories
:::caution
This feature is currently experimental and is not officially supported in Rancher.
:::
Helm v3 introduced storing Helm charts as [Open Container Initiative (OCI)](https://opencontainers.org/about/overview/) artifacts in container registries. With Rancher v2.9.0, you can add [OCI-based Helm chart repositories](https://helm.sh/docs/topics/registries/) alongside HTTP-based and Git-based repositories. This means you can deploy apps that are stored as OCI artifacts. For more information, see [Using OCI Helm Chart Repositories](./oci-repositories.md).
### Helm Compatibility
@@ -6,12 +6,6 @@ title: Using OCI-Based Helm Chart Repositories
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/helm-charts-in-rancher/oci-registries"/>
</head>
:::caution
This feature is currently experimental and is not officially supported in Rancher.
:::
Helm v3 introduced storing Helm charts as [Open Container Initiative (OCI)](https://opencontainers.org/about/overview/) artifacts in container registries. With Rancher v2.9.0, you can add [OCI-based Helm chart repositories](https://helm.sh/docs/topics/registries/) alongside HTTP-based and Git-based repositories. This means that you can deploy apps that are stored as OCI artifacts.
## Add an OCI-Based Helm Chart Repository
@@ -6,6 +6,8 @@ title: Setting up Infrastructure for a High Availability RKE Kubernetes Cluster
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster"/>
</head>
<EOLRKE1Warning />
This tutorial is intended to help you create a high-availability RKE cluster that can be used to install a Rancher server.
:::note Important:
@@ -6,6 +6,8 @@ title: Setting up a High-availability RKE Kubernetes Cluster
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-cluster-setup/rke1-for-rancher"/>
</head>
<EOLRKE1Warning />
This section describes how to install a Kubernetes cluster. This cluster should be dedicated to run only the Rancher server.
:::note
@@ -31,13 +31,13 @@ kubectl create clusterrolebinding cluster-admin-binding \
Since, by default, Google Kubernetes Engine (GKE) doesn't grant the `cluster-admin` role, you must run these commands on GKE clusters before you can register them. To learn more about role-based access control for GKE, please see [the official Google documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).
### Elastic Kubernetes Service (EKS), Azure Kubernetes Service (AKS), and Google Kubernetes Engine (GKE)
### Elastic Kubernetes Service (EKS), Azure Kubernetes Service (AKS), and Google Kubernetes Engine (GKE)
To successfully import or provision EKS, AKS, and GKE clusters from Rancher, the cluster must have at least one managed node group.
To successfully import or provision EKS, AKS, and GKE clusters from Rancher, the cluster must have at least one managed node group.
AKS clusters can only be imported if local accounts are enabled. If a cluster is configured to use Microsoft Entra ID for authentication, Rancher will not be able to import the cluster and report an error.
EKS Anywhere clusters can be imported/registered into Rancher with an API address and credentials, as with any downstream cluster. EKS Anywhere clusters are treated as imported clusters and do not have full lifecycle support from Rancher.
EKS Anywhere clusters can be imported/registered into Rancher with an API address and credentials, as with any downstream cluster. EKS Anywhere clusters are treated as imported clusters and do not have full lifecycle support from Rancher.
GKE Autopilot clusters aren't supported. See [Compare GKE Autopilot and Standard](https://cloud.google.com/kubernetes-engine/docs/resources/autopilot-standard-feature-comparison) for more information about the differences between GKE modes.
@@ -47,9 +47,10 @@ GKE Autopilot clusters aren't supported. See [Compare GKE Autopilot and Standard
2. On the **Clusters** page, **Import Existing**.
3. Choose the type of cluster.
4. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user.
5. If you are importing a generic Kubernetes cluster in Rancher, perform the following steps for setup:<br/>
a. Click **Agent Environment Variables** under **Cluster Options** to set environment variables for [rancher cluster agent](../launch-kubernetes-with-rancher/about-rancher-agents.md). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables.<br/>
b. Enable Project Network Isolation to ensure the cluster supports Kubernetes `NetworkPolicy` resources. Users can select the **Project Network Isolation** option under the **Advanced Options** dropdown to do so.
5. If you are importing a generic Kubernetes cluster in Rancher, perform the following steps for setup:
1. Click **Agent Environment Variables** under **Cluster Options** to set environment variables for [rancher cluster agent](../launch-kubernetes-with-rancher/about-rancher-agents.md). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables.
1. Enable Project Network Isolation to ensure the cluster supports Kubernetes `NetworkPolicy` resources. Users can select the **Project Network Isolation** option under the **Advanced Options** dropdown to do so.
1. [Configure the version management feature for imported RKE2 and K3s clusters](#configuring-version-management-for-rke2-and-k3s-clusters).
6. Click **Create**.
7. The prerequisite for `cluster-admin` privileges is shown (see **Prerequisites** above), including an example command to fulfil the prerequisite.
8. Copy the `kubectl` command to your clipboard and run it on a node where kubeconfig is configured to point to the cluster you want to import. If you are unsure it is configured correctly, run `kubectl get nodes` to verify before running the command shown in Rancher.
@@ -124,18 +125,16 @@ After registering a cluster, the cluster owner can:
### Additional Features for Registered RKE2 and K3s Clusters
[K3s](https://rancher.com/docs/k3s/latest/en/) is a lightweight, fully compliant Kubernetes distribution for edge installations.
[RKE2](https://docs.rke2.io) is Rancher's next-generation Kubernetes distribution for datacenter and cloud installations.
When an RKE2 or K3s cluster is registered in Rancher, Rancher will recognize it. The Rancher UI will expose the features for [all registered clusters,](#features-for-all-registered-clusters) in addition to the following features for editing and upgrading the cluster:
When an RKE2 or K3s cluster is registered in Rancher, Rancher will recognize it.
The Rancher UI will expose features available to [all registered clusters](#features-for-all-registered-clusters), along with the following options for editing and upgrading the cluster:
- The ability to [upgrade the Kubernetes version](../../../getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes.md)
:::danger
After a cluster has been imported into Rancher, upgrades should be performed using Rancher. Upgrading an imported cluster outside of Rancher is **not** supported.
:::
- The ability to configure the maximum number of nodes that will be upgraded concurrently
- The ability to see a read-only version of the cluster's configuration arguments and environment variables used to launch each node in the cluster
- Enable or disable [version management](#configuring-version-management-for-rke2-and-k3s-clusters)
- [Upgrade the Kubernetes version](../../../getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes.md) when version management is enabled
- Configure the [upgrade strategy](#configuring-rke2-and-k3s-cluster-upgrades) when version management is enabled
- View a read-only version of the cluster’s configuration arguments and environment variables used to launch each node
### Additional Features for Registered EKS, AKS, and GKE Clusters
@@ -145,6 +144,24 @@ When you create an EKS, AKS, or GKE cluster in Rancher, then delete it, Rancher
See [Cluster Management Capabilities by Cluster Type](kubernetes-clusters-in-rancher-setup.md) for more information about what features are available for managing registered clusters.
## Configuring Version Management for RKE2 and K3s Clusters
:::danger
When version management is enabled for an imported cluster, upgrading it outside of Rancher may lead to unexpected consequences.
:::
The version management feature for imported RKE2 and K3s clusters can be configured using one of the following options:
- **Global default** (default): Inherits behavior from the global **imported-cluster-version-management** setting.
- **True**: Enables version management, allowing users to control the Kubernetes version and upgrade strategy of the cluster through Rancher.
- **False**: Disables version management, enabling users to manage the cluster’s Kubernetes version independently, outside of Rancher.
You can define the default behavior for newly created clusters or existing ones set to "Global default" by modifying the **imported-cluster-version-management** setting.
Changes to the global **imported-cluster-version-management** setting take effect during the cluster’s next reconciliation cycle.
## Configuring RKE2 and K3s Cluster Upgrades
:::tip
@@ -180,8 +197,12 @@ The current status of the plans can be viewed with this command:
kubectl get plans -A -o yaml
```
:::tip
If the cluster becomes stuck in upgrading, restart the `system-upgrade-controller`.
:::
To prevent issues when upgrading, the [Kubernetes upgrade best practices](https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade/) should be followed.
## Authorized Cluster Endpoint Support for RKE2 and K3s Clusters
@@ -304,4 +325,4 @@ This section lists some of the most common errors that may occur when importing
```sh
az aks update --resource-group <resource-group> --name <cluster-name> --enable-local-accounts
```
```
@@ -175,34 +175,6 @@ stringData:
"loadBalancerSku": "standard",
"excludeMasterFromStandardLB": false,
}
---
apiVersion: rbac.authorization.k8s.io/v1beta1
kind: ClusterRole
metadata:
labels:
kubernetes.io/cluster-service: "true"
name: system:azure-cloud-provider-secret-getter
rules:
- apiGroups: [""]
resources: ["secrets"]
resourceNames: ["azure-cloud-config"]
verbs:
- get
---
apiVersion: rbac.authorization.k8s.io/v1beta1
kind: ClusterRoleBinding
metadata:
labels:
kubernetes.io/cluster-service: "true"
name: system:azure-cloud-provider-secret-getter
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: system:azure-cloud-provider-secret-getter
subjects:
- kind: ServiceAccount
name: azure-cloud-config
namespace: kube-system
```
## Using the Out-of-tree Azure Cloud Provider
@@ -212,109 +184,85 @@ roleRef:
1. Select **External** from the **Cloud Provider** drop-down in the **Cluster Configuration** section.
2. Prepare the Cloud Provider Configuration to set it in the next step. Note that Rancher automatically creates a new Network Security Group, Resource Group, Availability Set, Subnet, and Virtual Network. If you already have some or all of these created, you must specify them before creating the cluster.
- Click **Show Advanced** to view or edit these automatically generated names. Your Cloud Provider Configuration **must** match the fields in the **Machine Pools** section. If you have multiple pools, they must all use the same Resource Group, Availability Set, Subnet, Virtual Network, and Network Security Group.
2. Under **Cluster Configuration > Advanced**, click **Add** under **Additional Controller Manager Args** and add this flag: `--configure-cloud-routes=false`.
3. Under **Cluster Configuration > Advanced**, click **Add** under **Additional Controller Manager Args** and add this flag: `--configure-cloud-routes=false`.
3. Prepare the Cloud Provider Configuration to set it in the next step. Note that Rancher automatically creates a new Network Security Group, Resource Group, Availability Set, Subnet, and Virtual Network. If you already have some or all of these created, you must specify them before creating the cluster.
Note that the chart reads the Cloud Provider Config from the secret in the `kube-system` namespace. An example secret for the Cloud Provider Config is shown below. Modify it as needed. Refer to the full list of configuration options in the [upstream docs](https://cloud-provider-azure.sigs.k8s.io/install/configs/).
Click **Show Advanced** to view or edit these automatically generated names. Your Cloud Provider Configuration **must** match the fields in the **Machine Pools** section. If you have multiple pools, they must all use the same Resource Group, Availability Set, Subnet, Virtual Network, and Network Security Group.
4. Under **Cluster Configuration > Add-on Config**, add the cloud controller manager manifest shown below into **Additional Manifest**.
Note that this chart reads the Cloud Provider Config from the secret in the `kube-system` namespace. An example secret for the Cloud Provider Config is shown below; modify it as needed. Refer to the full list of configuration options in the [upstream docs](https://cloud-provider-azure.sigs.k8s.io/install/configs/).
Alternatively, you can also install the cloud controller manager using the [Helm CLI](#helm-chart-installation-from-cli).
```yaml
apiVersion: helm.cattle.io/v1
kind: HelmChart
metadata:
name: azure-cloud-controller-manager
namespace: kube-system
spec:
chart: cloud-provider-azure
repo: https://raw.githubusercontent.com/kubernetes-sigs/cloud-provider-azure/master/helm/repo
targetNamespace: kube-system
bootstrap: true
valuesContent: |-
infra:
clusterName: <cluster-name>
cloudControllerManager:
cloudConfigSecretName: azure-cloud-config
cloudConfig: null
clusterCIDR: null
enableDynamicReloading: 'true'
nodeSelector:
node-role.kubernetes.io/control-plane: 'true'
allocateNodeCidrs: 'false'
hostNetworking: true
caCertDir: /etc/ssl
configureCloudRoutes: 'false'
enabled: true
tolerations:
- effect: NoSchedule
key: node-role.kubernetes.io/master
- effect: NoSchedule
key: node-role.kubernetes.io/control-plane
value: 'true'
- effect: NoSchedule
key: node.cloudprovider.kubernetes.io/uninitialized
value: 'true'
---
apiVersion: v1
kind: Secret
metadata:
name: azure-cloud-config
namespace: kube-system
type: Opaque
stringData:
cloud-config: |-
{
"cloud": "AzurePublicCloud",
"tenantId": "<tenant-id>",
"subscriptionId": "<subscription-id>",
"aadClientId": "<client-id>",
"aadClientSecret": "<tenant-id>",
"resourceGroup": "docker-machine",
"location": "westus",
"subnetName": "docker-machine",
"securityGroupName": "rancher-managed-kqmtsjgJ",
"securityGroupResourceGroup": "docker-machine",
"vnetName": "docker-machine-vnet",
"vnetResourceGroup": "docker-machine",
"primaryAvailabilitySetName": "docker-machine",
"routeTableResourceGroup": "docker-machine",
"cloudProviderBackoff": false,
"useManagedIdentityExtension": false,
"useInstanceMetadata": true,
"loadBalancerSku": "standard",
"excludeMasterFromStandardLB": false,
}
---
apiVersion: rbac.authorization.k8s.io/v1beta1
kind: ClusterRole
metadata:
labels:
kubernetes.io/cluster-service: "true"
name: system:azure-cloud-provider-secret-getter
rules:
- apiGroups: [""]
resources: ["secrets"]
resourceNames: ["azure-cloud-config"]
verbs:
- get
---
apiVersion: rbac.authorization.k8s.io/v1beta1
kind: ClusterRoleBinding
metadata:
labels:
kubernetes.io/cluster-service: "true"
name: system:azure-cloud-provider-secret-getter
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: system:azure-cloud-provider-secret-getter
subjects:
- kind: ServiceAccount
name: azure-cloud-config
namespace: kube-system
apiVersion: helm.cattle.io/v1
kind: HelmChart
metadata:
name: azure-cloud-controller-manager
namespace: kube-system
spec:
chart: cloud-provider-azure
repo: https://raw.githubusercontent.com/kubernetes-sigs/cloud-provider-azure/master/helm/repo
targetNamespace: kube-system
bootstrap: true
valuesContent: |-
infra:
clusterName: <cluster-name>
cloudControllerManager:
cloudConfigSecretName: azure-cloud-config
cloudConfig: null
clusterCIDR: null
enableDynamicReloading: 'true'
nodeSelector:
node-role.kubernetes.io/control-plane: 'true'
allocateNodeCidrs: 'false'
hostNetworking: true
caCertDir: /etc/ssl
configureCloudRoutes: 'false'
enabled: true
tolerations:
- effect: NoSchedule
key: node-role.kubernetes.io/master
- effect: NoSchedule
key: node-role.kubernetes.io/control-plane
value: 'true'
- effect: NoSchedule
key: node.cloudprovider.kubernetes.io/uninitialized
value: 'true'
---
apiVersion: v1
kind: Secret
metadata:
name: azure-cloud-config
namespace: kube-system
type: Opaque
stringData:
cloud-config: |-
{
"cloud": "AzurePublicCloud",
"tenantId": "<tenant-id>",
"subscriptionId": "<subscription-id>",
"aadClientId": "<client-id>",
"aadClientSecret": "<tenant-id>",
"resourceGroup": "docker-machine",
"location": "westus",
"subnetName": "docker-machine",
"securityGroupName": "rancher-managed-kqmtsjgJ",
"securityGroupResourceGroup": "docker-machine",
"vnetName": "docker-machine-vnet",
"vnetResourceGroup": "docker-machine",
"primaryAvailabilitySetName": "docker-machine",
"routeTableResourceGroup": "docker-machine",
"cloudProviderBackoff": false,
"useManagedIdentityExtension": false,
"useInstanceMetadata": true,
"loadBalancerSku": "standard",
"excludeMasterFromStandardLB": false,
}
```
4. Click **Create** to submit the form and create the cluster.
5. Click **Create** to submit the form and create the cluster.
</TabItem>
@@ -11,7 +11,7 @@ description: Configuring an Ingress
For Kubernetes v1.21 and up, the NGINX Ingress controller no longer runs in hostNetwork by default. It instead uses hostPorts for port 80 and port 443, so you can configure the admission webhook to be accessible only through the ClusterIP. This ensures that the webhook is only accessible from within the cluster.
Because of this change to the controller, the default RKE1 behavior no longer sets `hostNetwork` to `true`. However, you must set `hostNetwork` to `true` for TCP- and UDP-based Services to work. To do so, [edit](../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#editing-clusters-with-yaml) the cluster's YAML and follow the steps in the [official RKE1 doccumention](https://rke.docs.rancher.com/config-options/add-ons/ingress-controllers#configuring-network-options).
Because of this change to the controller, the default RKE1 behavior no longer sets `hostNetwork` to `true`. However, you must set `hostNetwork` to `true` for TCP- and UDP-based Services to work. To do so, [edit](../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#editing-clusters-with-yaml) the cluster's YAML and follow the steps in the [official RKE1 documentation](https://rke.docs.rancher.com/config-options/add-ons/ingress-controllers#configuring-network-options).
:::
@@ -6,6 +6,8 @@ title: Behavior Differences Between RKE1 and RKE2
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/rke1-vs-rke2-differences"/>
</head>
<EOLRKE1Warning />
RKE2, also known as RKE Government, is a Kubernetes distribution that focuses on security and compliance for U.S. Federal Government entities. It is considered the next iteration of the Rancher Kubernetes Engine, now known as RKE1.
RKE1 and RKE2 have several slight behavioral differences to note, and this page will highlight some of these at a high level.
@@ -35,7 +35,7 @@ The packages that need to be installed on the template are listed below. These w
* cloud-init
* cloud-guest-utils
* cloud-image-utils
* growpart
* growpart (part of cloud-guest-utils)
* cloud-initramfs-growroot
* open-iscsi
* openssh-server
@@ -131,7 +131,7 @@ cloud-init clean -s -l
### Windows Preparation
Windows has a utility called [sysprep](https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/sysprep--generalize--a-windows-installation) that is used to generalize an image and reset the same items listed above for Linux. The command is as follows:
Windows has a utility called [sysprep](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/sysprep--generalize--a-windows-installation?view=windows-11) that is used to generalize an image and reset the same items listed above for Linux. The command is as follows:
```PowerShell
sysprep.exe /generalize /shutdown /oobe
@@ -6,7 +6,7 @@ title: Adding Users to Clusters
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/manage-clusters/access-clusters/add-users-to-clusters"/>
</head>
If you want to provide a user with access and permissions to _all_ projects, nodes, and resources within a cluster, assign the user a cluster membership.
To provide a user access to view certain cluster-level resources and create new projects, assign the user a **Cluster Membership**. Cluster members can create projects and manage resources in those projects. However, not all resources, namespaces and workloads in a cluster are accessible by cluster members.
:::tip
@@ -33,6 +33,14 @@ Cluster administrators can edit the membership for a cluster, controlling which
1. In the **Member Roles** tab, click **Add Member**.
1. Search for the user or group that you want to add to the cluster.
:::note Notes:
- At least 2 characters must be typed in the search box for results to appear.
- Users can be searched based on their username or display name.
- Search is prefix-based (e.g., a user named `Stan Dard` will appear when searching for `Sta`, but not when searching for `Dar`) and case-sensitive.
:::
If external authentication is configured:
- Rancher returns users from your [external authentication](../../authentication-permissions-and-global-configuration/authentication-config/authentication-config.md) source as you type.
@@ -42,7 +42,7 @@ These methods of communicating with downstream Kubernetes clusters are also expl
### About the kube-api-auth Authentication Webhook
The `kube-api-auth` microservice is deployed to provide the user authentication functionality for the [authorized cluster endpoint,](../../../../reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters.md#4-authorized-cluster-endpoint). When you access the user cluster using `kubectl`, the cluster's Kubernetes API server authenticates you by using the `kube-api-auth` service as a webhook.
The `kube-api-auth` microservice is deployed to provide the user authentication functionality for the [authorized cluster endpoint](../../../../reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters.md#4-authorized-cluster-endpoint). When you access the user cluster using `kubectl`, the cluster's Kubernetes API server authenticates you by using the `kube-api-auth` service as a webhook.
During cluster provisioning, the file `/etc/kubernetes/kube-api-authn-webhook.yaml` is deployed and `kube-apiserver` is configured with `--authentication-token-webhook-config-file=/etc/kubernetes/kube-api-authn-webhook.yaml`. This configures the `kube-apiserver` to query `http://127.0.0.1:6440/v1/authenticate` to determine authentication for bearer tokens.
@@ -184,6 +184,12 @@ for mount in $(mount | grep tmpfs | grep '/var/lib/kubelet' | awk '{ print $3 }'
</TabItem>
<TabItem value="RKE2">
:::note
For instructions on cleaning nodes in RKE2 clusters that weren't deployed by Rancher, see the [official RKE2 documentation](https://docs.rke2.io/install/uninstall) on uninstalling clusters.
:::
You need to remove the following components from Rancher-provisioned RKE2 nodes:
* The rancher-system-agent, which connects to Rancher and installs and manages RKE2.
@@ -52,12 +52,6 @@ In this section, you'll learn how to add the cluster template to the `local` clu
**Result:** The cluster template available from the **Apps** in Rancher's `local` cluster. It can now be used to deploy clusters.
:::note Restricted Admin access:
If you are a restricted admin and don’t have access to the `local` cluster, you may still add new RKE2 templates and manage cluster repositories. To navigate to the chart repository, go to the left navigation bar and click **☰ > Cluster Management > Advanced > Repositories**. You will bypass steps 1 - 6 above, then proceed to follow steps 7 - 12 to create the cluster template.
:::
## Creating a Cluster from a Cluster Template
:::note Prerequisites:
@@ -168,7 +168,15 @@ By default, your user is added as the project `Owner`.
To add members:
1. In the **Members** tab, click **Add**.
1. From the **Select Member** field, search for a user or group that you want to assign project access. Note: You can only search for groups if external authentication is enabled.
1. From the **Select Member** field, search for a user or group that you want to assign project access. You can only search for groups if external authentication is enabled.
:::note Notes:
- At least 2 characters must be typed in the search box for results to appear.
- Users can be searched based on their username or display name.
- Search is prefix-based (e.g., a user named `Stan Dard` will appear when searching for `Sta`, but not when searching for `Dar`) and case-sensitive.
:::
1. In the **Project Permissions** section, choose a role. For more information, refer to the [documentation on project roles.](../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md)
### 4. Optional: Add Resource Quotas
@@ -19,10 +19,9 @@ In order to deploy and run the adapter successfully, you need to ensure its vers
| Rancher Version | Adapter Version |
|-----------------|------------------|
| v2.10.3 | v105.0.0+up5.0.1 |
| v2.10.2 | v105.0.0+up5.0.1 |
| v2.10.1 | v105.0.0+up5.0.1 |
| v2.10.0 | v105.0.0+up5.0.1 |
| v2.11.2 | v106.0.0+up6.0.0 |
| v2.11.1 | v106.0.0+up6.0.0 |
| v2.11.0 | v106.0.0+up6.0.0 |
### 1. Gain Access to the Local Cluster
@@ -6,6 +6,14 @@ title: Configuration Options
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/istio/configuration-options"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
### Egress Support
By default the Egress gateway is disabled, but can be enabled on install or upgrade through the values.yaml or via the [overlay file](#overlay-file).
@@ -6,6 +6,14 @@ title: Additional Steps for Installing Istio on RKE2 and K3s Clusters
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/istio/configuration-options/install-istio-on-rke2-cluster"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
When installing or upgrading the Istio Helm chart through **Apps,**
1. If you are installing the chart, click **Customize Helm options before install** and click **Next**.
@@ -6,6 +6,14 @@ title: Enable Istio with Pod Security Policies
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/istio/configuration-options/pod-security-policies"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
If you have restrictive Pod Security Policies enabled, then Istio may not be able to function correctly, because it needs certain permissions in order to install itself and manage pod infrastructure. In this section, we will configure a cluster with PSPs enabled for an Istio install, and also set up the Istio CNI plugin.
The Istio CNI plugin removes the need for each application pod to have a privileged `NET_ADMIN` container. For further information, see the [Istio CNI Plugin docs](https://istio.io/docs/setup/additional-setup/cni). Please note that the [Istio CNI Plugin is in alpha](https://istio.io/about/feature-stages/).
@@ -6,6 +6,14 @@ title: Additional Steps for Project Network Isolation
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/istio/configuration-options/project-network-isolation"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
In clusters where:
- You are using the Canal network plugin with Rancher before v2.5.8, or you are using Rancher v2.5.8+ with an any RKE network plug-in that supports the enforcement of Kubernetes network policies, such as Canal or the Cisco ACI plugin
@@ -6,6 +6,14 @@ title: Selectors and Scrape Configs
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
The Monitoring app sets `prometheus.prometheusSpec.ignoreNamespaceSelectors=false`, which enables monitoring across all namespaces by default.
This ensures you can view traffic, metrics and graphs for resources deployed in a namespace with `istio-injection=enabled` label.
@@ -6,6 +6,14 @@ title: CPU and Memory Allocations
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/istio/cpu-and-memory-allocations"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
This section describes the minimum recommended computing resources for the Istio components in a cluster.
The CPU and memory allocations for each component are [configurable.](#configuring-resource-allocations)
@@ -6,6 +6,14 @@ title: Disabling Istio
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/istio/disable-istio"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
This section describes how to uninstall Istio in a cluster or disable a namespace, or workload.
## Uninstall Istio in a Cluster
+9 -1
View File
@@ -6,6 +6,14 @@ title: Istio
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/istio"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
[Istio](https://istio.io/) is an open-source tool that makes it easier for DevOps teams to observe, secure, control, and troubleshoot the traffic within a complex network of microservices.
As a network of microservices changes and grows, the interactions between them can become increasingly difficult to manage and understand. In such a situation, it is useful to have a service mesh as a separate infrastructure layer. Istio's service mesh lets you manipulate traffic between microservices without changing the microservices directly.
@@ -55,7 +63,7 @@ For Istio installations `103.1.0+up1.19.6` and later, Kiali uses a token value f
Our Istio installer includes a quick-start, all-in-one installation of [Jaeger,](https://www.jaegertracing.io/) a tool used for tracing distributed systems.
Note that this is not a production-qualified deployment of Jaeger. This deployment uses an in-memory storage component, while a persistent storage component is recommended for production. For more information on which deployment strategy you may need, refer to the [Jaeger documentation.](https://www.jaegertracing.io/docs/latest/operator/#production-strategy)
Note that this is not a production-qualified deployment of Jaeger. This deployment uses an in-memory storage component, while a persistent storage component is recommended for production. For more information on which deployment strategy you may need, refer to the [Jaeger documentation.](https://www.jaegertracing.io/docs/1.65/operator/#production-strategy)
## Prerequisites
@@ -6,6 +6,14 @@ title: Role-based Access Control
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/istio/rbac-for-istio"/>
</head>
:::warning
[Rancher-Istio](https://github.com/rancher/charts/tree/release-v2.11/charts/rancher-istio) will be deprecated in Rancher v2.12.0; turn to the [SUSE Rancher Application Collection](https://apps.rancher.io) build of Istio for enhanced security (included in SUSE Rancher Prime subscriptions).
Detailed information can be found in [this announcement](https://forums.suse.com/t/deprecation-of-rancher-istio/45043).
:::
This section describes the permissions required to access Istio features.
The rancher istio chart installs three `ClusterRoles`
@@ -66,7 +66,7 @@ In general, you want to scrape data from all the workloads running in your clust
### About Prometheus Exporters
Many 3rd party workloads, such as databases, queues, and web-servers, already support exposing metrics in a Prometheus format, or offer exporters that translate between the tool's metrics and a format that Prometheus understands. You can usually add these exporters as additional sidecar containers to the workload's Pods. Many Helm charts already include options to deploy the correct exporter. You can find a curated list of exports by SysDig on [promcat.io](https://promcat.io/) and on [ExporterHub](https://exporterhub.io/).
Many 3rd party workloads, such as databases, queues, and web-servers, already support exposing metrics in a Prometheus format, or offer exporters that translate between the tool's metrics and a format that Prometheus understands. You can usually add these exporters as additional sidecar containers to the workload's Pods. Many Helm charts already include options to deploy the correct exporter. You can find a curated list of exports on [ExporterHub](https://exporterhub.io/).
### Prometheus support in Programming Languages and Frameworks
@@ -48,7 +48,6 @@ Etcd is the backing database for Kubernetes and for Rancher. The database may ev
This is typical in Rancher, as many operations create new `RoleBinding` objects in the upstream cluster as a side effect.
You can reduce the number of `RoleBindings` in the upstream cluster in the following ways:
* Limit the use of the [Restricted Admin](../../../how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md#restricted-admin) role. Apply other roles wherever possible.
* Only add users to clusters and projects when necessary.
* Remove clusters and projects when they are no longer needed.
* Only use custom roles if necessary.
@@ -73,7 +72,6 @@ Predicting how many `RoleBinding` objects a given configuration will create is c
* `Ua` is the average number of users with a membership on a cluster.
* `P` is the total number of projects.
* `Pa` is the average number of users with a membership on a project.
* The Restricted Admin role follows a different formula, as every user with this role results in at least `7C + 2P + 2` additional `RoleBinding` objects.
* The number of `RoleBindings` increases linearly with the number of clusters, projects, and users.
### Using New Apps Over Legacy Apps
@@ -14,7 +14,7 @@ The Rancher CLI (Command Line Interface) is a unified tool that you can use to i
The binary can be downloaded directly from the UI.
1. In the upper left corner, click **☰**.
1. At the bottom of the navigation sidebar menu, click **About**.
1. At the bottom of the navigation sidebar menu, click the Rancher version number.
1. Under the **CLI Downloads section**, there are links to download the binaries for Windows, Mac, and Linux. You can also check the [releases page for our CLI](https://github.com/rancher/cli/releases) for direct downloads of the binary.
## Requirements
@@ -6,6 +6,8 @@ title: RKE Cluster Configuration Reference
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration"/>
</head>
<EOLRKE1Warning />
When Rancher installs Kubernetes, it uses [RKE](../../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md) or [RKE2](https://docs.rke2.io/) as the Kubernetes distribution.
This section covers the configuration options that are available in Rancher for a new or existing RKE Kubernetes cluster.
@@ -12,7 +12,7 @@ See the official prometheus-operator GitHub repo for an example [ServiceMonitor]
## PodMonitor
See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/getting-started/#using-podmonitors) for an example PodMonitor and an example Prometheus resource that refers to a PodMonitor.
See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/developer/getting-started/#using-podmonitors) for an example PodMonitor and an example Prometheus resource that refers to a PodMonitor.
## PrometheusRule
@@ -20,7 +20,7 @@ A PrometheusRule contains the alerting and recording rules that you would usuall
For a more fine-grained approach, the `ruleSelector` field on a Prometheus resource can select which PrometheusRules should be loaded onto Prometheus, based on the labels attached to the PrometheusRules resources.
See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/alerting/) for an example PrometheusRule.
See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/developer/alerting/) for an example PrometheusRule.
## Alertmanager Config
@@ -24,7 +24,7 @@ This pseudo-CRD maps to a section of the Prometheus custom resource configuratio
When a ServiceMonitor is created, the Prometheus Operator updates the Prometheus scrape configuration to include the ServiceMonitor configuration. Then Prometheus begins scraping metrics from the endpoint defined in the ServiceMonitor.
Any Services in your cluster that match the labels located within the ServiceMonitor `selector` field will be monitored based on the `endpoints` specified on the ServiceMonitor. For more information on what fields can be specified, please look at the [spec](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/api.md#servicemonitor) provided by Prometheus Operator.
Any Services in your cluster that match the labels located within the ServiceMonitor `selector` field will be monitored based on the `endpoints` specified on the ServiceMonitor. For more information on what fields can be specified, please look at the [spec](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#servicemonitor) provided by Prometheus Operator.
For more information about how ServiceMonitors work, refer to the [Prometheus Operator documentation.](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/user-guides/running-exporters.md)
@@ -34,4 +34,4 @@ This pseudo-CRD maps to a section of the Prometheus custom resource configuratio
When a PodMonitor is created, the Prometheus Operator updates the Prometheus scrape configuration to include the PodMonitor configuration. Then Prometheus begins scraping metrics from the endpoint defined in the PodMonitor.
Any Pods in your cluster that match the labels located within the PodMonitor `selector` field will be monitored based on the `podMetricsEndpoints` specified on the PodMonitor. For more information on what fields can be specified, please look at the [spec](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/api.md#podmonitorspec) provided by Prometheus Operator.
Any Pods in your cluster that match the labels located within the PodMonitor `selector` field will be monitored based on the `podMetricsEndpoints` specified on the PodMonitor. For more information on what fields can be specified, please look at the [spec](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#podmonitor) provided by Prometheus Operator.
@@ -2,6 +2,8 @@
title: RKE Hardening Guides
---
<EOLRKE1Warning />
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide"/>
</head>
@@ -6,6 +6,8 @@ title: RKE Self-Assessment Guide - CIS Benchmark v1.23 - K8s v1.23
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-self-assessment-guide-with-cis-v1.23-k8s-v1.23"/>
</head>
<EOLRKE1Warning />
This document is a companion to the [RKE Hardening Guide](rke1-hardening-guide.md), which provides prescriptive guidance on how to harden RKE clusters that are running in production and managed by Rancher. This benchmark guide helps you evaluate the security of a hardened cluster against each control in the CIS Kubernetes Benchmark.
This guide corresponds to the following versions of Rancher, CIS Benchmarks, and Kubernetes:
@@ -1,10 +1,12 @@
---
title: RKE Self-Assessment Guide - CIS Benchmark v1.24 - K8s v1.24
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-self-assessment-guide-with-cis-v1.24-k8s-v1.24"/>
</head>
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-self-assessment-guide-with-cis-v1.24-k8s-v1.24"/>
</head>
<EOLRKE1Warning />
This document is a companion to the [RKE Hardening Guide](rke1-hardening-guide.md), which provides prescriptive guidance on how to harden RKE clusters that are running in production and managed by Rancher. This benchmark guide helps you evaluate the security of a hardened cluster against each control in the CIS Kubernetes Benchmark.
@@ -1,10 +1,12 @@
---
title: RKE Self-Assessment Guide - CIS Benchmark v1.7 - K8s v1.25/v1.26/v1.27
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-self-assessment-guide-with-cis-v1.7-k8s-v1.25-v1.26-v1.27"/>
</head>
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-self-assessment-guide-with-cis-v1.7-k8s-v1.25-v1.26-v1.27"/>
</head>
<EOLRKE1Warning />
This document is a companion to the [RKE Hardening Guide](rke1-hardening-guide.md), which provides prescriptive guidance on how to harden RKE clusters that are running in production and managed by Rancher. This benchmark guide helps you evaluate the security of a hardened cluster against each control in the CIS Kubernetes Benchmark.
@@ -10,6 +10,10 @@ Rancher is committed to informing the community of security issues in our produc
| ID | Description | Date | Resolution |
|----|-------------|------|------------|
| [CVE-2025-23390](https://github.com/rancher/fleet/security/advisories/GHSA-xgpc-q899-67p8) | This vulnerability only affects customers using [Continuous Delivery with Fleet](https://ranchermanager.docs.rancher.com/integrations-in-rancher/fleet) where Fleet does not validate a server's certificate when connecting through SSH. This can allow for a main-in-the-middle-attack against Fleet. The fix provides a new `insecureSkipHostKeyChecks` value for the `fleet` Helm chart. The default value is set to **`true` (opt-in) for Rancher v2.9 - v2.11** for backward compatibility. The default value is set to **`false` (opt-out) for Rancher v2.12 and later**, and Fleet v0.13 and later. <br/><br/> `true` (opt-in): <br/><br/><ul> If `insecureSkipHostKeyChecks` is set to `true`, then not finding any matching `known_hosts` entry for an SSH host will not lead to any error. Please note, regardless of the configuration setting, if the `known-hosts` ConfigMap is deleted it will lead to errors as it will be considered a symptom of an incomplete Fleet deployment. </ul> `false` (opt-out): <br/><br/><ul> If `insecureSkipHostKeyChecks` is set to `false`, then strict host key checks are enabled. When enabled, the checks ensure that when using SSH, Fleet rejects connection attempts to hosts not matching any entry found in (decreasing order of precedence): <br/><br/><ul> <li>A secret referenced by name in a `GitRepo` which is located in the same `GitRepo's` namespace.</li> <li> If no such secret name is provided, in a `gitcredential` secret located in the same namespace. </li> <li> A new `known-hosts` ConfigMap, created during the Fleet chart installation time and located in the namespace `cattle-fleet-system`. </li></ul> <br></br> This happens regardless of whether a `GitRepo` uses an SSH URL to point to a Git repository since, once cloned, a repository may be found to contain external resources to be retrieved, such as Helm artifacts. </ul> A limitation with the default `known_hosts` entries is that they are only provided for GitHub, Gitlab, Bitbucket and Azure DevOps hosts. If you need to connect to a different host, or if key fingerprints for the provided entries are updated, the following options are available: <br/><br/><ul><li> Manually update the default `known-hosts` ConfigMap. </li> <li> Reference a secret from your `GitRepo` resources, containing the updated or additional `known_hosts` entries. </li> <li> Create a `gitcredential` secret containing the entries for `GitRepo` resources that do not already reference a secret. </li></ul> | 24 Apr 2025 | Rancher [v2.11.1](https://github.com/rancher/rancher/releases/tag/v2.11.1), [v2.10.5](https://github.com/rancher/rancher/releases/tag/v2.10.5), and [v2.9.9](https://github.com/rancher/rancher/releases/tag/v2.9.9) |
| [CVE-2025-22031](https://github.com/rancher/rancher/security/advisories/GHSA-8h6m-wv39-239m) | A vulnerability was found where users could create a project and then gain access to arbitrary projects. As a fix, a new field has been added to projects called the `BackingNampespace`, which represents the namespace created for a project containing all resources needed for project operations. This includes resources such as ProjectRoleTemplateBindings, project-scoped secrets and workloads. <br/><br/> The field is populated automatically during project creation and is formatted as `<clusterID>-<project.Name>`. For example, if your project is named `project-abc123` in a cluster with ID `cluster-xyz789`, then the project will have the `BackingNampespace`: `cluster-xyz789-project-abc123`. <br/><br/> If the `BackingNampespace` field is empty then the project will fallback to using the namespace that is the project's name as it did before. Existing projects will not be migrated and only newly created projects will have the new namespace naming convention. If listing projects via `kubectl` the `BackingNampespace` will also be listed as a column. | 24 Apr 2025 | Rancher [v2.11.1](https://github.com/rancher/rancher/releases/tag/v2.11.1), [v2.10.5](https://github.com/rancher/rancher/releases/tag/v2.10.5), and [v2.9.9](https://github.com/rancher/rancher/releases/tag/v2.9.9) |
| [CVE-2025-32198](https://github.com/rancher/steve/security/advisories/GHSA-95fc-g4gj-mqmx) | A vulnerability was found where users with permission to create a service in the Kubernetes cluster where Rancher is deployed can take over the Rancher UI, display their own UI, and gather sensitive information. This is only possible when the setting `ui-offline-preferred` is set to `remote`. This release introduces a patch, and the malicious user can no longer serve their own UI. If users can't upgrade, please make sure that only trustable users have access to create a service in the local cluster. | 24 Apr 2025 | Rancher [v2.11.1](https://github.com/rancher/rancher/releases/tag/v2.11.1), [v2.10.5](https://github.com/rancher/rancher/releases/tag/v2.10.5), [v2.9.9](https://github.com/rancher/rancher/releases/tag/v2.9.9) and [v2.8.15](https://github.com/rancher/rancher/releases/tag/v2.8.15) |
| [CVE-2025-23391](https://github.com/rancher/rancher/security/advisories/GHSA-8p83-cpfg-fj3g) | A vulnerability has been identified within Rancher where a Restricted Administrator can change the password of Administrators and take over their accounts. A Restricted Administrator should not be allowed to change the password of more privileged users unless it contains the Manage Users permissions. A new validation has been added to block a user from editing or deleting another user with more permissions than themselves. Rancher deployments where the Restricted Administrator role is not being used are not affected by this CVE. | 31 Mar 2025 | Rancher [v2.11.0](https://github.com/rancher/rancher/releases/tag/v2.11.0), [v2.10.4](https://github.com/rancher/rancher/releases/tag/v2.10.4), [v2.9.8](https://github.com/rancher/rancher/releases/tag/v2.9.8) and [v2.8.14](https://github.com/rancher/rancher/releases/tag/v2.8.14) |
| [CVE-2025-23389](https://github.com/rancher/rancher/security/advisories/GHSA-5qmp-9x47-92q8) | A vulnerability in Rancher has been discovered, leading to a local user impersonation through SAML Authentication on first login. <br/><br/> The issue occurs when a SAML authentication provider (AP) is configured (e.g. Keycloak). A newly created AP user can impersonate any user on Rancher by manipulating cookie values during their initial login to Rancher. This vulnerability could also be exploited if a Rancher user (present on the AP) is removed, either manually or automatically via the [User Retention feature](../../how-to-guides/advanced-user-guides/enable-user-retention.md) with delete-inactive-user-after | 27 Feb 2025 | Rancher [v2.10.3](https://github.com/rancher/rancher/releases/tag/v2.10.3), [v2.9.7](https://github.com/rancher/rancher/releases/tag/v2.9.7) and [v2.8.13](https://github.com/rancher/rancher/releases/tag/v2.8.13) |
| [CVE-2025-23388](https://github.com/rancher/rancher/security/advisories/GHSA-xr9q-h9c7-xw8q) | An unauthenticated stack overflow crash, leading to a denial of service (DoS), was identified in Rancher’s `/v3-public/authproviders` public API endpoint. A malicious user could submit data to the API which would cause the Rancher server to crash, but no malicious or incorrect data would actually be written in the API. The downstream clusters, i.e., the clusters managed by Rancher, are not affected by this issue. <br/><br/> This vulnerability affects those using external authentication providers as well as Rancher’s local authentication. | 27 Feb 2025 | Rancher [v2.10.3](https://github.com/rancher/rancher/releases/tag/v2.10.3), [v2.9.7](https://github.com/rancher/rancher/releases/tag/v2.9.7) and [v2.8.13](https://github.com/rancher/rancher/releases/tag/v2.8.13) |
| [CVE-2025-23387](https://github.com/rancher/rancher/security/advisories/GHSA-mq23-vvg7-xfm4) | A vulnerability has been identified within Rancher where it is possible for an unauthenticated user to list all CLI authentication tokens and delete them before the CLI is able to get the token value. This effectively prevents users from logging in via the CLI when using rancher token as the execution command (instead of the token directly being in the kubeconfig). <br/><br/> Note that this token is not the kubeconfig token and if an attacker is able to intercept it they can't use it to impersonate a real user since it is encrypted. | 27 Feb 2025 | Rancher [v2.10.3](https://github.com/rancher/rancher/releases/tag/v2.10.3), [v2.9.7](https://github.com/rancher/rancher/releases/tag/v2.9.7) and [v2.8.13](https://github.com/rancher/rancher/releases/tag/v2.8.13) |
+3 -4
View File
@@ -20,10 +20,9 @@ Each Rancher version is designed to be compatible with a single version of the w
| Rancher Version | Webhook Version | Availability in Prime | Availability in Community |
|-----------------|-----------------|-----------------------|---------------------------|
| v2.10.3 | v0.6.4 | &check; | &check; |
| v2.10.2 | v0.6.3 | &check; | &check; |
| v2.10.1 | v0.6.2 | &check; | &check; |
| v2.10.0 | v0.6.1 | &cross; | &check; |
| v2.11.2 | v0.7.2 | &check; | &check; |
| v2.11.1 | v0.7.1 | &check; | &check; |
| v2.11.0 | v0.7.0 | &cross; | &check; |
## Why Do We Need It?
@@ -6,6 +6,8 @@ title: RKE1 Example YAML
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/reference-guides/rke1-template-example-yaml"/>
</head>
<EOLRKE1Warning />
Below is an example RKE template configuration file for reference.
The YAML in the RKE template uses the same customization that is used when you create an RKE cluster. However, since the YAML is within the context of a Rancher provisioned RKE cluster, the customization from the RKE docs needs to be nested under the `rancher_kubernetes_engine` directive.
@@ -100,7 +100,7 @@ If you want to check resolving of domain names on all of the hosts, execute the
- image: busybox:1.28
imagePullPolicy: Always
name: alpine
command: ["sh", "-c", "tail -f /dev/null"]
command: ["sleep", "infinity"]
terminationMessagePath: /dev/termination-log
```
@@ -49,7 +49,7 @@ The `swiss-army-knife` container does not support Windows nodes. It also [does n
- image: rancherlabs/swiss-army-knife
imagePullPolicy: Always
name: overlaytest
command: ["sh", "-c", "tail -f /dev/null"]
command: ["sleep", "infinity"]
terminationMessagePath: /dev/termination-log
```
+3 -3
View File
@@ -185,9 +185,9 @@ module.exports = {
label: 'Latest',
},
'2.11': {
label: 'v2.11 (Preview)',
label: 'v2.11',
path: 'v2.11',
banner: 'unreleased'
banner: 'none'
},
'2.10': {
label: 'v2.10',
@@ -202,7 +202,7 @@ module.exports = {
2.8: {
label: 'v2.8',
path: 'v2.8',
banner: 'none'
className: 'toArchive'
},
2.7: {
label: 'v2.7',
@@ -1,25 +0,0 @@
---
title: Rancher 弃用的功能
---
## Rancher 的弃用策略是什么?
我们在支持[服务条款](https://rancher.com/support-maintenance-terms)中发布了官方弃用策略。
## 在哪里可以找到 Rancher 已弃用的功能?
Rancher 会在 GitHub 上的[发行说明](https://github.com/rancher/rancher/releases)中公布已弃用的功能。请参阅以下补丁版本了解已弃用的功能:
| 补丁版本 | 发布日期 |
|---------------|---------------|
| [2.6.0](https://github.com/rancher/rancher/releases/tag/v2.6.0) | 2021 年 8 月 31 日 |
| [2.6.1](https://github.com/rancher/rancher/releases/tag/v2.6.1) | 2021 年 10 月 11 日 |
| [2.6.2](https://github.com/rancher/rancher/releases/tag/v2.6.2) | 2021 年 10 月 19 日 |
| [2.6.3](https://github.com/rancher/rancher/releases/tag/v2.6.3) | 2021 年 12 月 21 日 |
| [2.6.4](https://github.com/rancher/rancher/releases/tag/v2.6.4) | 2022 年 3 月 31 日 |
| [2.6.5](https://github.com/rancher/rancher/releases/tag/v2.6.5) | 2022 年 5 月 12 日 |
| [2.6.6](https://github.com/rancher/rancher/releases/tag/v2.6.6) | 2022 年 6 月 30 日 |
## 如果某个功能标记为弃用,我要怎么做?
如果某个发行版将某功能标记为"Deprecated"(已弃用),该功能仍然可用并受支持,从而允许用户按照常规流程进行升级。在升级到该功能被标记为"已删除"的发行版前,用户/管理员应该计划剥离该功能。对于新部署,我们建议不要使用已弃用的功能。
@@ -14,12 +14,11 @@ title: Rancher 中已弃用的功能
Rancher 将在 GitHub 上发布的 Rancher 的[发版说明](https://github.com/rancher/rancher/releases)中发布已弃用的功能。有关已弃用的功能,请参阅以下的补丁版本:
| Patch 版本 | 发布时间 |
| --------------------------------------------------------------- | ------------------ |
| [2.8.3](https://github.com/rancher/rancher/releases/tag/v2.8.3) | 2024 年 3 月 28 日 |
| [2.8.2](https://github.com/rancher/rancher/releases/tag/v2.8.2) | 2024 年 2 月 8 日 |
| [2.8.1](https://github.com/rancher/rancher/releases/tag/v2.8.1) | 2024 年 1 月 22 日 |
| [2.8.0](https://github.com/rancher/rancher/releases/tag/v2.8.0) | 2023 年 12 月 6 日 |
| Patch 版本 | 发布时间 |
| ----------------------------------------------------------------- | ------------------ |
| [2.11.2](https://github.com/rancher/rancher/releases/tag/v2.11.2) | 2025 年 5 月 22 日 |
| [2.11.1](https://github.com/rancher/rancher/releases/tag/v2.11.1) | 2025 年 4 月 24 日 |
| [2.11.0](https://github.com/rancher/rancher/releases/tag/v2.11.0) | 2025 年 3 月 31 日 |
## 当一个功能被标记为弃用我可以得到什么样的预期?
@@ -30,7 +30,7 @@ kubeconfig 也可以通过 `--kubeconfig` 标签(详情请参见 https://helm.
<DeprecationHelm2 />
如果你使用 Helm 2,请参见 [Helm 2 迁移到 Helm 3 文档](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/)。如果你不能升级到 Helm 3,[Helm 2 升级页面](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/helm2.md)提供了使用 Helm 2 升级的旧升级指南。
如果你使用 Helm 2,请参见 [Helm 2 迁移到 Helm 3 文档](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/)。如果你不能升级到 Helm 3,[Helm 2 升级页面](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/helm2.md) 提供了使用 Helm 2 升级的旧升级指南。
### 离线安装:推送镜像到私有镜像仓库
@@ -2,6 +2,8 @@
title: 在不升级 Rancher 的情况下升级 Kubernetes
---
<EOLRKE1Warning />
RKE 元数据功能允许你在新版本 Kubernetes 发布后立即为集群配置新版本,而无需升级 Rancher。此功能对于使用 Kubernetes 的补丁版本非常有用,例如,在原本支持 Kubernetes v1.14.6 的 Rancher Server 版本中,将 Kubernetes 升级到 v1.14.7。
:::note
@@ -83,7 +85,7 @@ Rancher Server 会定期刷新 `rke-metadata-config` 来下载新的 Kubernetes
要下载私有镜像仓库的系统镜像:
1. 点击左上角的 **☰**。
1. 点击左侧导航底部的**简介**。
1. 点击左侧导航底部的Rancher版本号。
1. 下载适用于 Linux 或 Windows 操作系统的镜像。
1. 下载 `rancher-images.txt`。
1. 使用[离线环境安装](other-installation-methods/air-gapped-helm-cli-install/publish-images.md)时使用的步骤准备私有镜像仓库,但不要使用发布页面中的 `rancher-images.txt`,而是使用上一个步骤中获取的文件。
@@ -23,15 +23,13 @@ title: Rancher Equinix Metal 快速入门
## 先决条件
- [Equinix Metal 账号](https://metal.equinix.com/developers/docs/accounts/users/)
- [Equinix Metal 项目](https://metal.equinix.com/developers/docs/accounts/projects/)
- [Equinix Metal 账号](https://deploy.equinix.com/developers/docs/metal/identity-access-management/users/)
- [Equinix Metal 项目](https://deploy.equinix.com/developers/docs/metal/projects/creating-a-project/)
### 1. 配置 Equinix Metal 主机
开始部署 Equinix Metal 主机。你可以使用 Equinix Metal 控制台、CLI 或 API 来配置 Equinix Metal Server。如果你需要了解每种 Deployment 类型的说明,请参见 [Equinix Metal 部署](https://metal.equinix.com/developers/docs/deploy/on-demand/)。以下链接介绍 Equinix Metal Server 的类型以及价格:
- [Equinix Metal Server 类型](https://metal.equinix.com/developers/docs/servers/about/)
- [Equinix Metal 价格](https://metal.equinix.com/developers/docs/servers/server-specs/)
开始部署 Equinix Metal 主机。你可以使用 Equinix Metal 控制台、CLI 或 API 来配置 Equinix Metal Server。如果你需要了解每种 Deployment 类型的说明,请参见 [Equinix Metal 部署](https://metal.equinix.com/developers/docs/deploy/on-demand/)。You can find additional information on Equinix Metal server types in the [Equinix Metal Documentation](https://deploy.equinix.com/developers/docs/metal/hardware/standard-servers/).
:::note 注意事项:
@@ -16,12 +16,13 @@ title: Vagrant 快速入门
- [Virtualbox](https://www.virtualbox.org):需要把 Vagrant 配置的虚拟机配置到 VirtualBox。
- 至少 4GB 的可用内存。
### 注意
- Vagrant 需要使用插件来创建 VirtualBox 虚拟机。请执行以下命令进行安装:
::: 注意
`vagrant plugin install vagrant-vboxmanage`
Vagrant 需要使用插件来创建 VirtualBox 虚拟机。请执行以下命令进行安装:
- `vagrant plugin install vagrant-vboxmanage`
- `vagrant plugin install vagrant-vbguest`
`vagrant plugin install vagrant-vbguest`
:::
## 开始使用
@@ -27,6 +27,14 @@ title: 添加项目成员
1. 在**成员**选项卡中,单击**添加**。
1. 搜索要添加到项目的用户或组。
:::note Notes:
- At least 2 characters must be typed in the search box for results to appear.
- Users can be searched based on their username or display name.
- Search is prefix-based (e.g., a user named `Stan Dard` will appear when searching for `Sta`, but not when searching for `Dar`) and case-sensitive.
:::
如果配置了外部身份验证:
- 在你键入时,Rancher 会从你的外部身份验证源返回用户。
@@ -6,6 +6,9 @@ title: RKE 模板
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/zh/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates"/>
</head>
<EOLRKE1Warning />
RKE 模板旨在让 DevOps 和安全团队标准化和简化 Kubernetes 集群创建的流程。
RKE 的全称是 [Rancher Kubernetes Engine](https://rancher.com/docs/rke/latest/en/),它是 Rancher 用来配置 Kubernetes 集群的工具。
@@ -2,6 +2,8 @@
title: 创建和修改 RKE 模板
---
<EOLRKE1Warning />
本节介绍如何管理 RKE 模板和修订版。你可以从 **RKE1 配置 > RKE 模板**下的**集群管理**视图创建、共享、更新和删除模板。
模板更新通过修订系统处理。当模板所有者想要更改或更新模板时,他们会创建模板的新版本。单个修订无法编辑。但是,如果你想防止使用修订来创建新集群,你可以禁用它。
@@ -42,14 +42,15 @@ Rancher 认证代理可以与以下外部认证服务集成。
## 用户和组
Rancher 依赖用户和组来决定允许谁登录 Rancher 以及他们可以访问哪些资源。当使用外部认证时,外部认证系统会根据用户提供组的信息。这些用户和组被赋予了集群、项目及全局 DNS 提供商和条目等资源的特定角色。当你对组进行授权时,在认证服务中所有属于这个组中的用户都有访问指定的资源的权限。有关角色和权限的更多信息,请查看 [RBAC](../manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md)。
:::note
本地认证不支持创建或管理组
- Local authentication does not support creating or managing groups.
- After an external authentication provider is configured, note that local Rancher scoped administrative users only display resources such as users and groups that they are a member of in the respective authentication provider.
:::
Rancher 依赖用户和组来决定允许谁登录 Rancher 以及他们可以访问哪些资源。当使用外部认证时,外部认证系统会根据用户提供组的信息。这些用户和组被赋予了集群、项目及全局 DNS 提供商和条目等资源的特定角色。当你对组进行授权时,在认证服务中所有属于这个组中的用户都有访问指定的资源的权限。有关角色和权限的更多信息,请查看 [RBAC](../manage-role-based-access-control-rbac/manage-role-based-access-control-rbac.md)。
更多信息,请查看[用户和组](manage-users-and-groups.md)
## Rancher 授权范围
@@ -4,6 +4,10 @@ title: Pod 安全准入 (PSA) 配置模板
[Pod Security admission (PSA)](./pod-security-standards.md) 配置模板是 Rancher 自定义资源 (CRD),在 Rancher v2.7.2 及更高版本中可用。这些模板提供了可应用于集群的预定义安全配置:
:::info important
The policies shipped by default in Rancher aim to provide a trade-off between security and convenience. If a more strict policy configuration is needed, users are able to craft such policies themselves based on their specific requirements. In the case Rancher policies are preferred, you will need to deploy admission controllers that block the creation of any [exempted namespaces](#豁免必须的-rancher-命名空间) that won't be used within your environments.
:::
- `rancher-privileged`:最宽松的配置。它不限制任何 Pod 行为,允许已知的权限升级。该策略没有豁免。
- `rancher-restricted`:严格限制的配置,遵循当前加固 pod 的最佳实践。你必须对 Rancher 组件进行[命名空间级别豁免](./pod-security-standards.md#受-psa-限制的集群上的-rancher)。
@@ -48,10 +48,10 @@ Rancher 可以安装到任意 Kubernetes 集群上,包括托管的 Kubernetes
以上假设你的环境具有到 Docker Hub 的出站连接。
对于**离线环境**,在安装 rancher-backup Helm Chart 时,使用下面的 Helm 值从你的私有镜像仓库中拉取 `backup-restore-operator` 镜像。
对于**离线环境**,在安装 rancher-backup Helm Chart 时,使用下面的 Helm 值从你的私有镜像仓库中拉取 `backup-restore-operator` 和 `kubectl` 镜像。
```bash
--set image.repository $REGISTRY/rancher/backup-restore-operator
--set image.repository <registry>/rancher/backup-restore-operator --set global.kubectl.repository=<registry>/rancher/kubectl
```
:::

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