Commit Graph

94 Commits

Author SHA1 Message Date
Kinara Shah
f044c8d48a [2.9.0] add external cloud provider docs for azure (#1369)
* add external cloud provider docs for azure

* address review comments

* update2 to address review comments

* add csi info

* address review comments and fix nodeSelector for rke1 helm cli

* add info for 1.29 in migration note

* address review comments

* Apply 64f6d197..d4262bd5 (add external cloud provider docs for azure) to /v2.9

---------

Co-authored-by: Billy Tat <btat@suse.com>
2024-07-31 17:02:42 -07:00
Marty Hernandez Avedon
65611d53d3 [2.9.0] #1151 Add documentation for OCI feature in Apps & Marketplace Section (#1171)
* 1151 Add documentation for OCI feature in Apps & Marketplace Section

* rename file, edit intro, add canonical link

* edited refresh instructions

* edited update instructions

* edited delete instructions

* initial attempt at add an oci registry

* completed edit of first section, made misc revisions to other text

* escape angle brackets

* moved file

* added edited text of helm-charts-in-rancher from #1320

* instructions updated to sync with #1320

* updated with suggestions from review

* more edits

* more suggestions from reviews

* most changes addressed except line 101

* line 101 rate limiting addressed

* Apply suggestions from code review

Co-authored-by: Diogo Souza <diogo.souza@suse.com>
Co-authored-by: Sakala Venkata Krishna Rohit <rohitsakala@gmail.com>

* Apply suggestions from code review

Co-authored-by: Diogo Souza <diogo.souza@suse.com>

* Apply suggestions from code review

Co-authored-by: Sakala Venkata Krishna Rohit <rohitsakala@gmail.com>

* rename

* clarified what triggers the exp backoff

* edit suggestions on clarifications

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* sidebar for v2.9

* experimental feature caution

* ported to docs/

* removed slashes as they were displaying

* using literals to get around annoying confusion around how to treat slashes

* Apply suggestions from code review

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

* revised caution box

* drop the yet

* rm'd 2 instances of 'rate-limiting'

* added link to limitations section

* rm'd bit that begs the question about other options

* Apply suggestions from code review

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

* Apply suggestions from code review

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

---------

Co-authored-by: Diogo Souza <diogo.souza@suse.com>
Co-authored-by: Sakala Venkata Krishna Rohit <rohitsakala@gmail.com>
Co-authored-by: Sunil Singh <sunil.singh@suse.com>
Co-authored-by: Billy Tat <btat@suse.com>
2024-07-31 16:26:38 -07:00
Marty Hernandez Avedon
4673195018 #778 graceful shutdown of vsphere vm (#1368)
* [2.9.0] 778 Graceful shutdown of vSphere VM

* rm'd placeholder from canonical link

* typo in tag

* versioning + sidebars

* renamed files

* capitalization of vSphere

* spacing

* sidebar files

* rm'd duplicate files

* canonical links

* retitle, update instructions

* upddated chart in /node-template-configuration/vsphere

* note on imported clusters + revise wording around node templates

* fix broken link

* another typo

* versioning
2024-07-10 14:40:59 -04:00
Marty Hernandez Avedon
bab236b0a2 User Retention Feature for Security Release (#1343)
* SURE-8285 Document user retention feature

* fixing changes for global-configuration.md

* versioning plus the enable user authentication page

* Apply suggestions from code review

Co-authored-by: Andy Pitcher <andy.pitcher@suse.com>
Co-authored-by: Peter Matseykanets <peterm@mail.ru>
Co-authored-by: pdellamore <pietro.dellamore@suse.com>

* versioning, updates to descriptions of settings

* correcting versioning & rm v2.9 file

* one more correction

* if you can't remove the file, just make sure it's synced...

* Update docs/how-to-guides/advanced-user-guides/enable-user-retention.md

Co-authored-by: Peter Matseykanets <peterm@mail.ru>

* user-last-login-default

* more settings, more details about deletion behavior

* versioning

* more explanation for last-login

* revising blurb about disabling

* describing deletion behavior less direly

* corrected commands

* fix overwrite

* corrected commands

* updated description of zero value

* sidebars

* canonical link fixed

* rm'd parenthetical versioning remark

* heading capitalization, log in vs login

* more log in

* revise command, important box, enabling user retention section

* clarifying that some optional settings are also global

* rm patch mention from 2.9

* explain how to view settings for individual users

* Apply suggestions from code review

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

* duplicate word rm'd

---------

Co-authored-by: Andy Pitcher <andy.pitcher@suse.com>
Co-authored-by: Peter Matseykanets <peterm@mail.ru>
Co-authored-by: pdellamore <pietro.dellamore@suse.com>
Co-authored-by: Billy Tat <btat@suse.com>
2024-06-17 18:09:40 -04:00
Marty Hernandez Avedon
3c0a23c564 Glossary project part 1 (#1305)
* 358 Glossary project

initial draft + styling for definition tags

* added sidebar, revised styling

* redundant styling specification

* typo

* switching to shared-file/import structure so we have a single source file to update regardless of version

to achieve this, we needed to use an madx-code-block to give us a proper side navigation TOC

* updated styling + synonyms

* moved version back to before def as grouping it with the synonyms/related terms was visually confusing

added some definitions (catalogs, downstream cluster)

* styling

* filling out definitions icons through M

* build failed due to comment tag?

* rem'd comments as they were causing the build to fail due to unexpected token error

* revised some definitions

* revised wording and some formatting fixes

* syncing with list in PR

* versioning

* rm'd placeholders

* added Sunil's definitions

* tag

* Apply suggestions from code review

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

* rm'd placeholder

* rancher server definition + synonyms

* rm'd note from files to put in issue

* rm rancher enterprise, rke government

* + extension catalogs & registered cluster, syncing related terms, syncing language in definitions

* extra tag

* versioning info for rke2

* 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>

* updated RKE def

---------

Co-authored-by: Billy Tat <btat@suse.com>
Co-authored-by: Sunil Singh <sunil.singh@suse.com>
2024-05-30 13:30:36 -04:00
Sunil Singh
e31966c3af Merge branch 'rancher:main' into update-api-sidebar 2024-05-07 09:28:02 -07:00
Marty Hernandez Avedon
31c279bd42 #1240 Adding 'VMware' to mentions of vSphere in titles/headings (#1261)
* Adding 'VMware' to mentions of vSphere in titles/headings

* fix bad links

* vSphere stragglers

* versioning
2024-05-06 15:12:01 -04:00
Marty Hernandez Avedon
6ccd0b7b6c Syncing sidebar with page titles and disambiguating brief titles (#1197)
* Syncing sidebar labels with page titles

Deploying Rancher Server: Update sidebar label to match title

* Installing/Upgrading Rancher: Update title to match sidebar

This is a reference/hub page for install guides with no step-by-step instructions, so we're breaking the -ing rule to match other reference pages as well as the current sidebar label

* Cluster Access: Update title to match sidebar

* Kubernetes Persistent Storage: Volumes and Storage Classes - Update title to match sidebar

* Don't have a Kubernetes cluster? Try one of these tutorials: Update title to match sidebar and make old title intro to page

* Don't have infrastructure for your Kubernetes cluster? Try one of these tutorials: Update title to match sidebar and make old title intro to page

* versioning Deploying Rancher Server update to other sidebars

* Setting Up Kubernetes Clusters in Rancher: Update sidebars to match title and other sidebar labels

* capitalization

* Creating a vSphere Cluster: Update sidebar to match title and other labels

* Creating a Nutanix AOS Cluster: Update sidebar to match title and other labels

* Kubernetes Clusters in Rancher Setup across the board for title and sidebar, to match convention in sidebar

* Kubernetes Resources: Updated title to match sidebar and distinguish from identically-titled page in troubleshooting section

* The Horizontal Pod Autoscaler: Updated title to match sidebar

* Backups and Disaster Recovery: Update title to match sidebar

* typo fix

* revert to Installation and Upgrade of Rancher

fix typo in title: Create Kubernetes Persistent files

* fix typo in Persistent Storage files

* Configuration: Update title to match sidebar item Monitoring V2 Configuration Guides

* Setup Guide: Make both sidebar + title Istio Setup guides to match other sidebar labels

* Best Practices: Update both to Best Practice Guides

* Architecture: Update to match sidebar Rancher Architecture.

Note that there are multiple pages with identical titles, one is on Fleet and another on some other subject

* Architecture: Retitle logging-architecture.md files Logging Architecture

* Architecture: Retitle fleet/architecture.md files Fleet Architecture

* GKE Cluster Configuration: Update sidebar to match title and other labels in same section

* Security: Update both to Rancher Security Guides

* RKE Hardening Guide: Update to match sidebar

* typo

* RKE2 Hardening Guide: Update to match sidebar

* K3s Hardening Guide: Update to match sidebar

* various FAQ pages: Add FAQ to title to disambiguate content

* Cloud Native Storage with Longhorn: Versioning so older pages match current title

* rm international pages for now

* typo in metadata killed build

* updated sidebar: plural Istio Setup Guides

* updating Monitoring Config Guides title/label and distinguishing from similar section under References

* monitoring V2 config examples: rm 'V2'

* Kubernetes Cluster Setup > Setting up a Kubernetes Cluster for Rancher Server
2024-04-09 17:10:29 -04:00
Billy Tat
0f8d17de31 Merge pull request #1223 from btat/remove-multi-cluster-apps
Remove multi-cluster apps references
2024-04-09 10:54:26 -07:00
Sunil Singh
82fdb5d185 Merge pull request #1216 from sunilarjun/capi-integrations
Adding Rancher Turtles Overview - Integrations with Rancher Section
2024-04-09 08:02:09 -07:00
Billy Tat
b7997fcbac Merge branch 'main' into remove-multi-cluster-apps 2024-04-08 18:44:58 -07:00
Billy Tat
016670ac21 Update sidebars 2024-04-08 18:42:42 -07:00
Sunil Singh
05e29d94de Updating the capi.md page to cluster-api.md to correct intended URL.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-04-08 12:26:40 -07:00
Sunil Singh
c17765a0b5 Updating the sidebars across versions to match page title.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-04-08 09:25:27 -07:00
Billy Tat
a8470170cc Updated deprecated features table (#1214)
* Add missing entries to deprecated features table

* Remove reference to version in filename

* Add redirects

* Update canonical links

* Update sidebars

* Update header capitalization

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

---------

Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>
2024-04-04 12:04:08 -04:00
Sunil Singh
bbe73308a7 Adding the CAPI integrations dropdown and overview page to Rancher latest, v2.8, and v2.7. Adjusting the sidebars for the respective versions as well.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-04-03 17:03:20 -07:00
Sunil Singh
d7e29d7c19 This commit aims to fix the broken markdown links to pass the checker and updates the sidebar structure/titles of pages to add clarification.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-29 16:00:06 -07:00
Sunil Singh
0f6dec11ac This commit consists of removing the old API section completely and updating the API sidebards for Latest/2.8. Subsequent commits will focus on content adjustment as needed.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-03-29 14:26:45 -07:00
Sunil Singh
867eb490b7 Merge branch 'rancher:main' into update-api-sidebar 2024-03-29 13:24:58 -07:00
Marty Hernandez Avedon
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
Sunil Singh
38562b03e3 Moving the previous API documentation to the RKA section for the latest and 2.8 versions. Adjusted the titles and some wording, as well as updated the redirect for the latest versions.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-02-27 11:02: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
Billy Tat
26465bcb5f Update integrations list 2024-01-25 11:51:37 -08:00
Lena Garber
07f3aa96d0 Add Linode quick-start guide 2024-01-23 16:44:20 -05:00
Billy Tat
6d59b46f70 Merge remote-tracking branch 'upstream/main' into move-pages-for-subheaders-latest 2024-01-19 13:42:58 -08:00
Marty Hernandez Avedon
3a4b7e73c0 #766 Consistently using verbs in titles (#1038)
* gerundify Configuration for Storage Classes in Azure

* gerundify Authentication Config

* gerundify Bootstrap Password

* gerundify and disambiguate manage-PSP

* gerundify and disambiguate create-PSP

* syncing? Syncing what?

* updating label for Configure OpenLDAP

* updating label for authentication config

* updating label for configuring microsoft ad and shibboleth (saml)

* updating label for configuring microsoft ad and shibboleth (saml) in sidebars (last commit covered versioned docs)

* label + title for one of several sets of pages entitled role-based access control

* gerundify Upgrade a Hardened Custom/Imported Cluster to Kubernetes v1.25

* re-order title of Certificate Troubleshooting so verb comes first

* added 'about' to title because the page is about drivers that provision, not how to provision a driver

* template enforcement > enforcing templates

* update label to match title - deploy > deploying

* updated label to matach title - manage clusters > cluster administration

* gerundify set up in infrastructure setup section

* typo fix - spacing

* matching label to title - launch > launching

* label matching title - set up part 2

* label matching title - windows clusters

* how to configure > configuring

* using > launching (partially matches label to title)

* ingress config > configging an ingress

* match label to title - project administration

* match label to title - project resource quotas

* match title to label - monitoring/alerting guides

* matching label to title - enabling

* gerundify allow unsupported storage drivers

* Update openapi/swagger.json

* lost metadata syntax re-applied

* Apply suggestions from code review
2024-01-11 12:49:32 -05:00
Marty Hernandez Avedon
f47734f15b #991 refresh and restructure cloud provider guide section PART ONE: Restructure (#1025)
* moved amazon & vsphere files to subfolders

* versioning + fix broken links

* renames, retitles, page moves

* versioning changes in docs

* moved pages to new migration section, fixed config and sidebars

* link fixes

* update canonical links

* more links

* link fixes

* link to subsection fixed
2024-01-09 12:58:26 -05:00
Billy Tat
dd46955d9c [latest] Move files out of pages-for-subheaders 2023-12-22 13:33:02 -08:00
Jake Hyde
79ac876275 Add aws out of tree cloud provider install/upgrade docs (#844)
* Add aws out of tree cloud provider install/upgrade docs

* Add aws out of tree cloud provider install/upgrade docs

* Add info for aws cloud provider

* indentation fix

* Address review comments

* addressing review comments

* Address review comments

* syntax annotations, re-org sections, copy edits

* even more copy edits

* copy edits to note at top

* addressing suggestions from slickwarren

* Address review comments

* copyedits

* Fix numbering

* Update docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md

* update helm installation steps

* 2.8 versioning

* rm 'new in 2.7' from 2.8

* Update versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md

* revert -- change intended for other branch

* typo fixes

* fix headings, fix casing

* apply prev commit to 2.8

* Reorganizing AWS migration pages (#1015)

This partially addresses https://github.com/rancher/rancher-docs/issues/991 (rename file `migrating-from-in-tree-to-out-of-tree` to shorter and reference vsphere) and also fixes problems on the open PR: Duplicate sections (removed), difficulty navigating the file (split into two), sections with similar titles (opting for tabs instead of headings). I created this on its own working branch because moving around large blocks of text was unwieldly and I didn't want to mess up my local version of 763-document-aws-out-of-tree-v2prov. The last tab block (Helm Chart Installation through UI) contains contain that seems to be entirely the same for RKE and RKE2.

---------

Co-authored-by: Kinara Shah <kinara@rancher.com>
Co-authored-by: martyav <marty.avedon@suse.com>
2023-12-06 14:49:45 -05:00
Billy Tat
03ea6163fb Port version-2.8 updates to latest (/docs) (#1013)
* Port version-2.8 updates to latest (/docs)

Includes changes from 1b6d9506 (2023-10-06) to 1f39a6ff (2023-11-30)

* Fix redirects
2023-12-06 14:48:27 -05:00
Billy Tat
3ee6f637ab Add sidebar entry 2023-10-24 13:07:29 -07:00
Jiaqi Luo
0940a22d46 Update the namespace exception list at multiple places (#926) 2023-10-18 12:30:02 -07:00
Billy Tat
5c083c320a Remove version-latest dir
Originally added due to some unexpected versioning behavior that's no longer reproducible

Apply suggestions from code review

Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>
2023-10-12 10:26:54 -07:00
Silvio Moioli
5c83f5a6cc Merge branch 'main' into revise_hardware_recommendations 2023-10-11 10:17:52 +02:00
Billy Tat
7467f99d89 Merge branch 'main' into 2023-Q4-2.8x 2023-10-06 10:19:22 -07:00
Silvio Moioli
6d77c45ff2 Merge branch 'main' into revise_hardware_recommendations 2023-10-06 10:01:50 +02:00
Billy Tat
b27b00da87 Revert "Revert "Merge branch 'main' into main-to-2023-Q3-v2.7x""
This reverts commit 5eb3b2876f.
2023-10-05 16:32:09 -07:00
Silvio Moioli
1006603d73 tips-for-scaling-rancher: rename to tuning-and-best-practices-for-rancher-at-scale
Signed-off-by: Silvio Moioli <silvio@moioli.net>
2023-10-02 11:13:48 +02:00
Silvio Moioli
03318b55b1 make scaling tips page visible in the menu
Signed-off-by: Silvio Moioli <silvio@moioli.net>
2023-10-02 11:12:40 +02:00
Colleen Murphy
70380d36a7 Add hardening guide for Rancher Webhook (#864) 2023-09-29 14:39:29 -04:00
Billy Tat
5eb3b2876f Revert "Merge branch 'main' into main-to-2023-Q3-v2.7x"
This reverts commit 45aa5bb9bd, reversing
changes made to 5380fffa27.
2023-09-27 15:42:04 -07:00
Andy Pitcher
250171d9e4 Rebase and modify cis-1.7 page to include 1.26/1.27 2023-09-20 23:48:07 -03:00
Andy Pitcher
81464c73d6 Merge branch 'main' into rke1-self-assessment-guide-with-cis-1.7 2023-09-20 17:28:57 -04:00
Andy Pitcher
35f27f4130 Merge branch 'main' into k3s-self-assessment-guide-with-cis-1.24 2023-09-20 16:24:04 -04:00
Andy Pitcher
00c18c19cd Merge pull request #860 from andypitcher/rke2-self-assessment-guide-with-cis-1.24
[cis-1.24] update rke2-self-assessment-guide
2023-09-20 15:33:55 -04:00
Andy Pitcher
1c2b3f3cce Merge pull request #854 from andypitcher/k3s-self-assessment-guide-with-cis-1.7
[cis-1.7] update k3s-self-assessment-guide
2023-09-20 15:33:40 -04:00
Guilherme Macedo
484a832dff Update k3s-self-assessment-guide-with-cis-v1.24
Signed-off-by: Guilherme Macedo <guilherme@gmacedo.com>
2023-09-20 13:25:51 -03:00
Andy Pitcher
efe1d88afd Update sidebar for rke2 cis-1.24 2023-09-20 13:18:43 -03:00
Andy Pitcher
4519cffa32 Modify cis-1.7 page to include 1.26/1.27 2023-09-19 14:27:25 -04:00
Andy Pitcher
1bc4dd2ff7 Modify cis-1.7 page to include 1.26/1.27 2023-09-19 14:17:20 -04:00