From 4b73f6b985600434de94379c0c3781cd12ef634e Mon Sep 17 00:00:00 2001 From: Colin Griffin Date: Sat, 1 May 2021 10:30:55 -0400 Subject: [PATCH 1/9] add clarification for RKE Template managed clusters --- content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md b/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md index 7d4253f8c64..8504249cda3 100644 --- a/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md +++ b/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md @@ -46,6 +46,8 @@ Before you can install Monitoring V2, Monitoring V1 needs to be uninstalled comp * Disable the cluster monitoring installation under Cluster -> Tools -> Monitoring * Ensure that the cluster-monitoring app and the monitoring-operator app in the System project have been removed and are not recreated after a few minutes +If your cluster is managed using an RKE template: To prevent legacy monitoring from being re-enabled, disable Monitoring in future RKE template revisions. + #### Migrating Grafana Dashboards You can migrate any dashboard added to Grafana in Monitoring V1 to Monitoring V2. In Monitoring V1 you can export an existing dashboard like this: From 3e7ed31dbbea515aeb7a2a183c064a7db9c46fdf Mon Sep 17 00:00:00 2001 From: Colin Griffin Date: Sat, 1 May 2021 10:33:58 -0400 Subject: [PATCH 2/9] verbiage for consistency --- content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md b/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md index 8504249cda3..c3b5a444ce7 100644 --- a/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md +++ b/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md @@ -46,7 +46,7 @@ Before you can install Monitoring V2, Monitoring V1 needs to be uninstalled comp * Disable the cluster monitoring installation under Cluster -> Tools -> Monitoring * Ensure that the cluster-monitoring app and the monitoring-operator app in the System project have been removed and are not recreated after a few minutes -If your cluster is managed using an RKE template: To prevent legacy monitoring from being re-enabled, disable Monitoring in future RKE template revisions. +If the cluster is managed using an RKE template: To prevent legacy monitoring from being re-enabled, disable Monitoring in future RKE template revisions. #### Migrating Grafana Dashboards From 3a10cba498e12f745c8ef1287626d0f6929db2f5 Mon Sep 17 00:00:00 2001 From: Colin Griffin Date: Wed, 19 May 2021 14:27:03 -0400 Subject: [PATCH 3/9] Add variable examples for rke template requirements --- .../v2.5/en/monitoring-alerting/migrating/_index.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md b/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md index c3b5a444ce7..e5c077755ee 100644 --- a/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md +++ b/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md @@ -46,7 +46,14 @@ Before you can install Monitoring V2, Monitoring V1 needs to be uninstalled comp * Disable the cluster monitoring installation under Cluster -> Tools -> Monitoring * Ensure that the cluster-monitoring app and the monitoring-operator app in the System project have been removed and are not recreated after a few minutes -If the cluster is managed using an RKE template: To prevent legacy monitoring from being re-enabled, disable Monitoring in future RKE template revisions. +#### RKE Template Clusters + +To prevent v1 monitoring from being re-enabled, disable monitoring and in future RKE template revisions via modification of the RKE template yaml: + +```yaml +enable_cluster_alerting: true +enable_cluster_monitoring: true +``` #### Migrating Grafana Dashboards From 90fd25fe29c74d3cb2fdba8e986de6bc4955c102 Mon Sep 17 00:00:00 2001 From: Colin Griffin Date: Thu, 27 May 2021 11:12:19 -0400 Subject: [PATCH 4/9] update values to false --- .../rancher/v2.5/en/monitoring-alerting/migrating/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md b/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md index e5c077755ee..2dc21fd1374 100644 --- a/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md +++ b/content/rancher/v2.5/en/monitoring-alerting/migrating/_index.md @@ -51,8 +51,8 @@ Before you can install Monitoring V2, Monitoring V1 needs to be uninstalled comp To prevent v1 monitoring from being re-enabled, disable monitoring and in future RKE template revisions via modification of the RKE template yaml: ```yaml -enable_cluster_alerting: true -enable_cluster_monitoring: true +enable_cluster_alerting: false +enable_cluster_monitoring: false ``` #### Migrating Grafana Dashboards From 8ba180ea3105c242bb9469c489b79080216c45e9 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Thu, 10 Jun 2021 15:06:29 -0700 Subject: [PATCH 5/9] Fix links to Fleet page in multi-cluster app and pipeline docs --- layouts/_default/list.html | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/layouts/_default/list.html b/layouts/_default/list.html index a86588f3f57..19e03742357 100644 --- a/layouts/_default/list.html +++ b/layouts/_default/list.html @@ -30,24 +30,24 @@ We are transitioning to versioned documentation. The v2.x docs will no longer be maintained. For Rancher v2.5 docs, go here. For Rancher v2.0-v2.4 docs, go here. {{end}} - {{ if in .Dir "/rancher/v2.5/en/pipelines" }} + {{ if in .Dir "rancher/v2.5/en/pipelines" }}
- As of Rancher v2.5, Git-based deployment pipelines are now recommended to be handled with Rancher Continuous Delivery powered by Fleet, available in Cluster Explorer. + As of Rancher v2.5, Git-based deployment pipelines are now recommended to be handled with Rancher Continuous Delivery powered by Fleet, available in Cluster Explorer.
{{end}} - {{ if in .Dir "/rancher/v2.x/en/pipelines" }} + {{ if in .Dir "rancher/v2.x/en/pipelines" }}
- As of Rancher v2.5, Git-based deployment pipelines are now recommended to be handled with Rancher Continuous Delivery powered by Fleet, available in Cluster Explorer. + As of Rancher v2.5, Git-based deployment pipelines are now recommended to be handled with Rancher Continuous Delivery powered by Fleet, available in Cluster Explorer.
{{end}} - {{ if in .Dir "/rancher/v2.5/en/deploy-across-clusters/multi-cluster-apps" }} + {{ if in .Dir "rancher/v2.5/en/deploy-across-clusters/multi-cluster-apps" }}
- As of Rancher v2.5, we now recommend using Fleet for deploying apps across clusters. + As of Rancher v2.5, multi-cluster apps are deprecated. We now recommend using Fleet for deploying apps across clusters. It is available in Cluster Explorer.
{{end}} - {{ if in .Dir "/rancher/v2.x/en/deploy-across-clusters/multi-cluster-apps" }} + {{ if in .Dir "rancher/v2.x/en/deploy-across-clusters/multi-cluster-apps" }}
- As of Rancher v2.5, we now recommend using Fleet for deploying apps across clusters. + As of Rancher v2.5, multi-cluster apps are deprecated. We now recommend using Fleet for deploying apps across clusters. It is available in Cluster Explorer.
{{end}} From ffa29e286269a21e0943443626118d115646179a Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Thu, 10 Jun 2021 17:00:30 -0700 Subject: [PATCH 6/9] Tell Google not to index the non-versioned docs --- layouts/robots.txt | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/layouts/robots.txt b/layouts/robots.txt index 769d069a8d7..449f2c85a6b 100644 --- a/layouts/robots.txt +++ b/layouts/robots.txt @@ -1,4 +1,12 @@ User-agent: * -Disallow: {{ if ne (getenv "HUGO_ENV") "production" }}/{{ end }} +{{ if ne (getenv "HUGO_ENV") "production" }} +Disallow: / +{{ end }} + +{{ range .Pages }} +{{ if in .Dir "rancher/v2.x" }} +Disallow: {{ .RelPermalink }} +{{end}} +{{ end }} Sitemap: https://rancher.com/sitemap.xml From c2f6275a6cb654b48131554a0cf945254c70b292 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Thu, 10 Jun 2021 17:38:21 -0700 Subject: [PATCH 7/9] Add example URL for private registries. Closes #2703 --- .../en/config-options/private-registries/_index.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/content/rke/latest/en/config-options/private-registries/_index.md b/content/rke/latest/en/config-options/private-registries/_index.md index 1fe91b8b182..1d3226826ba 100644 --- a/content/rke/latest/en/config-options/private-registries/_index.md +++ b/content/rke/latest/en/config-options/private-registries/_index.md @@ -15,7 +15,18 @@ private_registries: password: mypassword ``` -> **Note:** If you are using a Docker Hub registry, you can omit the `url` or set it to `docker.io`. +If you are using a Docker Hub registry, you can omit the `url` or set it to `docker.io`. + +> **Note:** Although the directive is named `url`, there is no need to prefix the host or IP address with `https://`. + +Valid `url` examples include: + +```yaml +url: registry.com +url: registry.com:5555 +url: 1.1.1.1 +url: 1.1.1.1:5555/artifactory +``` ### Default Registry From b282c059b8265ab9d0dbbf4c318ae576bd90d401 Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Tue, 15 Jun 2021 09:00:06 -0700 Subject: [PATCH 8/9] Fix example command --- .../v2.5/en/installation/resources/update-ca-cert/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/rancher/v2.5/en/installation/resources/update-ca-cert/_index.md b/content/rancher/v2.5/en/installation/resources/update-ca-cert/_index.md index 93e428a3a54..99bfdce3fb7 100644 --- a/content/rancher/v2.5/en/installation/resources/update-ca-cert/_index.md +++ b/content/rancher/v2.5/en/installation/resources/update-ca-cert/_index.md @@ -113,7 +113,7 @@ Method 3 can be used as a fallback if method 1 and 2 are unfeasible. For each cluster under Rancher management (including `local`) run the following command using the Kubeconfig file of the Rancher management cluster (RKE or K3S). ``` -kubectl patch clusters -p '{"status":{"agentImage":"dummy"}}' --type merge +kubectl patch clusters.management.cattle.io -p '{"status":{"agentImage":"dummy"}}' --type merge ``` This command will cause all Agent Kubernetes resources to be reconfigured with the checksum of the new certificate. @@ -142,4 +142,4 @@ With this method you are recreating the Rancher agents by running a set of comma First, generate the agent definitions as described here: https://gist.github.com/superseb/076f20146e012f1d4e289f5bd1bd4971 Then, connect to a controlplane node of the downstream cluster via SSH, create a Kubeconfig and apply the definitions: -https://gist.github.com/superseb/b14ed3b5535f621ad3d2aa6a4cd6443b \ No newline at end of file +https://gist.github.com/superseb/b14ed3b5535f621ad3d2aa6a4cd6443b From de2bb515a36aff7b06bff5d4f883e677a1306005 Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Tue, 15 Jun 2021 16:58:46 -0700 Subject: [PATCH 9/9] Update User Prefs page --- .../en/user-settings/preferences/_index.md | 45 +++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/content/rancher/v2.5/en/user-settings/preferences/_index.md b/content/rancher/v2.5/en/user-settings/preferences/_index.md index fc2fe8c1f2b..8776329a6fc 100644 --- a/content/rancher/v2.5/en/user-settings/preferences/_index.md +++ b/content/rancher/v2.5/en/user-settings/preferences/_index.md @@ -5,6 +5,10 @@ weight: 7012 Each user can choose preferences to personalize their Rancher experience. To change preference settings, open the **User Settings** menu and then select **Preferences**. +The preferences available will differ depending on whether the **User Settings** menu was accessed while on the Cluster Manager UI or the Cluster Explorer UI. + +{{% tabs %}} +{{% tab "Cluster Manager" %}} ## Theme Choose your background color for the Rancher UI. If you choose **Auto**, the background color changes from light to dark at 6 PM, and then changes back at 6 AM. @@ -16,3 +20,44 @@ This section displays the **Name** (your display name) and **Username** (your lo ## Table Row per Page On pages that display system objects like clusters or deployments in a table, you can set the number of objects that display on the page before you must paginate. The default setting is `50`. + +{{% /tab %}} +{{% tab "Cluster Explorer" %}} +## Theme + +Choose your background color for the Rancher UI. If you choose **Auto**, the background color changes from light to dark at 6 PM, and then changes back at 6 AM. + +## Login Landing Page + +Choose the default page to display after logging in. + +## Date Format + +Choose your preferred format to display dates. By default, dates are displayed in the form `Wed, Jun 9 2021`. + +## Time Format + +Choose your preferred format to display time. By default, the 12-hour format is used. + +## Table Row per Page + +On pages that display system objects like clusters or deployments in a table, you can set the number of objects that display on the page before you must paginate. The default setting is `50`. + +## YAML Editor Key Mapping + +Choose the editor used when editing YAML configurations. When Emacs or Vim is chosen, the editor's shortcut commands can also be used. + +## Enable Developer Tools & Features + +Enables developer tools and features to be used. + +## Hide All Type Description Boxes + +Hides all description boxes. + +## Helm Charts + +When deploying applications from the "Apps & Marketplace", choose whether to show only released versions of the Helm chart or to include prerelease versions as well. + +{{% /tab %}} +{{% /tabs %}}