Commit Graph

287 Commits

Author SHA1 Message Date
martyav
6c694a48fb merge conflicts 2024-09-23 12:12:01 -04:00
Billy Tat
efd2bd289e Incorrect/self-referencing link 2024-09-22 10:17:26 -07:00
Marty Hernandez Avedon
c869ea69ac Fix order of headings (#1465)
* Fix 'title out of sequence' errors

fixed Dockershim.md

* fixed deprecated-features.md

* fixed install-and-configure-kubectl.md

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

* fixed security.md

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

* fixed telemetry.md

* fixed upgrades.md

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

* fixed air-gapped-upgrades.md

* fixed dockershim.md

* fixed docker-install-commands.md

* fixed install-kubernetes.md

* fixed infrastructure-private-registry.md

* fixed install-rancher-ha

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

* fixed cis-scans/configuration-reference.md

* fixed custom-benchmark.md

* fixed supportconfig.md

* fixed harvester/overview.md

* fixed logging-architecture.md

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

* fixed taints-and-tolerances.md

* fixed longhorn/overview.md

* fixed neuvector/overview.md

* fixed monitoring-and-alerting

* fixed rancher-cli.md

* fixed cluster-configuration.md

* fixed monitoring-v2-configuration/examples.md

* fixed servicemonitors-and-podmonitors.md

* fixed other-troubleshooting-tips/dns.md
2024-09-18 14:02:55 -04:00
martyav
e6ffc6456c fixed other-troubleshooting-tips/rancher-ha.md 2024-09-17 17:31:27 -04:00
martyav
40901b29f7 fixed rancher-security.md 2024-09-17 16:25:05 -04:00
martyav
7920b689cc Fix order of headings part 2 - next 30 commits
fixed communicating-with-downstream-user-clusters.md
2024-09-17 16:15:24 -04:00
Billy Tat
2458b04c66 Merge pull request #1383 from btat/typo
Fix Tabs groupId typo + other typos
2024-07-15 17:15:57 -07:00
Billy Tat
822f8f4974 Fix Tabs groupId typo + other typos 2024-07-15 14:33:43 -07:00
Marty Hernandez Avedon
305729a434 #1358 Link to 'Settings for etcd tuning' no longer valid, plus other fixes to links to etcd.io/docs (#1362)
* 1358 Link to 'Settings for etcd tuning' no longer valid

updates dead link to new URL

* updated etcd version links

2.0-2.4 was tricky, I opted for etcd v3.3 as it's identical to the text on v3.4 except for a single clarifying heading

* update link in v2.5 to etcd v3.3 to cover downstream

* other 3.4 files in /docs

* other 3.4 files in /v2.9

* other 3.4 files in /v2.8

* other 3.4 files in /v2.7

* other 3.4 files in /v2.6

* other 3.4 files in /v2.5

* other 3.4 files in /v2.0-2.4

* rm'ing '.0' from URLs

* update v2.6 links to account for differing etcd versions

* chinese links
2024-07-10 14:42:31 -04:00
Marty Hernandez Avedon
3710dae5c2 Warn not to allow nonadmin on Rancher server cluster (#1365)
* Warn not to allow nonadmin on Rancher local cluster

* versioning

* Apply suggestions from code review

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

* versioning applied to suggestion

---------

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>
2024-07-01 16:58:04 -04:00
Billy Tat
1fd0e4fd5e Remove unused dirs/files 2024-06-19 13:21:48 -07:00
Billy Tat
1dd33ee86b Merge pull request #1317 from mallardduck/audit-docs
correct audit log level table
2024-06-05 11:37:15 -07:00
Marty Hernandez Avedon
a4be67af23 Syncing for #1304 (#1314)
* 1293 Creating an AKS Cluster page may need a refresh

* consistent variable name and styling

* waffling on whether app or client ID should be primary

* --skip-assignment is deprecated

according to https://learn.microsoft.com/en-us/cli/azure/ad/sp?view=azure-cli-latest#az-ad-sp-create-for-rbac by default the az ad sp create-for-rbac command does not assign any role to the service principal

* slightly modifying command based on https://learn.microsoft.com/en-us/cli/azure/ad/sp?view=azure-cli-latest#az-ad-sp-create-for-rbac

* re-orging instructions and revising wording

* consistent variable names, assorted suggestions

* syncing versions

* missing changes

* Apply suggestions from code review

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

* correcting copy/paste error

---------

Co-authored-by: Billy Tat <btat@suse.com>
2024-06-04 17:43:05 -04:00
Billy Tat
42989a7850 Merge pull request #1315 from btat/link-fixes
Fix external links
2024-06-04 10:46:16 -07:00
Dan Pock
d99dc0ac98 sync table to match on all docs versions 2024-06-04 08:47:41 -04:00
Billy Tat
d06d7d9663 Fix external links 2024-05-31 15:08:12 -07: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
Billy Tat
8e208659b5 Remove extra column in table row 2024-05-29 15:42:16 -07:00
Marty Hernandez Avedon
18e5625b0c corrected typo: debugg (#1298) 2024-05-21 15:41:39 -04:00
Marty Hernandez Avedon
d4796a1ae8 #999 Clarify support and stipulations for use of firewall in documentation (#1292)
* 999 Clarify support and stipulations for use of firewall in documentation

added scarier warning about firewalld usage

* revised language slightly

* Update docs/how-to-guides/advanced-user-guides/open-ports-with-firewalld.md

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

* versioning, updated link, & abbreviated warning for v2.0-2.4

---------

Co-authored-by: Sunil Singh <sunil.singh@suse.com>
2024-05-21 11:42:33 -04:00
Marty Hernandez Avedon
5bf5c87b3f #1281 docker machine link redirects to docker desktop documentation (#1286)
* 1281 Docker machine link redirects to Docker Desktop documentation

* updated link to gcbw.github.io version of docker docs

* more explication of the Docker Machine situation

* versioning

* Apply suggestions from code review

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

---------

Co-authored-by: Billy Tat <btat@suse.com>
2024-05-15 12:21:23 -04:00
Marty Hernandez Avedon
6ae22a0431 When using AzureAD authentication provider the rancher URL gets redirected back to the primary URL instead of staying at an alternate. (#1241)
* When using AzureAD authentication provider the rancher URL gets redirected back to the primary URL instead of staying at an alternate.

* improve description and add example

* rv'ing preliminary edits -- they unnecessarily expand the scope of the PR

* reword

* revised wording again, rm'd example

* Update docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-azure-ad.md

* Update docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-azure-ad.md

* versioning up through v2.7

* added more versions

ticket notes that this is an inherent design decision in Rancher
2024-05-09 11:46:39 -04: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
54dc6b187b #1228 Overlay test for Windows nodes (#1239)
* 1228 Overlay test for Windows nodes

* Apply suggestions from code review

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

* updated note about error message

* versioned note on 2.0-2.4

---------

Co-authored-by: Sunil Singh <sunil.singh@suse.com>
2024-04-30 17:21:19 -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
Sunil Singh
03c6b650ca Updating some links after review.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-04-01 13:58:38 -07:00
Sunil Singh
6c79a27393 Updating links that were showing an error for previous pages-for-subheaders links, as well as a broken markdown link in the v2.0-v2.4 namespace-migration.md page.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2024-04-01 12:48:49 -07:00
Billy Tat
6c4eb63232 Apply suggestions from code review
Co-authored-by: Marty Hernandez Avedon <martyavedon@gmail.com>
2024-03-28 08:58:47 -07:00
Billy Tat
e81da89b4e Remove reference to archived repo 2024-03-27 16:59:56 -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
Trent V
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
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
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
Billy Tat
5a9d423cb6 Globally import CNI popularity 2024-02-21 10:56:33 -08:00
joshmeranda
829ec114c4 update monitoring node-exporter ports 2024-02-13 10:24:13 -05: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
Billy Tat
dae1b76dc6 Update canonical links 2024-01-29 10:07:22 -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
Billy Tat
94f7023246 Update CNI popularity table for 2.8.1 2024-01-22 15:35:35 -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
986e14346f Fix incorrect filename 2024-01-12 21:20:14 -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
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