Commit Graph

414 Commits

Author SHA1 Message Date
Billy Tat
8b96cbd5ae Merge remote-tracking branch 'upstream/main' into move-pages-for-subheaders-2.6 2024-01-19 13:56:27 -08:00
Marty Hernandez Avedon
2302e37376 #753 other title improvements (#1050)
* vagrant quickstart retitled for consistency

* rm number from title

* 2. rm number from title

* 3. rm number from title (Istio related, as were 2 prev)

* 4. rm number from title (Istio related)

* 5. rm number from title (Istio related)

* 6. rm number from title (Istio related)

* making backup 'examples' title more specific

* rewrite + making monitoring 'examples' title more specific

* suggestions from Btat

correcting capitalization for github, combining two lines into one

* versioning previous commit

* applying sunil's suggestions

rm'ing numbers from titles of pages missed in 2.0-2.4

* Apply suggestions from code review

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

---------

Co-authored-by: Billy Tat <btat@suse.com>
2024-01-17 13:30:50 -05:00
Billy Tat
573fcd717f Adjust phrasing to indicate distro list is not exhaustive. Fix links 2024-01-16 10:27:38 -08:00
Billy Tat
b1817890ac [2.6] Fix links to 'shared-files' module import 2024-01-11 15:40:58 -08:00
Billy Tat
0513177b76 [2.6] Move files out of pages-for-subheaders 2024-01-11 15:39:11 -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
Billy Tat
7bdc1c8d2a Merge pull request #1053 from danielhass/patch-1
Added non-changeable options to rke2-cluster-configuration
2024-01-09 14:16:20 -08:00
Billy Tat
6b4f8e792c Apply d0a260b3 & 74ea0817 (added non-changeable options to rke2-cluster-configuration) to versioned_docs 2024-01-09 13:46:07 -08:00
Billy Tat
9c4b0d3845 Merge branch 'main' into link-prep 2024-01-09 11:17:32 -08: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
51ed6e977b Convert 'broken' links to standard Markdown links 2024-01-08 16:30:27 -08:00
Marty Hernandez Avedon
3644d67b06 Clarifying the options for deploying rancher across clusters (#1042)
* clarifying the options for deploying rancher across clusters

* Update versioned_docs/version-2.6/pages-for-subheaders/deploy-apps-across-clusters.md
2023-12-26 10:59:01 -05:00
Marty Hernandez Avedon
2267d1c735 #1031 - Note about cloud credentials and admins (#1039)
* note about cloud credentials and admin view/write

* rewrite for more natural phrasing

* rm 'permanently' as it implies they can't be updated

* Update docs/reference-guides/user-settings/manage-cloud-credentials.md

* versioning
2023-12-20 17:36:10 -05:00
Marty Hernandez Avedon
01ef2065c0 Typo in heading, some style fixes across versions (#1040)
* typo in heading, some style fixes across versions

* avoid linking on the word 'here'
2023-12-20 12:51:22 -05:00
Billy Tat
2d61152c07 Merge pull request #1033 from lindhe/patch-1
Add `cloudcredential` as question type
2023-12-13 08:17:15 -08:00
Andreas Lindhé
e0407cfc17 Update rest of docs 2023-12-12 21:09:32 +01:00
Billy Tat
fc4731a933 Merge pull request #1032 from Echron/patch-1
Update rotate-certificates.md
2023-12-12 11:38:09 -08:00
Billy Tat
c52a0066ec Apply 'Fix typo (373fb6d1)' by @Echron to other versions 2023-12-12 11:10:35 -08:00
Marty Hernandez Avedon
b75f346558 Apply suggestions from code review
Co-authored-by: Billy Tat <btat@suse.com>
2023-12-12 10:24:35 -05:00
martyav
6dd952d0b2 note about patch version irrelevance 2023-12-11 17:31:05 -05:00
martyav
119fcccc8e generalize, link to support matrix, all versions 2023-12-11 15:53:41 -05:00
Billy Tat
b20b29918f Merge pull request #1027 from btat/link-fixes
Remove file path from link to section within same file
2023-12-11 10:59:21 -08:00
Marty Hernandez Avedon
b5dfa00ca8 Typo fix shabarin patch 1 (#1030)
* fix typo

* versioning

---------

Co-authored-by: ivan <ivan@shabarin.ru>
2023-12-11 13:30:55 -05:00
Billy Tat
37a65dce1a Remove file path from link to section within same file 2023-12-08 15:01:22 -08:00
Billy Tat
8203da887a Merge pull request #1024 from btat/link-fixes
Link fixes
2023-12-08 10:54:12 -08:00
Billy Tat
65659f87d2 Apply suggestions from code review
Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>
2023-12-08 10:32:52 -08:00
Andreas Lindhé
45620086ed Clarify "Linux dependencies" for vSphere (#960)
* Clarify "Linux dependencies" for vSphere

* Add note regarding rancher pentest reports public availability (#961)

* Add note regarding rancher pentest reports public availability

This PR will add a note regarding third-party penetration test reports
public disclosure.

* Update docs/pages-for-subheaders/rancher-security.md

* versioning for 2.7, 2.8

* added back in webhook material at end of 2.8 page

* corrected broken link

---------

Co-authored-by: Pietro Dell'Amore <pdellamore@MacBook-Pro-de-Pietro.local>
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>

* Add redirects for dashboard links

* Updates to the Global roles for new 2.8 features (#898)

* Updating docs to deprecate Restricted Admin

* Updating GlobalRole Docs

Updates the docs for GlobalRoles to include new info on the "escalate"
and "bind" verbs, as well as include info on how to use the new
"inheritedClusterRoles" field

* Apply suggestions from code review

* code review changes

* merged some minor copyedits

* Update docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md

* Update docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md

* fixed versioning for v2.8, v2.7

* Update docs/getting-started/installation-and-upgrade/installation-references/helm-chart-options.md

* copy/paste current version of global-permissions file in main to ensure file is correctly reverted to v2.7

---------

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

* #857 Add a API quickstart page under the (to be added) API section (#858)

* initial engineering draft of api quickstart

* spacing, headings

* copyedit

* note syntax added for last warning

* link to create api keys page, copy edits

* formating

* Apply suggestions from code review

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

* indentation, intro

* Update docs/api/quickstart.md

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

* Apply suggestions from code review

Co-authored-by: Michael Bolot <michael.bolot@suse.com>

* Update docs/api/quickstart.md

* removed commented-out line

* moved text from step 5 to step 3, made  into its own step, added info about not all resources offering detailed output

* added sidebar entry

* mv'd to version-2.8 dir

* rm'd remainders in /docs dir

---------

Co-authored-by: Billy Tat <btat@suse.com>
Co-authored-by: Michael Bolot <michael.bolot@suse.com>

* Fix version-2.8 broken links

* Update header: More from SUSE

* Fix quoting (single vs double) consistency

* Fix link rendering issue

* Add 2.7.9 entry to versions table

* Add initial Opni landing page

Signed-off-by: Mike Latimer <mlatimer@suse.com>

* added color icons to /static/img

* Add K8s Distro landing page content

* added css + elemental icon

* rm'd temp file

* Update src/css/custom.css

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

* rm usused icons

* canonical links for single-user-nodes and user-settings

* Update token setting page (#906)

* Update token setting page

* Remove unnecessary step

* Harvester landing page: apply feedback from #940

* Rancher Desktop landing page: apply feedback from #944

* Epinio landing page: apply feedback from #945

* fixed spacing problem that ruined callout (#978)

* rm mention of Rio from 2.7 & 2.8 (#980)

* General FAQ copyedit (#983)

* General FAQ copyedit

* restored intro

* Update etcd troubleshoot for etcd 3.5.7 and higher (#985)

* Add session management section (#981)

* Add note regarding rancher pentest reports public availability

This PR will add a note regarding third-party penetration test reports
public disclosure.

* Add session management section to rancher security best practices

This PR will create a new section inside Rancher Security Best Practices
adding security recommendations for RM deployments that might need additional
security controls.

* Apply suggestions from code review

Co-authored-by: Paulo Gomes <paulo.gomes.uk@gmail.com>

* Update docs/reference-guides/rancher-security/rancher-security-best-practices.md

* Update docs/reference-guides/rancher-security/rancher-security-best-practices.md

Co-authored-by: Guilherme Macedo <guilherme@gmacedo.com>

* versioned docs

---------

Co-authored-by: Pietro Dell'Amore <pdellamore@MacBook-Pro-de-Pietro.local>
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
Co-authored-by: Paulo Gomes <paulo.gomes.uk@gmail.com>
Co-authored-by: Guilherme Macedo <guilherme@gmacedo.com>

* #879 Add Project Owner to 'Project Member Can't Create Namespace' doc (#894)

* 879 Add Project Owner to 'Project Member Can't Create Namespace' doc

* versioned doc

* Update docs/reference-guides/rancher-webhook.md

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

* Update docs/reference-guides/rancher-webhook.md

Co-authored-by: Michael Bolot <michael.bolot@suse.com>

* Apply suggestions from code review

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

* Update docs/reference-guides/rancher-webhook.md

* page sync

* added v2.8 page

* merge syntax left in file, rm'd backticks from version numbers

---------

Co-authored-by: Billy Tat <btat@suse.com>
Co-authored-by: Michael Bolot <michael.bolot@suse.com>
Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

* 135 cloud-provider(aws): Need to correct content on cluster id in aws tagging section

* versioning

* Add delete permission and remove duplicate header (#989)

* Apply suggestions from code review

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

* Amazon only uses EC2, so 'use anything' is a moot point

* Update CNI popularity chart numbers. Credit to @amitmavgupta for original PR.

* Update Swagger file

* Fix etcd.backup_config.retention description

* Add Projects API workflow example

* Add project workflow to sidebar; remove duplicate API category

* Update versioned_docs/version-2.8/api/workflows/projects.md

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

* #963 clarify documentation for read only permissions in monitoring UI (#964)

* 963 - Clarify documentation around read-only permissions for monitoring.

* fixed random Capitalization of Nouns

* moved changes to v2.8 dir and revised capitalization again

* Update docs/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md

* copyedits, added workaround

* copyedits

* versioning

* Update versioned_docs/version-2.8/api/workflows/projects.md

* Update migrate-rancher-to-new-cluster.md (#1007)

* Update migrate-rancher-to-new-cluster.md

* Update docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md

* Update docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md

* Update docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md

* 2.7, 2.8 versioning

* restoring bulleted links to rke/k3s

* 2.5 to 2.8 synced

* rm'd info about rke2/k3s from inappropriate version

* reverted last commit -- done by mistake

---------

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

* fix: update v2.7 cn sidebar

* fixed typo in command (#1010)

* Apply 4b2f8125 (sidebar label update) to other versions. Originally changed in #926

* Remove term from translated sidebar label to match English label

* #420 Completes canonical links task (#1011)

* Completes canonical links task

* spacing

* Updating CSP Adapter versions

* embed video on aws marketplace page (#1016)

* 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

* #773: Add steps to install Rancher Extensions in an air-gapped environment (#807)

* Add steps to install Rancher Extensions in an air-gapped environment

* added link from install guide

* added notes to import/install steps as suggested by rohitsakala

* minor copyedits

* updating extensions explicitly given own section

* tightened up note

* updated note for v2.7

* ensuring all 3 versions have same text

* versioning install-rancher-ha

* del extension repos + (partially) upgrade

* fixed comment syntax

* Apply suggestions from code review

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

* Apply suggestions from code review

* completed update instructions

* no dropdown, text input

* more explanation + delete

* Apply suggestions from code review

* extensions repo container image delete

* versioning

* revert changes to v2.7

---------

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

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

* Add 2.8 entry to versions table (#1002)

* Update webhook version table (#1006)

* Update webhook version table

* Bump 2.8 webhook version

* Sync 2.8 table with latest table

* Bump webhook version

* correcting capitalization: helm > Helm (#1018)

* Remove preview label from 2.8

* Remove unreleased banner

* rm 'add additional' phrase from docs (#1020)

* rm 'add additional' phrase from docs

* these > more

* rm deprecation banner from v2.8

* rm deprecation banner from v2.8 (#1023)

* [skip ci] Update README to reflect current versioning model (#1022)

* [skip ci] Update README to reflect current versioning model

* Update README.md

* Update README.md

---------

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

* Apply suggestions from code review

* Update create-a-vm-template.md

* Update create-a-vm-template.md

* versioning

---------

Signed-off-by: Mike Latimer <mlatimer@suse.com>
Co-authored-by: pdellamore <pietro.dellamore@suse.com>
Co-authored-by: Pietro Dell'Amore <pdellamore@MacBook-Pro-de-Pietro.local>
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
Co-authored-by: Billy Tat <btat@suse.com>
Co-authored-by: Michael Bolot <michael.bolot@suse.com>
Co-authored-by: Mike Latimer <mlatimer@suse.com>
Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>
Co-authored-by: Jonathan Crowther <jonathan.crowther@suse.com>
Co-authored-by: Sebastiaan van Steenis <superseb@users.noreply.github.com>
Co-authored-by: Paulo Gomes <paulo.gomes.uk@gmail.com>
Co-authored-by: Guilherme Macedo <guilherme@gmacedo.com>
Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>
Co-authored-by: Denise <denise.schannon@suse.com>
Co-authored-by: [yzeng25] <[yzeng25@wisc.edu]>
Co-authored-by: Jake Hyde <33796120+jakefhyde@users.noreply.github.com>
Co-authored-by: Kinara Shah <kinara@rancher.com>
2023-12-08 12:17:53 -05:00
Billy Tat
1a2c38b8bd Fix external link to keycloak installation docs 2023-12-07 15:43:08 -08:00
Billy Tat
bdc318c33c Remove link to self 2023-12-07 14:02:20 -08:00
Marty Hernandez Avedon
e479cc33e3 rm 'add additional' phrase from docs (#1020)
* rm 'add additional' phrase from docs

* these > more
2023-12-06 18:35:48 -05:00
Marty Hernandez Avedon
437ab199da correcting capitalization: helm > Helm (#1018) 2023-12-06 16:17:31 -05:00
Marty Hernandez Avedon
f175eae6b4 embed video on aws marketplace page (#1016) 2023-12-06 10:03:58 -05:00
Billy Tat
1f39a6ffe8 Merge pull request #1012 from MbolotSuse/csp-adapter-3.0.0
Updating CSP Adapter Version Table
2023-11-30 09:03:17 -08:00
Michael Bolot
5864196421 Updating CSP Adapter versions 2023-11-30 10:24:50 -06:00
Marty Hernandez Avedon
662afc641b #420 Completes canonical links task (#1011)
* Completes canonical links task

* spacing
2023-11-30 10:10:34 -05:00
Denise
0b3fceefdc Update migrate-rancher-to-new-cluster.md (#1007)
* Update migrate-rancher-to-new-cluster.md

* Update docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md

* Update docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md

* Update docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md

* 2.7, 2.8 versioning

* restoring bulleted links to rke/k3s

* 2.5 to 2.8 synced

* rm'd info about rke2/k3s from inappropriate version

* reverted last commit -- done by mistake

---------

Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
2023-11-28 13:51:30 -05:00
Billy Tat
a49000ef22 Update CNI popularity chart numbers. Credit to @amitmavgupta for original PR. 2023-11-20 13:29:17 -08:00
martyav
42e24305a4 Amazon only uses EC2, so 'use anything' is a moot point 2023-11-17 10:30:34 -05:00
martyav
85fd70d7aa versioning 2023-11-16 16:03:58 -05:00
Marty Hernandez Avedon
0719859803 General FAQ copyedit (#983)
* General FAQ copyedit

* restored intro
2023-11-14 16:14:35 -05:00
Marty Hernandez Avedon
f3dfd92555 fixed spacing problem that ruined callout (#978) 2023-11-06 17:36:38 -05:00
martyav
717152a781 canonical links for single-user-nodes and user-settings 2023-11-03 14:49:51 -04:00
Billy Tat
b7626ba379 Fix link rendering issue 2023-10-31 19:06:48 -07:00
Billy Tat
8100893a0e Merge pull request #815 from btat/broken-links-2023-08
Fix broken links across versions
2023-10-24 11:30:45 -07:00
Sebastiaan van Steenis
0acb9c38c6 Download kubectl from dl.k8s.io URL 2023-10-23 14:37:18 +02:00
Billy Tat
628607a3ee Fix links in /versioned_docs/version-2.6 2023-10-20 17:02:53 -07:00
Billy Tat
a52f433848 More 2.0-2.4 link fixes
Syncing content was added to 2.x docs with a 2.5 milestone (https://github.com/rancher/docs/pull/2705). That portion of the content was likely not intended to be copied to the 2.0-2.4 docs when splitting the 2.x docs (https://github.com/rancher/docs/pull/3088).
2023-10-20 15:19:39 -07:00
Billy Tat
6b80dc4a1f Fix broken K8s.io cloud provider links 2023-10-20 15:19:38 -07:00
Billy Tat
e9f5f7ff15 Fix links lin /versioned_docs/version-2.5 2023-10-20 15:19:38 -07:00
Billy Tat
2cf44dc02b Fix links lin /versioned_docs/version-2.6 2023-10-20 15:19:38 -07:00