Compare commits

...
Author SHA1 Message Date
Sunil Singh 7b3067229e Merge pull request #1204 from mbelur/csp-adapter-3.0.1
Update csp-adapter version table
2024-03-29 09:57:15 -07:00
Meera Belur 7ec567a5a6 Update csp-adapter version table 2024-03-29 08:45:27 -07:00
Sunil Singh 34beb5f7f5 Merge pull request #1181 from sunilarjun/2.7.12-webhook-version
Adding Webhook Mapping for Release 2.7.12
2024-03-29 08:19:22 -07:00
Sunil Singh 79bef2c1ff Merge pull request #1200 from sunilarjun/2.7.12-versions-table
Updating Versions Table for 2.7.12
2024-03-29 08:19:09 -07:00
Jacie 785db2b776 Update missing Chinese translation about troubleshooting and RK API for latest and v2.8 (#1203)
* Update missing chinese translation about troubleshooting and RK API for latest

* Update missing chinese translation about troubleshooting and RK API for v2.8
2024-03-29 10:47:57 -04:00
Sunil Singh 5d05eb6118 Merge branch 'rancher:main' into 2.7.12-versions-table 2024-03-28 16:59:00 -07:00
Sunil Singh 5330e6e002 Merge pull request #1202 from sunilarjun/2.8.3-webhook-version
Update 2.8.3 Webhook Table - Community
2024-03-28 16:58:46 -07:00
Sunil Singh fd56e5239a Merge pull request #1201 from sunilarjun/2.8.3-versions-table
Update 2.8.3 Versions Table - Community Only
2024-03-28 16:51:23 -07:00
Sunil Singh ba04468ce6 Updating the webhook table for 2.8.3 to be community only.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-28 16:36:12 -07:00
Sunil Singh d711795c24 Syncing with 2.8.3 versions table.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-28 16:31:20 -07:00
Sunil Singh 561428df96 Updating the 2.8.3 versions table to show as community only.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-28 16:26:39 -07:00
Billy Tat 89d3efd25f Merge pull request #1199 from JacieChao/docs
Update missing Chinese translation about authentication and linked parts for latest and v2.8
2024-03-28 16:01:18 -07:00
Sunil Singh cda28da001 Updating the versions table for the upcoming 2.7.12 release.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-28 15:59:56 -07:00
Sunil Singh 3fb94fe646 Merge pull request #1178 from sunilarjun/2.8.3-versions-table
Update Docs Versions Table for v2.8.3
2024-03-28 15:56:02 -07:00
Sunil Singh 8ab7324802 Removing the 2.7.12 changes and will create additional PR with those changes.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-28 15:34:59 -07:00
Sunil Singh 48f4b33402 Merge pull request #1180 from sunilarjun/2.8.3-webhook-version
Adding Webhook Mapping for Release 2.8.3
2024-03-28 12:50:41 -07:00
Sunil Singh cd940d28c5 Merge pull request #1191 from rancher/leader-election-lease
Update trobleshooting tips regarding leader election
2024-03-28 12:50:11 -07:00
Sunil Singh 29c8fe37f9 Merge pull request #1179 from sunilarjun/2.8.3-cni-table
Update CNI Table - 2.8.3
2024-03-28 12:49:23 -07:00
Billy Tat c1d73dd091 Merge pull request #1198 from btat/archived-repo
Remove reference to archived repo
2024-03-28 09:22:59 -07:00
Billy TatandMarty Hernandez Avedon 6c4eb63232 Apply suggestions from code review
Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>
2024-03-28 08:58:47 -07:00
Jacie a0a74b9c31 Update missing translation about authentication and linked parts for version 2.8 2024-03-28 14:24:36 +08:00
Jacie fb77180158 Update missing translation about authentication and linked parts for latest 2024-03-28 14:06:23 +08:00
Billy Tat e81da89b4e Remove reference to archived repo 2024-03-27 16:59:56 -07:00
Sunil Singh 5e5385910c Updating docs version.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-26 15:08:33 -07:00
Billy Tat 3c043cac1e Merge pull request #1194 from btat/docker-warning
Warn users that Rancher in Docker isn't supported part 2
2024-03-26 14:42:57 -07:00
Sunil Singh e85792acfc Updating to correct webhook version (location mentioned in parent issue).
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-26 14:32:21 -07:00
Sunil Singh 3c2aaba993 Updating the 2.7.12 table as it is a prime only release.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-26 11:12:55 -07:00
0a7c7e7230 #1172 refresh helm charts in rancher page (#1173)
* 1172-refresh-helm-charts-in-rancher-page

* wording revised, steps compressed

* smoothing instructions, syncing language in similar steps

* updated heading levels

* versioning

* versioned headings

* Apply suggestions from code review

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

* rm'd br tag, revised descr of project/namespace filter, made all nouns plural to match verb

* Apply suggestions from code review

missed one

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

* Helm apps > Kubernetes apps

* h3 heading and moved feature charts section

* absolute link to older docs, spacing

* heading levels

* reorganizing/renaming helm charts in rancher section

* rename some headings

* changing path to apps/repositories to instead go through explore button

* once > after

* engineers say the default branch is set by the remote repo. Rancher will respect whatever that default is unless you specifically tell it to pull from another branch

* straggler

* fix in-page links after heading changed

* wrong verb!

* hyphen

* moved section up as to not interrupt flow

* moved info about upstream charts

* moved line 64 to part of line 31

* Apply suggestions from code review

Co-authored-by: Billy Tat <btat@suse.com>

* Update versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md

Co-authored-by: Billy Tat <btat@suse.com>

* Update versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md

Co-authored-by: Billy Tat <btat@suse.com>

* Update versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md

Co-authored-by: Billy Tat <btat@suse.com>

* Update versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md

Co-authored-by: Billy Tat <btat@suse.com>

* Update docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md

Co-authored-by: Billy Tat <btat@suse.com>

* Update docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md

Co-authored-by: Billy Tat <btat@suse.com>

* Apply suggestions from code review

Co-authored-by: Billy Tat <btat@suse.com>

---------

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>
Co-authored-by: Billy Tat <btat@suse.com>
2024-03-26 10:12:29 -04:00
Billy Tat b9c5733544 Add emphasis to warning 2024-03-25 16:53:35 -07:00
Billy Tat 87c743543a Headers should start at h2 2024-03-25 16:53:35 -07:00
Billy Tat 03db01f162 Apply Docker support warning to other files 2024-03-25 16:53:33 -07:00
Billy Tat 444bb237fe Refactor: convert Docker support warning to single file 2024-03-25 16:41:21 -07:00
Marty Hernandez AvedonandBilly Tat c256118aa9 API token docs are outdated (#1184)
* API token docs are outdated, out of sync

synced 2.8 and latest

* updates and syncing with v2.7

* more syncing, more revisions, v2.6 versioning

* more syncing

* sync v2.8 w latest

* Duration according to https://github.com/rancher/rancher/pull/42269

* Apply suggestions from code review

Co-authored-by: Billy Tat <btat@suse.com>

* syncing how we describe the value

* capitalization of ttl

---------

Co-authored-by: Billy Tat <btat@suse.com>
2024-03-25 18:05:17 -04:00
Marty Hernandez Avedon cb9ac7370c Fix broken canonical links for PAYG (#1192)
* fix broken canonical links for PAYG

* rm canonical links until we have alt versions
2024-03-25 14:21:33 -04:00
Alejandro Ruiz 680e7d4d20 Apply changes to versioned docs for 2.8 2024-03-22 17:49:42 +01:00
Alejandro Ruiz 84ac216b9c Update trobleshooting tips regarding leader election
Starting on Rancher 2.8.3 and 2.9.X, only `Lease` objects will be used as a lock for leader election. Previously, a multi-lock `ConfigMap` + `Lease` was used, so these docs changes are backward compatible.
2024-03-22 17:06:28 +01:00
Chirayu Kapoor ab8df7f920 Add additional linked libraries to be mounted as a volume to run systemd-run (#1186)
Signed-off-by: Chirayu Kapoor <chirayu.kapoor@suse.com>
2024-03-21 11:52:48 -04:00
Marty Hernandez Avedon bc33662b1f #1155 Amazon in-tree to out-of-tree migration guide contradicts UI behavior (#1162)
* 1155 Amazon in-tree to out-of-tree migration guide contradicts UI behavior

* typo fix

* re-adding info that got lost

* missed one
2024-03-21 11:36:28 -04:00
Jake Hyde 51beaa2aeb Update node selector to control-plane for RKE2 clusters (#1188) 2024-03-20 15:38:34 -04:00
Lucas Saintarbor d6a5c9cb78 Merge pull request #1165 from LucasSaintarbor/update-install-cert-manager-instructions
Update command for installing cert-manager helm chart
2024-03-19 11:28:38 -07:00
Sunil Singh e936aacd19 Updating the Rancher webhook table for release 2.7.12.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-15 14:49:40 -07:00
Sunil Singh 0d6df81676 Updating the Rancher Webhook table for release 2.8.3.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-15 13:41:57 -07:00
Sunil Singh ea8bdfc2a9 Updating the CNI Community Popularity table with updated statistics for 2.8.3.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-15 12:49:38 -07:00
Sunil Singh 7fea577f97 Adding updated versions list for2.8.3 and 2.7.12 Rancher releases. Additionally updated the headers to title case.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-15 12:14:39 -07:00
Lucas Saintarbor 558e533dd1 Merge pull request #1149 from LucasSaintarbor/unified-payg-faq
Add unified PAYG FAQ
2024-03-14 18:14:30 -07:00
Marty Hernandez AvedonandSunil Singh 31cdce4a59 #1163 Title change 'Helm Charts in Rancher' and add 'Catalogs' heading for SEO (#1170)
* 1163 Title change 'Helm Charts in Rancher' and add 'Catalogs' heading for SEO

* versioning + formatting

* casing, periods

* formatting force

* Apply suggestions from code review

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

* moved and renamed section about catalogs

* .

---------

Co-authored-by: Sunil Singh <sunil.singh@suse.com>
2024-03-14 14:10:19 -04:00
LucasSaintarbor c30bd272c7 Move FAQ reference to top of page for visibility 2024-03-14 10:25:07 -07:00
Lucas SaintarborandMarty Hernandez Avedon 8979f221b8 Fixes headers and removes repetitive content
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-03-14 10:19:47 -07:00
LucasSaintarbor b8cbfaa2c3 Add tabs for How to Use section 2024-03-12 10:40:52 -07:00
Lucas SaintarborandMarty Hernandez Avedon d6ef2f108f Apply suggestions from code review
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-03-12 10:23:42 -07:00
8fc6c72999 Apply suggestions from code review
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
Co-authored-by: Billy Tat <btat@suse.com>
2024-03-12 10:22:31 -07:00
Billy Tat 4db4014a20 Merge pull request #1145 from btat/broken-abs-links
Fix broken links
2024-03-11 14:27:29 -07:00
Marty Hernandez Avedon ef19e6525d #1153 update rancher kubernetes api project creation workflow doc to include annotation requirement for cluster member (#1167)
* Update Rancher Kubernetes API Project creation workflow doc to include annotation requirement for Cluster Member

* revised note

* revised wording
2024-03-11 10:15:29 -04:00
Lucas SaintarborandMarty Hernandez Avedon 37df45110e Apply suggestions from code review
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-03-08 14:33:39 -08:00
Marty Hernandez AvedonandLucas Saintarbor 1f6a00bef3 Added redirects for AWS PAYG integration (#1168)
* added redirects for aws payg

* azure and aws redirects added

* typos, rm'ing unnneeded redirects

* Update docusaurus.config.js

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

* Update docusaurus.config.js

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

* Update docusaurus.config.js

---------

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>
2024-03-08 15:47:36 -05:00
Trent VandMarty Hernandez Avedon f37b7655f9 Warn users that Rancher in Docker isn't supported (#1166)
* Warn users that Rancher in Docker isn't supported

Added a large Caution banner to the main Rancher in Docker page warning users that using the Rancher in docker method is not supported for production installs.

* revised language to rancher in docker caution message

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

* updated caution message for all versions of rancher

Signed-off-by: Trenton VanderWert <trenton.vanderwert@gmail.com>

---------

Signed-off-by: Trenton VanderWert <trenton.vanderwert@gmail.com>
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-03-08 13:48:48 -05:00
LucasSaintarbor 8dd35d3e02 Remove added redirects (preventing build) 2024-03-08 10:29:23 -08:00
LucasSaintarbor 41bc844cd3 Add refirect for aws/azure pages-for-subheader removal 2024-03-08 10:12:05 -08:00
LucasSaintarbor d6e4702ca7 Add reference to FAQ in AWS/Azure overview page 2024-03-08 10:01:20 -08:00
LucasSaintarbor 0316eb7e82 Remove individual AWS/Azure FAQ content 2024-03-08 09:54:03 -08:00
LucasSaintarbor ef8ac6c151 Small changes to unified FAQ 2024-03-08 09:50:40 -08:00
LucasSaintarbor 28c4c6951c Fix remaining broken links + change file name for Cloud Marketplace Pay-as-you-go (PAYG) Integration 2024-03-08 09:33:10 -08:00
LucasSaintarbor 119888948e Update command for installing cert-manager helm chart 2024-03-07 16:39:45 -08:00
LucasSaintarbor a784ebb49f Fix broken links in FAQ 2024-03-07 15:24:45 -08:00
Sunil Singh dfcb3b7fde Merge pull request #1159 from sunilarjun/update-repositories-page
Updating the Helm Charts in Rancher Page
2024-03-07 12:25:22 -08:00
Sunil Singh e18bb7cc04 Adding in rephrasing after review/citing sources.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-07 11:10:55 -08:00
Michal JuraandMarty Hernandez Avedon 0e76fd2d59 Update eks cluster configuration (#1048)
* Update eks cluster configuration

Issue: https://github.com/rancher/eks-operator/issues/301

Update eks cluster configuration with section about:
- Launching self-managed Amazon Linux nodes
- IAM roles for service accounts

* Apply suggestions from code review

* Apply suggestions from code review

* fixed bad link

* versioning

---------

Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-03-07 11:56:04 -05:00
Marty Hernandez Avedon 5664965fa1 #1128 Highlight expected behavior around permissions (#1130)
* 1128 Highlight expected behavior around permissions

* including test accounts

* versioning

* capitalization
2024-03-07 11:18:37 -05:00
Marty Hernandez Avedon 224bc8168b #743 Role template management title updated (#1160)
* 743 Role Templates management title updated

In v2.7.7, the title of the Roles page under Users & Authentication, was updated to instead read Role Templates

* updated for v2.7 pages

* syncing v2.7 verbage

* more syncing across versions
2024-03-07 10:28:26 -05:00
Marty Hernandez AvedonandKevin A 8e216e1700 Versioning for Kevinayres/patch 3 (#1161)
* Update aws-marketplace.md

Removed reference to outdated Youtube video.  New video will be referenced from Enceladus

* versioning

---------

Co-authored-by: Kevin A <9853029+kevinayres@users.noreply.github.com>
2024-03-06 15:50:38 -05:00
Kevin A 6b0b653e7c Update aws-marketplace.md (#1156)
Removed reference to outdated Youtube video.  New video will be referenced from Enceladus
2024-03-06 15:48:28 -05:00
Sunil Singh 189d93d656 Updating the Helm Charts in Rancher page to include information about creating chart repositories through Git/Helm.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-05 16:42:29 -08:00
LucasSaintarbor 6406d2aea5 Update sidebar for uified PAYG FAQ 2024-03-05 15:31:07 -08:00
Sunil Singh bbbb18eede Merge pull request #1154 from sunilarjun/update-v2.7.11-support-matrix
Updating Support Matrix Link - v2.7.11
2024-03-04 16:24:07 -08:00
Sunil Singh 0565314013 Updating the link now that the support matrix is published.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-04 15:26:13 -08:00
Sunil Singh 485b3c0c5d Merge pull request #1142 from btat/deprecation-weave
Add Weave deprecation notice
2024-03-04 09:53:08 -08:00
Sunil Singh 3ccf3ddd13 Merge branch 'main' into deprecation-weave 2024-03-04 09:29:11 -08:00
Sunil Singh 18b43d1c9c Merge pull request #1152 from rancher/release/v2.7.11
Sync Docs Items - v2.7.11
2024-03-04 09:26:08 -08:00
Sunil Singh dec4286a3b Merge branch 'main' into release/v2.7.11 2024-03-04 09:02:12 -08:00
Sunil Singh 7db7b7e49e Merge pull request #1133 from mbelur/csp-adapter-2.0.4
Update csp-adapter version
2024-03-04 07:57:41 -08:00
Sunil Singh 7383ce704b Merge pull request #1080 from martyav/backport-763-document-aws-out-of-tree-v2prov
[Backport for v2.7] 763 document aws out of tree v2prov
2024-03-04 07:55:21 -08:00
Sunil Singh 0563bcabc1 Merge pull request #1120 from sunilarjun/2.7.11-versions-table
Add release 2.7.11 to version table
2024-03-01 15:34:13 -08:00
Sunil Singh 87f7929549 Merge pull request #1123 from sunilarjun/2.7.11-webhook-version
Adding webhook mapping for release 2.7.11
2024-03-01 15:33:27 -08:00
Sunil Singh 1bd945da7d Adding in webhook entry after fixing merge conflict.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-01 14:05:44 -08:00
Sunil Singh a670421db3 Adding information for v2.7.11 versions table.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-01 14:00:12 -08:00
Sunil Singh 0888094685 Merge branch 'rancher:main' into 2.7.11-webhook-version 2024-03-01 13:19:04 -08:00
Sunil Singh 34bd9c5aa8 Revert "Updating the Rancher Webhook table for release 2.7.11."
This reverts commit 00ac7e524b.
2024-03-01 13:18:32 -08:00
Sunil Singh 1ad8d182bc Merge branch 'rancher:main' into 2.7.11-versions-table 2024-03-01 13:08:57 -08:00
Sunil Singh 4d002aa117 Revert "Updating with v2.7.11 information after fixing merge conflict."
This reverts commit 5f19499158.
2024-03-01 13:08:12 -08:00
Sunil Singh 5f19499158 Updating with v2.7.11 information after fixing merge conflict.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-01 13:01:05 -08:00
Sunil Singh b9e7863ef8 Fixing merge conflict.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-01 12:58:00 -08:00
Sunil Singh 73f1cda91a Fixing merge conflict.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-01 12:56:55 -08:00
Sunil Singh 004001a047 Fixing versions page conflict.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-01 12:55:21 -08:00
Sunil Singh b0b6b185b9 Merge pull request #1138 from sunilarjun/2.7.11-cni-table
Update CNI Table - 2.7.11
2024-03-01 12:03:34 -08:00
Josh Meranda b78a5cb897 Merge pull request #1148 from joshmeranda/view-monitoring
Clarify monitoring read only role limitations
2024-02-29 15:20:56 -05:00
Marty Hernandez Avedon d8180384be Apply suggestions from code review 2024-02-29 13:45:48 -05:00
Marty Hernandez Avedon de7cab1891 Update README.md (#1150) 2024-02-28 15:56:27 -05:00
joshmeranda 48bb9052b4 add visibility to monitoring-ui-view 2024-02-28 13:46:08 -05:00
LucasSaintarbor c8c3484196 Add unified FAQ page / update sidebar 2024-02-28 10:34:34 -08:00
joshmeranda f9bb639344 clarify monitoring read only role limitations 2024-02-27 19:57:44 -05:00
Billy Tat 9ad451f11f Merge pull request #1144 from btat/helm2-deprecation
Add Helm 2 deprecation note
2024-02-27 09:25:25 -08:00
Billy Tat 43fc8c84bd Fix broken links 2024-02-26 17:19:44 -08:00
Billy Tat a7ce4ff08f Add Helm 2 deprecation note 2024-02-26 16:41:31 -08:00
Billy Tat e332ff4ffa Merge pull request #1126 from btat/webhook-prime-community
Webhook table - indicate Prime/Community availability
2024-02-26 16:35:50 -08:00
Billy Tat 0ab94d8800 Merge pull request #1141 from btat/deprecation-opagatekeeper
Add OPA Gatekeeper deprecation notice
2024-02-23 15:17:41 -08:00
Billy Tat 53357bc7f0 Explicitly indicate when unavaiable. More descriptive headers 2024-02-23 14:51:05 -08:00
Sunil Singh 9a0df1f1ba Merge pull request #1143 from sunilarjun/bump-heap-size
Increase Heap Size
2024-02-23 14:41:59 -08:00
Sunil Singh f2a8dfaa0a Increasing the heap size as recent build failed due to heap allocation error.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-02-23 14:15:15 -08:00
Billy Tat ff63f11116 Add Weave deprecation notice 2024-02-23 14:12:58 -08:00
Billy Tat 1e76595c2f Add OPA Gatekeeper deprecation notice 2024-02-23 14:02:27 -08:00
Max Sokolovsky b187a46a75 Merge pull request #1140 from maxsokolovsky/project-deletion-does-not-trigger-namespaces-deletion
Add a note about project deletion in Public API
2024-02-23 15:37:31 -05:00
Max SokolovskyandMarty Hernandez Avedon b29b762dd6 Add a note about project deletion in Public API
Update docs/api/workflows/projects.md

Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>
2024-02-23 11:50:47 -05:00
Sunil Singh ba0fefb289 Updating CNI table with current stats as part of maintenance check list for 2.7.11.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-02-22 10:39:31 -08:00
Billy Tat fa11eeda9f Merge pull request #1135 from btat/global-import-cni-pop
Globally import CNI popularity
2024-02-21 12:53:44 -08:00
Marty Hernandez Avedon afa972e2b2 Syncing versions for #1014 (#1136)
Accidentally merged after confirmation w/o realizing that the PR needed to be versioned
2024-02-21 15:42:51 -05:00
Billy Tat 5a9d423cb6 Globally import CNI popularity 2024-02-21 10:56:33 -08:00
Marty Hernandez Avedon d56729e94a #995 Correct configure teams receiver commands (#1014)
* 995 - Correct receivers.md

* every heading uses the same verb form

* rm'd sentence fragment
2024-02-21 13:24:54 -05:00
Meera Belur 17af76d76f Updated csp-adapter version table (#1134) 2024-02-21 12:04:19 -05:00
Billy Tat d7dae21ca7 Merge pull request #1127 from btat/versions-prime-community
Versions table - indicate Prime/Community availability
2024-02-20 13:27:40 -08:00
Marty Hernandez AvedonandBilly Tat da7e68b044 Apply suggestions from code review
Co-authored-by: Billy Tat <btat@suse.com>
2024-02-20 15:28:56 -05:00
Meera Belur 82ed34bc7b Update csp-adapter version 2024-02-20 12:22:54 -08:00
Yilin Zeng d9ba7f2e95 chore: update copyright message to 2024 (#1132) 2024-02-20 14:17:51 -05:00
Billy Tat 2a02adeb72 Add purpose of Prime/Community columns in section intros. Also link to Prime page 2024-02-16 15:41:53 -08:00
Paulo Gomes 513cc5c340 Merge pull request #1129 from rancher/update
Update CVE page
2024-02-16 16:01:16 +00:00
Paulo Gomes 755080de3d Update CVE page 2024-02-16 15:58:27 +00:00
Billy Tat a4bb88e67d Indicate Prime/Community availability 2024-02-15 09:24:55 -08:00
Billy Tat c3aff0b8e4 Indicate Prime/Community availability 2024-02-14 16:31:55 -08:00
3a6b7e866a Add documentation for customizing the webhook (#1099)
* Add documentation for customizing the webhook.

* Apply suggestions from code review

Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>
Co-authored-by: Jonathan Crowther <jonathan.crowther@suse.com>

* Address comments

* Fix spacing issues

* versioning -- 2.8 and 2.7

issue specifices 2.7.7

---------

Co-authored-by: Kevin Joiner <10265309+KevinJoiner@users.noreply.github.com>
Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>
Co-authored-by: martyav <marty.avedon@suse.com>
2024-02-13 16:08:25 -05:00
Lucas Saintarbor 44ac9a470a Merge pull request #1058 from LucasSaintarbor/cli-commands
Update CLI commands for v2.6 - v2.8
2024-02-13 11:09:33 -08:00
Marty Hernandez AvedonandBilly Tat cab46bd291 #1108 Migrating Rancher to a new cluster lists old chart version (#1111)
* 1108 Migrating Rancher to a new cluster lists old chart version

* correction for 2.6.x based on https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/rancher-v2-6-13/

* updated with support matrix link, rm'd specific numbers

* syncing

* Apply suggestions from code review

Co-authored-by: Billy Tat <btat@suse.com>

* Apply suggestions from code review

Co-authored-by: Billy Tat <btat@suse.com>

---------

Co-authored-by: Billy Tat <btat@suse.com>
2024-02-13 14:05:07 -05:00
Lucas Saintarbor befa29d935 Merge branch 'main' into cli-commands 2024-02-13 10:43:48 -08:00
Billy Tat 5fd5c7f9db Merge pull request #1124 from joshmeranda/monitoring-exporter-port
update monitoring node-exporter ports
2024-02-13 09:53:17 -08:00
Billy Tat 8e81ecac58 Merge pull request #1121 from btat/mdx-canonical-links
Add canonical links to mdx files
2024-02-13 09:46:16 -08:00
Billy Tat 74f23ff609 Merge pull request #1122 from btat/sync-pr898-restricted-admin
Sync latest with changes from PR#989 - 'Updates to the Global roles f…
2024-02-13 09:45:59 -08:00
joshmeranda 829ec114c4 update monitoring node-exporter ports 2024-02-13 10:24:13 -05:00
Billy Tat b9f1ae86c9 Fix link 2024-02-12 15:42:07 -08:00
Sunil Singh 00ac7e524b Updating the Rancher Webhook table for release 2.7.11.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-02-12 15:40:06 -08:00
Billy Tat 64e634ff9a Sync latest with changes from PR#989 - 'Updates to the Global roles for new 2.8 features' 2024-02-12 15:29:43 -08:00
Billy Tat d9cab2613f Add canonical links to mdx files 2024-02-12 14:48:58 -08:00
martyav 813ceaa835 sync with https://github.com/rancher/rancher-docs/pull/1112 2024-02-12 16:13:12 -05:00
Sunil Singh eb27c457de Merge branch 'rancher:main' into 2.7.11-versions-table 2024-02-12 11:23:38 -08:00
Billy Tat 3d10005273 Merge pull request #1116 from btat/matrix-links
Add support matrix links for 2.6.14, 2.7.10, 2.8.2
2024-02-12 11:20:12 -08:00
Billy Tat 6fdd90be51 Merge pull request #1117 from btat/codeowners
Add CODEOWNERS file
2024-02-12 11:20:00 -08:00
8fcf90f7ac Apply suggestions from code review
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
Co-authored-by: Billy Tat <btat@suse.com>
2024-02-12 10:57:10 -08:00
Sunil Singh 0cd21101cd Updating the version entry for 2.7.11.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-02-12 10:03:12 -08:00
Carlos Salas 81637f366a docs: edit custom launch template updates for eks (#1118)
Signed-off-by: Carlos Salas <carlos.salas@suse.com>
2024-02-12 12:06:39 -05:00
Marty Hernandez Avedon 2e142301f6 991 Update AWS info about setting up cloud provider (#1112) 2024-02-12 11:09:54 -05:00
Billy Tat 212fa6c3de Add CODEOWNERS file 2024-02-09 15:49:36 -08:00
Billy Tat 3eb0e37387 Add support matrix links 2024-02-09 15:33:38 -08:00
Billy Tat c5a198f142 Merge pull request #1115 from andypitcher/sec-release-h1-q1-24
Add Rancher Security Release (Feb-2024) CVEs to latest/2.8/2.7/2.6
2024-02-09 11:28:27 -08:00
Andy Pitcher 77a86a5acc Add Rancher Security Release (Feb-2024) CVEs to latest/2.8/2.7/2.6
- CVE-2023-32193
	- CVE-2023-32192
        - CVE-2023-22649
        - CVE-2023-32194
2024-02-09 12:45:37 -05:00
Sunil Singh 22ed868912 Merge pull request #1103 from sunilarjun/2.8.2-update-cni
Updates CNI Table - 2.8.2 Release
2024-02-08 10:06:18 -08:00
Sunil Singh 0bce62456f Merge pull request #1101 from sunilarjun/2.7.10-webhook-version
Adding webhook mapping for release 2.7.10
2024-02-08 10:05:55 -08:00
Sunil Singh 4a9e9d0d0c Merge pull request #1102 from sunilarjun/2.8.2-webhook-version
Adding entries for the 2.8.2 webhook mapping
2024-02-08 10:02:56 -08:00
Sunil Singh ddabfef05e Merge pull request #1100 from sunilarjun/2.8.2-versions-table
Add release entries to versions table
2024-02-08 10:02:29 -08:00
Billy Tat adf6d83398 Merge pull request #1109 from btat/unused-files
Global tab import - remove unused files
2024-02-08 09:52:31 -08:00
Sunil Singh 9012432eb8 Merge pull request #1106 from sunilarjun/rancher-backup-operator-note
Update Body Text/Heading - Rancher backup-restore-operator Default Storage Location
2024-02-07 16:50:43 -08:00
Billy Tat de769a0cca Remove unused files - src/theme/MDXComponents.js wraps instead of ejects during swizzle 2024-02-07 16:25:32 -08:00
Marty Hernandez AvedonandBilly Tat c5bd3a9126 #990 create persistent grafana dashboard missing steps for creating in UI (#1026)
* rm deprecation banner from v2.8

* 990 create-persistent-grafana-dashboard missing steps for creating in UI

* added value plus note about modified helm chart

* 'note that' > :::note

* slight reword

* versioning

* Apply suggestions from code review

Co-authored-by: Billy Tat <btat@suse.com>

---------

Co-authored-by: Billy Tat <btat@suse.com>
2024-02-07 17:14:05 -05:00
martyav d3780fc278 note about prime 2024-02-07 15:28:40 -05:00
Billy Tat 00d9654e47 Merge pull request #1107 from btat/fix-link-check
Add missing frail flag
2024-02-06 11:10:53 -08:00
Sunil Singh f811383396 Updating the example YAML file link after the renaming of the header.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-02-06 10:53:00 -08:00
Billy Tat d90597785a Add missing frail flag 2024-02-06 10:30:30 -08:00
Sunil Singh c840cb331e Revising after review to avoid passive/future tense.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-02-06 10:15:01 -08:00
Silvio MoioliandMarty Hernandez Avedon ed88739bef tuning: recommend against third party apps (#1086)
* tuning: recommend against third party apps

Signed-off-by: Silvio Moioli <silvio@moioli.net>

* Wording suggestions from code review

Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
Signed-off-by: Silvio Moioli <silvio@moioli.net>

* Apply suggestions from code review

tense: was > are

---------

Signed-off-by: Silvio Moioli <silvio@moioli.net>
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2024-02-06 11:22:32 -05:00
Sunil Singh 9a4f272235 Updating the default storage location body text to better describe options for configuring the location, and revising the heading/term for the Rancher backup-restore-operator helm chart in both the how-to and reference pages to add a bit of clarification.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-02-05 15:41:30 -08:00
Billy Tat 00c791500f Merge pull request #1093 from btat/canonical-links
Update canonical links
2024-02-05 11:57:52 -08:00
Billy Tat 28d6268f5f Use correct link 2024-02-02 16:05:54 -08:00
Billy Tat 2044ea50d2 Use cis-scan-guides as target instead of intermediate page (that redirects) 2024-02-02 16:04:38 -08:00
Sunil Singh 80433ba8d4 Updates the table with the current counts as of the 2.8.2 release.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-02-02 15:45:58 -08:00
Sunil Singh d0f2f658c9 Adding entries for the 2.8.2 webhook mapping.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-02-02 13:07:07 -08:00
Sunil Singh 9b25313f60 Adding webhook mapping for security release 2.7.10.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-02-02 12:55:51 -08:00
Sunil Singh a834a55fac Updating the versions entries for the security releases (2.8.2, 2.7.10, 2.6.14).
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-02-02 12:33:06 -08:00
c6a11eaeab Update aws-marketplace.md (#1090)
* Update aws-marketplace.md

Edit link to new listing. Remove link to outdated doc. 
Remove outdated youtube video. 
New video is forthcoming under separate PR.

* Update docs/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md

Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>

* Update docs/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md

Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>

* versioning

---------

Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>
Co-authored-by: martyav <marty.avedon@suse.com>
2024-02-02 10:10:11 -05:00
Billy Tat 395d484bc7 Merge pull request #1096 from btat/2.8.1-stable-versons-table
Add support matrix link for 2.8.1
2024-02-01 12:56:00 -08:00
LucasSaintarbor 2ae06b1abc Review / update CLI commands 2024-02-01 12:27:02 -08:00
Billy Tat 9d1da51d63 Add support matrix link for 2.8.1 2024-01-31 10:49:22 -08:00
Billy Tat a3d005272b Merge pull request #1092 from btat/broken-links-2.7
Fix broken links
2024-01-29 12:59:25 -08:00
Billy TatandMarty Hernandez Avedon 4e438b5cb9 Update versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/azure-marketplace-payg-integration.md
Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>
2024-01-29 10:29:41 -08:00
Billy Tat dae1b76dc6 Update canonical links 2024-01-29 10:07:22 -08:00
Billy Tat a138306885 Merge branch 'main' into broken-links-2.7 2024-01-29 09:25:33 -08:00
Billy Tat 0b12ffe2ee Merge pull request #1091 from btat/pages-for-subheaders-payg
[2.7] Move PAYG pages-for-subheader
2024-01-29 09:23:53 -08:00
martyav 6085d82833 canonical links updated 2024-01-29 11:42:09 -05:00
Billy Tat 126228f266 Fix broken links 2024-01-26 19:18:05 -08:00
Billy Tat 253f80e509 Move PAYG pages-for-subheader 2024-01-26 16:36:39 -08:00
Billy Tat cdc3587166 Merge pull request #1087 from btat/integrations-update
Update integrations list
2024-01-26 10:41:48 -08:00
Marty Hernandez Avedon 1621ea5b5d revise the More from SUSE menu (#1088)
* revise the More from Rancher menu

rm Epinio from menu + rm styling and header icon

* + rancher desktop

* fixed ref to img
2024-01-26 13:36:28 -05:00
Billy Tat 76b61df25b Merge pull request #1082 from lgarber-akamai/doc/add-linode-quickstart
Add quick-start guide for Linode
2024-01-26 10:09:54 -08:00
Billy Tat 34dda87c71 Merge pull request #1064 from btat/move-pages-for-subheaders-2.0-2.4
[2.0-2.4] Move pages for subheaders
2024-01-26 09:28:14 -08:00
Billy Tat 04306dd362 Merge branch 'main' into move-pages-for-subheaders-2.0-2.4 2024-01-26 09:06:43 -08:00
Lena Garber a242cf5486 Apply feedback & update versioned sidebars 2024-01-25 16:47:46 -05:00
Marty Hernandez AvedonandLucas Saintarbor 5f6b134ddd #982 Fix Documentation for upgrade steps on a Rancher 2.6 air-gapped (originally installed and upgraded with helm template) (#1066)
* 982 Fix Documentation for upgrade steps on a Rancher 2.6 air-gapped (originally installed and upgraded with helm template)

* typo fix in heading, rm duplicate text

* rm explanation as it's not pertinent to upgrades

* added kubectl apply command

* revised command based on code review

* Apply suggestions from code review

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

---------

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>
2024-01-25 15:49:59 -05:00
Billy Tat 26465bcb5f Update integrations list 2024-01-25 11:51:37 -08:00
Billy Tat a2701ae760 Merge pull request #1083 from btat/heap-size
Bump heap size again
2024-01-25 11:29:17 -08:00
Billy Tat 03f245ac3b Merge pull request #1062 from btat/move-pages-for-subheaders-2.5
[2.5] Move pages for subheaders
2024-01-23 15:49:17 -08:00
Billy Tat 67c7ebcf1a Merge branch 'main' into move-pages-for-subheaders-2.5 2024-01-23 15:06:39 -08:00
Billy Tat 962e1cdfa6 Bump heap size again 2024-01-23 14:35:22 -08:00
Lena Garber 07f3aa96d0 Add Linode quick-start guide 2024-01-23 16:44:20 -05:00
martyav fdb9532d8a typo in filename and location 2024-01-22 17:08:51 -05:00
martyav cb914c11f6 updated 2.7 sidebar w new migration section 2024-01-22 16:42:33 -05:00
martyav 0b9bdeab24 Backport 844 Add aws out of tree cloud provider install/upgrade docs and 1025 refresh
created/updated relevant docs pages, moved vsphere migration guide to new migration section
2024-01-22 16:26:08 -05:00
Billy Tat 986e14346f Fix incorrect filename 2024-01-12 21:20:14 -08:00
Billy Tat 1c5e39e01b [2.0-2.4] Add redirects for pages-for-subheaders removal 2024-01-12 16:55:48 -08:00
Billy Tat 43a50c7518 Use absolute link for cross-version links 2024-01-12 16:17:03 -08:00
Billy Tat e9755fe5c8 Remove self-referencing link 2024-01-12 16:13:51 -08:00
Billy Tat 021840e6f4 [2.0-2.4] Fix links to 'shared-files' module import 2024-01-12 16:13:00 -08:00
Billy Tat c32fd49367 [2.0-2.4] Move files out of pages-for-subheaders 2024-01-12 16:07:44 -08:00
Billy Tat d8f25f1e7c Remove self-referencing link 2024-01-11 17:00:23 -08:00
Billy Tat 7b9b1e0bfc [2.5] Add redirects for pages-for-subheaders removal 2024-01-11 16:40:12 -08:00
Billy Tat e735be11b9 [2.5] Fix links to 'shared-files' module import 2024-01-11 16:38:07 -08:00
Billy Tat ca77220901 [2.5] Move files out of pages-for-subheaders 2024-01-11 16:36:20 -08:00
LucasSaintarbor c2dd038c3d Update CLI commands for v2.6 - v2.8 2024-01-11 10:40:38 -08:00
1105 changed files with 10847 additions and 5674 deletions
+1 -1
View File
@@ -22,7 +22,7 @@ jobs:
run: yarn install --frozen-lockfile
- name: Build website
env:
NODE_OPTIONS: "--max_old_space_size=5120"
NODE_OPTIONS: "--max_old_space_size=7168"
run: yarn build --no-minify
# Popular action to deploy to GitHub Pages:
+2 -2
View File
@@ -19,10 +19,10 @@ jobs:
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Check Markdown links
run: yarn run remark --quiet --use remark-validate-links ./docs
run: yarn run remark --quiet --frail --use remark-validate-links ./docs
- name: Check External links
run: yarn run remark --quiet --use remark-lint-no-dead-urls ./docs
- name: Test build website
env:
NODE_OPTIONS: "--max_old_space_size=5120"
NODE_OPTIONS: "--max_old_space_size=7168"
run: yarn build --no-minify
+1
View File
@@ -0,0 +1 @@
* @btat @LucasSaintarbor @martyav @sunilarjun
+1 -1
View File
@@ -23,7 +23,7 @@ If a file is moved or renamed, you'll also need to edit the `sidebars.js` files
### Navigate the Repo
The file paths in the repo correspond to the URLs for pages on the docs website. The docs for the latest version of Rancher are located in `/docs`. Most index pages are found within the `/pages-for-subheaders` directory in `/docs`. All images are in `/static/img` in the top level of the repo. Older docs are found within `/versioned_docs` and generally follow the same structure as the files in `/docs`.
The file paths in the repo correspond to the URLs for pages on the docs website. The docs for the latest version of Rancher are located in `/docs`. All images are in `/static/img` in the top level of the repo. Older docs are found within `/versioned_docs` and generally follow the same structure as the files in `/docs`.
### Style & Formatting
+4
View File
@@ -2,6 +2,10 @@
title: API Reference
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/api/api-reference"/>
</head>
:::note
At this time, not all Rancher resources are available through the Rancher Kubernetes API.
+4
View File
@@ -2,6 +2,10 @@
title: API Quick Start Guide
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/api/quickstart"/>
</head>
You can access Rancher's resources through the Kubernetes API. This guide will help you get started on using this API as a Rancher user.
1. In the upper left corner, click **☰ > Global Settings**.
+26
View File
@@ -2,6 +2,10 @@
title: Projects
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/api/workflows/projects"/>
</head>
## Creating a Project
Project resources may only be created on the management cluster. See below for [creating namespaces under projects in a managed cluster](#creating-a-namespace-in-a-project).
@@ -25,6 +29,26 @@ Use `metadata.generateName` to ensure a unique project ID, but note that `kubect
Set `metadata.namespace` and `spec.clusterName` to the ID for the cluster the project belongs to.
If you create a project through a cluster member account, you must include the annotation, `field.cattle.io/creatorId`, and set it to the cluster member account's user ID.
```bash
kubectl create -f - <<EOF
apiVersion: management.cattle.io/v3
kind: Project
metadata:
annotations:
field.cattle.io/creatorId:
user-id
generateName: p-
namespace: c-m-abcde
spec:
clusterName: c-m-abcde
displayName: myproject
EOF
```
Setting the `field.cattle.io/creatorId` field allows the cluster member account to see project resources with the `get` command and view the project in the Rancher UI. Cluster owner and admin accounts don't need to set this annotation to perform these tasks.
### Creating a Project With a Resource Quota
Refer to [Kubernetes Resource Quota](https://kubernetes.io/docs/concepts/policy/resource-quotas/).
@@ -107,3 +131,5 @@ Delete the project under the cluster namespace:
```bash
kubectl --namespace c-m-abcde delete project p-vwxyz
```
Note that this command doesn't delete the namespaces and resources that formerly belonged to the project.
@@ -86,6 +86,8 @@ For more information, see the [Flannel GitHub Page](https://github.com/flannel-i
#### Weave
<DeprecationWeave />
![Weave Logo](/img/weave-logo.png)
Weave enables networking and network policy in Kubernetes clusters across the cloud. Additionally, it support encrypting traffic between the peers.
@@ -184,8 +186,6 @@ The following table summarizes the different features available for each CNI net
## CNI Community Popularity
import CNIPopularityTable from '/shared-files/_cni-popularity.md';
<CNIPopularityTable />
## Which CNI Provider Should I Use?
@@ -38,6 +38,27 @@ helm upgrade rancher ./rancher-<VERSION>.tgz \
--set useBundledSystemChart=true # Use the packaged Rancher system charts
```
#### Resolving UPGRADE FAILED Error
If you encounter the error message, `Error: UPGRADE FAILED: "rancher" has no deployed releases`, Rancher might have been installed via the `helm template` command. To successfully upgrade Rancher, use the following command instead:
```
helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
--no-hooks \ # prevent files for Helm hooks from being generated
--namespace cattle-system \
--set hostname=<RANCHER.YOURDOMAIN.COM> \
--set certmanager.version=<CERTMANAGER_VERSION> \
--set rancherImage=<REGISTRY.YOURDOMAIN.COM:PORT>/rancher/rancher \
--set systemDefaultRegistry=<REGISTRY.YOURDOMAIN.COM:PORT> \ # Set a default private registry to be used in Rancher
--set useBundledSystemChart=true # Use the packaged Rancher system charts
```
After you run the Helm command, apply the rendered template:
```
kubectl -n cattle-system apply -R -f ./rancher
```
### Option B: Certificates from Files using Kubernetes Secrets
```plain
@@ -4,7 +4,7 @@ description: Learn how to install Rancher in development and production environm
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster"/>
</head>
In this section, you'll learn how to deploy Rancher on a Kubernetes cluster using the Helm CLI.
@@ -160,7 +160,8 @@ helm repo update
# Install the cert-manager Helm chart
helm install cert-manager jetstack/cert-manager \
--namespace cert-manager \
--create-namespace
--create-namespace \
--set installCRDs=true
```
Once you’ve installed cert-manager, you can verify it is deployed correctly by checking the cert-manager namespace for running pods:
@@ -78,7 +78,7 @@ A restore is performed by creating a Restore custom resource.
1. In the left navigation bar, click **Rancher Backups > Restore**.
:::note
If the Rancher Backups app is not visible, you will need to install it from the Charts page in **Apps**. Refer [here](../../../how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md#charts) for more information.
If the Rancher Backups app is not visible, you will need to install it from the Charts page in **Apps**. Refer [here](../../../how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md#access-charts) for more information.
:::
@@ -28,10 +28,13 @@ The kubeconfig can also be manually targeted for the intended cluster with the `
Review the list of known issues for each Rancher version, which can be found in the release notes on [GitHub](https://github.com/rancher/rancher/releases) and on the [Rancher forums.](https://forums.rancher.com/c/announcements/12)
Note that upgrades _to_ or _from_ any chart in the [rancher-alpha repository](../resources/choose-a-rancher-version.md#helm-chart-repositories) aren't supported.
### Helm Version
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](/versioned_docs/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
@@ -4,7 +4,7 @@ description: Learn how to install Rancher in development and production environm
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/installation-and-upgrade"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade"/>
</head>
This section provides an overview of the architecture options of installing Rancher, describing advantages of each option.
@@ -3,7 +3,7 @@ title: Installation References
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/installation-references"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/installation-references"/>
</head>
Please see the following reference guides for other installation resources: [Rancher Helm chart options](helm-chart-options.md), [TLS settings](tls-settings.md), and [feature flags](feature-flags.md).
@@ -4,7 +4,7 @@ description: Learn the node requirements for each node running Rancher server wh
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/installation-requirements"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/installation-requirements"/>
</head>
This page describes the software, hardware, and networking requirements for the nodes where the Rancher server will be installed. The Rancher server can be installed on a single node or a high-availability Kubernetes cluster.
@@ -3,7 +3,7 @@ title: Air-Gapped Helm CLI Install
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/air-gapped-helm-cli-install"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install"/>
</head>
This section is about using the Helm CLI to install the Rancher server in an air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy.
@@ -3,7 +3,7 @@ title: Other Installation Methods
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/other-installation-methods"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/other-installation-methods"/>
</head>
### Air Gapped Installations
@@ -10,6 +10,8 @@ Now that you have a running RKE cluster, you can install Rancher in it. For secu
### Install the Helm CLI
<DeprecationHelm2 />
Install the [Helm](https://helm.sh/docs/intro/install/) CLI on a host where you have a kubeconfig to access your Kubernetes cluster:
```
@@ -3,7 +3,7 @@ title: Installing Rancher behind an HTTP Proxy
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/rancher-behind-an-http-proxy"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy"/>
</head>
In a lot of enterprise environments, servers or VMs running on premise do not have direct Internet access, but must connect to external services through a HTTP(S) proxy for security reasons. This tutorial shows step by step how to set up a highly available Rancher installation in such an environment.
@@ -6,7 +6,9 @@ title: Troubleshooting Certificates
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/certificate-troubleshooting"/>
</head>
### How Do I Know if My Certificates are in PEM Format?
<DockerSupportWarning />
## How Do I Know if My Certificates are in PEM Format?
You can recognize the PEM format by the following traits:
@@ -48,7 +50,7 @@ VWQqljhfacYPgp8KJUJENQ9h5hZ2nSCrI+W00Jcw4QcEdCI8HL5wmg==
-----END PRIVATE KEY-----
```
### Converting a Certificate Key From PKCS8 to PKCS1
## Converting a Certificate Key From PKCS8 to PKCS1
If you are using a PKCS8 certificate key file, Rancher will log the following line:
@@ -64,7 +66,7 @@ openssl rsa -in key.pem -out convertedkey.pem
You can now use `convertedkey.pem` as certificate key file for Rancher.
### What is the Order of Certificates if I Want to Add My Intermediate(s)?
## What is the Order of Certificates if I Want to Add My Intermediate(s)?
The order of adding certificates is as follows:
@@ -77,7 +79,7 @@ The order of adding certificates is as follows:
-----END CERTIFICATE-----
```
### How Do I Validate My Certificate Chain?
## How Do I Validate My Certificate Chain?
You can validate the certificate chain by using the `openssl` binary. If the output of the command (see the command example below) ends with `Verify return code: 0 (ok)`, your certificate chain is valid. The `ca.pem` file must be the same as you added to the `rancher/rancher` container.
@@ -4,9 +4,11 @@ description: For development and testing environments only, use a Docker install
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/rancher-on-a-single-node-with-docker"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker"/>
</head>
<DockerSupportWarning />
Rancher can be installed by running a single Docker container.
In this installation scenario, you'll install Docker on a single Linux host, and then deploy Rancher on your host using a single Docker container.
@@ -6,6 +6,8 @@ title: Rolling Back Rancher Installed with Docker
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/roll-back-docker-installed-rancher"/>
</head>
<DockerSupportWarning />
If a Rancher upgrade does not complete successfully, you'll have to roll back to your Rancher setup that you were using before [Docker Upgrade](upgrade-docker-installed-rancher.md). Rolling back restores:
- Your previous version of Rancher.
@@ -6,14 +6,10 @@ title: Upgrading Rancher Installed with Docker
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher"/>
</head>
<DockerSupportWarning />
The following instructions will guide you through upgrading a Rancher server that was installed with Docker.
:::caution
**Docker installs are not supported in production environments.** These instructions are provided for testing and development purposes only. If you have already deployed a Docker install in production and need to upgrade to a new Rancher version, we recommend [migrating to the Helm chart install](../../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md) before upgrading.
:::
## Prerequisites
- **Review the [known upgrade issues](../../install-upgrade-on-a-kubernetes-cluster/upgrades.md#known-upgrade-issues)** section in the Rancher documentation for the most noteworthy issues to consider when upgrading Rancher. A more complete list of known issues for each Rancher version can be found in the release notes on [GitHub](https://github.com/rancher/rancher/releases) and on the [Rancher forums](https://forums.rancher.com/c/announcements/12). Note that upgrades to or from any chart in the [rancher-alpha repository](../../resources/choose-a-rancher-version.md#helm-chart-repositories) aren’t supported.
@@ -8,7 +8,9 @@ title: Helm Version Requirements
This section contains the requirements for Helm, which is the tool used to install Rancher on a high-availability Kubernetes cluster.
> The installation instructions have been updated for 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/) [This section](/versioned_docs/version-2.0-2.4/pages-for-subheaders/helm2.md) provides a copy of the older high-availability Rancher installation instructions that used Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible.
> The installation instructions have been updated for 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/) [This section](/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/helm2.md) provides a copy of the older high-availability Rancher installation instructions that used Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible.
<DeprecationHelm2 />
- Helm v3.2.x or higher is required to install or upgrade Rancher v2.5.
- Helm v2.16.0 or higher is required for Kubernetes v1.16. For the default Kubernetes version, refer to the [release notes](https://github.com/rancher/rke/releases) for the version of RKE that you are using.
@@ -3,7 +3,7 @@ title: Resources
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/resources"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/resources"/>
</head>
### Docker Installations
@@ -145,6 +145,8 @@ Before you can perform the upgrade, you must prepare your air gapped environment
--set cainjector.image.repository=<REGISTRY.YOURDOMAIN.COM:PORT>/quay.io/jetstack/cert-manager-cainjector
```
<DeprecationHelm2 />
The Helm 2 command is as follows:
```plain
@@ -1,14 +1,11 @@
---
title: Rancher AWS Marketplace Quick Start
description: Use Amazon EKS to deploy Rancher server.
title: Rancher Prime AWS Marketplace Quick Start
description: Deploy SUSE Rancher from the AWS Marketplace listing.
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace"/>
</head>
import YouTube from '@site/src/components/YouTube'
You can quickly deploy Rancher Prime on Amazon Elastic Kubernetes Service (EKS.) To learn more, see the [instructions](https://suse-enceladus.github.io/marketplace-docs/rancher-prime/aws/?repository=rancher-payg-billing-adapter-llc-prd) under Usage Information in the [AWS Marketplace listing](https://aws.amazon.com/marketplace/pp/prodview-f2bvszurj2p2c).
Amazon Elastic Kubernetes Service (EKS) can quickly [deploy Rancher to Amazon Web Services (AWS)](https://documentation.suse.com/trd/kubernetes/single-html/gs_rancher_aws-marketplace/). To learn more, see our [Amazon Marketplace listing](https://aws.amazon.com/marketplace/pp/prodview-go7ent7goo5ae). Watch the demo for a walkthrough of AWS Marketplace SUSE Rancher setup:
<YouTube id="9dznJ7Ons0M"/>
@@ -3,7 +3,7 @@ title: Deploying Rancher Server
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/deploy-rancher-manager"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/quick-start-guides/deploy-rancher-manager"/>
</head>
Use one of the following guides to deploy and provision Rancher and a Kubernetes cluster in the provider of your choice.
@@ -14,6 +14,7 @@ Use one of the following guides to deploy and provision Rancher and a Kubernetes
- [DigitalOcean](digitalocean.md) (uses Terraform)
- [GCP](gcp.md) (uses Terraform)
- [Hetzner Cloud](hetzner-cloud.md) (uses Terraform)
- [Linode](linode.md) (uses Terraform)
- [Vagrant](vagrant.md)
- [Equinix Metal](equinix-metal.md)
- [Outscale](outscale-qs.md) (uses Terraform)
@@ -0,0 +1,82 @@
---
title: Rancher Linode Quick Start Guide
description: Read this step by step guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/quick-start-guides/deploy-rancher-manager/linode"/>
</head>
The following steps will quickly deploy a Rancher server on Linode in a single-node K3s Kubernetes cluster, with a single-node downstream Kubernetes cluster attached.
:::caution
The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see [Installation](../../installation-and-upgrade/installation-and-upgrade.md).
:::
## Prerequisites
:::caution
Deploying to Linode will incur charges.
:::
- [Linode Account](https://linode.com): The Linode account to run provision server and cluster under.
- [Linode Personal Access Token](https://www.linode.com/docs/products/tools/api/guides/manage-api-tokens/): A Linode Personal Access Token to authenticate with.
- [Terraform](https://www.terraform.io/downloads.html): Used to provision the server and cluster on Linode.
## Getting Started
1. Clone [Rancher Quickstart](https://github.com/rancher/quickstart) to a folder using `git clone https://github.com/rancher/quickstart`.
2. Go into the Linode folder containing the Terraform files by executing `cd quickstart/rancher/linode`.
3. Rename the `terraform.tfvars.example` file to `terraform.tfvars`.
4. Edit `terraform.tfvars` and customize the following variables:
- `linode_token` - The Linode Personal Access Token mentioned above.
- `rancher_server_admin_password` - Admin password for created Rancher server (minimum 12 characters).
5. **Optional:** Modify optional variables within `terraform.tfvars`.
See the [Quickstart Readme](https://github.com/rancher/quickstart) and the [Linode Quickstart Readme](https://github.com/rancher/quickstart/tree/master/rancher/linode) for more information. Suggestions include:
- `linode_region` - The target Linode region to provision the server and cluster in.
- Default: `eu-central`
- For a complete list of regions, see the [official Region Availability page](https://www.linode.com/global-infrastructure/availability/).
- `prefix` - The prefix for all created infrastructure.
- `linode_type` - The type/plan that all infrastructure Linodes should use.
- Default: `g6-standard-2`
- For a complete list of plans, see the [official Plan Types page](https://www.linode.com/docs/products/compute/compute-instances/plans/).
6. Run `terraform init`.
7. To initiate the creation of the environment, run `terraform apply --auto-approve`. Then wait for output similar to the following:
```
Apply complete! Resources: 15 added, 0 changed, 0 destroyed.
Outputs:
rancher_node_ip = xx.xx.xx.xx
rancher_server_url = https://rancher.xx.xx.xx.xx.sslip.io
workload_node_ip = yy.yy.yy.yy
```
8. Paste the `rancher_server_url` from the output above into the browser and log in when prompted. The default username is `admin` and the password is defined in `rancher_server_admin_password`.
9. `ssh` into the Rancher Server using the `id_rsa` key generated in `quickstart/rancher/linode`.
#### Result
Two Kubernetes clusters are deployed on your Linode account, one running Rancher Server and the other ready for experimentation deployments. Please note that while this setup is a great way to explore Rancher functionality, a production setup should follow our high availability setup guidelines. SSH keys for the VMs are auto-generated and stored in the module directory.
### What's Next?
Use Rancher to create a deployment. For more information, see [Creating Deployments](../deploy-workloads/deploy-workloads.md).
## Destroying the Environment
1. From the `quickstart/rancher/linode` folder, execute `terraform destroy --auto-approve`.
2. Wait for confirmation that all resources have been destroyed.
@@ -3,7 +3,7 @@ title: Deploying Workloads
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/deploy-rancher-workloads"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/quick-start-guides/deploy-workloads"/>
</head>
These guides walk you through the deployment of an application, including how to expose the application for use outside of the cluster.
@@ -73,4 +73,5 @@ When you're done using your sandbox, destroy the Rancher Server and your cluster
- [Amazon AWS: Destroying the Environment](../deploy-rancher-manager/aws.md#destroying-the-environment)
- [DigitalOcean: Destroying the Environment](../deploy-rancher-manager/digitalocean.md#destroying-the-environment)
- [Linode: Destroying the Environment](../deploy-rancher-manager/linode.md#destroying-the-environment)
- [Vagrant: Destroying the Environment](../deploy-rancher-manager/vagrant.md#destroying-the-environment)
@@ -3,7 +3,7 @@ title: Rancher Deployment Quick Start Guides
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/quick-start-guides"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/getting-started/quick-start-guides"/>
</head>
:::caution
@@ -3,7 +3,7 @@ title: Advanced User Guides
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/advanced-user-guides"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides"/>
</head>
Advanced user guides are "problem-oriented" docs in which users learn how to answer questions or solve problems. The major difference between these and the new user guides is that these guides are geared toward more experienced or advanced users who have more technical needs from their documentation. These users already have an understanding of Rancher and its functions. They know what they need to accomplish; they just need additional guidance to complete some more complex task they they have encountered while working.
@@ -3,7 +3,7 @@ title: CIS Scan Guides
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/cis-scan-guides"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/cis-scan-guides"/>
</head>
- [Install rancher-cis-benchmark](install-rancher-cis-benchmark.md)
@@ -3,7 +3,7 @@ title: Enabling Experimental Features
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/enable-experimental-features"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/enable-experimental-features"/>
</head>
Rancher includes some features that are experimental and disabled by default. You might want to enable these features, for example, if you decide that the benefits of using an [unsupported storage type](unsupported-storage-drivers.md) outweighs the risk of using an untested feature. Feature flags were introduced to allow you to try these features that are not enabled by default.
@@ -3,7 +3,7 @@ title: Setup Guide
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/istio-setup-guide"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/istio-setup-guide"/>
</head>
This section describes how to enable Istio and start using it in your projects.
@@ -3,7 +3,7 @@ title: Project Resource Quotas
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/manage-project-resource-quotas"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas"/>
</head>
In situations where several teams share a cluster, one team may overconsume the resources available: CPU, memory, storage, services, Kubernetes objects like pods or secrets, and so on. To prevent this overconsumption, you can apply a _resource quota_, which is a Rancher feature that limits the resources available to a project or namespace.
@@ -3,7 +3,7 @@ title: Project Administration
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/manage-projects"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/manage-projects"/>
</head>
_Projects_ are objects introduced in Rancher that help organize namespaces in your Kubernetes cluster. You can use projects to create multi-tenant clusters, which allows a group of users to share the same underlying resources without interacting with each other's applications.
@@ -46,7 +46,7 @@ To use your own dashboard:
### 2. Create a ConfigMap using the Grafana JSON model
Create a ConfigMap in the namespace that contains your Grafana Dashboards (e.g. cattle-dashboards by default).
Create a ConfigMap in the namespace that contains your Grafana Dashboards (e.g. `cattle-dashboards` by default).
The ConfigMap should look like this:
@@ -65,19 +65,26 @@ data:
By default, Grafana is configured to watch all ConfigMaps with the `grafana_dashboard` label within the `cattle-dashboards` namespace.
To specify that you would like Grafana to watch for ConfigMaps across all namespaces, refer to [this section.](#configuring-namespaces-for-the-grafana-dashboard-configmap)
To specify that you would like Grafana to watch for ConfigMaps across all namespaces, refer to [this section](#configuring-namespaces-for-the-grafana-dashboard-configmap).
To create the ConfigMap in the Rancher UI,
To create the ConfigMap through the Rancher UI, first make sure that you are currently logged in to the Grafana UI, to ensure that dashboards import without encountering permissions issues. Then, return to the Rancher UI and perform the following steps:
1. In the upper left corner, click **☰ > Cluster Management**.
1. On the **Clusters** page, go to the cluster where you want to see the visualizations and click **Explore**.
1. Click **More Resources > Core > ConfigMaps**.
1. Click **Create**.
1. Set up the key-value pairs similar to the example above. When entering the value for `<dashboard-name>.json`, click **Read from File** to upload the JSON data model as the value.
1. On the **Data** tab, set up the key-value pairs similar to the example above. When entering the value for `<dashboard-name>.json`, click **Read from File** to upload the JSON data model as the value.
1. On the **Labels & Annotations** tab, click **Add Label** and enter `grafana_dashboard` as the key, and `1` as the value.
1. Click **Create**.
**Result:** After the ConfigMap is created, it should show up on the Grafana UI and be persisted even if the Grafana pod is restarted.
:::note
The actual key-value pair may differ if you have modified the Helm chart to watch a different dashboard label and value.
:::
Dashboards that are persisted using ConfigMaps cannot be deleted or edited from the Grafana UI.
If you attempt to delete the dashboard in the Grafana UI, you will see the error message "Dashboard cannot be deleted because it was provisioned." To delete the dashboard, you will need to delete the ConfigMap.
@@ -3,7 +3,7 @@ title: Monitoring/Alerting Guides
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/monitoring-alerting-guides"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/monitoring-alerting-guides"/>
</head>
- [Enable monitoring](enable-monitoring.md)
@@ -3,7 +3,7 @@ title: Prometheus Federator Guides
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/prometheus-federator-guides"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides"/>
</head>
- [Enable Prometheus Operator](enable-prometheus-federator.md)
@@ -3,7 +3,7 @@ title: Advanced Configuration
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/advanced-configuration"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration"/>
</head>
### Alertmanager
@@ -3,7 +3,7 @@ title: Configuration
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/monitoring-v2-configuration-guides"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides"/>
</head>
This page captures some of the most important options for configuring Monitoring V2 in the Rancher UI.
@@ -3,7 +3,7 @@ title: About Provisioning Drivers
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/about-provisioning-drivers"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers"/>
</head>
Drivers in Rancher allow you to manage which providers can be used to deploy [hosted Kubernetes clusters](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/set-up-clusters-from-hosted-kubernetes-providers.md) or [nodes in an infrastructure provider](../../launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md) to allow Rancher to deploy and manage Kubernetes.
@@ -23,7 +23,7 @@ To create, edit, or delete drivers, you need _one_ of the following permissions:
## Activating/Deactivating Node Drivers
By default, Rancher only activates drivers for the most popular cloud providers, Amazon EC2, Azure, DigitalOcean and vSphere. If you want to show or hide any node driver, you can change its status.
By default, Rancher only activates drivers for the most popular cloud providers, Amazon EC2, Azure, DigitalOcean, Linode and vSphere. If you want to show or hide any node driver, you can change its status.
1. In the upper left corner, click **☰ > Cluster Management**.
@@ -3,7 +3,7 @@ title: RKE Templates
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/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>
RKE templates are designed to allow DevOps and security teams to standardize and simplify the creation of Kubernetes clusters.
@@ -40,8 +40,8 @@ An administrator can individually grant the role **Create RKE Templates** to any
Alternatively, the administrator can give all new users the default permission to create RKE templates by following the following steps. This will not affect the permissions of existing users.
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Roles**.
1. Go to the role named **Create new RKE Cluster Templates and click **⋮ > Edit Config**.
1. In the left navigation bar, click **Role Templates**.
1. Select **Create new RKE Cluster Templates** and click **⋮ > Edit Config**.
1. Select the option **Yes: Default role for new users**.
1. Click **Save**.
1. If you would like new users to also be able to create RKE template revisions, enable that role as default as well.
@@ -52,8 +52,6 @@ When you need to make changes to your infrastructure, instead of manually updati
- You can reverse engineer how to do define a setting in Terraform by changing the setting in Rancher, then going back and checking your Terraform state file to see how it maps to the current state of your infrastructure.
- If you want to manage Kubernetes cluster settings, Rancher settings, and hardware settings all in one place, use [Terraform modules](https://github.com/rancher/terraform-modules). You can pass a cluster configuration YAML file or an RKE template configuration file to a Terraform module so that the Terraform module will create it. In that case, you could use your infrastructure-as-code to manage the version control and revision history of both your Kubernetes cluster and its underlying hardware.
## Tip for Creating CIS Benchmark Compliant Clusters
This section describes one way that you can make security and compliance-related config files standard in your clusters.
@@ -4,13 +4,19 @@ weight: 10
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/authentication-config"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config"/>
</head>
One of the key features that Rancher adds to Kubernetes is centralized user authentication. This feature allows your users to use one set of credentials to authenticate with any of your Kubernetes clusters.
This centralized user authentication is accomplished using the Rancher authentication proxy, which is installed along with the rest of Rancher. This proxy authenticates your users and forwards their requests to your Kubernetes clusters using a service account.
:::warning
The account used to enable the external provider will be granted admin permissions. If you use a test account or non-admin account, that account will still be granted admin-level permissions. See [External Authentication Configuration and Principal Users](#external-authentication-configuration-and-principal-users) to understand why.
:::
## External vs. Local Authentication
The Rancher authentication proxy integrates with the following external authentication services.
@@ -77,12 +83,14 @@ To set the Rancher access level for users in the authorization service, follow t
## External Authentication Configuration and Principal Users
Configuration of external authentication requires:
Configuring external authentication requires:
- A local user assigned the administrator role, called hereafter the _local principal_.
- An external user that can authenticate with your external authentication service, called hereafter the _external principal_.
Configuration of external authentication affects how principal users are managed within Rancher. Follow the list below to better understand these effects.
The configuration of external authentication also affects how principal users are managed within Rancher. Specifically, when a user account enables an external provider, it is granted admin-level permissions. This is because the local principal and external principal share the same user ID and access rights.
The following instructions demonstrate these effects:
1. Sign into Rancher as the local principal and complete configuration of external authentication.
@@ -3,7 +3,7 @@ title: Authentication, Permissions and Global Settings
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/authentication-permissions-and-global-configuration"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration"/>
</head>
After installation, the [system administrator](manage-role-based-access-control-rbac/global-permissions.md) should configure Rancher to configure authentication, authorization, security, default settings, security policies, drivers and global DNS entries.
@@ -82,4 +82,4 @@ 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](/versioned_docs/version-2.0-2.4/pages-for-subheaders/helm-charts-in-rancher.md), [global DNS entries](/versioned_docs/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](/versioned_docs/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](/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md), [global DNS entries](/versioned_docs/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](/versioned_docs/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.
@@ -3,7 +3,7 @@ title: Configuring Microsoft Active Directory Federation Service (SAML)
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/configure-microsoft-ad-federation-service-saml"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml"/>
</head>
If your organization uses Microsoft Active Directory Federation Services (AD FS) for user authentication, you can configure Rancher to allow your users to log in using their AD FS credentials.
@@ -3,7 +3,7 @@ title: Configuring OpenLDAP
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/configure-openldap"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap"/>
</head>
If your organization uses LDAP for user authentication, you can configure Rancher to communicate with an OpenLDAP server to authenticate users. This allows Rancher admins to control access to clusters and projects based on users and groups managed externally in the organisation's central user repository, while allowing end-users to authenticate with their LDAP credentials when logging in to the Rancher UI.
@@ -3,7 +3,7 @@ title: Configuring Shibboleth (SAML)
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/configure-shibboleth-saml"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml"/>
</head>
If your organization uses Shibboleth Identity Provider (IdP) for user authentication, you can configure Rancher to allow your users to log in to Rancher using their Shibboleth credentials.
@@ -11,7 +11,7 @@ Cluster and project roles define user authorization inside a cluster or project.
To manage these roles,
1. Click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Roles** and go to the **Cluster** or **Project/Namespaces** tab.
1. In the left navigation bar, click **Role Templates** and go to the **Cluster** or **Project/Namespaces** tab.
### Membership and Role Assignment
@@ -73,7 +73,7 @@ The following table lists the permissions available for the `Manage Nodes` role
For details on how each cluster role can access Kubernetes resources, you can look them up in the Rancher UI:
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Roles**.
1. In the left navigation bar, click **Role Templates**.
1. Click the **Cluster** tab.
1. Click the name of an individual role. The table shows all of the operations and resources that are permitted by the role.
@@ -220,7 +220,7 @@ There are two methods for changing default cluster/project roles:
You can change the cluster or project role(s) that are automatically assigned to the creating user.
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Roles**.
1. In the left navigation bar, click **Role Templates**.
1. Click the **Cluster** or **Project/Namespaces** tab.
1. Find the custom or individual role that you want to use as default. Then edit the role by selecting **⋮ > Edit Config**.
1. In the **Cluster Creator Default** or **Project Creator Default** section, enable the role as the default.
@@ -31,7 +31,7 @@ While Rancher comes out-of-the-box with a set of default user roles, you can als
The steps to add custom roles differ depending on the version of Rancher.
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Roles**.
1. In the left navigation bar, click **Role Templates**.
1. Select a tab to determine the scope of the role you're adding. The tabs are:
- **Global:** The role is valid for allowing members to manage global scoped resources.
@@ -65,7 +65,7 @@ The custom role can then be assigned to a user or group so that the role takes e
To create a custom role based on an existing role,
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Roles**.
1. In the left navigation bar, click **Role Templates**.
1. Click the **Cluster** or **Project/Namespaces** tab. Click **Create Cluster Role** or **Create Project/Namespaces Role** depending on the scope. Note: Only cluster roles and project/namespace roles can inherit from another role.
1. Enter a name for the role.
1. In the **Inherit From** tab, select the role(s) that the custom role will inherit permissions from.
@@ -86,7 +86,7 @@ Custom roles can be deleted, but built-in roles cannot be deleted.
To delete a custom role,
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Roles**.
1. In the left navigation bar, click **Role Templates**.
2. Go to the custom global role that should be deleted and click **⋮ (…) > Delete**.
3. Click **Delete**.
@@ -12,7 +12,7 @@ Global Permissions define user authorization outside the scope of any particular
- **Administrator:** These users have full control over the entire Rancher system and all clusters within it.
- **Restricted Admin:** These users have full control over downstream clusters, but cannot alter the local Kubernetes cluster.
- **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.
@@ -20,9 +20,282 @@ Global Permissions define user authorization outside the scope of any particular
You cannot update or delete the built-in Global Permissions.
## Global Permission Assignment
Global permissions for local users are assigned differently than users who log in to Rancher using external authentication.
### Global Permissions for New Local Users
When you create a new local user, you assign them a global permission as you complete the **Add User** form.
To see the default permissions for new users,
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Role Templates**.
1. The **Role Templates** page has tabs for roles grouped by scope. Each table lists the roles in that scope. In the **Global** tab, in the **New User Default** column, the permissions given to new users by default are indicated with a checkmark.
You can [change the default global permissions to meet your needs.](#configuring-default-global-permissions)
### Global Permissions for Users with External Authentication
When a user logs into Rancher using an external authentication provider for the first time, they are automatically assigned the **New User Default** global permissions. By default, Rancher assigns the **Standard User** permission for new users.
To see the default permissions for new users,
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Role Templates**.
1. The **Role Templates** page has tabs for roles grouped by scope. Each table lists the roles in that scope. In the **New User Default** column on each page, the permissions given to new users by default are indicated with a checkmark.
You can [change the default permissions to meet your needs.](#configuring-default-global-permissions)
Permissions can be [assigned](#configuring-global-permissions-for-individual-users) to an individual user.
You can [assign a role to everyone in the group at the same time](#configuring-global-permissions-for-groups) if the external authentication provider supports groups.
## Custom Global Permissions
Using custom permissions is convenient for providing users with narrow or specialized access to Rancher.
When a user from an [external authentication source](../authentication-config/authentication-config.md) signs into Rancher for the first time, they're automatically assigned a set of global permissions (hereafter, permissions). By default, after a user logs in for the first time, they are created as a user and assigned the default `user` permission. The standard `user` permission allows users to login and create clusters.
However, in some organizations, these permissions may extend too much access. Rather than assigning users the default global permissions of `Administrator` or `Standard User`, you can assign them a more restrictive set of custom global permissions.
The default roles, Administrator and Standard User, each come with multiple global permissions built into them. The Administrator role includes all global permissions, while the default user role includes three global permissions: Create Clusters, Use Catalog Templates, and User Base, which is equivalent to the minimum permission to log in to Rancher. In other words, the custom global permissions are modularized so that if you want to change the default user role permissions, you can choose which subset of global permissions are included in the new default user role.
Administrators can enforce custom global permissions in multiple ways:
- [Creating custom global roles](#custom-globalroles).
- [Changing the default permissions for new users](#configuring-default-global-permissions).
- [Configuring global permissions for individual users](#configuring-global-permissions-for-individual-users).
- [Configuring global permissions for groups](#configuring-global-permissions-for-groups).
### Combining Built-in GlobalRoles
Rancher provides several GlobalRoles which grant granular permissions for certain common use cases.
The following table lists each built-in global permission and whether it is included in the default global permissions, `Administrator`, `Standard User` and `User-Base`.
| Custom Global Permission | Administrator | Standard User | User-Base |
| ---------------------------------- | ------------- | ------------- |-----------|
| Create Clusters | ✓ | ✓ | |
| Create RKE Templates | ✓ | ✓ | |
| Manage Authentication | ✓ | | |
| Manage Catalogs | ✓ | | |
| Manage Cluster Drivers | ✓ | | |
| Manage Node Drivers | ✓ | | |
| Manage PodSecurityPolicy Templates | ✓ | | |
| Manage Roles | ✓ | | |
| Manage Settings | ✓ | | |
| Manage Users | ✓ | | |
| Use Catalog Templates | ✓ | ✓ | |
| User-Base (Basic log-in access) | ✓ | ✓ | |
For details on which Kubernetes resources correspond to each global permission,
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Role Templates**.
1. If you click the name of an individual role, a table shows all of the operations and resources that are permitted by the role.
:::note Notes:
- Each permission listed above is comprised of multiple individual permissions not listed in the Rancher UI. For a full list of these permissions and the rules they are comprised of, access through the API at `/v3/globalRoles`.
- When viewing the resources associated with default roles created by Rancher, if there are multiple Kubernetes API resources on one line item, the resource will have `(Custom)` appended to it. These are not custom resources but just an indication that there are multiple Kubernetes API resources as one resource.
:::
### Custom GlobalRoles
You can create custom GlobalRoles to satisfy use cases not directly addressed by built-in GlobalRoles.
Create custom GlobalRoles through the UI or through automation (such as the Rancher Kubernetes API). You can specify the same type of rules as the rules for upstream roles and clusterRoles.
#### Escalate and Bind verbs
When giving permissions on GlobalRoles, keep in mind that Rancher respects the `escalate` and `bind` verbs, in a similar fashion to [Kubernetes](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#restrictions-on-role-creation-or-update).
Both of these verbs, which are given on the GlobalRoles resource, can grant users the permission to bypass Rancher's privilege escalation checks. This potentially allows users to become admins. Since this represents a serious security risk, `bind` and `escalate` should be distributed to users with great caution.
The `escalate` verb allows users to change a GlobalRole and add any permission, even if the users doesn't have the permissions in the current GlobalRole or the new version of the GlobalRole.
The `bind` verb allows users to create a GlobalRoleBinding to the specified GlobalRole, even if they do not have the permissions in the GlobalRole.
:::danger
The wildcard verb `*` also includes the `bind` and `escalate` verbs. This means that giving `*` on GlobalRoles to a user also gives them both `escalate` and `bind`.
:::
##### Custom GlobalRole Examples
To grant permission to escalate only the `test-gr` GlobalRole:
```yaml
rules:
- apiGroups:
- 'management.cattle.io'
resources:
- 'globalroles'
resourceNames:
- 'test-gr'
verbs:
- 'escalate'
```
To grant permission to escalate all GlobalRoles:
```yaml
rules:
- apiGroups:
- 'management.cattle.io'
resources:
- 'globalroles'
verbs:
- 'escalate'
```
To grant permission to create bindings (which bypass escalation checks) to only the `test-gr` GlobalRole:
```yaml
rules:
- apiGroups:
- 'management.cattle.io'
resources:
- 'globalroles'
resourceNames:
- 'test-gr'
verbs:
- 'bind'
- apiGroups:
- 'management.cattle.io'
resources:
- 'globalrolebindings'
verbs:
- 'create'
```
Granting `*` permissions (which includes both `escalate` and `bind`):
```yaml
rules:
- apiGroups:
- 'management.cattle.io'
resources:
- 'globalroles'
verbs:
- '*'
```
#### GlobalRole Permissions on Downstream Clusters
GlobalRoles can grant one or more RoleTemplates on every downstream cluster through the `inheritedClusterRoles` field. Values in this field must refer to a RoleTemplate which exists and has a `context` of Cluster.
With this field, users gain the specified permissions on all current or future downstream clusters. For example, consider the following GlobalRole:
```yaml
apiVersion: management.cattle.io/v3
kind: GlobalRole
displayName: All Downstream Owner
metadata:
name: all-downstream-owner
inheritedClusterRoles:
- cluster-owner
```
Any user with this permission will be a cluster-owner on all downstream clusters. If a new cluster is added, regardless of type, the user will be an owner on that cluster as well.
:::danger
Using this field on [default GlobalRoles](#configuring-default-global-permissions) may result in users gaining excessive permissions.
:::
### Configuring Default Global Permissions
If you want to restrict the default permissions for new users, you can remove the `user` permission as default role and then assign multiple individual permissions as default instead. Conversely, you can also add administrative permissions on top of a set of other standard permissions.
:::note
Default roles are only assigned to users added from an external authentication provider. For local users, you must explicitly assign global permissions when adding a user to Rancher. You can customize these global permissions when adding the user.
:::
To change the default global permissions that are assigned to external users upon their first log in, follow these steps:
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Role Templates**. On the **Role Templates** page, make sure the **Global** tab is selected.
1. Find the permissions set that you want to add or remove as a default. Then edit the permission by selecting **⋮ > Edit Config**.
1. If you want to add the permission as a default, Select **Yes: Default role for new users** and then click **Save**. If you want to remove a default permission, edit the permission and select **No**.
**Result:** The default global permissions are configured based on your changes. Permissions assigned to new users display a check in the **New User Default** column.
### Configuring Global Permissions for Individual Users
To configure permission for a user,
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Users**.
1. Go to the user whose access level you want to change and click **⋮ > Edit Config**.
1. In the **Global Permissions** and **Built-in** sections, check the boxes for each permission you want the user to have. If you have created roles from the **Role Templates** page, they will appear in the **Custom** section and you can choose from them as well.
1. Click **Save**.
**Result:** The user's global permissions have been updated.
### Configuring Global Permissions for Groups
If you have a group of individuals that need the same level of access in Rancher, it can save time to assign permissions to the entire group at once, so that the users in the group have the appropriate level of access the first time they sign into Rancher.
After you assign a custom global role to a group, the custom global role will be assigned to a user in the group when they log in to Rancher.
For existing users, the new permissions will take effect when the users log out of Rancher and back in again, or when an administrator [refreshes the group memberships.](#refreshing-group-memberships)
For new users, the new permissions take effect when the users log in to Rancher for the first time. New users from this group will receive the permissions from the custom global role in addition to the **New User Default** global permissions. By default, the **New User Default** permissions are equivalent to the **Standard User** global role, but the default permissions can be [configured.](#configuring-default-global-permissions)
If a user is removed from the external authentication provider group, they would lose their permissions from the custom global role that was assigned to the group. They would continue to have any remaining roles that were assigned to them, which would typically include the roles marked as **New User Default**. Rancher will remove the permissions that are associated with the group when the user logs out, or when an administrator [refreshes group memberships,](#refreshing-group-memberships) whichever comes first.
:::note Prerequisites:
You can only assign a global role to a group if:
* You have set up an [external authentication provider](../authentication-config/authentication-config.md#external-vs-local-authentication)
* The external authentication provider supports [user groups](../authentication-config/manage-users-and-groups.md)
* You have already set up at least one user group with the authentication provider
:::
To assign a custom global role to a group, follow these steps:
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Groups**.
1. Go to the group you want to assign a custom global role to and click **⋮ > Edit Config**.
1. In the **Global Permissions,** **Custom,** and/or **Built-in** sections, select the permissions that the group should have.
1. Click **Create**.
**Result:** The custom global role will take effect when the users in the group log into Rancher.
### Refreshing Group Memberships
When an administrator updates the global permissions for a group, the changes take effect for individual group members after they log out of Rancher and log in again.
To make the changes take effect immediately, an administrator or cluster owner can refresh group memberships.
An administrator might also want to refresh group memberships if a user is removed from a group in the external authentication service. In that case, the refresh makes Rancher aware that the user was removed from the group.
To refresh group memberships,
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Users**.
1. Click **Refresh Group Memberships**.
**Result:** Any changes to the group members' permissions will take effect.
## Restricted Admin
A new `restricted-admin` role was created in Rancher v2.5 in order to prevent privilege escalation from 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.
:::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.
@@ -82,170 +355,10 @@ The following table lists the permissions and actions that a `restricted-admin`
| | Deploy GKE cluster | Yes | Yes | Yes | |
| | Deploy AKS cluster | Yes | Yes | Yes | |
### Changing Global Administrators to Restricted Admins
If Rancher already has a global administrator, they should change all global administrators over to the new `restricted-admin` role.
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.
## Global Permission Assignment
Global permissions for local users are assigned differently than users who log in to Rancher using external authentication.
### Global Permissions for New Local Users
When you create a new local user, you assign them a global permission as you complete the **Add User** form.
To see the default permissions for new users,
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Roles**.
1. The **Roles** page has tabs for roles grouped by scope. Each table lists the roles in that scope. In the **Global** tab, in the **New User Default** column, the permissions given to new users by default are indicated with a checkmark.
You can [change the default global permissions to meet your needs.](#configuring-default-global-permissions)
### Global Permissions for Users with External Authentication
When a user logs into Rancher using an external authentication provider for the first time, they are automatically assigned the **New User Default** global permissions. By default, Rancher assigns the **Standard User** permission for new users.
To see the default permissions for new users,
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Roles**.
1. The **Roles** page has tabs for roles grouped by scope. Each table lists the roles in that scope. In the **New User Default** column on each page, the permissions given to new users by default are indicated with a checkmark.
You can [change the default permissions to meet your needs.](#configuring-default-global-permissions)
Permissions can be [assigned](#configuring-global-permissions-for-individual-users) to an individual user.
You can [assign a role to everyone in the group at the same time](#configuring-global-permissions-for-groups) if the external authentication provider supports groups.
## Custom Global Permissions
Using custom permissions is convenient for providing users with narrow or specialized access to Rancher.
When a user from an [external authentication source](../authentication-config/authentication-config.md) signs into Rancher for the first time, they're automatically assigned a set of global permissions (hereafter, permissions). By default, after a user logs in for the first time, they are created as a user and assigned the default `user` permission. The standard `user` permission allows users to login and create clusters.
However, in some organizations, these permissions may extend too much access. Rather than assigning users the default global permissions of `Administrator` or `Standard User`, you can assign them a more restrictive set of custom global permissions.
The default roles, Administrator and Standard User, each come with multiple global permissions built into them. The Administrator role includes all global permissions, while the default user role includes three global permissions: Create Clusters, Use Catalog Templates, and User Base, which is equivalent to the minimum permission to log in to Rancher. In other words, the custom global permissions are modularized so that if you want to change the default user role permissions, you can choose which subset of global permissions are included in the new default user role.
Administrators can enforce custom global permissions in multiple ways:
- [Changing the default permissions for new users](#configuring-default-global-permissions)
- [Configuring global permissions for individual users](#configuring-global-permissions-for-individual-users)
- [Configuring global permissions for groups](#configuring-global-permissions-for-groups)
### Custom Global Permissions Reference
The following table lists each custom global permission available and whether it is included in the default global permissions, `Administrator`, `Standard User` and `User-Base`.
| Custom Global Permission | Administrator | Standard User | User-Base |
| ---------------------------------- | ------------- | ------------- |-----------|
| Create Clusters | ✓ | ✓ | |
| Create RKE Templates | ✓ | ✓ | |
| Manage Authentication | ✓ | | |
| Manage Catalogs | ✓ | | |
| Manage Cluster Drivers | ✓ | | |
| Manage Node Drivers | ✓ | | |
| Manage PodSecurityPolicy Templates | ✓ | | |
| Manage Roles | ✓ | | |
| Manage Settings | ✓ | | |
| Manage Users | ✓ | | |
| Use Catalog Templates | ✓ | ✓ | |
| User-Base (Basic log-in access) | ✓ | ✓ | |
For details on which Kubernetes resources correspond to each global permission,
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Roles**.
1. If you click the name of an individual role, a table shows all of the operations and resources that are permitted by the role.
:::note Notes:
- Each permission listed above is comprised of multiple individual permissions not listed in the Rancher UI. For a full list of these permissions and the rules they are comprised of, access through the API at `/v3/globalRoles`.
- When viewing the resources associated with default roles created by Rancher, if there are multiple Kubernetes API resources on one line item, the resource will have `(Custom)` appended to it. These are not custom resources but just an indication that there are multiple Kubernetes API resources as one resource.
:::
### Configuring Default Global Permissions
If you want to restrict the default permissions for new users, you can remove the `user` permission as default role and then assign multiple individual permissions as default instead. Conversely, you can also add administrative permissions on top of a set of other standard permissions.
:::note
Default roles are only assigned to users added from an external authentication provider. For local users, you must explicitly assign global permissions when adding a user to Rancher. You can customize these global permissions when adding the user.
:::
To change the default global permissions that are assigned to external users upon their first log in, follow these steps:
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Roles**. On the **Roles** page, make sure the **Global** tab is selected.
1. Find the permissions set that you want to add or remove as a default. Then edit the permission by selecting **⋮ > Edit Config**.
1. If you want to add the permission as a default, Select **Yes: Default role for new users** and then click **Save**. If you want to remove a default permission, edit the permission and select **No**.
**Result:** The default global permissions are configured based on your changes. Permissions assigned to new users display a check in the **New User Default** column.
### Configuring Global Permissions for Individual Users
To configure permission for a user,
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Users**.
1. Go to the user whose access level you want to change and click **⋮ > Edit Config**.
1. In the **Global Permissions** and **Built-in** sections, check the boxes for each permission you want the user to have. If you have created roles from the **Roles** page, they will appear in the **Custom** section and you can choose from them as well.
1. Click **Save**.
**Result:** The user's global permissions have been updated.
### Configuring Global Permissions for Groups
If you have a group of individuals that need the same level of access in Rancher, it can save time to assign permissions to the entire group at once, so that the users in the group have the appropriate level of access the first time they sign into Rancher.
After you assign a custom global role to a group, the custom global role will be assigned to a user in the group when they log in to Rancher.
For existing users, the new permissions will take effect when the users log out of Rancher and back in again, or when an administrator [refreshes the group memberships.](#refreshing-group-memberships)
For new users, the new permissions take effect when the users log in to Rancher for the first time. New users from this group will receive the permissions from the custom global role in addition to the **New User Default** global permissions. By default, the **New User Default** permissions are equivalent to the **Standard User** global role, but the default permissions can be [configured.](#configuring-default-global-permissions)
If a user is removed from the external authentication provider group, they would lose their permissions from the custom global role that was assigned to the group. They would continue to have any remaining roles that were assigned to them, which would typically include the roles marked as **New User Default**. Rancher will remove the permissions that are associated with the group when the user logs out, or when an administrator [refreshes group memberships,](#refreshing-group-memberships) whichever comes first.
:::note Prerequisites:
You can only assign a global role to a group if:
* You have set up an [external authentication provider](../authentication-config/authentication-config.md#external-vs-local-authentication)
* The external authentication provider supports [user groups](../authentication-config/manage-users-and-groups.md)
* You have already set up at least one user group with the authentication provider
:::
To assign a custom global role to a group, follow these steps:
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Groups**.
1. Go to the group you want to assign a custom global role to and click **⋮ > Edit Config**.
1. In the **Global Permissions,** **Custom,** and/or **Built-in** sections, select the permissions that the group should have.
1. Click **Create**.
**Result:** The custom global role will take effect when the users in the group log into Rancher.
### Refreshing Group Memberships
When an administrator updates the global permissions for a group, the changes take effect for individual group members after they log out of Rancher and log in again.
To make the changes take effect immediately, an administrator or cluster owner can refresh group memberships.
An administrator might also want to refresh group memberships if a user is removed from a group in the external authentication service. In that case, the refresh makes Rancher aware that the user was removed from the group.
To refresh group memberships,
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Users**.
1. Click **Refresh Group Memberships**.
**Result:** Any changes to the group members' permissions will take effect.
@@ -36,7 +36,7 @@ You can lock roles in two contexts:
Cluster roles and project/namespace roles can be locked, but global roles cannot.
1. In the upper left corner, click **☰ > Users & Authentication**.
1. In the left navigation bar, click **Roles**.
1. In the left navigation bar, click **Role Templates**.
1. Go to the **Cluster** tab or the **Project/Namespaces** tab.
1. From the role that you want to lock (or unlock), select **⋮ > Edit Config**.
1. From the **Locked** option, choose the **Yes** or **No** radio button. Then click **Save**.
@@ -3,7 +3,7 @@ title: Managing Role-Based Access Control (RBAC)
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/manage-role-based-access-control-rbac"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac"/>
</head>
Within Rancher, each person authenticates as a _user_, which is a login that grants you access to Rancher. As mentioned in [Authentication](../authentication-config/authentication-config.md), users can either be local or external.
@@ -4,7 +4,7 @@ keywords: [rancher backup restore, rancher backup and restore, backup restore ra
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/backup-restore-and-disaster-recovery"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery"/>
</head>
In this section, you'll learn how to create backups of Rancher, how to restore Rancher from backup, and how to migrate Rancher to a new Kubernetes cluster.
@@ -91,10 +91,10 @@ A migration is performed by following [these steps.](migrate-rancher-to-new-clus
## Default Storage Location Configuration
Configure a storage location where all backups are saved by default. You will have the option to override this with each backup, but will be limited to using an S3-compatible or Minio object store.
Configure a default storage location for your backups. There are various configuration options, such as specifying an S3-compatible object store as the location for individual backups or choosing an existing `StorageClass` during installation of the `backup-restore-operator` Helm chart. You also have the option to override the configured storage location with each backup, but are limited to using an S3-compatible or Minio object store.
For information on configuring these options, refer to [this page.](../../../reference-guides/backup-restore-configuration/storage-configuration.md)
### Example values.yaml for the rancher-backup Helm Chart
### Example YAML File: Rancher Backup Helm Chart
The example [values.yaml file](../../../reference-guides/backup-restore-configuration/storage-configuration.md#example-valuesyaml-for-the-rancher-backup-helm-chart) can be used to configure the `rancher-backup` operator when the Helm CLI is used to install it.
The example [values.yaml file](../../../reference-guides/backup-restore-configuration/storage-configuration.md#example-yaml-file-rancher-backup-helm-chart) can be used to configure the `backup-restore-operator` when the Helm CLI is used to install it.
@@ -27,7 +27,8 @@ Since Rancher can be installed on any Kubernetes cluster, you can use this backu
### 1. Install the rancher-backup Helm chart
Install the [rancher-backup chart](https://github.com/rancher/backup-restore-operator/tags), using a version in the 2.x.x major version range:
Install the [`rancher-backup chart`](https://github.com/rancher/backup-restore-operator/tags):
1. Add the Helm repository:
@@ -36,13 +37,14 @@ Install the [rancher-backup chart](https://github.com/rancher/backup-restore-ope
helm repo update
```
1. Select and set `CHART_VERSION` variable with a 2.x.x rancher-backup release version:
1. Set a `CHART_VERSION` variable, selecting a `rancher-backup` chart version compatible with your version of Rancher. See the [support matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions), within the **Rancher Apps / Cluster Tools** section, to see which `rancher-backup` versions are supported:
```bash
helm search repo --versions rancher-charts/rancher-backup
CHART_VERSION=<2.x.x>
CHART_VERSION=<chart-version>
```
1. Install the charts:
```bash
helm install rancher-backup-crd rancher-charts/rancher-backup-crd -n cattle-resources-system --create-namespace --version $CHART_VERSION
helm install rancher-backup rancher-charts/rancher-backup -n cattle-resources-system --version $CHART_VERSION
@@ -50,7 +52,7 @@ Install the [rancher-backup chart](https://github.com/rancher/backup-restore-ope
:::note
The above assumes an environment with outbound connectivity to Docker Hub
The above assumes an environment with outbound connectivity to Docker Hub.
For an **air-gapped environment**, use the Helm value below to pull the `backup-restore-operator` image from your private registry when installing the rancher-backup Helm chart.
@@ -3,7 +3,7 @@ title: Deploying Applications across Clusters
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/deploy-apps-across-clusters"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/deploy-apps-across-clusters"/>
</head>
Rancher offers several ways to deploy applications across clusters, depending on version.
@@ -1,20 +1,48 @@
---
title: Helm Charts in Rancher
title: Helm Charts and Apps
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/helm-charts-in-rancher"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/helm-charts-in-rancher"/>
</head>
In this section, you'll learn how to manage Helm chart repositories and applications in Rancher. Helm chart repositories are managed using **Apps**. It uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Helm applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster.
In this section, you'll learn how to manage Helm chart repositories and apps in Rancher.
## How Helm Charts Work in Rancher
Helm chart repositories in Rancher are managed using **Apps**.
Rancher uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Kubernetes applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster.
### Catalogs, Apps, and the Rancher UI
[Rancher v2.4 and earlier](/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md), repositories of ready-to-deploy applications were called "catalogs". These repositories were managed through the **Catalogs** section of the UI.
Rancher v2.5 replaced the former catalog system with a new **Apps & Marketplace** feature.
Since Rancher v2.6.5, the **Apps & Marketplace** feature is named **Apps** in the UI.
### Versioning Scheme
The Rancher feature charts versioning scheme is centered around the major version of the charts and the `+up` annotation for upstream charts, where applicable.
**Major Version:** The major version of the charts is tied to Rancher minor versions. When you upgrade to a new Rancher minor version, you should ensure that all of your **Apps** charts are also upgraded to the correct release line for the chart.
**Major Version:** The major versions of feature charts are tied to particular minor versions of Rancher. When you upgrade to a new Rancher minor version, you should ensure that all of your feature charts are also upgraded to the correct release line for the chart.
**Feature Charts:**
**Charts based on upstream:** When you upgrade, make sure that the upstream chart version is compatible with your Rancher version. The `+up` annotation for the chart indicates which upstream version the Rancher chart is tracking. For example, `100.x.x+up16.6.0` for Monitoring tracks upstream kube-prometheus-stack `16.6.0` with some additional Rancher patches.
When upgrading Rancher versions, don't downgrade the version of the chart that you are using. For example, if you are using a version of Monitoring that is later than `16.6.0` in Rancher v2.5, you shouldn't upgrade to `100.x.x+up16.6.0`. Instead, you should upgrade to the appropriate version in the next release.
#### Prerelease Versions
Prereleases adhere to [the specification](https://semver.org/#spec-item-9) defined by [Semantic Versioning 2.0.0](https://semver.org/). For example, a Helm chart with a version of `0.1.3-dev.12ab4f` is considered a prerelease. Prerelease versions are not displayed by default and must be configured to do so.
To display prerelease versions:
1. Click on your user avatar in the upper right corner.
1. Click **Preferences**.
1. Under **Helm Charts**, select **Include Prerelease Versions**.
### Feature Charts
| **Name** | **Supported Minimum Version** | **Supported Maximum Version** |
| ---------------- | ------------ | ------------ |
@@ -35,51 +63,82 @@ The Rancher feature charts versioning scheme is centered around the major versio
| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 |
| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 |
<br/>
**Charts based on upstream:** For charts that are based on upstreams, the +up annotation should inform you of what upstream version the Rancher chart is tracking. Check the upstream version compatibility with Rancher during upgrades also.
## Access Charts
- As an example, `100.x.x+up16.6.0` for Monitoring tracks upstream kube-prometheus-stack `16.6.0` with some Rancher patches added to it.
The **Charts** page contains all Rancher, Partner, and Custom charts. You can filter charts by selecting the left-most dropdown menu:
- On upgrades, ensure that you are not downgrading the version of the chart that you are using. For example, if you are using a version of Monitoring > `16.6.0` in Rancher 2.5, you should not upgrade to `100.x.x+up16.6.0`. Instead, you should upgrade to the appropriate version in the next release.
* Rancher tools such as Logging or Monitoring are listed under the **Rancher** label.
* Partner charts are under the **Partners** label.
* Custom charts are listed under the name of their respective repository.
### Prerelease Versions
Prereleases adhere to [the specification](https://semver.org/#spec-item-9) defined by [Semantic Versioning 2.0.0](https://semver.org/). For example, a Helm chart with a version of `0.1.3-dev.12ab4f` is considered a prerelease. Prerelease versions are not displayed by default and must be configured to do so.
To display prerelease versions:
1. Click on your user avatar in the upper right corner.
1. Click **Preferences**.
1. Under **Helm Charts**, select **Include Prerelease Versions**.
### Charts
From the top-left menu select _"Apps"_ and you will be taken to the Charts page.
The charts page contains all Rancher, Partner, and Custom Charts.
* Rancher tools such as Logging or Monitoring are included under the Rancher label
* Partner charts reside under the Partners label
* Custom charts will show up under the name of the repository
All three types are deployed and managed in the same way.
All three types of charts are deployed and managed in the same way.
:::note
Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) should continue to be managed only by the Cluster Manager, and apps managed with <b>Apps</b> in the new UI must be managed only by <b>Apps</b>.
Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) continue to be managed only by the Cluster Manager, and apps managed with **Apps** in the new UI must be managed only by **Apps**.
:::
### Repositories
To access the **Charts** page:
From the left sidebar select _"Repositories"_.
1. Click **☰ > Cluster Management**.
1. Find the name of the cluster whose charts you want to access. Click **Explore** at the end of the cluster's row.
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Charts**.
These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository.
## Manage Repositories
To add a private CA for Helm Chart repositories:
The **Repositories** page lists your Helm repositories. These include traditional Helm endpoints which have an index.yaml, and Git repositories that are cloned and point to a specific branch. To use custom charts, add your repository here. After you add a repository, you can access custom charts in the **Charts** page, listed under the name of the repository.
- **HTTP-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:<br/>
```
To access the **Repositories** page:
1. Click **☰ > Cluster Management**.
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
### Add Custom Git Repositories
To add a custom Git repository that contains your Helm charts or cluster template definitions:
1. Click **☰ > Cluster Management**.
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
1. Click **Create**.
1. Select the target, **Git repository containing Helm chart...**.
1. You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from whichever branch the repo owner has set as the default. Usually, the default branch is named either `main` or `master`.
1. Click **Create** to add the repository.
After you add a chart repository to Rancher, it becomes available immediately.
### Add Custom Helm Chart Repositories
You can add your own Helm chart repositories to serve chart packages to Rancher. You can use any HTTP server, as long as the server can respond to GET requests and serve YAML files and tar archives.
For more information on Helm chart repositories, see the [official Helm docs](https://helm.sh/docs/topics/chart_repository/).
To add a custom Helm chart repository to Rancher:
1. Click **☰ > Cluster Management**.
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
1. Click **Create**.
1. Select the target, **http(s) URL to an index generated by Helm**.
1. Enter a repo name and the index URL address of the chart repository.
1. Click **Create** to add the repository.
### Add Private Git/Helm Chart Repositories
You can add private Git or Helm chart repositories with SSH key credentials or an HTTP basic auth secret, such as a username and password.
### Add a Private CA to Repositories
To add a private CA to Helm chart repositories, you must add a base64 encoded copy of the CA certificate in DER format to the `spec.caBundle field` of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Instructions are the same for both Git-based and HTTP-based repositories:
1. Click **☰**. Under **Explore Cluster** in the left navigation menu, select a cluster.
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
1. Find the row associated with the Git-based or HTTP-based repository you want to add a private CA to, and click **⋮ > Edit YAML**.
1. Set the `caBundle` value, as in the following example:
```yaml
[...]
spec:
caBundle:
@@ -87,25 +146,13 @@ To add a private CA for Helm Chart repositories:
...
nDxZ/tNXt/WPJr/PgEB3hQdInDWYMg7vGO0Oz00G5kWg0sJ0ZTSoA10ZwdjIdGEeKlj1NlPyAqpQ+uDnmx6DW+zqfYtLnc/g6GuLLVPamraqN+gyU8CHwAWPNjZonFN9Vpg0PIk1I2zuOc4EHifoTAXSpnjfzfyAxCaZsnTptimlPFJJqAMj+FfDArGmr4=
[...]
```
- **Git-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:<br/>
```
[...]
spec:
caBundle:
MIIFXzCCA0egAwIBAgIUWNy8WrvSkgNzV0zdWRP79j9cVcEwDQYJKoZIhvcNAQELBQAwPzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRQwEgYDVQQKDAtNeU9yZywgSW5jLjENMAsGA1UEAwwEcm9vdDAeFw0yMTEyMTQwODMyMTdaFw0yNDEwMDMwODMyMT
...
nDxZ/tNXt/WPJr/PgEB3hQdInDWYMg7vGO0Oz00G5kWg0sJ0ZTSoA10ZwdjIdGEeKlj1NlPyAqpQ+uDnmx6DW+zqfYtLnc/g6GuLLVPamraqN+gyU8CHwAWPNjZonFN9Vpg0PIk1I2zuOc4EHifoTAXSpnjfzfyAxCaZsnTptimlPFJJqAMj+FfDArGmr4=
[...]
```
```
:::note Helm chart repositories with authentication
The Repo.Spec contains a `disableSameOriginCheck` value that allows users to bypass the same origin checks, sending the repository Authentication information as a Basic Auth Header with all API calls. This is not recommended but can be used as a temporary solution in cases of non-standard Helm chart repositories such as those that have redirects to a different origin URL.
The Repo.Spec contains a `disableSameOriginCheck` value. This value allows you to bypass the same origin checks, sending the repository Authentication information as a Basic Auth Header with all API calls. This is not recommended but can be used as a temporary solution in cases of non-standard Helm chart repositories, such as those that have redirects to a different origin URL.
To use this feature for an existing Helm chart repository, click <b>⋮ > Edit YAML</b>. On the `spec` portion of the YAML file, add `disableSameOriginCheck` and set it to `true`.
To use this feature for an existing Helm chart repository, follow previous steps up to edit the YAML. On the `spec` portion of the YAML file, add `disableSameOriginCheck` and set it to `true`.
```yaml
[...]
@@ -120,37 +167,51 @@ spec:
Only Helm 3 compatible charts are supported.
## Deploy and Upgrade Charts
### Deployment and Upgrades
To install and deploy a chart:
From the _"Charts"_ tab select a Chart to install. Rancher and Partner charts may have extra configurations available through custom pages or questions.yaml files, but all chart installations can modify the values.yaml and other basic settings. Once you click install, a Helm operation job is deployed, and the console for the job is displayed.
1. Click **☰ > Cluster Management**.
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Charts**.
1. Select a chart, and click **Install**.
To view all recent changes, go to the _"Recent Operations"_ tab. From there you can view the call that was made, conditions, events, and logs.
Rancher and Partner charts may have extra configurations available through custom pages or questions.yaml files. However, all chart installations can modify the values.yaml and other basic settings. After you click **Install**, a Helm operation job is deployed, and the console for the job is displayed.
After installing a chart, you can find it in the _"Installed Apps"_ tab. In this section you can upgrade or delete the installation, and see further details. When choosing to upgrade, the form and values presented will be the same as installation.
To view all recent changes, click **Apps > Recent Operations** in the left navigation menu. From there you can view the calls, conditions, events, and logs.
Most Rancher tools have additional pages located in the toolbar below the _"Apps"_ section to help manage and use the features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information.
After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during inital installation.
Most Rancher tools have additional pages located in the toolbar below the **Apps** section to help manage and use the features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information.
:::caution
If you are upgrading your chart using _"Customize Helm options before upgrade"_ , please be aware that using the _"--force"_ option may result in errors if your chart has immutable fields. This is because some objects in Kubernetes cannot be changed once they are created. To ensure you do not get this error you can:
If you are upgrading your chart using **Customize Helm options before upgrade**, and your chart contains immutable fields, using the `--force` option may result in errors. This is because some objects in Kubernetes can't be changed after they're created. To prevent this error:
* use the default upgrade option ( i.e do not use _"--force"_ option )
* uninstall the existing chart and install the upgraded chart
* delete the resources with immutable fields from the cluster before performing the _"--force"_ upgrade
* Use the default upgrade option (i.e don't use `--force`).
* Uninstall the existing chart and install the upgraded chart.
* Delete the resources with immutable fields from the cluster before performing a forced upgrade.
:::
#### Legacy Apps
### Legacy Apps
The upgrade button has been removed for legacy apps from the **Apps > Installed Apps** page.
The upgrade button isn't available for legacy apps on the **Apps > Installed Apps** page.
If you have a legacy app installed and want to upgrade it:
If you want to upgrade an installed legacy app, the [legacy feature flag](../../advanced-user-guides/enable-experimental-features/enable-experimental-features.md) must be turned on. This flag is automatically turned on if you had a legacy app already running before you upgraded Rancher.
- The legacy [feature flag](../../advanced-user-guides/enable-experimental-features/enable-experimental-features.md) must be turned on (if it's not turned on automatically because of having a legacy app before upgrading)
- You can upgrade the app from cluster explorer, from the left nav section **Legacy > Project > Apps**
- For multi-cluster apps, you can go to **≡ > Multi-cluster Apps** and upgrade the app from there
1. Enable the [legacy feature flag](../../advanced-user-guides/enable-experimental-features/enable-experimental-features.md), if it isn't enabled already.
1. Click **☰ > Cluster Management**.
1. Find the name of the cluster whose apps you want to access. Click **Explore** at the end of the cluster's row.
1. Click **Legacy > Project > Apps**.
### Limitations
If you don't see **Apps** listed under **Legacy > Project**, click the project/namespace search bar in the top navigation and select the relevant project from the dropdown menu.
Dashboard apps or Rancher feature charts **cannot** be installed using the Rancher CLI.
To upgrade legacy multi-cluster apps:
1. Click **☰**.
1. Under **Legacy Apps**, click **Multi-cluster Apps**.
## Limitations
Dashboard apps or Rancher feature charts can't be installed using the Rancher CLI.
@@ -3,7 +3,7 @@ title: Don't have infrastructure for your Kubernetes cluster? Try one of these t
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/infrastructure-setup"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/infrastructure-setup"/>
</head>
To set up infrastructure for a high-availability K3s Kubernetes cluster with an external DB, refer to [this page.](ha-k3s-kubernetes-cluster.md)
@@ -3,7 +3,7 @@ title: "Don't have a Kubernetes cluster? Try one of these tutorials."
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/kubernetes-cluster-setup"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-cluster-setup"/>
</head>
This section contains information on how to install a Kubernetes cluster that the Rancher server can be installed on.
@@ -3,7 +3,7 @@ title: Checklist for Production-Ready Clusters
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/checklist-for-production-ready-clusters"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters"/>
</head>
In this section, we recommend best practices for creating the production-ready Kubernetes clusters that will run your apps and services.
@@ -4,7 +4,7 @@ description: Provisioning Kubernetes Clusters
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/kubernetes-clusters-in-rancher-setup"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup"/>
</head>
Rancher simplifies the creation of clusters by allowing you to create them through the Rancher UI rather than more complex alternatives. Rancher provides multiple options for launching a cluster. Use the option that best fits your use case.
@@ -6,13 +6,13 @@ title: Migrating Amazon In-tree to Out-of-tree
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-amazon"/>
</head>
Kubernetes is moving away from maintaining cloud providers in-tree. In Kubernetes 1.27 and later, the in-tree cloud providers have been removed.
Kubernetes is moving away from maintaining cloud providers in-tree. In Kubernetes v1.27 and later, the in-tree cloud providers have been removed. The Rancher UI allows you to upgrade to Kubernetes v1.27 when you migrate from an in-tree to out-of-tree provider.
You can migrate from an in-tree to an out-of-tree AWS cloud provider on Kubernetes 1.26 and earlier. All existing clusters must migrate prior to upgrading to v1.27 in order to stay functional.
However, if you're performing a manual migration, existing clusters must upgrade to Kubernetes v1.27 after you migrate in order to remain functional.
To migrate from the in-tree cloud provider to the out-of-tree AWS cloud provider, you must stop the existing cluster's kube controller manager and install the AWS cloud controller manager. There are many ways to do this. Refer to the official AWS documentation on the [external cloud controller manager](https://cloud-provider-aws.sigs.k8s.io/getting_started/) for details.
If it's acceptable to have some downtime, you can [switch to an external cloud provider](../set-up-cloud-providers/amazon.md#using-the-out-of-tree-aws-cloud-provider), which removes in-tree components and then deploy charts to install the AWS cloud controller manager.
If it's acceptable to have some downtime during migration, follow the instructions to [set up an external cloud provider](../set-up-cloud-providers/amazon.md#using-the-out-of-tree-aws-cloud-provider). These instructions outline how to configure the out-of-tree cloud provider for a newly provisioned cluster. During set up, there will be some downtime, as there is a time gap between when the old cloud provider stops running and when the new cloud provider starts to run.
If your setup can't tolerate any control plane downtime, you must enable leader migration. This facilitates a smooth transition from the controllers in the kube controller manager to their counterparts in the cloud controller manager. Refer to the official AWS documentation on [Using leader migration](https://cloud-provider-aws.sigs.k8s.io/getting_started/) for more details.
@@ -52,7 +52,7 @@ spec:
2. Cordon control plane nodes so that AWS cloud controller pods run on nodes only after upgrading to the external cloud provider:
```shell
kubectl cordon -l "node-role.kubernetes.io/controlplane=true"
kubectl cordon -l "node-role.kubernetes.io/control-plane=true"
```
3. To install the AWS cloud controller manager with leader migration enabled, follow Steps 1-3 for [deploying the cloud controller manager chart](../set-up-cloud-providers/amazon.md#using-the-out-of-tree-aws-cloud-provider). From Kubernetes 1.22 onwards, the kube-controller-manager will utilize a default configuration which will satisfy the controller-to-manager migration. Update container args of the `aws-cloud-controller-manager` under `spec.rkeConfig.additionalManifest` to enable leader migration:
@@ -352,9 +352,9 @@ tolerations:
value: 'true'
- effect: NoSchedule
value: 'true'
key: node-role.kubernetes.io/controlplane
key: node-role.kubernetes.io/control-plane
nodeSelector:
node-role.kubernetes.io/controlplane: 'true'
node-role.kubernetes.io/control-plane: 'true'
args:
- --configure-cloud-routes=false
- --use-service-account-credentials=true
@@ -639,7 +639,7 @@ kubectl rollout status daemonset -n kube-system aws-cloud-controller-manager
- get
```
9. Rancher-provisioned RKE nodes are tainted `node-role.kubernetes.io/controlplane`. Update tolerations and the nodeSelector:
9. Rancher-provisioned RKE2 nodes are tainted `node-role.kubernetes.io/control-plane`. Update tolerations and the nodeSelector:
```yaml
tolerations:
@@ -648,13 +648,13 @@ tolerations:
value: 'true'
- effect: NoSchedule
value: 'true'
key: node-role.kubernetes.io/controlplane
key: node-role.kubernetes.io/control-plane
```
```yaml
nodeSelector:
node-role.kubernetes.io/controlplane: 'true'
node-role.kubernetes.io/control-plane: 'true'
```
:::note
@@ -663,7 +663,7 @@ There's currently a [known issue](https://github.com/rancher/dashboard/issues/92
```yaml
nodeSelector:
node-role.kubernetes.io/controlplane: 'true'
node-role.kubernetes.io/control-plane: 'true'
```
:::
@@ -3,7 +3,7 @@ title: Setting up Cloud Providers
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/set-up-cloud-providers"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers"/>
</head>
A _cloud provider_ is a module in Kubernetes that provides an interface for managing nodes, load balancers, and networking routes.
@@ -3,7 +3,7 @@ title: Setting up Clusters from Hosted Kubernetes Providers
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers"/>
</head>
In this scenario, Rancher does not provision Kubernetes because it is installed by providers such as Google Kubernetes Engine (GKE), Amazon Elastic Container Service for Kubernetes, or Azure Kubernetes Service.
@@ -3,7 +3,7 @@ title: Launching Kubernetes on Windows Clusters
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/use-windows-clusters"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters"/>
</head>
When provisioning a [custom cluster](../../../../reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md) using Rancher, Rancher uses RKE (the Rancher Kubernetes Engine) to install Kubernetes on your existing nodes.
@@ -4,7 +4,7 @@ description: Learn about the horizontal pod autoscaler (HPA). How to manage HPAs
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/horizontal-pod-autoscaler"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler"/>
</head>
The [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) (HPA) is a Kubernetes feature that allows you to configure your cluster to automatically scale the services it's running up or down.
@@ -3,7 +3,7 @@ title: Kubernetes Resources
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/kubernetes-resources-setup"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-resources-setup"/>
</head>
You can view and manipulate all of the custom resources and CRDs in a Kubernetes cluster from the Rancher UI.
@@ -4,7 +4,7 @@ description: Learn how you can set up load balancers and ingress controllers to
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/load-balancer-and-ingress-controller"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller"/>
</head>
Within Rancher, you can set up load balancers and ingress controllers to redirect service requests.
@@ -4,7 +4,7 @@ description: "Learn about the two constructs with which you can build any comple
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/workloads-and-pods"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods"/>
</head>
You can build any complex containerized application in Kubernetes using two basic constructs: pods and workloads. Once you build an application, you can expose it for access either within the same cluster or on the Internet using a third construct: services.
@@ -3,7 +3,7 @@ title: Launching Kubernetes with Rancher
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/launch-kubernetes-with-rancher"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/launch-kubernetes-with-rancher"/>
</head>
You can have Rancher launch a Kubernetes cluster using any nodes you want. When Rancher deploys Kubernetes onto these nodes, you can choose between [Rancher Kubernetes Engine](https://rancher.com/docs/rke/latest/en/) (RKE) or [RKE2](https://docs.rke2.io) distributions. Rancher can launch Kubernetes on any computers, including:
@@ -4,7 +4,7 @@ description: Use Rancher to create a Nutanix AOS (AHV) cluster. It may consist o
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/nutanix"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix"/>
</head>
[Nutanix Acropolis Operating System](https://www.nutanix.com/products/acropolis) (Nutanix AOS) is an operating system for the Nutanix hyper-converged infrastructure platform. AOS comes with a built-in hypervisor called [Acropolis Hypervisor](https://www.nutanix.com/products/ahv), or AHV. By using Rancher with Nutanix AOS (AHV), you can bring cloud operations on-premises.
@@ -3,7 +3,7 @@ title: Launching Kubernetes on New Nodes in an Infrastructure Provider
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/use-new-nodes-in-an-infra-provider"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider"/>
</head>
When you create an RKE or RKE2 cluster using a node template in Rancher, each resulting node pool is shown in a new **Machine Pools** tab. You can see the machine pools by doing the following:
@@ -4,7 +4,7 @@ description: Use Rancher to create a vSphere cluster. It may consist of groups o
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/vsphere"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere"/>
</head>
import YouTube from '@site/src/components/YouTube'
@@ -3,7 +3,7 @@ title: Cluster Access
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/access-clusters"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/manage-clusters/access-clusters"/>
</head>
This section is about what tools can be used to access clusters managed by Rancher.
@@ -4,7 +4,7 @@ description: "Learn about the two ways with which you can create persistent stor
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/create-kubernetes-persistent-storage"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage"/>
</head>
When deploying an application that needs to retain data, you'll need to create persistent storage. Persistent storage allows you to store application data external from the pod running your application. This storage practice allows you to maintain application data, even if the application's pod fails.
@@ -18,7 +18,7 @@ In clusters that store data on GlusterFS volumes, you may experience an issue wh
- The `systemd-run` binary needs to be compatible with Debian OS on which the hyperkube image is based (this can be checked using the following command on each cluster node, replacing the image tag with the Kubernetes version you want to use)
```
docker run -v /usr/bin/systemd-run:/usr/bin/systemd-run --entrypoint /usr/bin/systemd-run rancher/hyperkube:v1.16.2-rancher1 --version
docker run -v /usr/bin/systemd-run:/usr/bin/systemd-run -v /usr/lib/x86_64-linux-gnu/libcrypto.so.3:/usr/lib/x86_64-linux-gnu/libcrypto.so.3 -v /lib/systemd/libsystemd-shared-249.so:/lib/systemd/libsystemd-shared-249.so --entrypoint /usr/bin/systemd-run rancher/hyperkube:v1.26.14-rancher1 --version
```
:::caution
@@ -32,6 +32,8 @@ services:
kubelet:
extra_binds:
- "/usr/bin/systemd-run:/usr/bin/systemd-run"
- "/usr/lib/x86_64-linux-gnu/libcrypto.so.3:/usr/lib/x86_64-linux-gnu/libcrypto.so.3"
- "/lib/systemd/libsystemd-shared-249.so:/lib/systemd/libsystemd-shared-249.so"
```
After the cluster has finished provisioning, you can check the `kubelet` container logging to see if the functionality is activated by looking for the following logline:
@@ -3,7 +3,7 @@ title: Cluster Autoscaler
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/install-cluster-autoscaler"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/manage-clusters/install-cluster-autoscaler"/>
</head>
In this section, you'll learn how to install and use the [Kubernetes cluster-autoscaler](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/) on Rancher custom clusters using AWS EC2 Auto Scaling Groups.
@@ -3,7 +3,7 @@ title: Cluster Administration
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/manage-clusters"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/manage-clusters"/>
</head>
After you provision a cluster in Rancher, you can begin using powerful Kubernetes features to deploy and scale your containerized applications in development, testing, or production environments.
@@ -3,7 +3,7 @@ title: Provisioning Storage Examples
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/provisioning-storage-examples"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples"/>
</head>
Rancher supports persistent storage with a variety of volume plugins. However, before you use any of these plugins to bind persistent storage to your workloads, you have to configure the storage itself, whether its a cloud-based solution from a service-provider or an on-prem solution that you manage yourself.
@@ -3,7 +3,7 @@ title: New User Guides
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/new-user-guides"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides"/>
</head>
New user guides, also known as **tutorials**, describe practical steps for users to follow in order to complete some concrete action. These docs are known as "learning-oriented" docs in which users learn by "doing".
@@ -3,7 +3,7 @@ title: CIS Scans
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/cis-scans"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/cis-scans"/>
</head>
Rancher can run a security scan to check whether Kubernetes is deployed according to security best practices as defined in the CIS Kubernetes Benchmark. The CIS scans can run on any Kubernetes cluster, including hosted Kubernetes providers such as EKS, AKS, and GKE.
@@ -3,7 +3,7 @@ title: AWS Marketplace Integration
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/aws-cloud-marketplace"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace"/>
</head>
## Overview
@@ -20,6 +20,9 @@ In order to deploy and run the adapter successfully, you need to ensure its vers
| Rancher Version | Adapter Version |
|-----------------|:----------------:|
| v2.8.0 | v103.0.0+up3.0.0 |
| v2.8.1 | v103.0.0+up3.0.0 |
| v2.8.2 | v103.0.0+up3.0.0 |
| v2.8.3 | v103.0.1+up3.0.1 |
### 1. Gain Access to the Local Cluster
@@ -3,7 +3,7 @@ title: Cloud Marketplace Integration
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/cloud-marketplace"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/cloud-marketplace"/>
</head>
Rancher offers integration with cloud marketplaces to easily purchase support for installations hosted on certain cloud providers. In addition, this integration also provides the ability to generate a supportconfig bundle which can be provided to rancher support.
@@ -2,6 +2,10 @@
title: Operating System Management with Elemental
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/elemental"/>
</head>
Elemental enables cloud-native host management. Elemental allows you to onboard any machine in any location, whether its in a datacenter or on the edge, and integrate them seamlessly into Kubernetes while managing your workflows (e.g., OS updates).
## Elemental with Rancher
@@ -1,22 +0,0 @@
---
title: Application Development Engine with Epinio
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/epinio"/>
</head>
Epinio is a Kubernetes-based Application Development Platform. It helps operators and developers collaborate without conflict, and accelerates the development process. With Epinio, teams can move from application sources to a live URL in a single step.
## Epinio with Rancher
Epinio's integration with Rancher gives developers a jump start, without having to deal with the installation process or configuration. You can install Epinio directly from the Rancher UI's Apps page.
## Epinio with Rancher Prime
Rancher Prime customers can expect better integration of Epinio with other areas in the Rancher ecosystem such as:
- Better integration with Rancher authentication.
- Integration with Neuvector and Kubewarden.
- Custom Helm chart templates with preset annotations to seamlessly integrate with monitoring and other key tools.
- Improved service marketplace.
@@ -2,6 +2,10 @@
title: Architecture
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/fleet/architecture"/>
</head>
Fleet can manage deployments from git of raw Kubernetes YAML, Helm charts, or Kustomize or any combination of the three. Regardless of the source, all resources are dynamically turned into Helm charts, and Helm is used as the engine to deploy everything in the cluster. This gives you a high degree of control, consistency, and auditability. Fleet focuses not only on the ability to scale, but to give one a high degree of control and visibility to exactly what is installed on the cluster.
![Architecture](/img/fleet-architecture.svg)
@@ -2,6 +2,10 @@
title: Continuous Delivery with Fleet
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/fleet"/>
</head>
Fleet orchestrates and manages the continuous delivery of applications through the supply chain for fleets of clusters. Fleet organizes the supply chain to help teams deliver with confidence and trust in a timely manner using GitOps as a safe operating model.
## Fleet with Rancher
@@ -2,6 +2,10 @@
title: Overview
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/fleet/overview"/>
</head>
Continuous Delivery with Fleet is GitOps at scale. Fleet is designed to manage up to a million clusters. It’s also lightweight enough that it works great for a [single cluster](https://fleet.rancher.io/installation#default-install) too, but it really shines when you get to a [large scale](https://fleet.rancher.io/installation#configuration-for-multi-cluster). By large scale we mean either a lot of clusters, a lot of deployments, or a lot of teams in a single organization.
Fleet is a separate project from Rancher, and can be installed on any Kubernetes cluster with Helm.
@@ -2,6 +2,10 @@
title: Using Fleet Behind a Proxy
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/fleet/use-fleet-behind-a-proxy"/>
</head>
In this section, you'll learn how to enable Fleet in a setup that has a Rancher server with a public IP a Kubernetes cluster that has no public IP, but is configured to use a proxy.
Rancher does not establish connections with registered downstream clusters. The Rancher agent deployed on the downstream cluster must be able to establish the connection with Rancher.
@@ -2,6 +2,10 @@
title: Windows Support
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/fleet/windows-support"/>
</head>
Prior to Rancher v2.5.6, the `agent` did not have native Windows manifests on downstream clusters with Windows nodes. This would result in a failing `agent` pod for the cluster.
If you are upgrading from an older version of Rancher to v2.5.6+, you can deploy a working `agent` with the following workflow *in the downstream cluster*:
@@ -2,6 +2,10 @@
title: Virtualization on Kubernetes with Harvester
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/harvester"/>
</head>
## Harvester
Introduced in Rancher v2.6.1, Harvester is an open-source hyper-converged infrastructure (HCI) software built on Kubernetes. Harvester installs on bare metal servers and provides integrated virtualization and distributed storage capabilities. Although Harvester operates using Kubernetes, it does not require knowledge of Kubernetes concepts, making it more user-friendly.
@@ -2,6 +2,10 @@
title: Overview
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/harvester/overview"/>
</head>
Introduced in Rancher v2.6.1, [Harvester](https://docs.harvesterhci.io/) is an open-source hyper-converged infrastructure (HCI) software built on Kubernetes. Harvester installs on bare metal servers and provides integrated virtualization and distributed storage capabilities. Although Harvester operates using Kubernetes, it does not require users to know Kubernetes concepts, making it a more user-friendly application.
### Feature Flag
@@ -1,17 +1,13 @@
---
title: Integrations in Rancher
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher"/>
</head>
import {Card, CardSection} from '@site/src/components/CardComponents';
import {
ReadingModeMobileRegular,
QuestionRegular,
ArrowUpRegular,
PlayRegular,
FlowchartRegular,
RocketRegular
} from '@fluentui/react-icons';
import { FaAws, FaGoogle, FaCloud, FaServer, faGear } from "react-icons/fa6";
import HarvesterIcon from '@site/static/img/harvester_logo_horizontal.svg';
import {RocketRegular} from '@fluentui/react-icons';
Prime is the Rancher ecosystem’s enterprise offering, with additional security, extended lifecycles, and access to Prime-exclusive documentation. Rancher Prime installation assets are hosted on a trusted SUSE registry, owned and managed by Rancher. The trusted Prime registry includes only stable releases that have been community-tested.
@@ -47,10 +43,6 @@ To learn more and get started with Rancher Prime, please visit [this page](https
title="Operating System Management with Elemental"
to="./integrations-in-rancher/elemental"
/>
<Card
title="Observability with Opni"
to="./integrations-in-rancher/opni"
/>
<Card
title="Continuous Delivery with Fleet"
to="./integrations-in-rancher/fleet"
@@ -59,8 +51,4 @@ To learn more and get started with Rancher Prime, please visit [this page](https
title="Kubernetes on the Desktop"
to="./integrations-in-rancher/rancher-desktop"
/>
<Card
title="Application Development Engine with Epinio"
to="./integrations-in-rancher/epinio"
/>
</CardSection>

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