diff --git a/docs/en/admin-settings/drivers/drivers.md b/docs/en/admin-settings/drivers/drivers.md deleted file mode 100644 index 32d05779257..00000000000 --- a/docs/en/admin-settings/drivers/drivers.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Provisioning Drivers -weight: 70 ---- - -Drivers in Rancher allow you to manage which providers can be used to deploy [hosted Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/) or [nodes in an infrastructure provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/) to allow Rancher to deploy and manage Kubernetes. - -### Rancher Drivers - -With Rancher drivers, you can enable/disable existing built-in drivers that are packaged in Rancher. Alternatively, you can add your own driver if Rancher has not yet implemented it. - -There are two types of drivers within Rancher: - -* [Cluster Drivers](#cluster-drivers) -* [Node Drivers](#node-drivers) - -### Cluster Drivers - -Cluster drivers are used to provision [hosted Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/), such as GKE, EKS, AKS, etc.. The availability of which cluster driver to display when creating a cluster is defined based on the cluster driver's status. Only `active` cluster drivers will be displayed as an option for creating clusters for hosted Kubernetes clusters. By default, Rancher is packaged with several existing cluster drivers, but you can also create custom cluster drivers to add to Rancher. - -By default, Rancher has activated several hosted Kubernetes cloud providers including: - -* [Amazon EKS]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/eks/) -* [Google GKE]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/gke/) -* [Azure AKS]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/aks/) - -There are several other hosted Kubernetes cloud providers that are disabled by default, but are packaged in Rancher: - -* [Alibaba ACK]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/ack/) -* [Huawei CCE]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/cce/) -* [Tencent]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/tke/) - -### Node Drivers - -Node drivers are used to provision hosts, which Rancher uses to launch and manage Kubernetes clusters. A node driver is the same as a [Docker Machine driver](https://docs.docker.com/machine/drivers/). The availability of which node driver to display when creating node templates is defined based on the node driver's status. Only `active` node drivers will be displayed as an option for creating node templates. By default, Rancher is packaged with many existing Docker Machine drivers, but you can also create custom node drivers to add to Rancher. - -If there are specific node drivers that you don't want to show to your users, you would need to de-activate these node drivers. - -Rancher supports several major cloud providers, but by default, these node drivers are active and available for deployment: - -* [Amazon EC2]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/) -* [Azure]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/azure/) -* [Digital Ocean]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/) -* [vSphere]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/) - -There are several other node drivers that are disabled by default, but are packaged in Rancher: - -* [Harvester]({{}}/rancher/v2.6/en/virtualization-admin/#harvester-node-driver/), available in Rancher v2.6.1 diff --git a/docs/en/backups/configuration/configuration.md b/docs/en/backups/configuration/configuration.md deleted file mode 100644 index d83cc04b29f..00000000000 --- a/docs/en/backups/configuration/configuration.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Rancher Backup Configuration Reference -shortTitle: Configuration -weight: 4 ---- - -- [Backup configuration](./backup-config) -- [Restore configuration](./restore-config) -- [Storage location configuration](./storage-config) -- [Example Backup and Restore Custom Resources](../examples) \ No newline at end of file diff --git a/docs/en/backups/docker-installs/docker-installs.md b/docs/en/backups/docker-installs/docker-installs.md index a2a71cad6c2..162dec39a6b 100644 --- a/docs/en/backups/docker-installs/docker-installs.md +++ b/docs/en/backups/docker-installs/docker-installs.md @@ -4,5 +4,5 @@ shortTitle: Docker Installs weight: 10 --- -- [Backups](./docker-backups) -- [Restores](./docker-restores) \ No newline at end of file +- [Backups](../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-docker-installed-rancher.md) +- [Restores](../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-docker-installed-rancher.md) \ No newline at end of file diff --git a/docs/en/best-practices/rancher-managed/rancher-managed.md b/docs/en/best-practices/rancher-managed/rancher-managed.md deleted file mode 100644 index 9d3d86d1fc6..00000000000 --- a/docs/en/best-practices/rancher-managed/rancher-managed.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Best Practices for Rancher Managed Clusters -shortTitle: Rancher Managed Clusters -weight: 2 ---- - -### Logging - -Refer to [this guide](./logging) for our recommendations for cluster-level logging and application logging. - -### Monitoring - -Configuring sensible monitoring and alerting rules is vital for running any production workloads securely and reliably. Refer to this [guide](./monitoring) for our recommendations. - -### Tips for Setting Up Containers - -Running well-built containers can greatly impact the overall performance and security of your environment. Refer to this [guide](./containers) for tips. - -### Best Practices for Rancher Managed vSphere Clusters - -This [guide](./managed-vsphere) outlines a reference architecture for provisioning downstream Rancher clusters in a vSphere environment, in addition to standard vSphere best practices as documented by VMware. diff --git a/docs/en/best-practices/rancher-server/rancher-server.md b/docs/en/best-practices/rancher-server/rancher-server.md deleted file mode 100644 index 32786386a3b..00000000000 --- a/docs/en/best-practices/rancher-server/rancher-server.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Best Practices for the Rancher Server -shortTitle: Rancher Server -weight: 1 ---- - -This guide contains our recommendations for running the Rancher server, and is intended to be used in situations in which Rancher manages downstream Kubernetes clusters. - -### Recommended Architecture and Infrastructure - -Refer to this [guide](./deployment-types) for our general advice for setting up the Rancher server on a high-availability Kubernetes cluster. - -### Deployment Strategies - -This [guide](./deployment-strategies) is designed to help you choose whether a regional deployment strategy or a hub-and-spoke deployment strategy is better for a Rancher server that manages downstream Kubernetes clusters. - -### Installing Rancher in a vSphere Environment - -This [guide](./rancher-in-vsphere) outlines a reference architecture for installing Rancher in a vSphere environment, in addition to standard vSphere best practices as documented by VMware. \ No newline at end of file diff --git a/docs/en/cluster-admin/editing-clusters/editing-clusters.md b/docs/en/cluster-admin/editing-clusters/editing-clusters.md deleted file mode 100644 index b6baba3117d..00000000000 --- a/docs/en/cluster-admin/editing-clusters/editing-clusters.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Cluster Configuration -weight: 2025 ---- - -After you provision a Kubernetes cluster using Rancher, you can still edit options and settings for the cluster. - -For information on editing cluster membership, go to [this page.]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/cluster-members) - -### Cluster Configuration References - -The cluster configuration options depend on the type of Kubernetes cluster: - -- [RKE Cluster Configuration](./rke-config-reference) -- [RKE2 Cluster Configuration](./rke2-config-reference) -- [K3s Cluster Configuration](./k3s-config-reference) -- [EKS Cluster Configuration](./eks-config-reference) -- [GKE Cluster Configuration](./gke-config-reference) -- [AKS Cluster Configuration](./aks-config-reference) - -### Cluster Management Capabilities by Cluster Type - -The options and settings available for an existing cluster change based on the method that you used to provision it. - -The following table summarizes the options and settings available for each cluster type: - -import ClusterCapabilitiesTable from '/rancher/v2.6/en/shared-files/_cluster-capabilities-table.md'; - - - diff --git a/docs/en/cluster-provisioning/rke-clusters/options/options.md b/docs/en/cluster-provisioning/rke-clusters/options/options.md index fa55f4c6be3..aeaf493d3bb 100644 --- a/docs/en/cluster-provisioning/rke-clusters/options/options.md +++ b/docs/en/cluster-provisioning/rke-clusters/options/options.md @@ -3,4 +3,4 @@ title: RKE Cluster Configuration weight: 2300 --- -This page has moved [here.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/rke-config-reference) +This page has moved [here.](../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md) diff --git a/docs/en/contributing/contributing.md b/docs/en/contribute-to-rancher.md similarity index 99% rename from docs/en/contributing/contributing.md rename to docs/en/contribute-to-rancher.md index 781c277bb30..44017019ff6 100644 --- a/docs/en/contributing/contributing.md +++ b/docs/en/contribute-to-rancher.md @@ -36,7 +36,7 @@ loglevel repository | https://github.com/rancher/loglevel | This repository is t To see all libraries/projects used in Rancher, see the [`go.mod` file](https://github.com/rancher/rancher/blob/master/go.mod) in the `rancher/rancher` repository. -![Rancher diagram]({{}}/img/rancher/ranchercomponentsdiagram-2.6.svg)
+![Rancher diagram](/img/ranchercomponentsdiagram-2.6.svg)
Rancher components used for provisioning/managing Kubernetes clusters. # Building diff --git a/docs/en/explanations.md b/docs/en/explanations.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/explanations.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/cis-scans/configuration/configuration.md b/docs/en/explanations/integrations-in-rancher/cis-scans/configuration-reference.md similarity index 100% rename from docs/en/cis-scans/configuration/configuration.md rename to docs/en/explanations/integrations-in-rancher/cis-scans/configuration-reference.md diff --git a/docs/en/cis-scans/custom-benchmark/custom-benchmark.md b/docs/en/explanations/integrations-in-rancher/cis-scans/custom-benchmark.md similarity index 100% rename from docs/en/cis-scans/custom-benchmark/custom-benchmark.md rename to docs/en/explanations/integrations-in-rancher/cis-scans/custom-benchmark.md diff --git a/docs/en/cis-scans/rbac/rbac.md b/docs/en/explanations/integrations-in-rancher/cis-scans/rbac-for-cis-scans.md similarity index 100% rename from docs/en/cis-scans/rbac/rbac.md rename to docs/en/explanations/integrations-in-rancher/cis-scans/rbac-for-cis-scans.md diff --git a/docs/en/cis-scans/skipped-tests/skipped-tests.md b/docs/en/explanations/integrations-in-rancher/cis-scans/skipped-and-not-applicable-tests.md similarity index 100% rename from docs/en/cis-scans/skipped-tests/skipped-tests.md rename to docs/en/explanations/integrations-in-rancher/cis-scans/skipped-and-not-applicable-tests.md diff --git a/docs/en/deploy-across-clusters/fleet/architecture/architecture.md b/docs/en/explanations/integrations-in-rancher/fleet-gitops-at-scale/architecture.md similarity index 88% rename from docs/en/deploy-across-clusters/fleet/architecture/architecture.md rename to docs/en/explanations/integrations-in-rancher/fleet-gitops-at-scale/architecture.md index 620747b01ca..f7725ddddde 100644 --- a/docs/en/deploy-across-clusters/fleet/architecture/architecture.md +++ b/docs/en/explanations/integrations-in-rancher/fleet-gitops-at-scale/architecture.md @@ -5,5 +5,5 @@ weight: 1 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/rancher/fleet-architecture.svg) +![Architecture](/img/fleet-architecture.svg) diff --git a/docs/en/deploy-across-clusters/fleet/proxy/proxy.md b/docs/en/explanations/integrations-in-rancher/fleet-gitops-at-scale/use-fleet-behind-a-proxy.md similarity index 100% rename from docs/en/deploy-across-clusters/fleet/proxy/proxy.md rename to docs/en/explanations/integrations-in-rancher/fleet-gitops-at-scale/use-fleet-behind-a-proxy.md diff --git a/docs/en/deploy-across-clusters/fleet/windows/windows.md b/docs/en/explanations/integrations-in-rancher/fleet-gitops-at-scale/windows-support.md similarity index 100% rename from docs/en/deploy-across-clusters/fleet/windows/windows.md rename to docs/en/explanations/integrations-in-rancher/fleet-gitops-at-scale/windows-support.md diff --git a/docs/en/virtualization-admin/virtualization-admin.md b/docs/en/explanations/integrations-in-rancher/harvester.md similarity index 90% rename from docs/en/virtualization-admin/virtualization-admin.md rename to docs/en/explanations/integrations-in-rancher/harvester.md index 2176f020f60..5bee9547a7e 100644 --- a/docs/en/virtualization-admin/virtualization-admin.md +++ b/docs/en/explanations/integrations-in-rancher/harvester.md @@ -13,7 +13,7 @@ Harvester is GA. Please refer to the [Harvester release notes](https://github.co --- ### Feature Flag -The Harvester feature flag is used to manage access to the Virtualization Management (VM) page in Rancher where users can navigate directly to Harvester clusters and access the Harvester UI. The Harvester feature flag is enabled by default. Click [here]({{}}/rancher/v2.6/en/installation/resources/feature-flags/) for more information on feature flags in Rancher. +The Harvester feature flag is used to manage access to the Virtualization Management (VM) page in Rancher where users can navigate directly to Harvester clusters and access the Harvester UI. The Harvester feature flag is enabled by default. Click [here](../../pages-for-subheaders/enable-experimental-features.md) for more information on feature flags in Rancher. To navigate to the Harvester cluster, click **☰ > Virtualization Management**. From Harvester Clusters page, click one of the clusters listed to go to the single Harvester cluster view. @@ -31,7 +31,7 @@ The [Harvester node driver](https://docs.harvesterhci.io/v0.3/rancher/node-drive Harvester allows `.ISO` images to be uploaded and displayed through the Harvester UI, but this is not supported in the Rancher UI. This is because `.ISO` images usually require additional setup that interferes with a clean deployment (without requiring user intervention), and they are not typically used in cloud environments. -Click [here]({{}}/rancher/v2.6/en/admin-settings/drivers/#node-drivers) for more information on node drivers in Rancher. +Click [here](../../pages-for-subheaders/about-provisioning-drivers.md#node-drivers) for more information on node drivers in Rancher. ### Limitations diff --git a/docs/en/istio/configuration-reference/rke2/rke2.md b/docs/en/explanations/integrations-in-rancher/istio/configuration-options/install-istio-on-rke2-cluster.md similarity index 100% rename from docs/en/istio/configuration-reference/rke2/rke2.md rename to docs/en/explanations/integrations-in-rancher/istio/configuration-options/install-istio-on-rke2-cluster.md diff --git a/docs/en/istio/configuration-reference/enable-istio-with-psp/enable-istio-with-psp.md b/docs/en/explanations/integrations-in-rancher/istio/configuration-options/pod-security-policies.md similarity index 100% rename from docs/en/istio/configuration-reference/enable-istio-with-psp/enable-istio-with-psp.md rename to docs/en/explanations/integrations-in-rancher/istio/configuration-options/pod-security-policies.md diff --git a/docs/en/istio/configuration-reference/canal-and-project-network/canal-and-project-network.md b/docs/en/explanations/integrations-in-rancher/istio/configuration-options/project-network-isolation.md similarity index 100% rename from docs/en/istio/configuration-reference/canal-and-project-network/canal-and-project-network.md rename to docs/en/explanations/integrations-in-rancher/istio/configuration-options/project-network-isolation.md diff --git a/docs/en/istio/configuration-reference/selectors-and-scrape/selectors-and-scrape.md b/docs/en/explanations/integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations.md similarity index 100% rename from docs/en/istio/configuration-reference/selectors-and-scrape/selectors-and-scrape.md rename to docs/en/explanations/integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations.md diff --git a/docs/en/istio/resources/resources.md b/docs/en/explanations/integrations-in-rancher/istio/cpu-and-memory-allocations.md similarity index 93% rename from docs/en/istio/resources/resources.md rename to docs/en/explanations/integrations-in-rancher/istio/cpu-and-memory-allocations.md index e45edd50f53..469dc529f6f 100644 --- a/docs/en/istio/resources/resources.md +++ b/docs/en/explanations/integrations-in-rancher/istio/cpu-and-memory-allocations.md @@ -42,7 +42,7 @@ To configure the resources allocated to an Istio component, 1. In the left navigation bar, click **Apps & Marketplace**. 1. Click **Installed Apps**. 1. Go to the `istio-system` namespace. In one of the Istio workloads, such as `rancher-istio`, click **⋮ > Edit/Upgrade**. -1. Click **Upgrade** to edit the base components via changes to the values.yaml or add an [overlay file]({{}}/rancher/v2.6/en/istio/configuration-reference/#overlay-file). For more information about editing the overlay file, see [this section.](./#editing-the-overlay-file) +1. Click **Upgrade** to edit the base components via changes to the values.yaml or add an [overlay file](../../../pages-for-subheaders/configuration-options.md#overlay-file). For more information about editing the overlay file, see [this section.](cpu-and-memory-allocations.md#editing-the-overlay-file) 1. Change the CPU or memory allocations, the nodes where each component will be scheduled to, or the node tolerations. 1. Click **Upgrade**. to rollout changes diff --git a/docs/en/istio/disabling-istio/disabling-istio.md b/docs/en/explanations/integrations-in-rancher/istio/disable-istio.md similarity index 100% rename from docs/en/istio/disabling-istio/disabling-istio.md rename to docs/en/explanations/integrations-in-rancher/istio/disable-istio.md diff --git a/docs/en/istio/rbac/rbac.md b/docs/en/explanations/integrations-in-rancher/istio/rbac-for-istio.md similarity index 100% rename from docs/en/istio/rbac/rbac.md rename to docs/en/explanations/integrations-in-rancher/istio/rbac-for-istio.md diff --git a/docs/en/logging/custom-resource-config/flows/flows.md b/docs/en/explanations/integrations-in-rancher/logging/custom-resource-configuration/flows-and-clusterflows.md similarity index 100% rename from docs/en/logging/custom-resource-config/flows/flows.md rename to docs/en/explanations/integrations-in-rancher/logging/custom-resource-configuration/flows-and-clusterflows.md diff --git a/docs/en/logging/custom-resource-config/outputs/outputs.md b/docs/en/explanations/integrations-in-rancher/logging/custom-resource-configuration/outputs-and-clusteroutputs.md similarity index 100% rename from docs/en/logging/custom-resource-config/outputs/outputs.md rename to docs/en/explanations/integrations-in-rancher/logging/custom-resource-configuration/outputs-and-clusteroutputs.md diff --git a/docs/en/logging/architecture/architecture.md b/docs/en/explanations/integrations-in-rancher/logging/logging-architecture.md similarity index 93% rename from docs/en/logging/architecture/architecture.md rename to docs/en/explanations/integrations-in-rancher/logging/logging-architecture.md index b72ddeacbd5..d977b279819 100644 --- a/docs/en/logging/architecture/architecture.md +++ b/docs/en/explanations/integrations-in-rancher/logging/logging-architecture.md @@ -26,4 +26,4 @@ The following figure from the [Banzai documentation](https://banzaicloud.com/doc
How the Banzai Cloud Logging Operator Works with Fluentd and Fluent Bit
-![How the Banzai Cloud Logging Operator Works with Fluentd]({{}}/img/rancher/banzai-cloud-logging-operator.png) +![How the Banzai Cloud Logging Operator Works with Fluentd](/img/banzai-cloud-logging-operator.png) diff --git a/docs/en/logging/helm-chart-options/helm-chart-options.md b/docs/en/explanations/integrations-in-rancher/logging/logging-helm-chart-options.md similarity index 97% rename from docs/en/logging/helm-chart-options/helm-chart-options.md rename to docs/en/explanations/integrations-in-rancher/logging/logging-helm-chart-options.md index bee19349e81..ae4edcb6520 100644 --- a/docs/en/logging/helm-chart-options/helm-chart-options.md +++ b/docs/en/explanations/integrations-in-rancher/logging/logging-helm-chart-options.md @@ -38,7 +38,7 @@ If there are any Windows nodes in the cluster, the change will not be applicable ### Adding NodeSelector Settings and Tolerations for Custom Taints -You can add your own `nodeSelector` settings and add `tolerations` for additional taints by editing the logging Helm chart values. For details, see [this page.](../taints-tolerations) +You can add your own `nodeSelector` settings and add `tolerations` for additional taints by editing the logging Helm chart values. For details, see [this page.](taints-and-tolerations.md) ### Enabling the Logging Application to Work with SELinux @@ -50,7 +50,7 @@ Logging v2 was tested with SELinux on RHEL/CentOS 7 and 8. [Security-Enhanced Linux (SELinux)](https://en.wikipedia.org/wiki/Security-Enhanced_Linux) is a security enhancement to Linux. After being historically used by government agencies, SELinux is now industry standard and is enabled by default on CentOS 7 and 8. -To use Logging v2 with SELinux, we recommend installing the `rancher-selinux` RPM according to the instructions on [this page.]({{}}/rancher/v2.6/en/security/selinux/#installing-the-rancher-selinux-rpm) +To use Logging v2 with SELinux, we recommend installing the `rancher-selinux` RPM according to the instructions on [this page.](../../../pages-for-subheaders/selinux-rpm.md#installing-the-rancher-selinux-rpm) Then, when installing the logging application, configure the chart to be SELinux aware by changing `global.seLinux.enabled` to `true` in the `values.yaml`. diff --git a/docs/en/logging/migrating/migrating.md b/docs/en/explanations/integrations-in-rancher/logging/migrate-to-rancher-v2.5+-logging.md similarity index 99% rename from docs/en/logging/migrating/migrating.md rename to docs/en/explanations/integrations-in-rancher/logging/migrate-to-rancher-v2.5+-logging.md index e039e3bb958..498569ea50b 100644 --- a/docs/en/logging/migrating/migrating.md +++ b/docs/en/explanations/integrations-in-rancher/logging/migrate-to-rancher-v2.5+-logging.md @@ -21,7 +21,7 @@ Among the many features and changes in the new logging functionality is the remo # Installation -To install logging in Rancher v2.5+, refer to the [installation instructions]({{}}/rancher/v2.6/en/logging/#enabling-logging). +To install logging in Rancher v2.5+, refer to the [installation instructions](../../../pages-for-subheaders/logging.md#enabling-logging). ### Terminology diff --git a/docs/en/logging/rbac/rbac.md b/docs/en/explanations/integrations-in-rancher/logging/rbac-for-logging.md similarity index 100% rename from docs/en/logging/rbac/rbac.md rename to docs/en/explanations/integrations-in-rancher/logging/rbac-for-logging.md diff --git a/docs/en/logging/taints-tolerations/taints-tolerations.md b/docs/en/explanations/integrations-in-rancher/logging/taints-and-tolerations.md similarity index 100% rename from docs/en/logging/taints-tolerations/taints-tolerations.md rename to docs/en/explanations/integrations-in-rancher/logging/taints-and-tolerations.md diff --git a/docs/en/longhorn/longhorn.md b/docs/en/explanations/integrations-in-rancher/longhorn.md similarity index 95% rename from docs/en/longhorn/longhorn.md rename to docs/en/explanations/integrations-in-rancher/longhorn.md index 187bfd5d2a9..ce7f6f77f4f 100644 --- a/docs/en/longhorn/longhorn.md +++ b/docs/en/explanations/integrations-in-rancher/longhorn.md @@ -20,7 +20,7 @@ With Longhorn, you can: - Upgrade Longhorn without disrupting persistent volumes
Longhorn Dashboard
-![Longhorn Dashboard]({{}}/img/rancher/longhorn-screenshot.png) +![Longhorn Dashboard](/img/longhorn-screenshot.png) ### Installing Longhorn with Rancher @@ -67,4 +67,4 @@ The storage controller and replicas are themselves orchestrated using Kubernetes You can learn more about its architecture [here.](https://longhorn.io/docs/latest/concepts/)
Longhorn Architecture
-![Longhorn Architecture]({{}}/img/rancher/longhorn-architecture.svg) +![Longhorn Architecture](/img/longhorn-architecture.svg) diff --git a/docs/en/monitoring-alerting/dashboards/dashboards.md b/docs/en/explanations/integrations-in-rancher/monitoring-and-alerting/built-in-dashboards.md similarity index 83% rename from docs/en/monitoring-alerting/dashboards/dashboards.md rename to docs/en/explanations/integrations-in-rancher/monitoring-and-alerting/built-in-dashboards.md index 100796b63cf..544fe729567 100644 --- a/docs/en/monitoring-alerting/dashboards/dashboards.md +++ b/docs/en/explanations/integrations-in-rancher/monitoring-and-alerting/built-in-dashboards.md @@ -15,15 +15,15 @@ To see the default dashboards for time series data visualization, go to the Graf ### Customizing Grafana -To view and customize the PromQL queries powering the Grafana dashboard, see [this page.](../guides/customize-grafana) +To view and customize the PromQL queries powering the Grafana dashboard, see [this page.](../../../how-to-guides/advanced-user-guides/monitoring-alerting-guides/customize-grafana-dashboard.md) ### Persistent Grafana Dashboards -To create a persistent Grafana dashboard, see [this page.](../guides/persist-grafana) +To create a persistent Grafana dashboard, see [this page.](../../../how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md) ### Access to Grafana -For information about role-based access control for Grafana, see [this section.](../rbac/#role-based-access-control-for-grafana) +For information about role-based access control for Grafana, see [this section.](rbac-for-monitoring.md#role-based-access-control-for-grafana) # Alertmanager UI @@ -32,7 +32,7 @@ When `rancher-monitoring` is installed, the Prometheus Alertmanager UI is deploy :::note -This section assumes familiarity with how monitoring components work together. For more information about Alertmanager, see [this section.](../how-monitoring-works/#how-alertmanager-works) +This section assumes familiarity with how monitoring components work together. For more information about Alertmanager, see [this section.](how-monitoring-works.md#how-alertmanager-works) ::: @@ -55,10 +55,10 @@ To see the Alertmanager UI, **Result:** The Alertmanager UI opens in a new tab. For help with configuration, refer to the [official Alertmanager documentation.](https://prometheus.io/docs/alerting/latest/alertmanager/) -For more information on configuring Alertmanager in Rancher, see [this page.](../configuration/advanced/alertmanager) +For more information on configuring Alertmanager in Rancher, see [this page.](../../../how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager.md)
The Alertmanager UI
-![Alertmanager UI]({{}}/img/rancher/alertmanager-ui.png) +![Alertmanager UI](/img/alertmanager-ui.png) ### Viewing Default Alerts @@ -78,7 +78,7 @@ To see the Prometheus UI, install `rancher-monitoring`. Then: 1. Click **Prometheus Graph**.
Prometheus Graph UI
-![Prometheus Graph UI]({{}}/img/rancher/prometheus-graph-ui.png) +![Prometheus Graph UI](/img/prometheus-graph-ui.png) ### Viewing the Prometheus Targets @@ -93,7 +93,7 @@ To see the Prometheus Targets, install `rancher-monitoring`. Then: 1. Click **Prometheus Targets**.
Targets in the Prometheus UI
-![Prometheus Targets UI]({{}}/img/rancher/prometheus-targets-ui.png) +![Prometheus Targets UI](/img/prometheus-targets-ui.png) ### Viewing the PrometheusRules @@ -109,6 +109,6 @@ To see the PrometheusRules, install `rancher-monitoring`. Then: You can also see the rules in the Prometheus UI:
Rules in the Prometheus UI
-![PrometheusRules UI]({{}}/img/rancher/prometheus-rules-ui.png) +![PrometheusRules UI](/img/prometheus-rules-ui.png) -For more information on configuring PrometheusRules in Rancher, see [this page.](../configuration/advanced/prometheusrules) \ No newline at end of file +For more information on configuring PrometheusRules in Rancher, see [this page.](../../../how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheusrules.md) \ No newline at end of file diff --git a/docs/en/monitoring-alerting/how-monitoring-works/how-monitoring-works.md b/docs/en/explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works.md similarity index 99% rename from docs/en/monitoring-alerting/how-monitoring-works/how-monitoring-works.md rename to docs/en/explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works.md index fcd70f138e8..d2937abac79 100644 --- a/docs/en/monitoring-alerting/how-monitoring-works/how-monitoring-works.md +++ b/docs/en/explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works.md @@ -45,7 +45,7 @@ ServiceMonitors and PodMonitors declaratively specify targets, such as Services

Process for Exporting Metrics with PushProx:
-![Process for Exporting Metrics with PushProx]({{}}/img/rancher/pushprox-process.svg) +![Process for Exporting Metrics with PushProx](/img/pushprox-process.svg) ### PrometheusRules @@ -137,7 +137,7 @@ While the Rancher UI forms only allow editing a routing tree that is two levels By editing the forms in the Rancher UI, you can set up a Receiver resource with all the information Alertmanager needs to send alerts to your notification system. -By editing custom YAML in the Alertmanager or Receiver configuration, you can also send alerts to multiple notification systems. For more information, see the section on configuring [Receivers.](../configuration/receiver/#configuring-multiple-receivers) +By editing custom YAML in the Alertmanager or Receiver configuration, you can also send alerts to multiple notification systems. For more information, see the section on configuring [Receivers.](../../../reference-guides/monitoring-v2-configuration/receivers.md#configuring-multiple-receivers) # 4. Monitoring V2 Specific Components diff --git a/docs/en/monitoring-alerting/expression/expression.md b/docs/en/explanations/integrations-in-rancher/monitoring-and-alerting/promql-expressions.md similarity index 100% rename from docs/en/monitoring-alerting/expression/expression.md rename to docs/en/explanations/integrations-in-rancher/monitoring-and-alerting/promql-expressions.md diff --git a/docs/en/monitoring-alerting/rbac/rbac.md b/docs/en/explanations/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md similarity index 98% rename from docs/en/monitoring-alerting/rbac/rbac.md rename to docs/en/explanations/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md index e025b733e64..418d42d95fe 100644 --- a/docs/en/monitoring-alerting/rbac/rbac.md +++ b/docs/en/explanations/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md @@ -175,7 +175,7 @@ To see the Grafana UI, install `rancher-monitoring`. Then: 1. Click **Grafana**.
Cluster Compute Resources Dashboard in Grafana
-![Cluster Compute Resources Dashboard in Grafana]({{}}/img/rancher/cluster-compute-resources-dashboard.png) +![Cluster Compute Resources Dashboard in Grafana](/img/cluster-compute-resources-dashboard.png)
Default Dashboards in Grafana
-![Default Dashboards in Grafana]({{}}/img/rancher/grafana-default-dashboard.png) \ No newline at end of file +![Default Dashboards in Grafana](/img/grafana-default-dashboard.png) \ No newline at end of file diff --git a/docs/en/monitoring-alerting/windows-clusters/windows-clusters.md b/docs/en/explanations/integrations-in-rancher/monitoring-and-alerting/windows-support.md similarity index 100% rename from docs/en/monitoring-alerting/windows-clusters/windows-clusters.md rename to docs/en/explanations/integrations-in-rancher/monitoring-and-alerting/windows-support.md diff --git a/docs/en/neuvector-integration/neuvector-integration.md b/docs/en/explanations/integrations-in-rancher/neuvector.md similarity index 95% rename from docs/en/neuvector-integration/neuvector-integration.md rename to docs/en/explanations/integrations-in-rancher/neuvector.md index 534019fabb0..e3635379261 100644 --- a/docs/en/neuvector-integration/neuvector-integration.md +++ b/docs/en/explanations/integrations-in-rancher/neuvector.md @@ -5,7 +5,7 @@ weight: 22 ### NeuVector Integration in Rancher -New in Rancher v2.6.5, [NeuVector 5.x](https://open-docs.neuvector.com/) is an open-source container-centric security platform that is now integrated into Rancher. NeuVector offers real-time compliance, visibility, and protection for critical applications and data during runtime. NeuVector provides a firewall, container process/file system monitoring, security auditing with CIS benchmarks, and vulnerability scanning. For more information on Rancher security, please see the [security documentation]({{}}/rancher/v2.6/en/security/). +New in Rancher v2.6.5, [NeuVector 5.x](https://open-docs.neuvector.com/) is an open-source container-centric security platform that is now integrated into Rancher. NeuVector offers real-time compliance, visibility, and protection for critical applications and data during runtime. NeuVector provides a firewall, container process/file system monitoring, security auditing with CIS benchmarks, and vulnerability scanning. For more information on Rancher security, please see the [security documentation](../../pages-for-subheaders/rancher-security.md). NeuVector can be enabled through a Helm chart that may be installed either through **Apps & Marketplace** or through the **Cluster Tools** button in the Rancher UI. Once the Helm chart is installed, users can easily [deploy and manage NeuVector clusters within Rancher](https://open-docs.neuvector.com/deploying/rancher#deploy-and-manage-neuvector-through-rancher-apps-marketplace). @@ -79,10 +79,10 @@ The NeuVector security solution contains four types of security containers: Cont - **Updater:** Updates the CVE database for Neuvector (when run); redeploys scanner pods.
**NeuVector Security Containers:**
-![NeuVector Security Containers]({{}}/img/rancher/neuvector-security-containers.png) +![NeuVector Security Containers](/img/neuvector-security-containers.png)
**NeuVector Architecture:**
-![NeuVector Architecture]({{}}/img/rancher/neuvector-architecture.png) +![NeuVector Architecture](/img/neuvector-architecture.png) To learn more about NeuVector's architecture, please refer [here](https://open-docs.neuvector.com/basics/overview#architecture). diff --git a/docs/en/opa-gatekeper/opa-gatekeeper.md b/docs/en/explanations/integrations-in-rancher/opa-gatekeeper.md similarity index 100% rename from docs/en/opa-gatekeper/opa-gatekeeper.md rename to docs/en/explanations/integrations-in-rancher/opa-gatekeeper.md diff --git a/docs/en/faq/faq.md b/docs/en/faq.md similarity index 89% rename from docs/en/faq/faq.md rename to docs/en/faq.md index 92b3894af2a..d92c75835d5 100644 --- a/docs/en/faq/faq.md +++ b/docs/en/faq.md @@ -5,7 +5,7 @@ weight: 25 This FAQ is a work in progress designed to answers the questions our users most frequently ask about Rancher v2.x. -See [Technical FAQ]({{}}/rancher/v2.6/en/faq/technical/), for frequently asked technical questions. +See [Technical FAQ](faq/technical-items.md), for frequently asked technical questions.
@@ -23,13 +23,13 @@ Yes. **Does Rancher support Windows?** -As of Rancher 2.3.0, we support Windows Server 1809 containers. For details on how to set up a cluster with Windows worker nodes, refer to the section on [configuring custom clusters for Windows.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/) +As of Rancher 2.3.0, we support Windows Server 1809 containers. For details on how to set up a cluster with Windows worker nodes, refer to the section on [configuring custom clusters for Windows.](pages-for-subheaders/use-windows-clusters.md)
**Does Rancher support Istio?** -As of Rancher 2.3.0, we support [Istio.]({{}}/rancher/v2.6/en/istio/) +As of Rancher 2.3.0, we support [Istio.](pages-for-subheaders/istio.md) Furthermore, Istio is implemented in our micro-PaaS "Rio", which works on Rancher 2.x along with any CNCF compliant Kubernetes cluster. You can read more about it [here](https://rio.io/) diff --git a/docs/en/faq/networking/cni-providers/cni-providers.md b/docs/en/faq/container-network-interface-providers.md similarity index 87% rename from docs/en/faq/networking/cni-providers/cni-providers.md rename to docs/en/faq/container-network-interface-providers.md index 362c8e8d22a..f80df98d395 100644 --- a/docs/en/faq/networking/cni-providers/cni-providers.md +++ b/docs/en/faq/container-network-interface-providers.md @@ -10,7 +10,7 @@ CNI (Container Network Interface), a [Cloud Native Computing Foundation project] Kubernetes uses CNI as an interface between network providers and Kubernetes pod networking. -![CNI Logo]({{}}/img/rancher/cni-logo.png) +![CNI Logo](/img/cni-logo.png) For more information visit [CNI GitHub project](https://github.com/containernetworking/cni). @@ -28,7 +28,7 @@ This network model is used when an extended L2 bridge is preferred. This network CNI network providers using this network model include Flannel, Canal, Weave, and Cilium. By default, Calico is not using this model, but it can be configured to do so. -![Encapsulated Network]({{}}/img/rancher/encapsulated-network.png) +![Encapsulated Network](/img/encapsulated-network.png) ### What is an Unencapsulated Network? @@ -40,7 +40,7 @@ This network model is used when a routed L3 network is preferred. This mode dyna CNI network providers using this network model include Calico and Cilium. Cilium may be configured with this model although it is not the default mode. -![Unencapsulated Network]({{}}/img/rancher/unencapsulated-network.png) +![Unencapsulated Network](/img/unencapsulated-network.png) ## What CNI Providers are Provided by Rancher? @@ -52,21 +52,21 @@ You can choose your CNI network provider when you create new Kubernetes clusters #### Canal -![Canal Logo]({{}}/img/rancher/canal-logo.png) +![Canal Logo](/img/canal-logo.png) Canal is a CNI network provider that gives you the best of Flannel and Calico. It allows users to easily deploy Calico and Flannel networking together as a unified networking solution, combining Calico’s network policy enforcement with the rich superset of Calico (unencapsulated) and/or Flannel (encapsulated) network connectivity options. In Rancher, Canal is the default CNI network provider combined with Flannel and VXLAN encapsulation. -Kubernetes workers should open UDP port `8472` (VXLAN) and TCP port `9099` (health checks). If using Wireguard, you should open UDP ports `51820` and `51821`. For more details, refer to [the port requirements for user clusters]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/). +Kubernetes workers should open UDP port `8472` (VXLAN) and TCP port `9099` (health checks). If using Wireguard, you should open UDP ports `51820` and `51821`. For more details, refer to [the port requirements for user clusters](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md). -{{< img "/img/rancher/canal-diagram.png" "Canal Diagram">}} +![](/img/canal-diagram.png) For more information, see the [Canal GitHub Page.](https://github.com/projectcalico/canal) #### Flannel -![Flannel Logo]({{}}/img/rancher/flannel-logo.png) +![Flannel Logo](/img/flannel-logo.png) Flannel is a simple and easy way to configure L3 network fabric designed for Kubernetes. Flannel runs a single binary agent named flanneld on each host, which is responsible for allocating a subnet lease to each host out of a larger, preconfigured address space. Flannel uses either the Kubernetes API or etcd directly to store the network configuration, the allocated subnets, and any auxiliary data (such as the host's public IP). Packets are forwarded using one of several backend mechanisms, with the default encapsulation being [VXLAN](https://github.com/flannel-io/flannel/blob/master/Documentation/backends.md#vxlan). @@ -75,19 +75,19 @@ Encapsulated traffic is unencrypted by default. Flannel provides two solutions f * [IPSec](https://github.com/flannel-io/flannel/blob/master/Documentation/backends.md#ipsec), which makes use of [strongSwan](https://www.strongswan.org/) to establish encrypted IPSec tunnels between Kubernetes workers. It is an experimental backend for encryption. * [WireGuard](https://github.com/flannel-io/flannel/blob/master/Documentation/backends.md#wireguard), which is a more faster-performing alternative to strongSwan. -Kubernetes workers should open UDP port `8472` (VXLAN). See [the port requirements for user clusters]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements) for more details. +Kubernetes workers should open UDP port `8472` (VXLAN). See [the port requirements for user clusters](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md#networking-requirements) for more details. -![Flannel Diagram]({{}}/img/rancher/flannel-diagram.png) +![Flannel Diagram](/img/flannel-diagram.png) For more information, see the [Flannel GitHub Page](https://github.com/flannel-io/flannel). #### Weave -![Weave Logo]({{}}/img/rancher/weave-logo.png) +![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. -Kubernetes workers should open TCP port `6783` (control port), UDP port `6783` and UDP port `6784` (data ports). See the [port requirements for user clusters]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements) for more details. +Kubernetes workers should open TCP port `6783` (control port), UDP port `6783` and UDP port `6784` (data ports). See the [port requirements for user clusters](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md#networking-requirements) for more details. For more information, see the following pages: @@ -101,13 +101,13 @@ You can choose your CNI network provider when you create new Kubernetes clusters #### Calico -![Calico Logo]({{}}/img/rancher/calico-logo.png) +![Calico Logo](/img/calico-logo.png) Calico enables networking and network policy in Kubernetes clusters across the cloud. By default, Calico uses a pure, unencapsulated IP network fabric and policy engine to provide networking for your Kubernetes workloads. Workloads are able to communicate over both cloud infrastructure and on-prem using BGP. Calico also provides a stateless IP-in-IP or VXLAN encapsulation mode that can be used, if necessary. Calico also offers policy isolation, allowing you to secure and govern your Kubernetes workloads using advanced ingress and egress policies. -Kubernetes workers should open TCP port `179` if using BGP or UDP port `4789` if using VXLAN encapsulation. In addition, TCP port `5473` is needed when using Typha. See [the port requirements for user clusters]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements) for more details. +Kubernetes workers should open TCP port `179` if using BGP or UDP port `4789` if using VXLAN encapsulation. In addition, TCP port `5473` is needed when using Typha. See [the port requirements for user clusters](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md#networking-requirements) for more details. :::note Important: @@ -119,7 +119,7 @@ In Rancher v2.6.3, Calico probes fail on Windows nodes upon RKE2 installation. < ::: -![Calico Diagram]({{}}/img/rancher/calico-diagram.svg) +![Calico Diagram](/img/calico-diagram.svg) For more information, see the following pages: @@ -128,7 +128,7 @@ For more information, see the following pages: #### Cilium -![Cilium Logo]({{}}/img/rancher/cilium-logo.png) +![Cilium Logo](/img/cilium-logo.png) Cilium enables networking and network policies (L3, L4, and L7) in Kubernetes. By default, Cilium uses eBPF technologies to route packets inside the node and VXLAN to send packets to other nodes. Unencapsulated techniques can also be configured. @@ -202,4 +202,4 @@ Canal is the default CNI network provider. We recommend it for most use cases. I ## How can I configure a CNI network provider? -Please see [Cluster Options]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/) on how to configure a network provider for your cluster. For more advanced configuration options, please see how to configure your cluster using a [Config File]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#cluster-config-file) and the options for [Network Plug-ins]({{}}/rke/latest/en/config-options/add-ons/network-plugins/). +Please see [Cluster Options](cluster-provisioning/rke-clusters/options/) on how to configure a network provider for your cluster. For more advanced configuration options, please see how to configure your cluster using a [Config File](cluster-provisioning/rke-clusters/options/#cluster-config-file) and the options for [Network Plug-ins](https://rancher.com/docs/rke/latest/en/config-options/add-ons/network-plugins/). diff --git a/docs/en/faq/deprecated-features/deprecated-features.md b/docs/en/faq/deprecated-features-in-v2.5.md similarity index 100% rename from docs/en/faq/deprecated-features/deprecated-features.md rename to docs/en/faq/deprecated-features-in-v2.5.md diff --git a/docs/en/faq/dockershim/dockershim.md b/docs/en/faq/dockershim.md similarity index 100% rename from docs/en/faq/dockershim/dockershim.md rename to docs/en/faq/dockershim.md diff --git a/docs/en/faq/kubectl/kubectl.md b/docs/en/faq/install-and-configure-kubectl.md similarity index 100% rename from docs/en/faq/kubectl/kubectl.md rename to docs/en/faq/install-and-configure-kubectl.md diff --git a/docs/en/faq/networking/networking.md b/docs/en/faq/networking/networking.md index e9ebe37f4df..149ff4853a3 100644 --- a/docs/en/faq/networking/networking.md +++ b/docs/en/faq/networking/networking.md @@ -5,5 +5,5 @@ weight: 8005 Networking FAQ's -- [CNI Providers]({{}}/rancher/v2.6/en/faq/networking/cni-providers/) +- [CNI Providers](../container-network-interface-providers.md) diff --git a/docs/en/faq/removing-rancher/removing-rancher.md b/docs/en/faq/rancher-is-no-longer-needed.md similarity index 74% rename from docs/en/faq/removing-rancher/removing-rancher.md rename to docs/en/faq/rancher-is-no-longer-needed.md index 33f41f44b49..ac895b26f31 100644 --- a/docs/en/faq/removing-rancher/removing-rancher.md +++ b/docs/en/faq/rancher-is-no-longer-needed.md @@ -21,17 +21,17 @@ The capability to access a downstream cluster without Rancher depends on the typ - **Registered clusters:** The cluster will be unaffected and you can access the cluster using the same methods that you did before the cluster was registered into Rancher. - **Hosted Kubernetes clusters:** If you created the cluster in a cloud-hosted Kubernetes provider such as EKS, GKE, or AKS, you can continue to manage the cluster using your provider's cloud credentials. -- **RKE clusters:** To access an [RKE cluster,]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) the cluster must have the [authorized cluster endpoint]({{}}/rancher/v2.6/en/overview/architecture/#4-authorized-cluster-endpoint) enabled, and you must have already downloaded the cluster's kubeconfig file from the Rancher UI. (The authorized cluster endpoint is enabled by default for RKE clusters.) With this endpoint, you can access your cluster with kubectl directly instead of communicating through the Rancher server's [authentication proxy.]({{}}/rancher/v2.6/en/overview/architecture/#1-the-authentication-proxy) For instructions on how to configure kubectl to use the authorized cluster endpoint, refer to the section about directly accessing clusters with [kubectl and the kubeconfig file.]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) These clusters will use a snapshot of the authentication as it was configured when Rancher was removed. +- **RKE clusters:** To access an [RKE cluster,](../pages-for-subheaders/launch-kubernetes-with-rancher.md) the cluster must have the [authorized cluster endpoint](../pages-for-subheaders/rancher-manager-architecture.md#4-authorized-cluster-endpoint) enabled, and you must have already downloaded the cluster's kubeconfig file from the Rancher UI. (The authorized cluster endpoint is enabled by default for RKE clusters.) With this endpoint, you can access your cluster with kubectl directly instead of communicating through the Rancher server's [authentication proxy.](../pages-for-subheaders/rancher-manager-architecture.md#1-the-authentication-proxy) For instructions on how to configure kubectl to use the authorized cluster endpoint, refer to the section about directly accessing clusters with [kubectl and the kubeconfig file.](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#authenticating-directly-with-a-downstream-cluster) These clusters will use a snapshot of the authentication as it was configured when Rancher was removed. ### What if I don't want Rancher anymore? :::note -The previously recommended [System Tools]({{}}/rancher/v2.6/en/system-tools/) has been deprecated since June 2022. +The previously recommended [System Tools](../reference-guides/system-tools.md) has been deprecated since June 2022. ::: -If you [installed Rancher on a Kubernetes cluster,]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) remove Rancher by using the [Rancher Cleanup](https://github.com/rancher/rancher-cleanup) tool. +If you [installed Rancher on a Kubernetes cluster,](../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md) remove Rancher by using the [Rancher Cleanup](https://github.com/rancher/rancher-cleanup) tool. As of Rancher v2.5.8, uninstalling Rancher in high-availability (HA) mode will also remove all `helm-operation-*` pods and the following apps: diff --git a/docs/en/faq/security/security.md b/docs/en/faq/security.md similarity index 60% rename from docs/en/faq/security/security.md rename to docs/en/faq/security.md index 6759f6d2946..aee42e0fb93 100644 --- a/docs/en/faq/security/security.md +++ b/docs/en/faq/security.md @@ -6,10 +6,10 @@ weight: 8007 **Is there a Hardening Guide?** -The Hardening Guide is now located in the main [Security]({{}}/rancher/v2.6/en/security/) section. +The Hardening Guide is now located in the main [Security](../pages-for-subheaders/rancher-security.md) section.
**What are the results of Rancher's Kubernetes cluster when it is CIS benchmarked?** -We have run the CIS Kubernetes benchmark against a hardened Rancher Kubernetes cluster. The results of that assessment can be found in the main [Security]({{}}/rancher/v2.6/en/security/) section. +We have run the CIS Kubernetes benchmark against a hardened Rancher Kubernetes cluster. The results of that assessment can be found in the main [Security](../pages-for-subheaders/rancher-security.md) section. diff --git a/docs/en/faq/technical/technical.md b/docs/en/faq/technical-items.md similarity index 89% rename from docs/en/faq/technical/technical.md rename to docs/en/faq/technical-items.md index 59630e73b9d..7698bbb4f7a 100644 --- a/docs/en/faq/technical/technical.md +++ b/docs/en/faq/technical-items.md @@ -40,7 +40,7 @@ New password for default administrator (user-xxxxx): ``` ### How can I enable debug logging? -See [Troubleshooting: Logging]({{}}/rancher/v2.6/en/troubleshooting/logging/) +See [Troubleshooting: Logging](../troubleshooting/other-troubleshooting-tips/logging.md) ### My ClusterIP does not respond to ping @@ -52,7 +52,7 @@ Node Templates can be accessed by opening your account menu (top right) and sele ### Why is my Layer-4 Load Balancer in `Pending` state? -The Layer-4 Load Balancer is created as `type: LoadBalancer`. In Kubernetes, this needs a cloud provider or controller that can satisfy these requests, otherwise these will be in `Pending` state forever. More information can be found on [Cloud Providers]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/) or [Create External Load Balancer](https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/) +The Layer-4 Load Balancer is created as `type: LoadBalancer`. In Kubernetes, this needs a cloud provider or controller that can satisfy these requests, otherwise these will be in `Pending` state forever. More information can be found on [Cloud Providers](../pages-for-subheaders/set-up-cloud-providers.md) or [Create External Load Balancer](https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/) ### Where is the state of Rancher stored? @@ -67,7 +67,7 @@ We follow the validated Docker versions for upstream Kubernetes releases. The va SSH keys to access the nodes created by Rancher can be downloaded via the **Nodes** view. Choose the node which you want to access and click on the vertical ⋮ button at the end of the row, and choose **Download Keys** as shown in the picture below. -![Download Keys]({{}}/img/rancher/downloadsshkeys.png) +![Download Keys](/img/downloadsshkeys.png) Unzip the downloaded zip file, and use the file `id_rsa` to connect to you host. Be sure to use the correct username (`rancher` or `docker` for RancherOS, `ubuntu` for Ubuntu, `ec2-user` for Amazon Linux) @@ -86,13 +86,13 @@ The UI consists of static files, and works based on responses of the API. That m A node is required to have a static IP configured (or a reserved IP via DHCP). If the IP of a node has changed, you will have to remove it from the cluster and readd it. After it is removed, Rancher will update the cluster to the correct state. If the cluster is no longer in `Provisioning` state, the node is removed from the cluster. -When the IP address of the node changed, Rancher lost connection to the node, so it will be unable to clean the node properly. See [Cleaning cluster nodes]({{}}/rancher/v2.6/en/cluster-admin/cleaning-cluster-nodes/) to clean the node. +When the IP address of the node changed, Rancher lost connection to the node, so it will be unable to clean the node properly. See [Cleaning cluster nodes](../how-to-guides/advanced-user-guides/manage-clusters/clean-cluster-nodes.md) to clean the node. When the node is removed from the cluster, and the node is cleaned, you can readd the node to the cluster. ### How can I add additional arguments/binds/environment variables to Kubernetes components in a Rancher Launched Kubernetes cluster? -You can add additional arguments/binds/environment variables via the [Config File]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#cluster-config-file) option in Cluster Options. For more information, see the [Extra Args, Extra Binds, and Extra Environment Variables]({{}}/rke/latest/en/config-options/services/services-extras/) in the RKE documentation or browse the [Example Cluster.ymls]({{}}/rke/latest/en/example-yamls/). +You can add additional arguments/binds/environment variables via the [Config File](cluster-provisioning/rke-clusters/options/#cluster-config-file) option in Cluster Options. For more information, see the [Extra Args, Extra Binds, and Extra Environment Variables](https://rancher.com/docs/rke/latest/en/config-options/services/services-extras/) in the RKE documentation or browse the [Example Cluster.ymls](https://rancher.com/docs/rke/latest/en/example-yamls/). ### How do I check if my certificate chain is valid? diff --git a/docs/en/faq/telemetry/telemetry.md b/docs/en/faq/telemetry.md similarity index 100% rename from docs/en/faq/telemetry/telemetry.md rename to docs/en/faq/telemetry.md diff --git a/docs/en/getting-started.md b/docs/en/getting-started.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/getting-started.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/installation/resources/advanced/single-node-install-external-lb/single-node-install-external-lb.md b/docs/en/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/configure-layer-7-nginx-load-balancer.md similarity index 86% rename from docs/en/installation/resources/advanced/single-node-install-external-lb/single-node-install-external-lb.md rename to docs/en/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/configure-layer-7-nginx-load-balancer.md index 6c5e27f7901..964fe74f4e1 100644 --- a/docs/en/installation/resources/advanced/single-node-install-external-lb/single-node-install-external-lb.md +++ b/docs/en/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/configure-layer-7-nginx-load-balancer.md @@ -11,7 +11,7 @@ This install procedure walks you through deployment of Rancher using a single co ## Requirements for OS, Docker, Hardware, and Networking -Make sure that your node fulfills the general [installation requirements.]({{}}/rancher/v2.6/en/installation/requirements/) +Make sure that your node fulfills the general [installation requirements.](../../../../pages-for-subheaders/installation-requirements.md) ## Installation Outline @@ -25,7 +25,7 @@ Make sure that your node fulfills the general [installation requirements.]({{}}/rancher/v2.6/en/installation/requirements) to launch your Rancher Server. +Provision a single Linux host according to our [Requirements](../../../../pages-for-subheaders/installation-requirements.md) to launch your Rancher Server. ## 2. Choose an SSL Option and Install Rancher @@ -173,20 +173,20 @@ http { ## What's Next? -- **Recommended:** Review [Single Node Backup and Restore]({{}}/rancher/v2.6/en/backups/docker-installs/). Although you don't have any data you need to back up right now, we recommend creating backups after regular Rancher use. -- Create a Kubernetes cluster: [Provisioning Kubernetes Clusters]({{}}/rancher/v2.6/en/cluster-provisioning/). +- **Recommended:** Review [Single Node Backup and Restore](backups/docker-installs/). Although you don't have any data you need to back up right now, we recommend creating backups after regular Rancher use. +- Create a Kubernetes cluster: [Provisioning Kubernetes Clusters](../../../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md).
## FAQ and Troubleshooting -For help troubleshooting certificates, see [this section.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting) +For help troubleshooting certificates, see [this section.](../../other-installation-methods/rancher-on-a-single-node-with-docker/certificate-troubleshooting.md) ## Advanced Options ### API Auditing -If you want to record all transactions with the Rancher API, enable the [API Auditing]({{}}/rancher/v2.6/en/installation/resources/advanced/api-audit-log) feature by adding the flags below into your install command. +If you want to record all transactions with the Rancher API, enable the [API Auditing](enable-api-audit-log.md) feature by adding the flags below into your install command. -e AUDIT_LEVEL=1 \ -e AUDIT_LOG_PATH=/var/log/auditlog/rancher-api-audit.log \ @@ -196,7 +196,7 @@ If you want to record all transactions with the Rancher API, enable the [API Aud ### Air Gap -If you are visiting this page to complete an [Air Gap Installation]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap), you must pre-pend your private registry URL to the server tag when running the installation command in the option that you choose. Add `` with your private registry URL in front of `rancher/rancher:latest`. +If you are visiting this page to complete an [Air Gap Installation](../../../../pages-for-subheaders/air-gapped-helm-cli-install.md), you must pre-pend your private registry URL to the server tag when running the installation command in the option that you choose. Add `` with your private registry URL in front of `rancher/rancher:latest`. **Example:** @@ -216,7 +216,7 @@ docker run -d --restart=unless-stopped \ rancher/rancher:latest ``` -As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) +As of Rancher v2.5, privileged access is [required.](../../../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher-v2-5) This layer 7 NGINX configuration is tested on NGINX version 1.13 (mainline) and 1.14 (stable). diff --git a/docs/en/installation/resources/advanced/api-audit-log/api-audit-log.md b/docs/en/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/enable-api-audit-log.md similarity index 98% rename from docs/en/installation/resources/advanced/api-audit-log/api-audit-log.md rename to docs/en/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/enable-api-audit-log.md index 687cbff55ec..d42f6bb902b 100644 --- a/docs/en/installation/resources/advanced/api-audit-log/api-audit-log.md +++ b/docs/en/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/enable-api-audit-log.md @@ -11,9 +11,9 @@ You can enable API Auditing during Rancher installation or upgrade. The Audit Log is enabled and configured by passing environment variables to the Rancher server container. See the following to enable on your installation. -- [Docker Install]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#api-audit-log) +- [Docker Install](../../../../reference-guides/single-node-rancher-in-docker/advanced-options.md#api-audit-log) -- [Kubernetes Install]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#api-audit-log) +- [Kubernetes Install](../../../../reference-guides/installation-references/helm-chart-options.md#api-audit-log) ## API Audit Log Options @@ -60,7 +60,7 @@ kubectl -n cattle-system logs -f rancher-84d886bdbb-s4s69 rancher-audit-log #### Shipping the Audit Log -You can enable Rancher's built in log collection and shipping for the cluster to ship the audit and other services logs to a supported collection endpoint. See [Rancher Tools - Logging]({{}}/rancher/v2.6/en/logging) for details. +You can enable Rancher's built in log collection and shipping for the cluster to ship the audit and other services logs to a supported collection endpoint. See [Rancher Tools - Logging](../../../../pages-for-subheaders/logging.md) for details. ## Audit Log Samples diff --git a/docs/en/installation/resources/advanced/firewall/firewall.md b/docs/en/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/open-ports-with-firewalld.md similarity index 96% rename from docs/en/installation/resources/advanced/firewall/firewall.md rename to docs/en/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/open-ports-with-firewalld.md index 69c1afae91d..78b4313e145 100644 --- a/docs/en/installation/resources/advanced/firewall/firewall.md +++ b/docs/en/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/open-ports-with-firewalld.md @@ -32,7 +32,7 @@ You can check the default firewall rules with this command: sudo iptables --list ``` -This section describes how to use `firewalld` to apply the [firewall port rules]({{}}/rancher/v2.6/en/installation/requirements/ports) for nodes in a high-availability Rancher server cluster. +This section describes how to use `firewalld` to apply the [firewall port rules](../../installation-requirements/port-requirements.md) for nodes in a high-availability Rancher server cluster. # Prerequisite diff --git a/docs/en/installation/resources/advanced/etcd/etcd.md b/docs/en/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/tune-etcd-for-large-installs.md similarity index 100% rename from docs/en/installation/resources/advanced/etcd/etcd.md rename to docs/en/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/tune-etcd-for-large-installs.md diff --git a/docs/en/installation/resources/feature-flags/continuous-delivery/continuous-delivery.md b/docs/en/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/continuous-delivery.md similarity index 58% rename from docs/en/installation/resources/feature-flags/continuous-delivery/continuous-delivery.md rename to docs/en/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/continuous-delivery.md index c3fb7f798ef..2451705a993 100644 --- a/docs/en/installation/resources/feature-flags/continuous-delivery/continuous-delivery.md +++ b/docs/en/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/continuous-delivery.md @@ -3,9 +3,9 @@ title: Continuous Delivery weight: 3 --- -As of Rancher v2.5, [Fleet]({{}}/rancher/v2.6/en/deploy-across-clusters/fleet) comes preinstalled in Rancher, and as of Rancher v2.6, Fleet can no longer be fully disabled. However, the Fleet feature for GitOps continuous delivery may be disabled using the `continuous-delivery` feature flag. +As of Rancher v2.5, [Fleet](../../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) comes preinstalled in Rancher, and as of Rancher v2.6, Fleet can no longer be fully disabled. However, the Fleet feature for GitOps continuous delivery may be disabled using the `continuous-delivery` feature flag. -To enable or disable this feature, refer to the instructions on [the main page about enabling experimental features.]({{}}/rancher/v2.6/en/installation/resources/feature-flags/) +To enable or disable this feature, refer to the instructions on [the main page about enabling experimental features.](../../../../pages-for-subheaders/enable-experimental-features.md) Environment Variable Key | Default Value | Description ---|---|--- diff --git a/docs/en/installation/resources/feature-flags/istio-virtual-service-ui/istio-virtual-service-ui.md b/docs/en/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/istio-traffic-management-features.md similarity index 91% rename from docs/en/installation/resources/feature-flags/istio-virtual-service-ui/istio-virtual-service-ui.md rename to docs/en/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/istio-traffic-management-features.md index 0b5a1395ab6..19a38981b1b 100644 --- a/docs/en/installation/resources/feature-flags/istio-virtual-service-ui/istio-virtual-service-ui.md +++ b/docs/en/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/istio-traffic-management-features.md @@ -5,9 +5,9 @@ weight: 2 This feature enables a UI that lets you create, read, update and delete virtual services and destination rules, which are traffic management features of Istio. -> **Prerequisite:** Turning on this feature does not enable Istio. A cluster administrator needs to [enable Istio for the cluster]({{}}/rancher/v2.6/en/istio/setup) in order to use the feature. +> **Prerequisite:** Turning on this feature does not enable Istio. A cluster administrator needs to [enable Istio for the cluster](../../../../pages-for-subheaders/istio-setup-guide.md) in order to use the feature. -To enable or disable this feature, refer to the instructions on [the main page about enabling experimental features.]({{}}/rancher/v2.6/en/installation/resources/feature-flags/) +To enable or disable this feature, refer to the instructions on [the main page about enabling experimental features.](../../../../pages-for-subheaders/enable-experimental-features.md) Environment Variable Key | Default Value | Status | Available as of ---|---|---|--- diff --git a/docs/en/installation/resources/advanced/arm64-platform/arm64-platform.md b/docs/en/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/rancher-on-arm64.md similarity index 87% rename from docs/en/installation/resources/advanced/arm64-platform/arm64-platform.md rename to docs/en/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/rancher-on-arm64.md index 3d7e1462fff..04da6234022 100644 --- a/docs/en/installation/resources/advanced/arm64-platform/arm64-platform.md +++ b/docs/en/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/rancher-on-arm64.md @@ -33,11 +33,11 @@ version's release notes in the following two ways: - Create custom cluster and adding ARM64 based node(s) - Kubernetes cluster version must be 1.12 or higher - - CNI Network Provider must be [Flannel]({{}}/rancher/v2.6/en/faq/networking/cni-providers/#flannel) + - CNI Network Provider must be [Flannel](../../../../faq/container-network-interface-providers.md#flannel) - Importing clusters that contain ARM64 based nodes - Kubernetes cluster version must be 1.12 or higher -Please see [Cluster Options]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/) how to configure the cluster options. +Please see [Cluster Options](cluster-provisioning/rke-clusters/options/) how to configure the cluster options. The following features are not tested: diff --git a/docs/en/installation/resources/feature-flags/enable-not-default-storage-drivers/enable-not-default-storage-drivers.md b/docs/en/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/unsupported-storage-drivers.md similarity index 92% rename from docs/en/installation/resources/feature-flags/enable-not-default-storage-drivers/enable-not-default-storage-drivers.md rename to docs/en/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/unsupported-storage-drivers.md index 05affcc91ad..3d8c86b8c5a 100644 --- a/docs/en/installation/resources/feature-flags/enable-not-default-storage-drivers/enable-not-default-storage-drivers.md +++ b/docs/en/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/unsupported-storage-drivers.md @@ -5,7 +5,7 @@ weight: 1 This feature allows you to use types for storage providers and provisioners that are not enabled by default. -To enable or disable this feature, refer to the instructions on [the main page about enabling experimental features.]({{}}/rancher/v2.6/en/installation/resources/feature-flags/) +To enable or disable this feature, refer to the instructions on [the main page about enabling experimental features.](../../../../pages-for-subheaders/enable-experimental-features.md) Environment Variable Key | Default Value | Description ---|---|--- diff --git a/docs/en/installation/install-rancher-on-k8s/upgrades/air-gap-upgrade/air-gap-upgrade.md b/docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/air-gapped-upgrades.md similarity index 96% rename from docs/en/installation/install-rancher-on-k8s/upgrades/air-gap-upgrade/air-gap-upgrade.md rename to docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/air-gapped-upgrades.md index 0f334a5a20a..1a210945322 100644 --- a/docs/en/installation/install-rancher-on-k8s/upgrades/air-gap-upgrade/air-gap-upgrade.md +++ b/docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/air-gapped-upgrades.md @@ -6,7 +6,7 @@ weight: 1 :::note -These instructions assume you have already followed the instructions for a Kubernetes upgrade on [this page,]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/) including the prerequisites, up until step 3. Upgrade Rancher. +These instructions assume you have already followed the instructions for a Kubernetes upgrade on [this page,](upgrades.md) including the prerequisites, up until step 3. Upgrade Rancher. ::: diff --git a/docs/en/installation/resources/k8s-tutorials/aks/aks.md b/docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md similarity index 93% rename from docs/en/installation/resources/k8s-tutorials/aks/aks.md rename to docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md index c8f891eec54..f6029f909ba 100644 --- a/docs/en/installation/resources/k8s-tutorials/aks/aks.md +++ b/docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md @@ -8,7 +8,7 @@ This page covers how to install Rancher on Microsoft's Azure Kubernetes Service The guide uses command line tools to provision an AKS cluster with an ingress. If you prefer to provision your cluster using the Azure portal, refer to the [official documentation](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal). -If you already have an AKS Kubernetes cluster, skip to the step about [installing an ingress.](#5-install-an-ingress) Then install the Rancher Helm chart following the instructions on [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) +If you already have an AKS Kubernetes cluster, skip to the step about [installing an ingress.](#5-install-an-ingress) Then install the Rancher Helm chart following the instructions on [this page.](../../../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md#install-the-rancher-helm-chart) # Prerequisites @@ -21,7 +21,7 @@ Deploying to Microsoft Azure will incur charges. - [Microsoft Azure Account](https://azure.microsoft.com/en-us/free/): A Microsoft Azure Account is required to create resources for deploying Rancher and Kubernetes. - [Microsoft Azure Subscription](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription#create-a-subscription-in-the-azure-portal): Use this link to follow a tutorial to create a Microsoft Azure subscription if you don't have one yet. - [Micsoroft Azure Tenant](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-create-new-tenant): Use this link and follow instructions to create a Microsoft Azure tenant. -- Your subscription has sufficient quota for at least 2 vCPUs. For details on Rancher server resource requirements, refer to [this section]({{}}/rancher/v2.6/en/installation/requirements/#rke-and-hosted-kubernetes) +- Your subscription has sufficient quota for at least 2 vCPUs. For details on Rancher server resource requirements, refer to [this section](../../../pages-for-subheaders/installation-requirements.md#rke-and-hosted-kubernetes) - When installing Rancher with Helm in Azure, use the L7 load balancer to avoid networking issues. For more information, refer to the documentation on [Azure load balancer limitations](https://docs.microsoft.com/en-us/azure/load-balancer/components#limitations). # 1. Prepare your Workstation @@ -123,6 +123,6 @@ There are many valid ways to set up the DNS. For help, refer to the [Azure DNS d # 8. Install the Rancher Helm Chart -Next, install the Rancher Helm chart by following the instructions on [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) The Helm instructions are the same for installing Rancher on any Kubernetes distribution. +Next, install the Rancher Helm chart by following the instructions on [this page.](../../../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md#install-the-rancher-helm-chart) The Helm instructions are the same for installing Rancher on any Kubernetes distribution. Use that DNS name from the previous step as the Rancher server URL when you install Rancher. It can be passed in as a Helm option. For example, if the DNS name is `rancher.my.org`, you could run the Helm installation command with the option `--set hostname=rancher.my.org`. diff --git a/docs/en/installation/resources/k8s-tutorials/amazon-eks/amazon-eks.md b/docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md similarity index 96% rename from docs/en/installation/resources/k8s-tutorials/amazon-eks/amazon-eks.md rename to docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md index 71b6133ca19..b65a54d2832 100644 --- a/docs/en/installation/resources/k8s-tutorials/amazon-eks/amazon-eks.md +++ b/docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md @@ -10,7 +10,7 @@ The first is a guide for deploying the Rancher server on an EKS cluster using Cl The second is a guide for installing an EKS cluster with an ingress by using command line tools. This guide may be useful if you want to use fewer resources while trying out Rancher on EKS. -If you already have an EKS Kubernetes cluster, skip to the step about [installing an ingress.](#5-install-an-ingress) Then install the Rancher Helm chart following the instructions on [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) +If you already have an EKS Kubernetes cluster, skip to the step about [installing an ingress.](#5-install-an-ingress) Then install the Rancher Helm chart following the instructions on [this page.](../../../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md#install-the-rancher-helm-chart) - [Automated Quickstart using AWS Best Practices](#automated-quickstart-using-aws-best-practices) - [Creating an EKS Cluster for the Rancher Server](#creating-an-eks-cluster-for-the-rancher-server) @@ -161,6 +161,6 @@ There are many valid ways to set up the DNS. For help, refer to the AWS document ### 8. Install the Rancher Helm Chart -Next, install the Rancher Helm chart by following the instructions on [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) The Helm instructions are the same for installing Rancher on any Kubernetes distribution. +Next, install the Rancher Helm chart by following the instructions on [this page.](../../../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md#install-the-rancher-helm-chart) The Helm instructions are the same for installing Rancher on any Kubernetes distribution. Use that DNS name from the previous step as the Rancher server URL when you install Rancher. It can be passed in as a Helm option. For example, if the DNS name is `rancher.my.org`, you could run the Helm installation command with the option `--set hostname=rancher.my.org`. diff --git a/docs/en/installation/resources/k8s-tutorials/gke/gke.md b/docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-gke.md similarity index 93% rename from docs/en/installation/resources/k8s-tutorials/gke/gke.md rename to docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-gke.md index c6f2778ecdf..1122319b15b 100644 --- a/docs/en/installation/resources/k8s-tutorials/gke/gke.md +++ b/docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-gke.md @@ -9,13 +9,13 @@ import TabItem from '@theme/TabItem'; In this section, you'll learn how to install Rancher using Google Kubernetes Engine. -If you already have a GKE Kubernetes cluster, skip to the step about [installing an ingress.](#7-install-an-ingress) Then install the Rancher Helm chart following the instructions on [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) +If you already have a GKE Kubernetes cluster, skip to the step about [installing an ingress.](#7-install-an-ingress) Then install the Rancher Helm chart following the instructions on [this page.](../../../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md#install-the-rancher-helm-chart) # Prerequisites - You will need a Google account. - You will need a Google Cloud billing account. You can manage your Cloud Billing accounts using the Google Cloud Console. For more information about the Cloud Console, visit [General guide to the console.](https://support.google.com/cloud/answer/3465889?hl=en&ref_topic=3340599) -- You will need a cloud quota for at least one in-use IP address and at least 2 CPUs. For more details about hardware requirements for the Rancher server, refer to [this section.]({{}}/rancher/v2.6/en/installation/requirements/#rke-and-hosted-kubernetes) +- You will need a cloud quota for at least one in-use IP address and at least 2 CPUs. For more details about hardware requirements for the Rancher server, refer to [this section.](../../../pages-for-subheaders/installation-requirements.md#rke-and-hosted-kubernetes) # 1. Enable the Kubernetes Engine API @@ -181,6 +181,6 @@ There are many valid ways to set up the DNS. For help, refer to the Google Cloud # 10. Install the Rancher Helm chart -Next, install the Rancher Helm chart by following the instructions on [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) The Helm instructions are the same for installing Rancher on any Kubernetes distribution. +Next, install the Rancher Helm chart by following the instructions on [this page.](../../../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md#install-the-rancher-helm-chart) The Helm instructions are the same for installing Rancher on any Kubernetes distribution. Use the DNS name from the previous step as the Rancher server URL when you install Rancher. It can be passed in as a Helm option. For example, if the DNS name is `rancher.my.org`, you could run the Helm installation command with the option `--set hostname=rancher.my.org`. diff --git a/docs/en/installation/install-rancher-on-k8s/rollbacks/rollbacks.md b/docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md similarity index 86% rename from docs/en/installation/install-rancher-on-k8s/rollbacks/rollbacks.md rename to docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md index 599f5a1c18c..2f297a1894c 100644 --- a/docs/en/installation/install-rancher-on-k8s/rollbacks/rollbacks.md +++ b/docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md @@ -17,7 +17,7 @@ A restore is performed by creating a Restore custom resource. :::note Important: -* Follow the instructions from this page for restoring Rancher on the same cluster where it was backed up from. In order to migrate Rancher to a new cluster, follow the steps to [migrate Rancher.]({{}}/rancher/v2.6/en/backups/migrating-rancher) +* Follow the instructions from this page for restoring Rancher on the same cluster where it was backed up from. In order to migrate Rancher to a new cluster, follow the steps to [migrate Rancher.](../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md) * While restoring Rancher on the same setup, the Rancher deployment is manually scaled down before the restore starts, then the operator will scale it back up once the restore completes. As a result, Rancher and its UI will be unavailable until the restore is complete. While the UI is unavailable, use the original cluster kubeconfig with the restore YAML file: `kubectl create -f restore.yaml`. @@ -40,12 +40,12 @@ 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 & Marketplace**. Refer [here]({{}}/rancher/v2.6/en/helm-charts/#charts) for more information. + If the Rancher Backups app is not visible, you will need to install it from the Charts page in **Apps & Marketplace**. Refer [here](../../../pages-for-subheaders/helm-charts-in-rancher.md#charts) for more information. ::: 1. Click **Create**. -1. Create the Restore with the form or with YAML. For help creating the Restore resource using the online form, refer to the [configuration reference]({{}}/rancher/v2.6/en/backups/configuration/restore-config) and to the [examples.]({{}}/rancher/v2.6/en/backups/examples) +1. Create the Restore with the form or with YAML. For help creating the Restore resource using the online form, refer to the [configuration reference](../../../reference-guides/backup-restore-configuration/restore-configuration.md) and to the [examples.](../../../reference-guides/backup-restore-configuration/examples.md) 1. To use the YAML editor, you can click **Create > Create from YAML.** Enter the Restore YAML. The following is an example Restore custom resource: ```yaml @@ -65,7 +65,7 @@ A restore is performed by creating a Restore custom resource. region: us-west-2 endpoint: s3.us-west-2.amazonaws.com ``` - For help configuring the Restore, refer to the [configuration reference]({{}}/rancher/v2.6/en/backups/configuration/restore-config) and to the [examples.]({{}}/rancher/v2.6/en/backups/examples) + For help configuring the Restore, refer to the [configuration reference](../../../reference-guides/backup-restore-configuration/restore-configuration.md) and to the [examples.](../../../reference-guides/backup-restore-configuration/examples.md) 1. Click **Create**. @@ -106,7 +106,7 @@ helm rollback rancher 3 -n cattle-system To roll back to Rancher before v2.5, follow the procedure detailed here: [Restoring Backups — Kubernetes installs]({{}}/rancher/v2.0-v2.4/en/backups/restore/rke-restore/) Restoring a snapshot of the Rancher server cluster will revert Rancher to the version and state at the time of the snapshot. -For information on how to roll back Rancher installed with Docker, refer to [this page.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks) +For information on how to roll back Rancher installed with Docker, refer to [this page.](../other-installation-methods/rancher-on-a-single-node-with-docker/roll-back-docker-installed-rancher.md) :::note diff --git a/docs/en/installation/resources/troubleshooting/troubleshooting.md b/docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/troubleshooting.md similarity index 100% rename from docs/en/installation/resources/troubleshooting/troubleshooting.md rename to docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/troubleshooting.md diff --git a/docs/en/installation/install-rancher-on-k8s/upgrades/upgrades.md b/docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md similarity index 73% rename from docs/en/installation/install-rancher-on-k8s/upgrades/upgrades.md rename to docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md index 0bc1984ad14..31621a1bd84 100644 --- a/docs/en/installation/install-rancher-on-k8s/upgrades/upgrades.md +++ b/docs/en/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md @@ -4,9 +4,9 @@ weight: 2 --- The following instructions will guide you through upgrading a Rancher server that was installed on a Kubernetes cluster with Helm. These steps also apply to air-gapped installs with Helm. -For the instructions to upgrade Rancher installed with Docker, refer to [this page.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-upgrades) +For the instructions to upgrade Rancher installed with Docker, refer to [this page.](../other-installation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher.md) -To upgrade the components in your Kubernetes cluster, or the definition of the [Kubernetes services]({{}}/rke/latest/en/config-options/services/) or [add-ons]({{}}/rke/latest/en/config-options/add-ons/), refer to the [upgrade documentation for RKE]({{}}/rke/latest/en/upgrades/), the Rancher Kubernetes Engine. +To upgrade the components in your Kubernetes cluster, or the definition of the [Kubernetes services](https://rancher.com/docs/rke/latest/en/config-options/services/) or [add-ons](https://rancher.com/docs/rke/latest/en/config-options/add-ons/), refer to the [upgrade documentation for RKE](https://rancher.com/docs/rke/latest/en/upgrades/), the Rancher Kubernetes Engine. - [Prerequisites](#prerequisites) - [Upgrade Outline](#upgrade-outline) @@ -27,7 +27,7 @@ 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]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories/) aren't supported. +Note that upgrades _to_ or _from_ any chart in the [rancher-alpha repository](../../../reference-guides/installation-references/helm-chart-options.md#helm-chart-repositories/) aren't supported. ### Helm Version @@ -37,15 +37,15 @@ For migration of installs started with Helm 2, refer to the official [Helm 2 to ### For air-gapped installs: Populate private registry -For [air-gapped installs only,]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap) collect and populate images for the new Rancher server version. Follow the guide to [populate your private registry]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/populate-private-registry/) with the images for the Rancher version that you want to upgrade to. +For [air-gapped installs only,](../../../pages-for-subheaders/air-gapped-helm-cli-install.md) collect and populate images for the new Rancher server version. Follow the guide to [populate your private registry](../other-installation-methods/air-gapped-helm-cli-install/publish-images.md) with the images for the Rancher version that you want to upgrade to. ### For upgrades from a Rancher server with a hidden local cluster -If you are upgrading to Rancher v2.5 from a Rancher server that was started with the Helm chart option `--add-local=false`, you will need to drop that flag when upgrading. Otherwise, the Rancher server will not start. The `restricted-admin` role can be used to continue restricting access to the local cluster. For more information, see [this section.]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/#upgrading-from-rancher-with-a-hidden-local-cluster) +If you are upgrading to Rancher v2.5 from a Rancher server that was started with the Helm chart option `--add-local=false`, you will need to drop that flag when upgrading. Otherwise, the Rancher server will not start. The `restricted-admin` role can be used to continue restricting access to the local cluster. For more information, see [this section.](../../../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md#upgrading-from-rancher-with-a-hidden-local-cluster) ### For upgrades with cert-manager older than 0.8.0 -[Let's Encrypt will be blocking cert-manager instances older than 0.8.0 starting November 1st 2019.](https://community.letsencrypt.org/t/blocking-old-cert-manager-versions/98753) Upgrade cert-manager to the latest version by following [these instructions.]({{}}/rancher/v2.6/en/installation/resources/upgrading-cert-manager) +[Let's Encrypt will be blocking cert-manager instances older than 0.8.0 starting November 1st 2019.](https://community.letsencrypt.org/t/blocking-old-cert-manager-versions/98753) Upgrade cert-manager to the latest version by following [these instructions.](../resources/upgrade-cert-manager.md) # Upgrade Outline @@ -58,7 +58,7 @@ Follow the steps to upgrade Rancher server: # 1. Back up Your Kubernetes Cluster that is Running Rancher Server -Use the [backup application]({{}}/rancher/v2.6/en/backups/back-up-rancher) to back up Rancher. +Use the [backup application](../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md) to back up Rancher. You'll use the backup as a restore point if something goes wrong during upgrade. @@ -72,7 +72,7 @@ You'll use the backup as a restore point if something goes wrong during upgrade. 1. Get the repository name that you used to install Rancher. - For information about the repos and their differences, see [Helm Chart Repositories]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories). + For information about the repos and their differences, see [Helm Chart Repositories](../../../reference-guides/installation-references/helm-chart-options.md#helm-chart-repositories). {{< release-channel >}} @@ -86,7 +86,7 @@ You'll use the backup as a restore point if something goes wrong during upgrade. :::note - If you want to switch to a different Helm chart repository, please follow the [steps on how to switch repositories]({{}}/rancher/v2.6/en/installation/resources/choosing-version/#switching-to-a-different-helm-chart-repository). If you switch repositories, make sure to list the repositories again before continuing onto Step 3 to ensure you have the correct one added. + If you want to switch to a different Helm chart repository, please follow the [steps on how to switch repositories](../resources/choose-a-rancher-version.md#switching-to-a-different-helm-chart-repository). If you switch repositories, make sure to list the repositories again before continuing onto Step 3 to ensure you have the correct one added. ::: @@ -109,7 +109,7 @@ This section describes how to upgrade normal (Internet-connected) or air-gapped :::note Air Gap Instructions: -If you are installing Rancher in an air-gapped environment, skip the rest of this page and render the Helm template by following the instructions on [this page.](./air-gap-upgrade) +If you are installing Rancher in an air-gapped environment, skip the rest of this page and render the Helm template by following the instructions on [this page.](air-gapped-upgrades.md) ::: @@ -129,7 +129,7 @@ There will be more values that are listed with this command. This is just an exa ::: -If you are upgrading cert-manager to the latest version from v1.5 or below, follow the [cert-manager upgrade docs]({{}}/rancher/v2.6/en/installation/resources/upgrading-cert-manager/#option-c-upgrade-cert-manager-from-versions-1-5-and-below) to learn how to upgrade cert-manager without needing to perform an uninstall or reinstall of Rancher. Otherwise, follow the [steps to upgrade Rancher](#steps-to-upgrade-rancher) below. +If you are upgrading cert-manager to the latest version from v1.5 or below, follow the [cert-manager upgrade docs](../resources/upgrade-cert-manager.md#option-c-upgrade-cert-manager-from-versions-1-5-and-below) to learn how to upgrade cert-manager without needing to perform an uninstall or reinstall of Rancher. Otherwise, follow the [steps to upgrade Rancher](#steps-to-upgrade-rancher) below. ### Steps to Upgrade Rancher diff --git a/docs/en/installation/requirements/dockershim/dockershim.md b/docs/en/getting-started/installation-and-upgrade/installation-requirements/dockershim.md similarity index 100% rename from docs/en/installation/requirements/dockershim/dockershim.md rename to docs/en/getting-started/installation-and-upgrade/installation-requirements/dockershim.md diff --git a/docs/en/installation/requirements/installing-docker/installing-docker.md b/docs/en/getting-started/installation-and-upgrade/installation-requirements/install-docker.md similarity index 100% rename from docs/en/installation/requirements/installing-docker/installing-docker.md rename to docs/en/getting-started/installation-and-upgrade/installation-requirements/install-docker.md diff --git a/docs/en/installation/requirements/ports/ports.md b/docs/en/getting-started/installation-and-upgrade/installation-requirements/port-requirements.md similarity index 92% rename from docs/en/installation/requirements/ports/ports.md rename to docs/en/getting-started/installation-and-upgrade/installation-requirements/port-requirements.md index 60407c14c97..6dcd2ce95f7 100644 --- a/docs/en/installation/requirements/ports/ports.md +++ b/docs/en/getting-started/installation-and-upgrade/installation-requirements/port-requirements.md @@ -192,13 +192,13 @@ The following tables break down the port requirements for Rancher nodes, for inb Downstream Kubernetes clusters run your apps and services. This section describes what ports need to be opened on the nodes in downstream clusters so that Rancher can communicate with them. -The port requirements differ depending on how the downstream cluster was launched. Each of the tabs below list the ports that need to be opened for different [cluster types]({{}}/rancher/v2.6/en/cluster-provisioning/). +The port requirements differ depending on how the downstream cluster was launched. Each of the tabs below list the ports that need to be opened for different [cluster types](../../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md). -The following diagram depicts the ports that are opened for each [cluster type]({{}}/rancher/v2.6/en/cluster-provisioning). +The following diagram depicts the ports that are opened for each [cluster type](../../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md).
Port Requirements for the Rancher Management Plane
-![Basic Port Requirements]({{}}/img/rancher/port-communications.svg) +![Basic Port Requirements](/img/port-communications.svg) :::tip @@ -211,7 +211,7 @@ If security isn't a large concern and you're okay with opening a few additional
Click to expand -The following table depicts the port requirements for [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) with nodes created in an [Infrastructure Provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/). +The following table depicts the port requirements for [Rancher Launched Kubernetes](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) with nodes created in an [Infrastructure Provider](../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md). :::note @@ -228,7 +228,7 @@ The required ports are automatically opened by Rancher during creation of cluste
Click to expand -The following table depicts the port requirements for [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) with [Custom Nodes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/). +The following table depicts the port requirements for [Rancher Launched Kubernetes](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) with [Custom Nodes](../../../pages-for-subheaders/use-existing-nodes.md). {{< ports-custom-nodes >}} @@ -239,7 +239,7 @@ The following table depicts the port requirements for [Rancher Launched Kubernet
Click to expand -The following table depicts the port requirements for [hosted clusters]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters). +The following table depicts the port requirements for [hosted clusters](../../../pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers.md). {{< ports-imported-hosted >}} @@ -256,7 +256,7 @@ Registered clusters were called imported clusters before Rancher v2.5.
Click to expand -The following table depicts the port requirements for [registered clusters]({{}}/rancher/v2.6/en/cluster-provisioning/registered-clusters/). +The following table depicts the port requirements for [registered clusters](../../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md). {{< ports-imported-hosted >}} @@ -269,7 +269,7 @@ The following table depicts the port requirements for [registered clusters]({{ @@ -289,7 +289,7 @@ In these cases, you have to explicitly allow this traffic in your host firewall, ### Rancher AWS EC2 Security Group -When using the [AWS EC2 node driver]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/) to provision cluster nodes in Rancher, you can choose to let Rancher create a security group called `rancher-nodes`. The following rules are automatically added to this security group. +When using the [AWS EC2 node driver](../../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster.md) to provision cluster nodes in Rancher, you can choose to let Rancher create a security group called `rancher-nodes`. The following rules are automatically added to this security group. | Type | Protocol | Port Range | Source/Destination | Rule Type | |-----------------|:--------:|:-----------:|------------------------|:---------:| diff --git a/docs/en/installation/other-installation-methods/air-gap/install-rancher/docker-install-commands/docker-install-commands.md b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/docker-install-commands.md similarity index 91% rename from docs/en/installation/other-installation-methods/air-gap/install-rancher/docker-install-commands/docker-install-commands.md rename to docs/en/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/docker-install-commands.md index e799fa66a52..48376f76973 100644 --- a/docs/en/installation/other-installation-methods/air-gap/install-rancher/docker-install-commands/docker-install-commands.md +++ b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/docker-install-commands.md @@ -7,7 +7,7 @@ The Docker installation is for Rancher users who want to test out Rancher. Instead of running on a Kubernetes cluster, you install the Rancher server component on a single node using a `docker run` command. Since there is only one node and a single Docker container, if the node goes down, there is no copy of the etcd data available on other nodes and you will lose all the data of your Rancher server. -The backup application can be used to migrate the Rancher server from a Docker install to a Kubernetes install using [these steps.]({{}}/rancher/v2.6/en/backups/migrating-rancher) +The backup application can be used to migrate the Rancher server from a Docker install to a Kubernetes install using [these steps.](../../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md) For security purposes, SSL (Secure Sockets Layer) is required when using Rancher. SSL secures all Rancher network communication, like when you login or interact with a cluster. @@ -18,8 +18,8 @@ For security purposes, SSL (Secure Sockets Layer) is required when using Rancher :::note Do you want to.. -- Configure custom CA root certificate to access your services? See [Custom CA root certificate]({{}}/rancher/v2.6/en/installation/resources/custom-ca-root-certificate/). -- Record all transactions with the Rancher API? See [API Auditing]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#api-audit-log). +- Configure custom CA root certificate to access your services? See [Custom CA root certificate](../../resources/custom-ca-root-certificates.md). +- Record all transactions with the Rancher API? See [API Auditing](../../../../reference-guides/single-node-rancher-in-docker/advanced-options.md#api-audit-log). ::: @@ -37,7 +37,7 @@ Log into your Linux host, and then run the installation command below. When ente | Placeholder | Description | | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | `` | Your private registry URL and port. | -| `` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to install. | +| `` | The release tag of the [Rancher version](installation/resources/chart-options/) that you want to install. | Privileged access is [required.](#privileged-access-for-rancher) @@ -64,7 +64,7 @@ In development or testing environments where your team will access your Rancher From a computer with an internet connection, create a self-signed certificate using [OpenSSL](https://www.openssl.org/) or another method of your choice. - The certificate files must be in PEM format. -- In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting) +- In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.](../rancher-on-a-single-node-with-docker/certificate-troubleshooting.md) ::: @@ -77,7 +77,7 @@ After creating your certificate, log into your Linux host, and then run the inst | `` | The path to the private key for your certificate. | | `` | The path to the certificate authority's certificate. | | `` | Your private registry URL and port. | -| `` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to install. | +| `` | The release tag of the [Rancher version](installation/resources/chart-options/) that you want to install. | Privileged access is [required.](#privileged-access-for-rancher) @@ -116,7 +116,7 @@ After obtaining your certificate, log into your Linux host, and then run the ins | `` | The path to your full certificate chain. | | `` | The path to the private key for your certificate. | | `` | Your private registry URL and port. | -| `` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to install. | +| `` | The release tag of the [Rancher version](installation/resources/chart-options/) that you want to install. | :::note @@ -144,7 +144,7 @@ docker run -d --restart=unless-stopped \ :::note -If you don't intend to send telemetry data, opt out [telemetry]({{}}/rancher/v2.6/en/faq/telemetry/) during the initial login. +If you don't intend to send telemetry data, opt out [telemetry](../../../../faq/telemetry.md) during the initial login. ::: diff --git a/docs/en/installation/other-installation-methods/air-gap/prepare-nodes/prepare-nodes.md b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/infrastructure-private-registry.md similarity index 84% rename from docs/en/installation/other-installation-methods/air-gap/prepare-nodes/prepare-nodes.md rename to docs/en/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/infrastructure-private-registry.md index 6c69d36e8a6..151ecb98223 100644 --- a/docs/en/installation/other-installation-methods/air-gap/prepare-nodes/prepare-nodes.md +++ b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/infrastructure-private-registry.md @@ -10,7 +10,7 @@ In this section, you will provision the underlying infrastructure for your Ranch An air gapped environment is an environment where the Rancher server is installed offline or behind a firewall. -The infrastructure depends on whether you are installing Rancher on a K3s Kubernetes cluster, an RKE Kubernetes cluster, or a single Docker container. For more information on each installation option, refer to [this page.]({{}}/rancher/v2.6/en/installation/) +The infrastructure depends on whether you are installing Rancher on a K3s Kubernetes cluster, an RKE Kubernetes cluster, or a single Docker container. For more information on each installation option, refer to [this page.](../../../../pages-for-subheaders/installation-and-upgrade.md) Rancher can be installed on any Kubernetes cluster. The RKE and K3s Kubernetes infrastructure tutorials below are still included for convenience. @@ -29,9 +29,9 @@ We recommend setting up the following infrastructure for a high-availability ins These hosts will be disconnected from the internet, but require being able to connect with your private registry. -Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.6/en/installation/requirements/) +Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.](../../../../pages-for-subheaders/installation-requirements.md) -For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node) for setting up nodes as instances in Amazon EC2. +For an example of one way to set up Linux nodes, refer to this [tutorial](../../../../how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2.md) for setting up nodes as instances in Amazon EC2. ### 2. Set up External Datastore @@ -45,9 +45,9 @@ For a high-availability K3s installation, you will need to set up one of the fol When you install Kubernetes, you will pass in details for K3s to connect to the database. -For an example of one way to set up the database, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds) for setting up a MySQL database on Amazon's RDS service. +For an example of one way to set up the database, refer to this [tutorial](../../../../how-to-guides/new-user-guides/infrastructure-setup/mysql-database-in-amazon-rds.md) for setting up a MySQL database on Amazon's RDS service. -For the complete list of options that are available for configuring a K3s cluster datastore, refer to the [K3s documentation.]({{}}/k3s/latest/en/installation/datastore/) +For the complete list of options that are available for configuring a K3s cluster datastore, refer to the [K3s documentation.](https://rancher.com/docs/k3s/latest/en/installation/datastore/) ### 3. Set up the Load Balancer @@ -60,11 +60,11 @@ When Rancher is installed (also in a later step), the Rancher system creates an For your implementation, consider if you want or need to use a Layer-4 or Layer-7 load balancer: - **A layer-4 load balancer** is the simpler of the two choices, in which you are forwarding TCP traffic to your nodes. We recommend configuring your load balancer as a Layer 4 balancer, forwarding traffic to ports TCP/80 and TCP/443 to the Rancher management cluster nodes. The Ingress controller on the cluster will redirect HTTP traffic to HTTPS and terminate SSL/TLS on port TCP/443. The Ingress controller will forward traffic to port TCP/80 to the Ingress pod in the Rancher deployment. -- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination) +- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.](../../../../reference-guides/installation-references/helm-chart-options.md#external-tls-termination) -For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/) +For an example showing how to set up an NGINX load balancer, refer to [this page.](../../../../how-to-guides/new-user-guides/infrastructure-setup/nginx-load-balancer.md) -For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/) +For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.](../../../../how-to-guides/new-user-guides/infrastructure-setup/amazon-elb-load-balancer.md) :::note Important: @@ -86,7 +86,7 @@ For a how-to guide for setting up a DNS record to route domain traffic to an Ama Rancher supports air gap installs using a private registry. You must have your own private registry or other means of distributing Docker images to your machines. -In a later step, when you set up your K3s Kubernetes cluster, you will create a [private registries configuration file]({{}}/k3s/latest/en/installation/private-registry/) with details from this registry. +In a later step, when you set up your K3s Kubernetes cluster, you will create a [private registries configuration file](https://rancher.com/docs/k3s/latest/en/installation/private-registry/) with details from this registry. If you need help with creating a private registry, please refer to the [official Docker documentation.](https://docs.docker.com/registry/deploying/#run-an-externally-accessible-registry) @@ -112,9 +112,9 @@ The etcd database requires an odd number of nodes so that it can always elect a These hosts will be disconnected from the internet, but require being able to connect with your private registry. -Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.6/en/installation/requirements/) +Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.](../../../../pages-for-subheaders/installation-requirements.md) -For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/) for setting up nodes as instances in Amazon EC2. +For an example of one way to set up Linux nodes, refer to this [tutorial](../../../../how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2.md) for setting up nodes as instances in Amazon EC2. ### 2. Set up the Load Balancer @@ -127,11 +127,11 @@ When Rancher is installed (also in a later step), the Rancher system creates an For your implementation, consider if you want or need to use a Layer-4 or Layer-7 load balancer: - **A layer-4 load balancer** is the simpler of the two choices, in which you are forwarding TCP traffic to your nodes. We recommend configuring your load balancer as a Layer 4 balancer, forwarding traffic to ports TCP/80 and TCP/443 to the Rancher management cluster nodes. The Ingress controller on the cluster will redirect HTTP traffic to HTTPS and terminate SSL/TLS on port TCP/443. The Ingress controller will forward traffic to port TCP/80 to the Ingress pod in the Rancher deployment. -- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination) +- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.](../../../../reference-guides/installation-references/helm-chart-options.md#external-tls-termination) -For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/) +For an example showing how to set up an NGINX load balancer, refer to [this page.](../../../../how-to-guides/new-user-guides/infrastructure-setup/nginx-load-balancer.md) -For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/) +For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.](../../../../how-to-guides/new-user-guides/infrastructure-setup/amazon-elb-load-balancer.md) :::caution @@ -153,7 +153,7 @@ For a how-to guide for setting up a DNS record to route domain traffic to an Ama Rancher supports air gap installs using a secure Docker private registry. You must have your own private registry or other means of distributing Docker images to your machines. -In a later step, when you set up your RKE Kubernetes cluster, you will create a [private registries configuration file]({{}}/rke/latest/en/config-options/private-registries/) with details from this registry. +In a later step, when you set up your RKE Kubernetes cluster, you will create a [private registries configuration file](https://rancher.com/docs/rke/latest/en/config-options/private-registries/) with details from this registry. If you need help with creating a private registry, please refer to the [official Docker documentation.](https://docs.docker.com/registry/deploying/#run-an-externally-accessible-registry) @@ -164,7 +164,7 @@ If you need help with creating a private registry, please refer to the [official - The Docker installation is for Rancher users that are wanting to test out Rancher. Since there is only one node and a single Docker container, if the node goes down, you will lose all the data of your Rancher server. -- The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.]({{}}/rancher/v2.6/en/backups/migrating-rancher) +- The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.](../../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md) ::: @@ -172,9 +172,9 @@ If you need help with creating a private registry, please refer to the [official This host will be disconnected from the Internet, but needs to be able to connect to your private registry. -Make sure that your node fulfills the general installation requirements for [OS, Docker, hardware, and networking.]({{}}/rancher/v2.6/en/installation/requirements/) +Make sure that your node fulfills the general installation requirements for [OS, Docker, hardware, and networking.](../../../../pages-for-subheaders/installation-requirements.md) -For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/) for setting up nodes as instances in Amazon EC2. +For an example of one way to set up Linux nodes, refer to this [tutorial](../../../../how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2.md) for setting up nodes as instances in Amazon EC2. ### 2. Set up a Private Docker Registry @@ -185,4 +185,4 @@ If you need help with creating a private registry, please refer to the [official -### [Next: Collect and Publish Images to your Private Registry]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/populate-private-registry/) +### [Next: Collect and Publish Images to your Private Registry](publish-images.md) diff --git a/docs/en/installation/other-installation-methods/air-gap/launch-kubernetes/launch-kubernetes.md b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md similarity index 91% rename from docs/en/installation/other-installation-methods/air-gap/launch-kubernetes/launch-kubernetes.md rename to docs/en/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md index 70d0ad65746..9100a3441af 100644 --- a/docs/en/installation/other-installation-methods/air-gap/launch-kubernetes/launch-kubernetes.md +++ b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md @@ -12,7 +12,7 @@ Skip this section if you are installing Rancher on a single node with Docker. ::: -This section describes how to install a Kubernetes cluster according to our [best practices for the Rancher server environment.]({{}}/rancher/v2.6/en/overview/architecture-recommendations/#environment-for-kubernetes-installations) This cluster should be dedicated to run only the Rancher server. +This section describes how to install a Kubernetes cluster according to our [best practices for the Rancher server environment.](../../../../reference-guides/rancher-manager-architecture/architecture-recommendations.md#environment-for-kubernetes-installations) This cluster should be dedicated to run only the Rancher server. Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes providers. @@ -64,7 +64,7 @@ configs: Note, at this time only secure registries are supported with K3s (SSL with custom CA). -For more information on private registries configuration file for K3s, refer to the [K3s documentation.]({{}}/k3s/latest/en/installation/private-registry/) +For more information on private registries configuration file for K3s, refer to the [K3s documentation.](https://rancher.com/docs/k3s/latest/en/installation/private-registry/) ### 3. Install K3s @@ -137,7 +137,7 @@ users: kubectl --kubeconfig ~/.kube/config/k3s.yaml get pods --all-namespaces ``` -For more information about the `kubeconfig` file, refer to the [K3s documentation]({{}}/k3s/latest/en/cluster-access/) or the [official Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) about organizing cluster access using `kubeconfig` files. +For more information about the `kubeconfig` file, refer to the [K3s documentation](https://rancher.com/docs/k3s/latest/en/cluster-access/) or the [official Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) about organizing cluster access using `kubeconfig` files. ### Note on Upgrading @@ -294,7 +294,7 @@ We will create a Kubernetes cluster using Rancher Kubernetes Engine (RKE). Befor ### 1. Install RKE -Install RKE by following the instructions in the [RKE documentation.]({{}}/rke/latest/en/installation/) +Install RKE by following the instructions in the [RKE documentation.](https://rancher.com/docs/rke/latest/en/installation/) ### 2. Create an RKE Config File @@ -306,7 +306,7 @@ Replace values in the code sample below with help of the _RKE Options_ table. Us :::tip -For more details on the options available, see the RKE [Config Options]({{}}/rke/latest/en/config-options/). +For more details on the options available, see the RKE [Config Options](https://rancher.com/docs/rke/latest/en/config-options/). ::: @@ -366,8 +366,8 @@ The files mentioned below are needed to maintain, troubleshoot, and upgrade your Save a copy of the following files in a secure location: - `rancher-cluster.yml`: The RKE cluster configuration file. -- `kube_config_cluster.yml`: The [Kubeconfig file]({{}}/rke/latest/en/kubeconfig/) for the cluster, this file contains credentials for full access to the cluster. -- `rancher-cluster.rkestate`: The [Kubernetes Cluster State file]({{}}/rke/latest/en/installation/#kubernetes-cluster-state), this file contains the current state of the cluster including the RKE configuration and the certificates.

_The Kubernetes Cluster State file is only created when using RKE v0.2.0 or higher._ +- `kube_config_cluster.yml`: The [Kubeconfig file](https://rancher.com/docs/rke/latest/en/kubeconfig/) for the cluster, this file contains credentials for full access to the cluster. +- `rancher-cluster.rkestate`: The [Kubernetes Cluster State file](https://rancher.com/docs/rke/latest/en/installation/#kubernetes-cluster-state), this file contains the current state of the cluster including the RKE configuration and the certificates.

_The Kubernetes Cluster State file is only created when using RKE v0.2.0 or higher._ @@ -380,6 +380,6 @@ The "rancher-cluster" parts of the two latter file names are dependent on how yo ### Issues or errors? -See the [Troubleshooting]({{}}/rancher/v2.6/en/installation/resources/troubleshooting/) page. +See the [Troubleshooting](../../install-upgrade-on-a-kubernetes-cluster/troubleshooting.md) page. -### [Next: Install Rancher](../install-rancher) +### [Next: Install Rancher](install-rancher-ha.md) diff --git a/docs/en/installation/other-installation-methods/air-gap/install-rancher/install-rancher.md b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-rancher-ha.md similarity index 90% rename from docs/en/installation/other-installation-methods/air-gap/install-rancher/install-rancher.md rename to docs/en/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-rancher-ha.md index 8ef4ef364ed..3e0f24669eb 100644 --- a/docs/en/installation/other-installation-methods/air-gap/install-rancher/install-rancher.md +++ b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-rancher-ha.md @@ -11,7 +11,7 @@ When the Rancher server is deployed in the Docker container, a local Kubernetes # Docker Instructions -If you want to continue the air gapped installation using Docker commands, skip the rest of this page and follow the instructions on [this page.](./docker-install-commands) +If you want to continue the air gapped installation using Docker commands, skip the rest of this page and follow the instructions on [this page.](docker-install-commands.md) # Kubernetes Instructions @@ -28,9 +28,9 @@ This section describes installing Rancher: From a system that has access to the internet, fetch the latest Helm chart and copy the resulting manifests to a system that has access to the Rancher server cluster. -1. If you haven't already, install `helm` locally on a workstation that has internet access. Note: Refer to the [Helm version requirements]({{}}/rancher/v2.6/en/installation/resources/helm-version) to choose a version of Helm to install Rancher. +1. If you haven't already, install `helm` locally on a workstation that has internet access. Note: Refer to the [Helm version requirements](../../resources/helm-version-requirements.md) to choose a version of Helm to install Rancher. -2. Use `helm repo add` command to add the Helm chart repository that contains charts to install Rancher. For more information about the repository choices and which is best for your use case, see [Choosing a Version of Rancher]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories). +2. Use `helm repo add` command to add the Helm chart repository that contains charts to install Rancher. For more information about the repository choices and which is best for your use case, see [Choosing a Version of Rancher](../../../../reference-guides/installation-references/helm-chart-options.md#helm-chart-repositories). {{< release-channel >}} ``` helm repo add rancher- https://releases.rancher.com/server-charts/ @@ -54,7 +54,7 @@ When Rancher is installed on an air gapped Kubernetes cluster, there are two rec :::note -If you want terminate SSL/TLS externally, see [TLS termination on an External Load Balancer]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination). +If you want terminate SSL/TLS externally, see [TLS termination on an External Load Balancer](../../../../reference-guides/installation-references/helm-chart-options.md#external-tls-termination). ::: @@ -84,7 +84,7 @@ By default, Rancher generates a CA and uses cert-manager to issue the certificat :::note -Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.11.0, please see our [upgrade cert-manager documentation]({{}}/rancher/v2.6/en/installation/resources/upgrading-cert-manager/). +Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.11.0, please see our [upgrade cert-manager documentation](../../resources/upgrade-cert-manager.md). ::: @@ -200,7 +200,7 @@ If you are using a Private CA signed cert, add `--set privateCA=true` following **Optional**: To install a specific Rancher version, set the `rancherImageTag` value, example: `--set rancherImageTag=v2.3.6` -Then refer to [Adding TLS Secrets]({{}}/rancher/v2.6/en/installation/resources/tls-secrets/) to publish the certificate files so Rancher and the ingress controller can use them. +Then refer to [Adding TLS Secrets](../../resources/add-tls-secrets.md) to publish the certificate files so Rancher and the ingress controller can use them. # 4. Install Rancher @@ -250,7 +250,7 @@ The installation is complete. :::caution -If you don't intend to send telemetry data, opt out [telemetry]({{}}/rancher/v2.6/en/faq/telemetry/) during the initial login. Leaving this active in an air-gapped environment can cause issues if the sockets cannot be opened successfully. +If you don't intend to send telemetry data, opt out [telemetry](../../../../faq/telemetry.md) during the initial login. Leaving this active in an air-gapped environment can cause issues if the sockets cannot be opened successfully. ::: @@ -258,6 +258,6 @@ If you don't intend to send telemetry data, opt out [telemetry]({{}}/ra These resources could be helpful when installing Rancher: -- [Rancher Helm chart options]({{}}/rancher/v2.6/en/installation/resources/chart-options/) -- [Adding TLS secrets]({{}}/rancher/v2.6/en/installation/resources/tls-secrets/) -- [Troubleshooting Rancher Kubernetes Installations]({{}}/rancher/v2.6/en/installation/resources/troubleshooting/) +- [Rancher Helm chart options](installation/resources/chart-options/) +- [Adding TLS secrets](../../resources/add-tls-secrets.md) +- [Troubleshooting Rancher Kubernetes Installations](../../install-upgrade-on-a-kubernetes-cluster/troubleshooting.md) diff --git a/docs/en/installation/other-installation-methods/air-gap/populate-private-registry/populate-private-registry.md b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md similarity index 93% rename from docs/en/installation/other-installation-methods/air-gap/populate-private-registry/populate-private-registry.md rename to docs/en/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md index 237d583adb3..c79cddeecec 100644 --- a/docs/en/installation/other-installation-methods/air-gap/populate-private-registry/populate-private-registry.md +++ b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md @@ -8,11 +8,11 @@ import TabItem from '@theme/TabItem'; This section describes how to set up your private registry so that when you install Rancher, Rancher will pull all the required images from this registry. -By default, all images used to [provision Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/) or launch any tools in Rancher, e.g. monitoring, pipelines, alerts, are pulled from Docker Hub. In an air gapped installation of Rancher, you will need a private registry that is located somewhere accessible by your Rancher server. Then, you will load the registry with all the images. +By default, all images used to [provision Kubernetes clusters](../../../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md) or launch any tools in Rancher, e.g. monitoring, pipelines, alerts, are pulled from Docker Hub. In an air gapped installation of Rancher, you will need a private registry that is located somewhere accessible by your Rancher server. Then, you will load the registry with all the images. Populating the private registry with images is the same process for installing Rancher with Docker and for installing Rancher on a Kubernetes cluster. -The steps in this section differ depending on whether or not you are planning to use Rancher to provision a downstream cluster with Windows nodes or not. By default, we provide the steps of how to populate your private registry assuming that Rancher will provision downstream Kubernetes clusters with only Linux nodes. But if you plan on provisioning any [downstream Kubernetes clusters using Windows nodes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/), there are separate instructions to support the images needed. +The steps in this section differ depending on whether or not you are planning to use Rancher to provision a downstream cluster with Windows nodes or not. By default, we provide the steps of how to populate your private registry assuming that Rancher will provision downstream Kubernetes clusters with only Linux nodes. But if you plan on provisioning any [downstream Kubernetes clusters using Windows nodes](../../../../pages-for-subheaders/use-windows-clusters.md), there are separate instructions to support the images needed. :::note Prerequisites: @@ -71,7 +71,7 @@ New in v2.6.4, cert-manager versions 1.6.2 and 1.7.1 are compatible. We recommen :::note - Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.12.0, please see our [upgrade documentation]({{}}/rancher/v2.6/en/installation/resources/upgrading-cert-manager/). + Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.12.0, please see our [upgrade documentation](../../resources/upgrade-cert-manager.md). ::: @@ -250,7 +250,7 @@ The workstation must have Docker 18.02+ in order to support manifests, which are :::note - Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.12.0, please see our [upgrade documentation]({{}}/rancher/v2.6/en/installation/resources/upgrading-cert-manager/). + Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.12.0, please see our [upgrade documentation](../../resources/upgrade-cert-manager.md). ::: @@ -311,6 +311,6 @@ The image list, `rancher-images.txt` or `rancher-windows-images.txt`, is expecte -### [Next step for Kubernetes Installs - Launch a Kubernetes Cluster]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/launch-kubernetes/) +### [Next step for Kubernetes Installs - Launch a Kubernetes Cluster](install-kubernetes.md) -### [Next step for Docker Installs - Install Rancher]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/install-rancher/) +### [Next step for Docker Installs - Install Rancher](install-rancher-ha.md) diff --git a/docs/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/launch-kubernetes.md b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-kubernetes.md similarity index 88% rename from docs/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/launch-kubernetes.md rename to docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-kubernetes.md index 71f7c1039d7..bf915741f89 100644 --- a/docs/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/launch-kubernetes.md +++ b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-kubernetes.md @@ -80,7 +80,7 @@ acl Safe_ports port 2376 # docker port You need several command line tools on the host where you have SSH access to the Linux nodes to create and interact with the cluster: -* [RKE CLI binary]({{}}/rke/latest/en/installation/#download-the-rke-binary) +* [RKE CLI binary](https://rancher.com/docs/rke/latest/en/installation/#download-the-rke-binary) ``` sudo curl -fsSL -o /usr/local/bin/rke https://github.com/rancher/rke/releases/download/v1.1.4/rke_linux-amd64 @@ -103,7 +103,7 @@ chmod +x get_helm.sh sudo ./get_helm.sh ``` -Next, create a YAML file that describes the RKE cluster. Ensure that the IP addresses of the nodes and the SSH username are correct. For more information on the cluster YAML, have a look at the [RKE documentation]({{}}/rke/latest/en/example-yamls/). +Next, create a YAML file that describes the RKE cluster. Ensure that the IP addresses of the nodes and the SSH username are correct. For more information on the cluster YAML, have a look at the [RKE documentation](https://rancher.com/docs/rke/latest/en/example-yamls/). ``` nodes: @@ -160,8 +160,8 @@ The files mentioned below are needed to maintain, troubleshoot and upgrade your Save a copy of the following files in a secure location: - `rancher-cluster.yml`: The RKE cluster configuration file. -- `kube_config_cluster.yml`: The [Kubeconfig file]({{}}/rke/latest/en/kubeconfig/) for the cluster, this file contains credentials for full access to the cluster. -- `rancher-cluster.rkestate`: The [Kubernetes Cluster State file]({{}}/rke/latest/en/installation/#kubernetes-cluster-state), this file contains the current state of the cluster including the RKE configuration and the certificates. +- `kube_config_cluster.yml`: The [Kubeconfig file](https://rancher.com/docs/rke/latest/en/kubeconfig/) for the cluster, this file contains credentials for full access to the cluster. +- `rancher-cluster.rkestate`: The [Kubernetes Cluster State file](https://rancher.com/docs/rke/latest/en/installation/#kubernetes-cluster-state), this file contains the current state of the cluster including the RKE configuration and the certificates. :::note @@ -171,6 +171,6 @@ The "rancher-cluster" parts of the two latter file names are dependent on how yo ### Issues or errors? -See the [Troubleshooting]({{}}/rancher/v2.6/en/installation/resources/troubleshooting/) page. +See the [Troubleshooting](../../install-upgrade-on-a-kubernetes-cluster/troubleshooting.md) page. -### [Next: Install Rancher](../install-rancher) +### [Next: Install Rancher](install-rancher.md) diff --git a/docs/en/installation/other-installation-methods/behind-proxy/install-rancher/install-rancher.md b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md similarity index 84% rename from docs/en/installation/other-installation-methods/behind-proxy/install-rancher/install-rancher.md rename to docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md index f9e67812888..3bcdb3466fb 100644 --- a/docs/en/installation/other-installation-methods/behind-proxy/install-rancher/install-rancher.md +++ b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md @@ -88,7 +88,7 @@ You can now navigate to `https://rancher.example.com` and start using Rancher. :::caution -If you don't intend to send telemetry data, opt out [telemetry]({{}}/rancher/v2.6/en/faq/telemetry/) during the initial login. Leaving this active in an air-gapped environment can cause issues if the sockets cannot be opened successfully. +If you don't intend to send telemetry data, opt out [telemetry](../../../../faq/telemetry.md) during the initial login. Leaving this active in an air-gapped environment can cause issues if the sockets cannot be opened successfully. ::: @@ -96,6 +96,6 @@ If you don't intend to send telemetry data, opt out [telemetry]({{}}/ra These resources could be helpful when installing Rancher: -- [Rancher Helm chart options]({{}}/rancher/v2.6/en/installation/resources/chart-options/) -- [Adding TLS secrets]({{}}/rancher/v2.6/en/installation/resources/tls-secrets/) -- [Troubleshooting Rancher Kubernetes Installations]({{}}/rancher/v2.6/en/installation/resources/troubleshooting/) +- [Rancher Helm chart options](installation/resources/chart-options/) +- [Adding TLS secrets](../../resources/add-tls-secrets.md) +- [Troubleshooting Rancher Kubernetes Installations](../../install-upgrade-on-a-kubernetes-cluster/troubleshooting.md) diff --git a/docs/en/installation/other-installation-methods/behind-proxy/prepare-nodes/prepare-nodes.md b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/set-up-infrastructure.md similarity index 86% rename from docs/en/installation/other-installation-methods/behind-proxy/prepare-nodes/prepare-nodes.md rename to docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/set-up-infrastructure.md index 94095c6c64e..945dca55a61 100644 --- a/docs/en/installation/other-installation-methods/behind-proxy/prepare-nodes/prepare-nodes.md +++ b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/set-up-infrastructure.md @@ -23,9 +23,9 @@ The etcd database requires an odd number of nodes so that it can always elect a These hosts will connect to the internet through an HTTP proxy. -Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.6/en/installation/requirements/) +Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.](../../../../pages-for-subheaders/installation-requirements.md) -For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/) for setting up nodes as instances in Amazon EC2. +For an example of one way to set up Linux nodes, refer to this [tutorial](../../../../how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2.md) for setting up nodes as instances in Amazon EC2. ### 2. Set up the Load Balancer @@ -38,11 +38,11 @@ When Rancher is installed (also in a later step), the Rancher system creates an For your implementation, consider if you want or need to use a Layer-4 or Layer-7 load balancer: - **A layer-4 load balancer** is the simpler of the two choices, in which you are forwarding TCP traffic to your nodes. We recommend configuring your load balancer as a Layer 4 balancer, forwarding traffic to ports TCP/80 and TCP/443 to the Rancher management cluster nodes. The Ingress controller on the cluster will redirect HTTP traffic to HTTPS and terminate SSL/TLS on port TCP/443. The Ingress controller will forward traffic to port TCP/80 to the Ingress pod in the Rancher deployment. -- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination) +- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.](../../../../reference-guides/installation-references/helm-chart-options.md#external-tls-termination) -For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/) +For an example showing how to set up an NGINX load balancer, refer to [this page.](../../../../how-to-guides/new-user-guides/infrastructure-setup/nginx-load-balancer.md) -For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/) +For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.](../../../../how-to-guides/new-user-guides/infrastructure-setup/amazon-elb-load-balancer.md) :::note Important: @@ -61,4 +61,4 @@ You will need to specify this hostname in a later step when you install Rancher, For a how-to guide for setting up a DNS record to route domain traffic to an Amazon ELB load balancer, refer to the [official AWS documentation.](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-elb-load-balancer) -### [Next: Set up a Kubernetes cluster]({{}}/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/) +### [Next: Set up a Kubernetes cluster](install-kubernetes.md) diff --git a/docs/en/installation/other-installation-methods/single-node-docker/troubleshooting/troubleshooting.md b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/certificate-troubleshooting.md similarity index 100% rename from docs/en/installation/other-installation-methods/single-node-docker/troubleshooting/troubleshooting.md rename to docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/certificate-troubleshooting.md diff --git a/docs/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/single-node-rollbacks.md b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/roll-back-docker-installed-rancher.md similarity index 84% rename from docs/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/single-node-rollbacks.md rename to docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/roll-back-docker-installed-rancher.md index 87cdd19514d..4e9a3a1abd2 100644 --- a/docs/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/single-node-rollbacks.md +++ b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/roll-back-docker-installed-rancher.md @@ -3,7 +3,7 @@ title: Rolling Back Rancher Installed with Docker weight: 1015 --- -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]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-upgrades). Rolling back restores: +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. - Your data backup created before upgrade. @@ -20,7 +20,7 @@ In this command, `` is the version of Rancher you were ru Cross reference the image and reference table below to learn how to obtain this placeholder data. Write down or copy this information before starting the procedure below. -Terminal docker ps Command, Displaying Where to Find <PRIOR_RANCHER_VERSION> and <RANCHER_CONTAINER_NAME>![Placeholder Reference]({{}}/img/rancher/placeholder-ref-2.png) +Terminal docker ps Command, Displaying Where to Find <PRIOR_RANCHER_VERSION> and <RANCHER_CONTAINER_NAME>![Placeholder Reference](/img/placeholder-ref-2.png) | Placeholder | Example | Description | | -------------------------- | -------------------------- | ------------------------------------------------------- | @@ -59,9 +59,9 @@ Rolling back to a previous version of Rancher destroys any changes made to Ranch ``` You can obtain the name for your Rancher container by entering `docker ps`. -1. Move the backup tarball that you created during completion of [Docker Upgrade]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-upgrades) onto your Rancher Server. Change to the directory that you moved it to. Enter `dir` to confirm that it's there. +1. Move the backup tarball that you created during completion of [Docker Upgrade](upgrade-docker-installed-rancher.md) onto your Rancher Server. Change to the directory that you moved it to. Enter `dir` to confirm that it's there. - If you followed the naming convention we suggested in [Docker Upgrade]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-upgrades), it will have a name similar to (`rancher-data-backup--.tar.gz`). + If you followed the naming convention we suggested in [Docker Upgrade](upgrade-docker-installed-rancher.md), it will have a name similar to (`rancher-data-backup--.tar.gz`). 1. Run the following command to replace the data in the `rancher-data` container with the data in the backup tarball, replacing the placeholder. Don't forget to close the quotes. @@ -79,7 +79,7 @@ Rolling back to a previous version of Rancher destroys any changes made to Ranch --privileged \ rancher/rancher: ``` - Privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher) + Privileged access is [required.](../../../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher) :::danger diff --git a/docs/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/single-node-upgrades.md b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher.md similarity index 80% rename from docs/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/single-node-upgrades.md rename to docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher.md index 6f07e2a42b5..34e5d2b55e0 100644 --- a/docs/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/single-node-upgrades.md +++ b/docs/en/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher.md @@ -10,14 +10,14 @@ The following instructions will guide you through upgrading a Rancher server tha :::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]({{}}/rancher/v2.6/en/backups/migrating-rancher/) before upgrading. +**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]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/#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]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories/) aren’t supported. -- **For [air gap installs only,]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap) collect and populate images for the new Rancher server version**. Follow the guide to [populate your private registry]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/populate-private-registry/) with the images for the Rancher version that you want to upgrade to. +- **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](../../../../reference-guides/installation-references/helm-chart-options.md#helm-chart-repositories/) aren’t supported. +- **For [air gap installs only,](../../../../pages-for-subheaders/air-gapped-helm-cli-install.md) collect and populate images for the new Rancher server version**. Follow the guide to [populate your private registry](../air-gapped-helm-cli-install/publish-images.md) with the images for the Rancher version that you want to upgrade to. # Placeholder Review @@ -43,7 +43,7 @@ Write down or copy this information before starting the upgrade. Terminal docker ps Command, Displaying Where to Find <RANCHER_CONTAINER_TAG> and <RANCHER_CONTAINER_NAME> -![Placeholder Reference]({{}}/img/rancher/placeholder-ref.png) +![Placeholder Reference](/img/placeholder-ref.png) | Placeholder | Example | Description | | -------------------------- | -------------------------- | --------------------------------------------------------- | @@ -110,7 +110,7 @@ Pull the image of the Rancher version that you want to upgrade to. Placeholder | Description ------------|------------- -`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to upgrade to. +`` | The release tag of the [Rancher version](installation/resources/chart-options/) that you want to upgrade to. ``` docker pull rancher/rancher: @@ -126,11 +126,11 @@ Start a new Rancher server container using the data from the `rancher-data` cont ::: -If you used a proxy, see [HTTP Proxy Configuration.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/proxy/) +If you used a proxy, see [HTTP Proxy Configuration.](../../../../reference-guides/single-node-rancher-in-docker/http-proxy-configuration.md) -If you configured a custom CA root certificate to access your services, see [Custom CA root certificate.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#custom-ca-certificate) +If you configured a custom CA root certificate to access your services, see [Custom CA root certificate.](../../../../reference-guides/single-node-rancher-in-docker/advanced-options.md#custom-ca-certificate) -If you are recording all transactions with the Rancher API, see [API Auditing]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#api-audit-log) +If you are recording all transactions with the Rancher API, see [API Auditing](../../../../reference-guides/single-node-rancher-in-docker/advanced-options.md#api-audit-log) To see the command to use when starting the new Rancher server container, choose from the following options: @@ -151,7 +151,7 @@ If you have selected to use the Rancher generated self-signed certificate, you a Placeholder | Description ------------|------------- -`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to upgrade to. +`` | The release tag of the [Rancher version](installation/resources/chart-options/) that you want to upgrade to. ``` docker run -d --volumes-from rancher-data \ @@ -161,7 +161,7 @@ docker run -d --volumes-from rancher-data \ rancher/rancher: ``` -Privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher) +Privileged access is [required.](../../../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher)
@@ -184,7 +184,7 @@ Placeholder | Description `` | The path to your full certificate chain. `` | The path to the private key for your certificate. `` | The path to the certificate authority's certificate. -`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to upgrade to. +`` | The release tag of the [Rancher version](installation/resources/chart-options/) that you want to upgrade to. ``` docker run -d --volumes-from rancher-data \ @@ -197,7 +197,7 @@ docker run -d --volumes-from rancher-data \ rancher/rancher: ``` -Privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher) +Privileged access is [required.](../../../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher)
@@ -210,7 +210,7 @@ If you have selected to use a certificate signed by a recognized CA, you add the :::note Reminder of the Cert Prerequisite: -The certificate files must be in PEM format. In your certificate file, include all intermediate certificates provided by the recognized CA. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting) +The certificate files must be in PEM format. In your certificate file, include all intermediate certificates provided by the recognized CA. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.](certificate-troubleshooting.md) ::: @@ -219,7 +219,7 @@ Placeholder | Description `` | The path to the directory containing your certificate files. `` | The path to your full certificate chain. `` | The path to the private key for your certificate. -`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to upgrade to. +`` | The release tag of the [Rancher version](installation/resources/chart-options/) that you want to upgrade to. ``` docker run -d --volumes-from rancher-data \ @@ -232,7 +232,7 @@ docker run -d --volumes-from rancher-data \ --no-cacerts ``` -Privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher) +Privileged access is [required.](../../../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher)
### Option D: Let's Encrypt Certificate @@ -257,7 +257,7 @@ If you have selected to use [Let's Encrypt](https://letsencrypt.org/) certificat Placeholder | Description ------------|------------- -`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to upgrade to. +`` | The release tag of the [Rancher version](installation/resources/chart-options/) that you want to upgrade to. `` | The domain address that you had originally started with ``` @@ -269,7 +269,7 @@ docker run -d --volumes-from rancher-data \ --acme-domain ``` -Privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher) +Privileged access is [required.](../../../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher)
@@ -290,7 +290,7 @@ If you have selected to use the Rancher generated self-signed certificate, you a Placeholder | Description ------------|------------- `` | Your private registry URL and port. -`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to to upgrade to. +`` | The release tag of the [Rancher version](installation/resources/chart-options/) that you want to to upgrade to. ``` docker run -d --volumes-from rancher-data \ @@ -302,7 +302,7 @@ Placeholder | Description /rancher/rancher: ``` -Privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher) +Privileged access is [required.](../../../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher) ### Option B: Bring Your Own Certificate: Self-Signed @@ -314,7 +314,7 @@ If you have selected to bring your own self-signed certificate, you add the `--v :::note Reminder of the Cert Prerequisite: -The certificate files must be in PEM format. In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting) +The certificate files must be in PEM format. In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.](certificate-troubleshooting.md) ::: @@ -325,7 +325,7 @@ Placeholder | Description `` | The path to the private key for your certificate. `` | The path to the certificate authority's certificate. `` | Your private registry URL and port. -`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to upgrade to. +`` | The release tag of the [Rancher version](installation/resources/chart-options/) that you want to upgrade to. ``` docker run -d --restart=unless-stopped \ @@ -338,7 +338,7 @@ docker run -d --restart=unless-stopped \ --privileged \ /rancher/rancher: ``` -Privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher) +Privileged access is [required.](../../../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher) ### Option C: Bring Your Own Certificate: Signed by Recognized CA @@ -350,7 +350,7 @@ If you have selected to use a certificate signed by a recognized CA, you add the :::note Reminder of the Cert Prerequisite: - The certificate files must be in PEM format. In your certificate file, include all intermediate certificates provided by the recognized CA. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting) + The certificate files must be in PEM format. In your certificate file, include all intermediate certificates provided by the recognized CA. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.](certificate-troubleshooting.md) ::: @@ -360,7 +360,7 @@ Placeholder | Description `` | The path to your full certificate chain. `` | The path to the private key for your certificate. `` | Your private registry URL and port. -`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to upgrade to. +`` | The release tag of the [Rancher version](installation/resources/chart-options/) that you want to upgrade to. :::note @@ -380,7 +380,7 @@ docker run -d --volumes-from rancher-data \ --privileged /rancher/rancher: ``` -privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher) +privileged access is [required.](../../../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher) @@ -404,4 +404,4 @@ Remove the previous Rancher server container. If you only stop the previous Ranc # Rolling Back -If your upgrade does not complete successfully, you can roll back Rancher server and its data back to its last healthy state. For more information, see [Docker Rollback]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/). +If your upgrade does not complete successfully, you can roll back Rancher server and its data back to its last healthy state. For more information, see [Docker Rollback](roll-back-docker-installed-rancher.md). diff --git a/docs/en/installation/resources/tls-secrets/tls-secrets.md b/docs/en/getting-started/installation-and-upgrade/resources/add-tls-secrets.md similarity index 83% rename from docs/en/installation/resources/tls-secrets/tls-secrets.md rename to docs/en/getting-started/installation-and-upgrade/resources/add-tls-secrets.md index f64c6378cdc..9cfdd524752 100644 --- a/docs/en/installation/resources/tls-secrets/tls-secrets.md +++ b/docs/en/getting-started/installation-and-upgrade/resources/add-tls-secrets.md @@ -43,4 +43,4 @@ The configured `tls-ca` secret is retrieved when Rancher starts. On a running Ra # Updating a Private CA Certificate -Follow the steps on [this page]({{}}/rancher/v2.6/en/installation/resources/update-rancher-cert) to update the SSL certificate of the ingress in a Rancher [high availability Kubernetes installation]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) or to switch from the default self-signed certificate to a custom certificate. \ No newline at end of file +Follow the steps on [this page](update-rancher-certificate.md) to update the SSL certificate of the ingress in a Rancher [high availability Kubernetes installation](../../../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md) or to switch from the default self-signed certificate to a custom certificate. \ No newline at end of file diff --git a/docs/en/installation/resources/bootstrap-password/bootstrap-password.md b/docs/en/getting-started/installation-and-upgrade/resources/bootstrap-password.md similarity index 100% rename from docs/en/installation/resources/bootstrap-password/bootstrap-password.md rename to docs/en/getting-started/installation-and-upgrade/resources/bootstrap-password.md diff --git a/docs/en/installation/resources/choosing-version/choosing-version.md b/docs/en/getting-started/installation-and-upgrade/resources/choose-a-rancher-version.md similarity index 85% rename from docs/en/installation/resources/choosing-version/choosing-version.md rename to docs/en/getting-started/installation-and-upgrade/resources/choose-a-rancher-version.md index 351749cf8a1..5dccca87fb6 100644 --- a/docs/en/installation/resources/choosing-version/choosing-version.md +++ b/docs/en/getting-started/installation-and-upgrade/resources/choose-a-rancher-version.md @@ -8,16 +8,16 @@ import TabItem from '@theme/TabItem'; This section describes how to choose a Rancher version. -For a high-availability installation of Rancher, which is recommended for production, the Rancher server is installed using a **Helm chart** on a Kubernetes cluster. Refer to the [Helm version requirements]({{}}/rancher/v2.6/en/installation/resources/helm-version) to choose a version of Helm to install Rancher. +For a high-availability installation of Rancher, which is recommended for production, the Rancher server is installed using a **Helm chart** on a Kubernetes cluster. Refer to the [Helm version requirements](helm-version-requirements.md) to choose a version of Helm to install Rancher. For Docker installations of Rancher, which is used for development and testing, you will install Rancher as a **Docker image**. -When installing, upgrading, or rolling back Rancher Server when it is [installed on a Kubernetes cluster]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/), Rancher server is installed using a Helm chart on a Kubernetes cluster. Therefore, as you prepare to install or upgrade a high availability Rancher configuration, you must add a Helm chart repository that contains the charts for installing Rancher. +When installing, upgrading, or rolling back Rancher Server when it is [installed on a Kubernetes cluster](../../../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md), Rancher server is installed using a Helm chart on a Kubernetes cluster. Therefore, as you prepare to install or upgrade a high availability Rancher configuration, you must add a Helm chart repository that contains the charts for installing Rancher. -Refer to the [Helm version requirements]({{}}/rancher/v2.6/en/installation/resources/helm-version) to choose a version of Helm to install Rancher. +Refer to the [Helm version requirements](helm-version-requirements.md) to choose a version of Helm to install Rancher. ### Helm Chart Repositories @@ -83,11 +83,11 @@ Because the rancher-alpha repository contains only alpha charts, switching betwe helm repo add rancher- https://releases.rancher.com/server-charts/ ``` -4. Continue to follow the steps to [upgrade Rancher]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades) from the new Helm chart repository. +4. Continue to follow the steps to [upgrade Rancher](../install-upgrade-on-a-kubernetes-cluster/upgrades.md) from the new Helm chart repository. -When performing [Docker installs]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker), upgrades, or rollbacks, you can use _tags_ to install a specific version of Rancher. +When performing [Docker installs](../../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md), upgrades, or rollbacks, you can use _tags_ to install a specific version of Rancher. ### Server Tags diff --git a/docs/en/installation/resources/custom-ca-root-certificate/custom-ca-root-certificate.md b/docs/en/getting-started/installation-and-upgrade/resources/custom-ca-root-certificates.md similarity index 79% rename from docs/en/installation/resources/custom-ca-root-certificate/custom-ca-root-certificate.md rename to docs/en/getting-started/installation-and-upgrade/resources/custom-ca-root-certificates.md index e3f3e9f05ed..a45fb23afa5 100644 --- a/docs/en/installation/resources/custom-ca-root-certificate/custom-ca-root-certificate.md +++ b/docs/en/getting-started/installation-and-upgrade/resources/custom-ca-root-certificates.md @@ -19,7 +19,7 @@ Examples of services that Rancher can access: For details on starting a Rancher container with your private CA certificates mounted, refer to the installation docs: -- [Docker install Custom CA certificate options]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#custom-ca-certificate) +- [Docker install Custom CA certificate options](../../../reference-guides/single-node-rancher-in-docker/advanced-options.md#custom-ca-certificate) -- [Kubernetes install options for Additional Trusted CAs]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#additional-trusted-cas) +- [Kubernetes install options for Additional Trusted CAs](../../../reference-guides/installation-references/helm-chart-options.md#additional-trusted-cas) diff --git a/docs/en/installation/resources/helm-version/helm-version.md b/docs/en/getting-started/installation-and-upgrade/resources/helm-version-requirements.md similarity index 100% rename from docs/en/installation/resources/helm-version/helm-version.md rename to docs/en/getting-started/installation-and-upgrade/resources/helm-version-requirements.md diff --git a/docs/en/installation/resources/local-system-charts/local-system-charts.md b/docs/en/getting-started/installation-and-upgrade/resources/local-system-charts.md similarity index 83% rename from docs/en/installation/resources/local-system-charts/local-system-charts.md rename to docs/en/getting-started/installation-and-upgrade/resources/local-system-charts.md index 3e39fe26ca0..49d5b18af53 100644 --- a/docs/en/installation/resources/local-system-charts/local-system-charts.md +++ b/docs/en/getting-started/installation-and-upgrade/resources/local-system-charts.md @@ -11,5 +11,5 @@ In an air gapped installation of Rancher, you will need to configure Rancher to A local copy of `system-charts` has been packaged into the `rancher/rancher` container. To be able to use these features in an air gap install, you will need to run the Rancher install command with an extra environment variable, `CATTLE_SYSTEM_CATALOG=bundled`, which tells Rancher to use the local copy of the charts instead of attempting to fetch them from GitHub. -Example commands for a Rancher installation with a bundled `system-charts` are included in the [air gap installation]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap) instructions for Docker and Helm installs. +Example commands for a Rancher installation with a bundled `system-charts` are included in the [air gap installation](../../../pages-for-subheaders/air-gapped-helm-cli-install.md) instructions for Docker and Helm installs. diff --git a/docs/en/installation/resources/update-rancher-cert/update-rancher-cert.md b/docs/en/getting-started/installation-and-upgrade/resources/update-rancher-certificate.md similarity index 93% rename from docs/en/installation/resources/update-rancher-cert/update-rancher-cert.md rename to docs/en/getting-started/installation-and-upgrade/resources/update-rancher-certificate.md index 34eb35577d5..d7e111af1cf 100644 --- a/docs/en/installation/resources/update-rancher-cert/update-rancher-cert.md +++ b/docs/en/getting-started/installation-and-upgrade/resources/update-rancher-certificate.md @@ -5,7 +5,7 @@ weight: 10 # Updating a Private CA Certificate -Follow these steps to update the SSL certificate of the ingress in a Rancher [high availability Kubernetes installation]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) or to switch from the default self-signed certificate to a custom certificate. +Follow these steps to update the SSL certificate of the ingress in a Rancher [high availability Kubernetes installation](../../../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md) or to switch from the default self-signed certificate to a custom certificate. A summary of the steps is as follows: @@ -153,7 +153,7 @@ https://gist.github.com/superseb/b14ed3b5535f621ad3d2aa6a4cd6443b ## 5. Select Force Update of Fleet clusters to connect fleet-agent to Rancher -Select 'Force Update' for the clusters within the [Continuous Delivery]({{}}/rancher/v2.6/en/deploy-across-clusters/fleet/#accessing-fleet-in-the-rancher-ui) view of the Rancher UI to allow the fleet-agent in downstream clusters to successfully connect to Rancher. +Select 'Force Update' for the clusters within the [Continuous Delivery](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md#accessing-fleet-in-the-rancher-ui) view of the Rancher UI to allow the fleet-agent in downstream clusters to successfully connect to Rancher. ### Why is this step required? @@ -208,7 +208,7 @@ kubectl -n cattle-system delete secret tls-ca :::note Important: -Before proceeding, [generate an API token in the Rancher UI]({{}}/rancher/v2.6/en/user-settings/api-keys/#creating-an-api-key) (User > API & Keys). +Before proceeding, [generate an API token in the Rancher UI](../../../reference-guides/user-settings/api-keys.md#creating-an-api-key) (User > API & Keys). ::: @@ -256,7 +256,7 @@ set privateCA=false ## 5. Select Force Update of Fleet clusters to connect fleet-agent to Rancher -Select 'Force Update' for the clusters within the [Continuous Delivery]({{}}/rancher/v2.6/en/deploy-across-clusters/fleet/#accessing-fleet-in-the-rancher-ui) view of the Rancher UI to allow the fleet-agent in downstream clusters to successfully connect to Rancher. +Select 'Force Update' for the clusters within the [Continuous Delivery](../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md#accessing-fleet-in-the-rancher-ui) view of the Rancher UI to allow the fleet-agent in downstream clusters to successfully connect to Rancher. ### Why is this step required? diff --git a/docs/en/installation/resources/upgrading-cert-manager/upgrading-cert-manager.md b/docs/en/getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md similarity index 94% rename from docs/en/installation/resources/upgrading-cert-manager/upgrading-cert-manager.md rename to docs/en/getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md index d71de5e54c8..3cb767496a7 100644 --- a/docs/en/installation/resources/upgrading-cert-manager/upgrading-cert-manager.md +++ b/docs/en/getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md @@ -114,7 +114,7 @@ In order to upgrade cert-manager, follow these instructions: Before you can perform the upgrade, you must prepare your air gapped environment by adding the necessary container images to your private registry and downloading or rendering the required Kubernetes manifest files. -1. Follow the guide to [Prepare your Private Registry]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/populate-private-registry) with the images needed for the upgrade. +1. Follow the guide to [Prepare your Private Registry](../other-installation-methods/air-gapped-helm-cli-install/publish-images.md) with the images needed for the upgrade. 1. From a system connected to the internet, add the cert-manager repo to Helm @@ -263,7 +263,7 @@ cert-manager-webhook-787858fcdb-nlzsq 1/1 Running 0 2m --- _New in v2.6.4_ -Rancher now supports cert-manager versions 1.6.2 and 1.7.1. We recommend v1.7.x because v 1.6.x will reach end-of-life on March 30, 2022. To read more, see the [cert-manager docs]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#4-install-cert-manager). For instructions on upgrading cert-manager from version 1.5 to 1.6, see the upstream cert-manager documentation [here](https://cert-manager.io/docs/installation/upgrading/upgrading-1.5-1.6/). For instructions on upgrading cert-manager from version 1.6 to 1.7, see the upstream cert-manager documentation [here](https://cert-manager.io/docs/installation/upgrading/upgrading-1.6-1.7/). +Rancher now supports cert-manager versions 1.6.2 and 1.7.1. We recommend v1.7.x because v 1.6.x will reach end-of-life on March 30, 2022. To read more, see the [cert-manager docs](../../../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md#4-install-cert-manager). For instructions on upgrading cert-manager from version 1.5 to 1.6, see the upstream cert-manager documentation [here](https://cert-manager.io/docs/installation/upgrading/upgrading-1.5-1.6/). For instructions on upgrading cert-manager from version 1.6 to 1.7, see the upstream cert-manager documentation [here](https://cert-manager.io/docs/installation/upgrading/upgrading-1.6-1.7/). --- diff --git a/docs/en/cluster-admin/upgrading-kubernetes/upgrading-kubernetes.md b/docs/en/getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes.md similarity index 80% rename from docs/en/cluster-admin/upgrading-kubernetes/upgrading-kubernetes.md rename to docs/en/getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes.md index f3123e62bb8..44cc5c72866 100644 --- a/docs/en/cluster-admin/upgrading-kubernetes/upgrading-kubernetes.md +++ b/docs/en/getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes.md @@ -5,7 +5,7 @@ weight: 70 Following an upgrade to the latest version of Rancher, downstream Kubernetes clusters can be upgraded to use the latest supported version of Kubernetes. -Rancher calls RKE (Rancher Kubernetes Engine) as a library when provisioning and editing RKE clusters. For more information on configuring the upgrade strategy for RKE clusters, refer to the [RKE documentation]({{}}/rke/latest/en/). +Rancher calls RKE (Rancher Kubernetes Engine) as a library when provisioning and editing RKE clusters. For more information on configuring the upgrade strategy for RKE clusters, refer to the [RKE documentation](https://rancher.com/docs/rke/latest/en/). This section covers the following topics: @@ -30,7 +30,7 @@ Before a new version of Rancher is released, it's tested with the latest minor v RKE v1.1.0 changed the way that clusters are upgraded. -In this section of the [RKE documentation,]({{}}/rke/latest/en/upgrades/how-upgrades-work) you'll learn what happens when you edit or upgrade your RKE Kubernetes cluster. +In this section of the [RKE documentation,](https://rancher.com/docs/rke/latest/en/upgrades/how-upgrades-work) you'll learn what happens when you edit or upgrade your RKE Kubernetes cluster. # Recommended Best Practice for Upgrades @@ -47,8 +47,8 @@ The restore operation will work on a cluster that is not in a healthy or active :::note Prerequisites: -- The options below are available only for [Rancher-launched RKE Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) and [Registered K3s Kubernetes clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/registered-clusters/#additional-features-for-registered-k3s-clusters) -- Before upgrading Kubernetes, [back up your cluster.]({{}}/rancher/v2.6/en/backups) +- The options below are available only for [Rancher-launched RKE Kubernetes clusters](../../pages-for-subheaders/launch-kubernetes-with-rancher.md) and [Registered K3s Kubernetes clusters.](../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md#additional-features-for-registered-k3s-clusters) +- Before upgrading Kubernetes, [back up your cluster.](../../pages-for-subheaders/backup-restore-and-disaster-recovery.md) ::: @@ -63,12 +63,12 @@ The restore operation will work on a cluster that is not in a healthy or active A cluster can be restored to a backup in which the previous Kubernetes version was used. For more information, refer to the following sections: -- [Backing up a cluster]({{}}/rancher/v2.6/en/cluster-admin/backing-up-etcd/#how-snapshots-work) -- [Restoring a cluster from backup]({{}}/rancher/v2.6/en/cluster-admin/restoring-etcd/#restoring-a-cluster-from-a-snapshot) +- [Backing up a cluster](../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher-launched-kubernetes-clusters.md#how-snapshots-work) +- [Restoring a cluster from backup](../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup.md#restoring-a-cluster-from-a-snapshot) # Configuring the Upgrade Strategy -As of RKE v1.1.0, additional upgrade options became available to give you more granular control over the upgrade process. These options can be used to maintain availability of your applications during a cluster upgrade if certain [conditions and requirements]({{}}/rke/latest/en/upgrades/maintaining-availability) are met. +As of RKE v1.1.0, additional upgrade options became available to give you more granular control over the upgrade process. These options can be used to maintain availability of your applications during a cluster upgrade if certain [conditions and requirements](https://rancher.com/docs/rke/latest/en/upgrades/maintaining-availability) are met. The upgrade strategy can be configured in the Rancher UI, or by editing the `cluster.yml`. More advanced options are available by editing the `cluster.yml`. @@ -97,7 +97,7 @@ To enable draining each node during a cluster upgrade, 1. On the **Clusters** page, go to the cluster you want to enable node draining and click **⋮ > Edit Config**. 1. Click **⋮ > Edit**. 1. In the **Upgrade Strategy** tab, go to the **Drain nodes** field and click **Yes**. Node draining is configured separately for control plane and worker nodes. -1. Configure the options for how pods are deleted. For more information about each option, refer to [this section.]({{}}/rancher/v2.6/en/cluster-admin/nodes/#aggressive-and-safe-draining-options) +1. Configure the options for how pods are deleted. For more information about each option, refer to [this section.](../../how-to-guides/advanced-user-guides/manage-clusters/nodes-and-node-pools.md#aggressive-and-safe-draining-options) 1. Optionally, configure a grace period. The grace period is the timeout given to each pod for cleaning things up, so they will have chance to exit gracefully. Pods might need to finish any outstanding requests, roll back transactions or save state to some external storage. If this value is negative, the default value specified in the pod will be used. 1. Optionally, configure a timeout, which is the amount of time the drain should continue to wait before giving up. 1. Click **Save**. @@ -114,13 +114,13 @@ As of Rancher v2.4.0, there is a [known issue](https://github.com/rancher/ranche _Available as of RKE v1.1.0_ -In [this section of the RKE documentation,]({{}}/rke/latest/en/upgrades/maintaining-availability/) you'll learn the requirements to prevent downtime for your applications when upgrading the cluster. +In [this section of the RKE documentation,](https://rancher.com/docs/rke/latest/en/upgrades/maintaining-availability/) you'll learn the requirements to prevent downtime for your applications when upgrading the cluster. ### Configuring the Upgrade Strategy in the cluster.yml More advanced upgrade strategy configuration options are available by editing the `cluster.yml`. -For details, refer to [Configuring the Upgrade Strategy]({{}}/rke/latest/en/upgrades/configuring-strategy) in the RKE documentation. The section also includes an example `cluster.yml` for configuring the upgrade strategy. +For details, refer to [Configuring the Upgrade Strategy](https://rancher.com/docs/rke/latest/en/upgrades/configuring-strategy) in the RKE documentation. The section also includes an example `cluster.yml` for configuring the upgrade strategy. # Troubleshooting diff --git a/docs/en/admin-settings/k8s-metadata/k8s-metadata.md b/docs/en/getting-started/installation-and-upgrade/upgrade-kubernetes-without-upgrading-rancher.md similarity index 86% rename from docs/en/admin-settings/k8s-metadata/k8s-metadata.md rename to docs/en/getting-started/installation-and-upgrade/upgrade-kubernetes-without-upgrading-rancher.md index 7ef4e1cfa7f..18d7dd505a5 100644 --- a/docs/en/admin-settings/k8s-metadata/k8s-metadata.md +++ b/docs/en/getting-started/installation-and-upgrade/upgrade-kubernetes-without-upgrading-rancher.md @@ -11,7 +11,7 @@ The Kubernetes API can change between minor versions. Therefore, we don't suppor ::: -Rancher's Kubernetes metadata contains information specific to the Kubernetes version that Rancher uses to provision [RKE clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/). Rancher syncs the data periodically and creates custom resource definitions (CRDs) for **system images,** **service options** and **addon templates**. Consequently, when a new Kubernetes version is compatible with the Rancher server version, the Kubernetes metadata makes the new version available to Rancher for provisioning clusters. The metadata gives you an overview of the information that the [Rancher Kubernetes Engine]({{}}/rke/latest/en/) (RKE) uses for deploying various Kubernetes versions. +Rancher's Kubernetes metadata contains information specific to the Kubernetes version that Rancher uses to provision [RKE clusters](../../pages-for-subheaders/launch-kubernetes-with-rancher.md). Rancher syncs the data periodically and creates custom resource definitions (CRDs) for **system images,** **service options** and **addon templates**. Consequently, when a new Kubernetes version is compatible with the Rancher server version, the Kubernetes metadata makes the new version available to Rancher for provisioning clusters. The metadata gives you an overview of the information that the [Rancher Kubernetes Engine](https://rancher.com/docs/rke/latest/en/) (RKE) uses for deploying various Kubernetes versions. This table below describes the CRDs that are affected by the periodic data sync. @@ -35,7 +35,7 @@ Administrators might configure the RKE metadata settings to do the following: ### Refresh Kubernetes Metadata -The option to refresh the Kubernetes metadata is available for administrators by default, or for any user who has the **Manage Cluster Drivers** [global role.]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) +The option to refresh the Kubernetes metadata is available for administrators by default, or for any user who has the **Manage Cluster Drivers** [global role.](../../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md) To force Rancher to refresh the Kubernetes metadata, a manual refresh action is available: @@ -84,6 +84,6 @@ After new Kubernetes versions are loaded into the Rancher setup, additional step 1. To download the system images for the private registry, click the Rancher server version at the bottom left corner of the Rancher UI. 1. Download the OS specific image lists for Linux or Windows. 1. Download `rancher-images.txt`. -1. Prepare the private registry using the same steps during the [air gap install]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/populate-private-registry), but instead of using the `rancher-images.txt` from the releases page, use the one obtained from the previous steps. +1. Prepare the private registry using the same steps during the [air gap install](other-installation-methods/air-gapped-helm-cli-install/publish-images.md), but instead of using the `rancher-images.txt` from the releases page, use the one obtained from the previous steps. **Result:** The air gap installation of Rancher can now sync the Kubernetes metadata. If you update your private registry when new versions of Kubernetes are released, you can provision clusters with the new version without having to upgrade Rancher. diff --git a/docs/en/overview/overview.md b/docs/en/getting-started/introduction/overview.md similarity index 63% rename from docs/en/overview/overview.md rename to docs/en/getting-started/introduction/overview.md index 8840c78bf82..6961919689c 100644 --- a/docs/en/overview/overview.md +++ b/docs/en/getting-started/introduction/overview.md @@ -23,7 +23,7 @@ Rancher provides an intuitive user interface for DevOps engineers to manage thei The following figure illustrates the role Rancher plays in IT and DevOps organizations. Each team deploys their applications on the public or private clouds they choose. IT administrators gain visibility and enforce policies across all users, clusters, and clouds. -![Platform]({{}}/img/rancher/platform.png) +![Platform](/img/platform.png) # Features of the Rancher API Server @@ -31,21 +31,21 @@ The Rancher API server is built on top of an embedded Kubernetes API server and ### Authorization and Role-Based Access Control -- **User management:** The Rancher API server [manages user identities]({{}}/rancher/v2.6/en/admin-settings/authentication/) that correspond to external authentication providers like Active Directory or GitHub, in addition to local users. -- **Authorization:** The Rancher API server manages [access control]({{}}/rancher/v2.6/en/admin-settings/rbac/) and [security]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/) policies. +- **User management:** The Rancher API server [manages user identities](../../pages-for-subheaders/about-authentication.md) that correspond to external authentication providers like Active Directory or GitHub, in addition to local users. +- **Authorization:** The Rancher API server manages [access control](../../pages-for-subheaders/manage-role-based-access-control-rbac.md) and [security](../../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies.md) policies. ### Working with Kubernetes -- **Provisioning Kubernetes clusters:** The Rancher API server can [provision Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/) on existing nodes, or perform [Kubernetes upgrades.]({{}}/rancher/v2.6/en/cluster-admin/upgrading-kubernetes) -- **Catalog management:** Rancher provides the ability to use a [catalog of Helm charts]({{}}/rancher/v2.6/en/helm-charts/) that make it easy to repeatedly deploy applications. -- **Managing projects:** A project is a group of multiple namespaces and access control policies within a cluster. A project is a Rancher concept, not a Kubernetes concept, which allows you to manage multiple namespaces as a group and perform Kubernetes operations in them. The Rancher UI provides features for [project administration]({{}}/rancher/v2.6/en/project-admin/) and for [managing applications within projects.]({{}}/rancher/v2.6/en/k8s-in-rancher/) -- **Pipelines:** Setting up a [pipeline]({{}}/rancher/v2.6/en/project-admin/pipelines/) can help developers deliver new software as quickly and efficiently as possible. Within Rancher, you can configure pipelines for each of your Rancher projects. -- **Istio:** Our [integration with Istio]({{}}/rancher/v2.6/en/istio/) is designed so that a Rancher operator, such as an administrator or cluster owner, can deliver Istio to developers. Then developers can use Istio to enforce security policies, troubleshoot problems, or manage traffic for green/blue deployments, canary deployments, or A/B testing. +- **Provisioning Kubernetes clusters:** The Rancher API server can [provision Kubernetes](../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md) on existing nodes, or perform [Kubernetes upgrades.](../installation-and-upgrade/upgrade-and-roll-back-kubernetes.md) +- **Catalog management:** Rancher provides the ability to use a [catalog of Helm charts](../../pages-for-subheaders/helm-charts-in-rancher.md) that make it easy to repeatedly deploy applications. +- **Managing projects:** A project is a group of multiple namespaces and access control policies within a cluster. A project is a Rancher concept, not a Kubernetes concept, which allows you to manage multiple namespaces as a group and perform Kubernetes operations in them. The Rancher UI provides features for [project administration](../../pages-for-subheaders/manage-projects.md) and for [managing applications within projects.](../../pages-for-subheaders/kubernetes-resources-setup.md) +- **Pipelines:** Setting up a [pipeline](../../how-to-guides/advanced-user-guides/manage-projects/ci-cd-pipelines.md) can help developers deliver new software as quickly and efficiently as possible. Within Rancher, you can configure pipelines for each of your Rancher projects. +- **Istio:** Our [integration with Istio](../../pages-for-subheaders/istio.md) is designed so that a Rancher operator, such as an administrator or cluster owner, can deliver Istio to developers. Then developers can use Istio to enforce security policies, troubleshoot problems, or manage traffic for green/blue deployments, canary deployments, or A/B testing. ### Working with Cloud Infrastructure -- **Tracking nodes:** The Rancher API server tracks identities of all the [nodes]({{}}/rancher/v2.6/en/cluster-admin/nodes/) in all clusters. -- **Setting up infrastructure:** When configured to use a cloud provider, Rancher can dynamically provision [new nodes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/) and [persistent storage]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/) in the cloud. +- **Tracking nodes:** The Rancher API server tracks identities of all the [nodes](../../how-to-guides/advanced-user-guides/manage-clusters/nodes-and-node-pools.md) in all clusters. +- **Setting up infrastructure:** When configured to use a cloud provider, Rancher can dynamically provision [new nodes](../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md) and [persistent storage](../../pages-for-subheaders/create-kubernetes-persistent-storage.md) in the cloud. ### Cluster Visibility @@ -55,12 +55,12 @@ The Rancher API server is built on top of an embedded Kubernetes API server and # Editing Downstream Clusters with Rancher -The options and settings available for an existing cluster change based on the method that you used to provision it. For example, only clusters [provisioned by RKE]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) have **Cluster Options** available for editing. +The options and settings available for an existing cluster change based on the method that you used to provision it. For example, only clusters [provisioned by RKE](../../pages-for-subheaders/launch-kubernetes-with-rancher.md) have **Cluster Options** available for editing. -After a cluster is created with Rancher, a cluster administrator can manage cluster membership, enable pod security policies, and manage node pools, among [other options.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/) +After a cluster is created with Rancher, a cluster administrator can manage cluster membership, enable pod security policies, and manage node pools, among [other options.](../../pages-for-subheaders/cluster-configuration.md) The following table summarizes the options and settings available for each cluster type: -import ClusterCapabilitiesTable from '/rancher/v2.6/en/shared-files/_cluster-capabilities-table.md'; +import ClusterCapabilitiesTable from '../../shared-files/_cluster-capabilities-table.md'; diff --git a/docs/en/getting-started/introduction/what-are-divio-docs.md b/docs/en/getting-started/introduction/what-are-divio-docs.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/getting-started/introduction/what-are-divio-docs.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/quick-start-guide/deployment/amazon-aws-marketplace-qs/amazon-aws-marketplace-qs.md b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md similarity index 100% rename from docs/en/quick-start-guide/deployment/amazon-aws-marketplace-qs/amazon-aws-marketplace-qs.md rename to docs/en/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md diff --git a/docs/en/quick-start-guide/deployment/amazon-aws-qs/amazon-aws-qs.md b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/aws.md similarity index 96% rename from docs/en/quick-start-guide/deployment/amazon-aws-qs/amazon-aws-qs.md rename to docs/en/getting-started/quick-start-guides/deploy-rancher-manager/aws.md index f808f6de87a..d382b354b2c 100644 --- a/docs/en/quick-start-guide/deployment/amazon-aws-qs/amazon-aws-qs.md +++ b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/aws.md @@ -7,7 +7,7 @@ The following steps will quickly deploy a Rancher server on AWS in a single-node :::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]({{}}/rancher/v2.6/en/installation/). +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](../../../pages-for-subheaders/installation-and-upgrade.md). ::: @@ -85,7 +85,7 @@ Two Kubernetes clusters are deployed into your AWS account, one running Rancher ## What's Next? -Use Rancher to create a deployment. For more information, see [Creating Deployments]({{}}/rancher/v2.6/en/quick-start-guide/workload). +Use Rancher to create a deployment. For more information, see [Creating Deployments](../../../pages-for-subheaders/deploy-rancher-workloads.md). ## Destroying the Environment diff --git a/docs/en/quick-start-guide/deployment/microsoft-azure-qs/microsoft-azure-qs.md b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/azure.md similarity index 96% rename from docs/en/quick-start-guide/deployment/microsoft-azure-qs/microsoft-azure-qs.md rename to docs/en/getting-started/quick-start-guides/deploy-rancher-manager/azure.md index 0a2c827735a..39b77c8aaa1 100644 --- a/docs/en/quick-start-guide/deployment/microsoft-azure-qs/microsoft-azure-qs.md +++ b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/azure.md @@ -8,7 +8,7 @@ The following steps will quickly deploy a Rancher server on Azure in a single-no :::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]({{}}/rancher/v2.6/en/installation/). +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](../../../pages-for-subheaders/installation-and-upgrade.md). ::: @@ -74,7 +74,7 @@ Two Kubernetes clusters are deployed into your Azure account, one running Ranche ### What's Next? -Use Rancher to create a deployment. For more information, see [Creating Deployments]({{< baseurl >}}/rancher/v2.6/en/quick-start-guide/workload). +Use Rancher to create a deployment. For more information, see [Creating Deployments](../../../pages-for-subheaders/deploy-rancher-workloads.md). ## Destroying the Environment diff --git a/docs/en/quick-start-guide/deployment/digital-ocean-qs/digital-ocean-qs.md b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/digitalocean.md similarity index 95% rename from docs/en/quick-start-guide/deployment/digital-ocean-qs/digital-ocean-qs.md rename to docs/en/getting-started/quick-start-guides/deploy-rancher-manager/digitalocean.md index b25b6a07ef2..ac8d7c156a2 100644 --- a/docs/en/quick-start-guide/deployment/digital-ocean-qs/digital-ocean-qs.md +++ b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/digitalocean.md @@ -7,7 +7,7 @@ The following steps will quickly deploy a Rancher server on DigitalOcean in a si :::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]({{}}/rancher/v2.6/en/installation/). +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](../../../pages-for-subheaders/installation-and-upgrade.md). ::: @@ -66,7 +66,7 @@ Two Kubernetes clusters are deployed into your DigitalOcean account, one running ### What's Next? -Use Rancher to create a deployment. For more information, see [Creating Deployments]({{}}/rancher/v2.6/en/quick-start-guide/workload). +Use Rancher to create a deployment. For more information, see [Creating Deployments](../../../pages-for-subheaders/deploy-rancher-workloads.md). ## Destroying the Environment diff --git a/docs/en/quick-start-guide/deployment/equinix-metal-qs/equinix-metal-qs.md b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/equinix-metal.md similarity index 92% rename from docs/en/quick-start-guide/deployment/equinix-metal-qs/equinix-metal-qs.md rename to docs/en/getting-started/quick-start-guides/deploy-rancher-manager/equinix-metal.md index eece16f895f..8d8c45826a0 100644 --- a/docs/en/quick-start-guide/deployment/equinix-metal-qs/equinix-metal-qs.md +++ b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/equinix-metal.md @@ -12,7 +12,7 @@ weight: 250 :::caution -The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. The Docker install is not recommended for production environments. For comprehensive setup instructions, see [Installation]({{}}/rancher/v2.6/en/installation/). +The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. The Docker install is not recommended for production environments. For comprehensive setup instructions, see [Installation](../../../pages-for-subheaders/installation-and-upgrade.md). ::: @@ -50,8 +50,8 @@ This Quick Start Guide is divided into different tasks for easier consumption. - When provisioning a new Equinix Metal Server via the CLI or API you will need to be able to provide the following information: project-id, plan, metro, and the operating-system - When using a cloud-hosted virtual machine you need to allow inbound TCP communication to ports 80 and 443. Please see your cloud-host's documentation for information regarding port configuration. -- For a full list of port requirements, refer to [Docker Installation]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/). -- Provision the host according to our [Requirements]({{}}/rancher/v2.6/en/installation/requirements/). +- For a full list of port requirements, refer to [Docker Installation](../../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md). +- Provision the host according to our [Requirements](../../../pages-for-subheaders/installation-requirements.md). ::: ### 2. Install Rancher @@ -127,4 +127,4 @@ Congratulations! You have created your first cluster. #### What's Next? -Use Rancher to create a deployment. For more information, see [Creating Deployments]({{}}/rancher/v2.6/en/quick-start-guide/workload). +Use Rancher to create a deployment. For more information, see [Creating Deployments](../../../pages-for-subheaders/deploy-rancher-workloads.md). diff --git a/docs/en/quick-start-guide/deployment/google-gcp-qs/google-gcp-qs.md b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/gcp.md similarity index 95% rename from docs/en/quick-start-guide/deployment/google-gcp-qs/google-gcp-qs.md rename to docs/en/getting-started/quick-start-guides/deploy-rancher-manager/gcp.md index 9f274311ae7..aed01fd3284 100644 --- a/docs/en/quick-start-guide/deployment/google-gcp-qs/google-gcp-qs.md +++ b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/gcp.md @@ -7,7 +7,7 @@ The following steps will quickly deploy a Rancher server on GCP in a single-node :::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]({{}}/rancher/v2.6/en/installation/). +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](../../../pages-for-subheaders/installation-and-upgrade.md). ::: @@ -68,7 +68,7 @@ Two Kubernetes clusters are deployed into your GCP account, one running Rancher ### What's Next? -Use Rancher to create a deployment. For more information, see [Creating Deployments]({{< baseurl >}}/rancher/v2.6/en/quick-start-guide/workload). +Use Rancher to create a deployment. For more information, see [Creating Deployments](../../../pages-for-subheaders/deploy-rancher-workloads.md). ## Destroying the Environment diff --git a/docs/en/quick-start-guide/deployment/quickstart-manual-setup/quickstart-manual-setup.md b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli.md similarity index 92% rename from docs/en/quick-start-guide/deployment/quickstart-manual-setup/quickstart-manual-setup.md rename to docs/en/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli.md index d1dd7282a78..f93a1ef1ce5 100644 --- a/docs/en/quick-start-guide/deployment/quickstart-manual-setup/quickstart-manual-setup.md +++ b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli.md @@ -12,9 +12,9 @@ These instructions assume you have a Linux virtual machine that you will communi We don't recommend installing Rancher locally because it creates a networking problem. Installing Rancher on localhost does not allow Rancher to communicate with downstream Kubernetes clusters, so on localhost you wouldn't be able to test Rancher's cluster provisioning or cluster management functionality. -Your Linux machine can be anywhere. It could be an Amazon EC2 instance, a Digital Ocean droplet, or an Azure virtual machine, to name a few examples. Other Rancher docs often use 'node' as a generic term for all of these. One possible way to deploy a Linux machine is by setting up an Amazon EC2 instance as shown in [this tutorial]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/). +Your Linux machine can be anywhere. It could be an Amazon EC2 instance, a Digital Ocean droplet, or an Azure virtual machine, to name a few examples. Other Rancher docs often use 'node' as a generic term for all of these. One possible way to deploy a Linux machine is by setting up an Amazon EC2 instance as shown in [this tutorial](../../../how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2.md). -The full installation requirements are [here]({{}}/rancher/v2.6/en/installation/requirements/). +The full installation requirements are [here](../../../pages-for-subheaders/installation-requirements.md). ## Install K3s on Linux @@ -135,6 +135,6 @@ Now if you navigate to `.sslip.io` in a web browser, you shoul To make these instructions simple, we used a fake domain name and self-signed certificates to do this installation. Therefore, you will probably need to add a security exception to your web browser to see the Rancher UI. Note that for production installs, you would need a high-availability setup with a load balancer, a real domain name and real certificates. -These instructions also left out the full installation requirements and other installation options. If you have any issues with these steps, refer to the full [Helm CLI installation docs.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) +These instructions also left out the full installation requirements and other installation options. If you have any issues with these steps, refer to the full [Helm CLI installation docs.](../../../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md) -To launch new Kubernetes clusters with your new Rancher server, you may need to set up cloud credentials in Rancher. For more information, see [Launching Kubernetes clusters with Rancher.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) +To launch new Kubernetes clusters with your new Rancher server, you may need to set up cloud credentials in Rancher. For more information, see [Launching Kubernetes clusters with Rancher.](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) diff --git a/docs/en/quick-start-guide/deployment/hetzner-cloud-qs/hetzner-cloud-qs.md b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/hetzner-cloud.md similarity index 95% rename from docs/en/quick-start-guide/deployment/hetzner-cloud-qs/hetzner-cloud-qs.md rename to docs/en/getting-started/quick-start-guides/deploy-rancher-manager/hetzner-cloud.md index 8bddb487d1b..8347bcecfab 100644 --- a/docs/en/quick-start-guide/deployment/hetzner-cloud-qs/hetzner-cloud-qs.md +++ b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/hetzner-cloud.md @@ -7,7 +7,7 @@ The following steps will quickly deploy a Rancher server on Hetzner Cloud in a s :::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]({{}}/rancher/v2.6/en/installation/). +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](../../../pages-for-subheaders/installation-and-upgrade.md). ::: @@ -66,7 +66,7 @@ Two Kubernetes clusters are deployed into your Hetzner account, one running Ranc ### What's Next? -Use Rancher to create a deployment. For more information, see [Creating Deployments]({{}}/rancher/v2.6/en/quick-start-guide/workload). +Use Rancher to create a deployment. For more information, see [Creating Deployments](../../../pages-for-subheaders/deploy-rancher-workloads.md). ## Destroying the Environment diff --git a/docs/en/quick-start-guide/deployment/outscale-qs/outscale-qs.md b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/outscale-qs.md similarity index 95% rename from docs/en/quick-start-guide/deployment/outscale-qs/outscale-qs.md rename to docs/en/getting-started/quick-start-guides/deploy-rancher-manager/outscale-qs.md index c48c64f5efa..9f41b777e0d 100644 --- a/docs/en/quick-start-guide/deployment/outscale-qs/outscale-qs.md +++ b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/outscale-qs.md @@ -7,7 +7,7 @@ The following steps will quickly deploy a Rancher server on Outscale in a single :::note -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]({{}}/rancher/v2.6/en/installation/). +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](../../../pages-for-subheaders/installation-and-upgrade.md). ::: @@ -67,7 +67,7 @@ Two Kubernetes clusters are deployed into your Outscale account, one running Ran ### What's Next? -Use Rancher to create a deployment. For more information, see [Creating Deployments]({{}}/rancher/v2.6/en/quick-start-guide/workload). +Use Rancher to create a deployment. For more information, see [Creating Deployments](../../../pages-for-subheaders/deploy-rancher-workloads.md). ## Destroying the Environment diff --git a/docs/en/quick-start-guide/deployment/quickstart-vagrant/quickstart-vagrant.md b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md similarity index 92% rename from docs/en/quick-start-guide/deployment/quickstart-vagrant/quickstart-vagrant.md rename to docs/en/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md index c7d9cf170d7..5fc264a1a69 100644 --- a/docs/en/quick-start-guide/deployment/quickstart-vagrant/quickstart-vagrant.md +++ b/docs/en/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md @@ -6,7 +6,7 @@ The following steps quickly deploy a Rancher Server with a single node cluster a :::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]({{}}/rancher/v2.6/en/installation/). +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](../../../pages-for-subheaders/installation-and-upgrade.md). ::: @@ -42,7 +42,7 @@ The intent of these guides is to quickly launch a sandbox that you can use to ev ### What's Next? -Use Rancher to create a deployment. For more information, see [Creating Deployments]({{}}/rancher/v2.6/en/quick-start-guide/workload). +Use Rancher to create a deployment. For more information, see [Creating Deployments](../../../pages-for-subheaders/deploy-rancher-workloads.md). ## Destroying the Environment diff --git a/docs/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/quickstart-deploy-workload-nodeport.md b/docs/en/getting-started/quick-start-guides/deploy-workloads/nodeports.md similarity index 87% rename from docs/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/quickstart-deploy-workload-nodeport.md rename to docs/en/getting-started/quick-start-guides/deploy-workloads/nodeports.md index f064b9dc50e..154f51e5ef1 100644 --- a/docs/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/quickstart-deploy-workload-nodeport.md +++ b/docs/en/getting-started/quick-start-guides/deploy-workloads/nodeports.md @@ -22,11 +22,11 @@ For this workload, you'll be deploying the application Rancher Hello-World. 1. Click **Add Port**. 1. From the **Service Type** drop-down, make sure that **NodePort** is selected. - ![As a dropdown, NodePort (On every node selected)]({{}}/img/rancher/nodeport-dropdown.png) + ![As a dropdown, NodePort (On every node selected)](/img/nodeport-dropdown.png) 1. From the **Publish the container port** field, enter port `80`. - ![Publish the container port, 80 entered]({{}}/img/rancher/container-port-field.png) + ![Publish the container port, 80 entered](/img/container-port-field.png) 1. Click **Create**. @@ -134,6 +134,6 @@ Congratulations! You have successfully deployed a workload exposed via a NodePor When you're done using your sandbox, destroy the Rancher Server and your cluster. See one of the following: -- [Amazon AWS: Destroying the Environment]({{}}/rancher/v2.6/en/quick-start-guide/deployment/amazon-aws-qs/#destroying-the-environment) -- [DigitalOcean: Destroying the Environment]({{}}/rancher/v2.6/en/quick-start-guide/deployment/digital-ocean-qs/#destroying-the-environment) -- [Vagrant: Destroying the Environment]({{}}/rancher/v2.6/en/quick-start-guide/deployment/quickstart-vagrant/#destroying-the-environment) +- [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) +- [Vagrant: Destroying the Environment](../deploy-rancher-manager/vagrant.md#destroying-the-environment) diff --git a/docs/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/quickstart-deploy-workload-ingress.md b/docs/en/getting-started/quick-start-guides/deploy-workloads/workload-ingress.md similarity index 85% rename from docs/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/quickstart-deploy-workload-ingress.md rename to docs/en/getting-started/quick-start-guides/deploy-workloads/workload-ingress.md index 004950b7fe2..1f4de821d40 100644 --- a/docs/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/quickstart-deploy-workload-ingress.md +++ b/docs/en/getting-started/quick-start-guides/deploy-workloads/workload-ingress.md @@ -20,7 +20,7 @@ For this workload, you'll be deploying the application Rancher Hello-World. 1. Click **Deployment**. 1. Enter a **Name** for your workload. 1. From the **Docker Image** field, enter `rancher/hello-world`. This field is case-sensitive. -1. Click **Add Port** and enter `80` in the **Private Container Port** field. Adding a port enables access to the application inside and outside of the cluster. For more information, see [Services]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/#services). +1. Click **Add Port** and enter `80` in the **Private Container Port** field. Adding a port enables access to the application inside and outside of the cluster. For more information, see [Services](../../../pages-for-subheaders/workloads-and-pods.md#services). 1. Click **Create**. **Result:** @@ -69,6 +69,6 @@ Congratulations! You have successfully deployed a workload exposed via an ingres When you're done using your sandbox, destroy the Rancher Server and your cluster. See one of the following: -- [Amazon AWS: Destroying the Environment]({{}}/rancher/v2.6/en/quick-start-guide/deployment/amazon-aws-qs/#destroying-the-environment) -- [DigitalOcean: Destroying the Environment]({{}}/rancher/v2.6/en/quick-start-guide/deployment/digital-ocean-qs/#destroying-the-environment) -- [Vagrant: Destroying the Environment]({{}}/rancher/v2.6/en/quick-start-guide/deployment/quickstart-vagrant/#destroying-the-environment) +- [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) +- [Vagrant: Destroying the Environment](../deploy-rancher-manager/vagrant.md#destroying-the-environment) diff --git a/docs/en/how-to-guides.md b/docs/en/how-to-guides.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/how-to-guides.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/admin-settings/authentication/ad/ad.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-active-directory.md similarity index 96% rename from docs/en/admin-settings/authentication/ad/ad.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-active-directory.md index 2e89ec0afd8..57c4b3afbb0 100644 --- a/docs/en/admin-settings/authentication/ad/ad.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-active-directory.md @@ -5,11 +5,11 @@ weight: 1112 If your organization uses Microsoft Active Directory as central user repository, you can configure Rancher to communicate with an Active Directory server to authenticate users. This allows Rancher admins to control access to clusters and projects based on users and groups managed externally in the Active Directory, while allowing end-users to authenticate with their AD credentials when logging in to the Rancher UI. -Rancher uses LDAP to communicate with the Active Directory server. The authentication flow for Active Directory is therefore the same as for the [OpenLDAP authentication]({{}}/rancher/v2.6/en/admin-settings/authentication/openldap) integration. +Rancher uses LDAP to communicate with the Active Directory server. The authentication flow for Active Directory is therefore the same as for the [OpenLDAP authentication](../../../../../pages-for-subheaders/configure-openldap.md) integration. :::note -Before you start, please familiarise yourself with the concepts of [External Authentication Configuration and Principal Users]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). +Before you start, please familiarise yourself with the concepts of [External Authentication Configuration and Principal Users](../../../../../pages-for-subheaders/about-authentication.md#external-authentication-configuration-and-principal-users). ::: @@ -167,7 +167,7 @@ $ ldapsearch -x -D "acme\jdoe" -w "secret" -p 389 \ This command performs an LDAP search with the search base set to the domain root (`-b "dc=acme,dc=com"`) and a filter targeting the user account (`sAMAccountNam=jdoe`), returning the attributes for said user: -{{< img "/img/rancher/ldapsearch-user.png" "LDAP User">}} +![](/img/ldapsearch-user.png) Since in this case the user's DN is `CN=John Doe,CN=Users,DC=acme,DC=com` [5], we should configure the **User Search Base** with the parent node DN `CN=Users,DC=acme,DC=com`. @@ -202,7 +202,7 @@ $ ldapsearch -x -D "acme\jdoe" -w "secret" -p 389 \ This command will inform us on the attributes used for group objects: -{{< img "/img/rancher/ldapsearch-group.png" "LDAP Group">}} +![](/img/ldapsearch-group.png) Again, this allows us to determine the correct values to enter in the group schema configuration: @@ -217,4 +217,4 @@ In the same way, we can observe that the value in the **memberOf** attribute in ## Annex: Troubleshooting -If you are experiencing issues while testing the connection to the Active Directory server, first double-check the credentials entered for the service account as well as the search base configuration. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging]({{}}/rancher/v2.6/en/faq/technical/#how-can-i-enable-debug-logging) in this documentation. +If you are experiencing issues while testing the connection to the Active Directory server, first double-check the credentials entered for the service account as well as the search base configuration. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging](../../../../../faq/technical-items.md#how-can-i-enable-debug-logging) in this documentation. diff --git a/docs/en/admin-settings/authentication/azure-ad/azure-ad.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-azure-ad.md similarity index 90% rename from docs/en/admin-settings/authentication/azure-ad/azure-ad.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-azure-ad.md index b87723397e0..688e4fc5ff6 100644 --- a/docs/en/admin-settings/authentication/azure-ad/azure-ad.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-azure-ad.md @@ -48,11 +48,11 @@ Before enabling Azure AD within Rancher, you must register Rancher with Azure. 1. Use search to open the **App registrations** service. - ![Open App Registrations]({{}}/img/rancher/search-app-registrations.png) + ![Open App Registrations](/img/search-app-registrations.png) 1. Click **New registrations** and complete the **Create** form. - ![New App Registration]({{}}/img/rancher/new-app-registration.png) + ![New App Registration](/img/new-app-registration.png) 1. Enter a **Name** (something like `Rancher`). @@ -80,13 +80,13 @@ From the Azure portal, create a client secret. Rancher will use this key to auth 1. Use search to open **App registrations** services. Then open the entry for Rancher that you created in the last procedure. - ![Open Rancher Registration]({{}}/img/rancher/open-rancher-app.png) + ![Open Rancher Registration](/img/open-rancher-app.png) 1. From the navigation pane on left, click **Certificates and Secrets**. 1. Click **New client secret**. - ![Create new client secret]({{< baseurl >}}/img/rancher/select-client-secret.png) + ![Create new client secret](/img/select-client-secret.png) 1. Enter a **Description** (something like `Rancher`). @@ -107,13 +107,13 @@ Next, set API permissions for Rancher within Azure. 1. From the navigation pane on left, select **API permissions**. - ![Open Required Permissions]({{}}/img/rancher/select-required-permissions.png) + ![Open Required Permissions](/img/select-required-permissions.png) 1. Click **Add a permission**. 1. From the **Azure Active Directory Graph**, select the following **Delegated Permissions**: - ![Select API Permissions]({{< baseurl >}}/img/rancher/select-required-permissions-2.png) + ![Select API Permissions](/img/select-required-permissions-2.png)

@@ -142,7 +142,7 @@ To use Azure AD with Rancher you must whitelist Rancher with Azure. You can comp 1. From the **Setting** blade, select **Reply URLs**. - ![Azure: Enter Reply URL]({{}}/img/rancher/enter-azure-reply-url.png) + ![Azure: Enter Reply URL](/img/enter-azure-reply-url.png) 1. From the **Reply URLs** blade, enter the URL of your Rancher Server, appended with the verification path: `/verify-auth-azure`. @@ -170,7 +170,7 @@ As your final step in Azure, copy the data that you'll use to configure Rancher 1. Use search to open the **Azure Active Directory** service. - ![Open Azure Active Directory]({{}}/img/rancher/search-azure-ad.png) + ![Open Azure Active Directory](/img/search-azure-ad.png) 1. From the left navigation pane, open **Overview**. @@ -182,7 +182,7 @@ As your final step in Azure, copy the data that you'll use to configure Rancher 1. Use search to open **App registrations**. - ![Open App Registrations]({{}}/img/rancher/search-app-registrations.png) + ![Open App Registrations](/img/search-app-registrations.png) 1. Find the entry you created for Rancher. @@ -192,7 +192,7 @@ As your final step in Azure, copy the data that you'll use to configure Rancher 1. From **App registrations**, click **Endpoints**. - ![Click Endpoints]({{}}/img/rancher/click-endpoints.png) + ![Click Endpoints](/img/click-endpoints.png) 2. Copy the following endpoints to your clipboard and paste them into your [text file](#tip) (these values will be your Rancher endpoint values). diff --git a/docs/en/admin-settings/authentication/freeipa/freeipa.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-freeipa.md similarity index 95% rename from docs/en/admin-settings/authentication/freeipa/freeipa.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-freeipa.md index 052313f9c57..275e9ccf38b 100644 --- a/docs/en/admin-settings/authentication/freeipa/freeipa.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-freeipa.md @@ -9,7 +9,7 @@ If your organization uses FreeIPA for user authentication, you can configure Ran - You must have a [FreeIPA Server](https://www.freeipa.org/) configured. - Create a service account in FreeIPA with `read-only` access. Rancher uses this account to verify group membership when a user makes a request using an API key. -- Read [External Authentication Configuration and Principal Users]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). +- Read [External Authentication Configuration and Principal Users](../../../../../pages-for-subheaders/about-authentication.md#external-authentication-configuration-and-principal-users). ::: diff --git a/docs/en/admin-settings/authentication/github/github.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-github.md similarity index 94% rename from docs/en/admin-settings/authentication/github/github.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-github.md index 61b0ab03d45..b1634e3e27f 100644 --- a/docs/en/admin-settings/authentication/github/github.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-github.md @@ -7,7 +7,7 @@ In environments using GitHub, you can configure Rancher to allow sign on using G :::note Prerequisites: -Read [External Authentication Configuration and Principal Users]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). +Read [External Authentication Configuration and Principal Users](../../../../../pages-for-subheaders/about-authentication.md#external-authentication-configuration-and-principal-users). ::: diff --git a/docs/en/admin-settings/authentication/google/google.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-google-oauth.md similarity index 90% rename from docs/en/admin-settings/authentication/google/google.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-google-oauth.md index 2ac8b6cb8c9..54a6c6d0c00 100644 --- a/docs/en/admin-settings/authentication/google/google.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-google-oauth.md @@ -7,7 +7,7 @@ If your organization uses G Suite for user authentication, you can configure Ran Only admins of the G Suite domain have access to the Admin SDK. Therefore, only G Suite admins can configure Google OAuth for Rancher. -Within Rancher, only administrators or users with the **Manage Authentication** [global role]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) can configure authentication. +Within Rancher, only administrators or users with the **Manage Authentication** [global role](../../manage-role-based-access-control-rbac/global-permissions.md) can configure authentication. # Prerequisites @@ -16,7 +16,7 @@ Within Rancher, only administrators or users with the **Manage Authentication** - You must have the Admin SDK API enabled for your G Suite domain. You can enable it using the steps on [this page.](https://support.google.com/a/answer/60757?hl=en) After the Admin SDK API is enabled, your G Suite domain's API screen should look like this: -![Enable Admin APIs]({{}}/img/rancher/Google-Enable-APIs-Screen.png) +![Enable Admin APIs](/img/Google-Enable-APIs-Screen.png) # Setting up G Suite for OAuth with Rancher @@ -31,7 +31,7 @@ Before you can set up Google OAuth in Rancher, you need to log in to your G Suit 1. Click [here](https://console.developers.google.com/apis/credentials) to go to credentials page of your Google domain. 1. Select your project and click **OAuth consent screen**. -![OAuth Consent Screen]({{}}/img/rancher/Google-OAuth-consent-screen-tab.png) +![OAuth Consent Screen](/img/Google-OAuth-consent-screen-tab.png) 1. Go to **Authorized Domains** and enter the top private domain of your Rancher server URL in the list. The top private domain is the rightmost superdomain. So for example, www.foo.co.uk a top private domain of foo.co.uk. For more information on top-level domains, refer to [this article.](https://github.com/google/guava/wiki/InternetDomainNameExplained#public-suffixes-and-private-domains) 1. Go to **Scopes for Google APIs** and make sure **email,** **profile** and **openid** are enabled. @@ -40,7 +40,7 @@ Before you can set up Google OAuth in Rancher, you need to log in to your G Suit ### 2. Creating OAuth2 Credentials for the Rancher Server 1. Go to the Google API console, select your project, and go to the [credentials page.](https://console.developers.google.com/apis/credentials) -![Credentials]({{}}/img/rancher/Google-Credentials-tab.png) +![Credentials](/img/Google-Credentials-tab.png) 1. On the **Create Credentials** dropdown, select **OAuth client ID**. 1. Click **Web application**. 1. Provide a name. @@ -67,11 +67,11 @@ This section describes how to: 1. Click [here](https://console.developers.google.com/iam-admin/serviceaccounts) and select your project for which you generated OAuth credentials. 1. Click on **Create Service Account**. 1. Enter a name and click **Create**. -![Service account creation Step 1]({{}}/img/rancher/Google-svc-acc-step1.png) +![Service account creation Step 1](/img/Google-svc-acc-step1.png) 1. Don't provide any roles on the **Service account permissions** page and click **Continue** -![Service account creation Step 2]({{}}/img/rancher/Google-svc-acc-step2.png) +![Service account creation Step 2](/img/Google-svc-acc-step2.png) 1. Click on **Create Key** and select the JSON option. Download the JSON file and save it so that you can provide it as the service account credentials to Rancher. -![Service account creation Step 3]({{}}/img/rancher/Google-svc-acc-step3-key-creation.png) +![Service account creation Step 3](/img/Google-svc-acc-step3-key-creation.png) **Result:** Your service account is created. @@ -83,7 +83,7 @@ Using the Unique ID of the service account key, register it as an Oauth Client u 1. Get the Unique ID of the key you just created. If it's not displayed in the list of keys right next to the one you created, you will have to enable it. To enable it, click **Unique ID** and click **OK**. This will add a **Unique ID** column to the list of service account keys. Save the one listed for the service account you created. NOTE: This is a numeric key, not to be confused with the alphanumeric field **Key ID**. - ![Service account Unique ID]({{}}/img/rancher/Google-Select-UniqueID-column.png) + ![Service account Unique ID](/img/Google-Select-UniqueID-column.png) 1. Go to the [**Domain-wide Delegation** page.](https://admin.google.com/ac/owl/domainwidedelegation) 1. Add the Unique ID obtained in the previous step in the **Client Name** field. 1. In the **One or More API Scopes** field, add the following scopes: @@ -96,7 +96,7 @@ Using the Unique ID of the service account key, register it as an Oauth Client u # Configuring Google OAuth in Rancher -1. Sign into Rancher using a local user assigned the [administrator]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions) role. This user is also called the local principal. +1. Sign into Rancher using a local user assigned the [administrator](../../manage-role-based-access-control-rbac/global-permissions.md) role. This user is also called the local principal. 1. In the top left corner, click **☰ > Users & Authentication**. 1. In the left navigation menu, click **Auth Provider**. 1. Click **Google**. The instructions in the UI cover the steps to set up authentication with Google OAuth. diff --git a/docs/en/admin-settings/authentication/keycloak-oidc/keycloak-oidc.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak-oidc.md similarity index 97% rename from docs/en/admin-settings/authentication/keycloak-oidc/keycloak-oidc.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak-oidc.md index aa31c4bdd40..6c96c5d5152 100644 --- a/docs/en/admin-settings/authentication/keycloak-oidc/keycloak-oidc.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak-oidc.md @@ -5,7 +5,7 @@ weight: 1200 --- If your organization uses [Keycloak Identity Provider (IdP)](https://www.keycloak.org) for user authentication, you can configure Rancher to allow your users to log in using their IdP credentials. Rancher supports integration with Keycloak using the OpenID Connect (OIDC) protocol and the SAML protocol. Both implementations are functionally equivalent when used with Rancher. This page describes the process to configure Rancher to work with Keycloak using the OIDC protocol. -If you prefer to use Keycloak with the SAML protocol instead, refer to [this page]({{}}/rancher/v2.6/en/admin-settings/authentication/keycloak-saml/). +If you prefer to use Keycloak with the SAML protocol instead, refer to [this page](configure-keycloak-saml.md). If you have an existing configuration using the SAML protocol and want to switch to the OIDC protocol, refer to [this section](#migrating-from-saml-to-oidc). @@ -126,7 +126,7 @@ After configuration is completed, Rancher user permissions will need to be reapp ## Annex: Troubleshooting -If you are experiencing issues while testing the connection to the Keycloak server, first double-check the configuration options of your OIDC client. You may also inspect the Rancher logs to help pinpoint what's causing issues. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging]({{}}/rancher/v2.6/en/faq/technical/#how-can-i-enable-debug-logging) in this documentation. +If you are experiencing issues while testing the connection to the Keycloak server, first double-check the configuration options of your OIDC client. You may also inspect the Rancher logs to help pinpoint what's causing issues. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging](../../../../../faq/technical-items.md#how-can-i-enable-debug-logging) in this documentation. All Keycloak related log entries will be prepended with either `[generic oidc]` or `[keycloak oidc]`. diff --git a/docs/en/admin-settings/authentication/keycloak-saml/keycloak-saml.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak-saml.md similarity index 96% rename from docs/en/admin-settings/authentication/keycloak-saml/keycloak-saml.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak-saml.md index ff5d24f259d..2283169b6e5 100644 --- a/docs/en/admin-settings/authentication/keycloak-saml/keycloak-saml.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak-saml.md @@ -27,13 +27,13 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati >1: Optionally, you can enable either one or both of these settings. >2: Rancher SAML metadata won't be generated until a SAML provider is configured and saved. - {{< img "/img/rancher/keycloak/keycloak-saml-client-configuration.png" "">}} + ![](/img/keycloak/keycloak-saml-client-configuration.png) - In the new SAML client, create Mappers to expose the users fields - Add all "Builtin Protocol Mappers" - {{< img "/img/rancher/keycloak/keycloak-saml-client-builtin-mappers.png" "">}} + ![](/img/keycloak/keycloak-saml-client-builtin-mappers.png) - Create a new "Group list" mapper to map the member attribute to a user's groups - {{< img "/img/rancher/keycloak/keycloak-saml-client-group-mapper.png" "">}} + ![](/img/keycloak/keycloak-saml-client-group-mapper.png) ## Getting the IDP Metadata @@ -154,7 +154,7 @@ openssl req -x509 -sha256 -nodes -days 365 -newkey rsa:2048 -keyout myservice.ke ## Annex: Troubleshooting -If you are experiencing issues while testing the connection to the Keycloak server, first double-check the configuration option of your SAML client. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging]({{}}/rancher/v2.6/en/faq/technical/#how-can-i-enable-debug-logging) in this documentation. +If you are experiencing issues while testing the connection to the Keycloak server, first double-check the configuration option of your SAML client. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging](../../../../../faq/technical-items.md#how-can-i-enable-debug-logging) in this documentation. ### You are not redirected to Keycloak diff --git a/docs/en/admin-settings/authentication/okta/okta.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-okta-saml.md similarity index 100% rename from docs/en/admin-settings/authentication/okta/okta.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-okta-saml.md diff --git a/docs/en/admin-settings/authentication/ping-federate/ping-federate.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-pingidentity.md similarity index 100% rename from docs/en/admin-settings/authentication/ping-federate/ping-federate.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-pingidentity.md diff --git a/docs/en/admin-settings/authentication/local/local.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/create-local-users.md similarity index 100% rename from docs/en/admin-settings/authentication/local/local.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/create-local-users.md diff --git a/docs/en/admin-settings/authentication/user-groups/user-groups.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/manage-users-and-groups.md similarity index 95% rename from docs/en/admin-settings/authentication/user-groups/user-groups.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/manage-users-and-groups.md index 11ed02f1afb..a98c27e2fce 100644 --- a/docs/en/admin-settings/authentication/user-groups/user-groups.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/manage-users-and-groups.md @@ -5,11 +5,11 @@ weight: 1 Rancher relies on users and groups to determine who is allowed to log in to Rancher and which resources they can access. When you configure an external authentication provider, users from that provider will be able to log in to your Rancher server. When a user logs in, the authentication provider will supply your Rancher server with a list of groups to which the user belongs. -Access to clusters, projects, multi-cluster apps, and global DNS providers and entries can be controlled by adding either individual users or groups to these resources. When you add a group to a resource, all users who are members of that group in the authentication provider, will be able to access the resource with the permissions that you've specified for the group. For more information on roles and permissions, see [Role Based Access Control]({{}}/rancher/v2.6/en/admin-settings/rbac/). +Access to clusters, projects, multi-cluster apps, and global DNS providers and entries can be controlled by adding either individual users or groups to these resources. When you add a group to a resource, all users who are members of that group in the authentication provider, will be able to access the resource with the permissions that you've specified for the group. For more information on roles and permissions, see [Role Based Access Control](../../../../../pages-for-subheaders/manage-role-based-access-control-rbac.md). ## Managing Members -When adding a user or group to a resource, you can search for users or groups by beginning to type their name. The Rancher server will query the authentication provider to find users and groups that match what you've entered. Searching is limited to the authentication provider that you are currently logged in with. For example, if you've enabled GitHub authentication but are logged in using a [local]({{}}/rancher/v2.6/en/admin-settings/authentication/local/) user account, you will not be able to search for GitHub users or groups. +When adding a user or group to a resource, you can search for users or groups by beginning to type their name. The Rancher server will query the authentication provider to find users and groups that match what you've entered. Searching is limited to the authentication provider that you are currently logged in with. For example, if you've enabled GitHub authentication but are logged in using a [local](create-local-users.md) user account, you will not be able to search for GitHub users or groups. All users, whether they are local users or from an authentication provider, can be viewed and managed. In the upper left corner, click **☰ > Users & Authentication**. In the left navigation bar, click **Users**. diff --git a/docs/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/microsoft-adfs-setup.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-ms-adfs-for-rancher.md similarity index 75% rename from docs/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/microsoft-adfs-setup.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-ms-adfs-for-rancher.md index 190ebafee11..9bde44ef331 100644 --- a/docs/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/microsoft-adfs-setup.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-ms-adfs-for-rancher.md @@ -9,57 +9,57 @@ Before configuring Rancher to support AD FS users, you must add Rancher as a [re 1. Open the **AD FS Management** console. Select **Add Relying Party Trust..**. from the **Actions** menu and click **Start**. - {{< img "/img/rancher/adfs/adfs-overview.png" "">}} + ![](/img/adfs/adfs-overview.png) 1. Select **Enter data about the relying party manually** as the option for obtaining data about the relying party. - {{< img "/img/rancher/adfs/adfs-add-rpt-2.png" "">}} + ![](/img/adfs/adfs-add-rpt-2.png) 1. Enter your desired **Display name** for your Relying Party Trust. For example, `Rancher`. - {{< img "/img/rancher/adfs/adfs-add-rpt-3.png" "">}} + ![](/img/adfs/adfs-add-rpt-3.png) 1. Select **AD FS profile** as the configuration profile for your relying party trust. - {{< img "/img/rancher/adfs/adfs-add-rpt-4.png" "">}} + ![](/img/adfs/adfs-add-rpt-4.png) 1. Leave the **optional token encryption certificate** empty, as Rancher AD FS will not be using one. - {{< img "/img/rancher/adfs/adfs-add-rpt-5.png" "">}} + ![](/img/adfs/adfs-add-rpt-5.png) 1. Select **Enable support for the SAML 2.0 WebSSO protocol** and enter `https:///v1-saml/adfs/saml/acs` for the service URL. - {{< img "/img/rancher/adfs/adfs-add-rpt-6.png" "">}} + ![](/img/adfs/adfs-add-rpt-6.png) 1. Add `https:///v1-saml/adfs/saml/metadata` as the **Relying party trust identifier**. - {{< img "/img/rancher/adfs/adfs-add-rpt-7.png" "">}} + ![](/img/adfs/adfs-add-rpt-7.png) 1. This tutorial will not cover multi-factor authentication; please refer to the [Microsoft documentation](https://docs.microsoft.com/en-us/windows-server/identity/ad-fs/operations/configure-additional-authentication-methods-for-ad-fs) if you would like to configure multi-factor authentication. - {{< img "/img/rancher/adfs/adfs-add-rpt-8.png" "">}} + ![](/img/adfs/adfs-add-rpt-8.png) 1. From **Choose Issuance Authorization RUles**, you may select either of the options available according to use case. However, for the purposes of this guide, select **Permit all users to access this relying party**. - {{< img "/img/rancher/adfs/adfs-add-rpt-9.png" "">}} + ![](/img/adfs/adfs-add-rpt-9.png) 1. After reviewing your settings, select **Next** to add the relying party trust. - {{< img "/img/rancher/adfs/adfs-add-rpt-10.png" "">}} + ![](/img/adfs/adfs-add-rpt-10.png) 1. Select **Open the Edit Claim Rules..**. and click **Close**. - {{< img "/img/rancher/adfs/adfs-add-rpt-11.png" "">}} + ![](/img/adfs/adfs-add-rpt-11.png) 1. On the **Issuance Transform Rules** tab, click **Add Rule..**.. - {{< img "/img/rancher/adfs/adfs-edit-cr.png" "">}} + ![](/img/adfs/adfs-edit-cr.png) 1. Select **Send LDAP Attributes as Claims** as the **Claim rule template**. - {{< img "/img/rancher/adfs/adfs-add-tcr-1.png" "">}} + ![](/img/adfs/adfs-add-tcr-1.png) 1. Set the **Claim rule name** to your desired name (for example, `Rancher Attributes`) and select **Active Directory** as the **Attribute store**. Create the following mapping to reflect the table below: @@ -70,7 +70,7 @@ Before configuring Rancher to support AD FS users, you must add Rancher as a [re | Token-Groups - Qualified by Long Domain Name | Group | | SAM-Account-Name | Name |
- {{< img "/img/rancher/adfs/adfs-add-tcr-2.png" "">}} + ![](/img/adfs/adfs-add-tcr-2.png) 1. Download the `federationmetadata.xml` from your AD server at: ``` @@ -79,4 +79,4 @@ https:///federationmetadata/2007-06/federationmetadata.xml **Result:** You've added Rancher as a relying trust party. Now you can configure Rancher to leverage AD. -### [Next: Configuring Rancher for Microsoft AD FS]({{}}/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/) +### [Next: Configuring Rancher for Microsoft AD FS](configure-rancher-for-ms-adfs.md) diff --git a/docs/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/rancher-adfs-setup.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-rancher-for-ms-adfs.md similarity index 94% rename from docs/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/rancher-adfs-setup.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-rancher-for-ms-adfs.md index 1ed5ae53f32..313b6b842b4 100644 --- a/docs/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/rancher-adfs-setup.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-rancher-for-ms-adfs.md @@ -3,7 +3,7 @@ title: 2. Configuring Rancher for Microsoft AD FS weight: 1205 --- -After you complete [Configuring Microsoft AD FS for Rancher]({{}}/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/), enter your AD FS information into Rancher to allow AD FS users to authenticate with Rancher. +After you complete [Configuring Microsoft AD FS for Rancher](configure-ms-adfs-for-rancher.md), enter your AD FS information into Rancher to allow AD FS users to authenticate with Rancher. :::note Important Notes For Configuring Your ADFS Server: diff --git a/docs/en/admin-settings/authentication/shibboleth/about/about.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-shibboleth-saml/about-group-permissions.md similarity index 95% rename from docs/en/admin-settings/authentication/shibboleth/about/about.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-shibboleth-saml/about-group-permissions.md index fc8797e82ef..746cb06ae73 100644 --- a/docs/en/admin-settings/authentication/shibboleth/about/about.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-shibboleth-saml/about-group-permissions.md @@ -28,5 +28,5 @@ When a member of the OpenLDAP group logs in to Rancher, she is redirected to Shi Shibboleth validates her credentials, and retrieves user attributes from OpenLDAP, including groups. Then Shibboleth sends a SAML assertion to Rancher including the user attributes. Rancher uses the group data so that she can access all of the resources and permissions that her groups have permissions for. -![Adding OpenLDAP Group Permissions to Rancher Resources]({{}}/img/rancher/shibboleth-with-openldap-groups.svg) +![Adding OpenLDAP Group Permissions to Rancher Resources](/img/shibboleth-with-openldap-groups.svg) \ No newline at end of file diff --git a/docs/en/admin-settings/drivers/cluster-drivers/cluster-drivers.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md similarity index 66% rename from docs/en/admin-settings/drivers/cluster-drivers/cluster-drivers.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md index a5ef92605a5..7803f1f6b8a 100644 --- a/docs/en/admin-settings/drivers/cluster-drivers/cluster-drivers.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md @@ -3,7 +3,7 @@ title: Cluster Drivers weight: 1 --- -Cluster drivers are used to create clusters in a [hosted Kubernetes provider]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/), such as Google GKE. The availability of which cluster driver to display when creating clusters is defined by the cluster driver's status. Only `active` cluster drivers will be displayed as an option for creating clusters. By default, Rancher is packaged with several existing cloud provider cluster drivers, but you can also add custom cluster drivers to Rancher. +Cluster drivers are used to create clusters in a [hosted Kubernetes provider](../../../../pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers.md), such as Google GKE. The availability of which cluster driver to display when creating clusters is defined by the cluster driver's status. Only `active` cluster drivers will be displayed as an option for creating clusters. By default, Rancher is packaged with several existing cloud provider cluster drivers, but you can also add custom cluster drivers to Rancher. If there are specific cluster drivers that you do not want to show your users, you may deactivate those cluster drivers within Rancher and they will not appear as an option for cluster creation. @@ -13,8 +13,8 @@ If there are specific cluster drivers that you do not want to show your users, y To create, edit, or delete cluster drivers, you need _one_ of the following permissions: -- [Administrator Global Permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) -- [Custom Global Permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/#custom-global-permissions) with the [Manage Cluster Drivers]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) role assigned. +- [Administrator Global Permissions](../manage-role-based-access-control-rbac/global-permissions.md) +- [Custom Global Permissions](../manage-role-based-access-control-rbac/global-permissions.md#custom-global-permissions) with the [Manage Cluster Drivers](../manage-role-based-access-control-rbac/global-permissions.md) role assigned. ::: diff --git a/docs/en/admin-settings/drivers/node-drivers/node-drivers.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers.md similarity index 84% rename from docs/en/admin-settings/drivers/node-drivers/node-drivers.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers.md index 05a19659436..71e2af898b3 100644 --- a/docs/en/admin-settings/drivers/node-drivers/node-drivers.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers.md @@ -13,8 +13,8 @@ If there are specific node drivers that you don't want to show to your users, yo To create, edit, or delete drivers, you need _one_ of the following permissions: -- [Administrator Global Permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) -- [Custom Global Permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/#custom-global-permissions) with the [Manage Node Drivers]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) role assigned. +- [Administrator Global Permissions](../manage-role-based-access-control-rbac/global-permissions.md) +- [Custom Global Permissions](../manage-role-based-access-control-rbac/global-permissions.md#custom-global-permissions) with the [Manage Node Drivers](../manage-role-based-access-control-rbac/global-permissions.md) role assigned. ::: diff --git a/docs/en/admin-settings/rke-templates/template-access-and-sharing/template-access-and-sharing.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/access-or-share-templates.md similarity index 97% rename from docs/en/admin-settings/rke-templates/template-access-and-sharing/template-access-and-sharing.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/access-or-share-templates.md index 8784d5cfcd3..2d0f8d92ca3 100644 --- a/docs/en/admin-settings/rke-templates/template-access-and-sharing/template-access-and-sharing.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/access-or-share-templates.md @@ -14,7 +14,7 @@ When you share a template, each user can have one of two access levels: If you create a template, you automatically become an owner of that template. -If you want to delegate responsibility for updating the template, you can share ownership of the template. For details on how owners can modify templates, refer to the [documentation about revising templates.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising) +If you want to delegate responsibility for updating the template, you can share ownership of the template. For details on how owners can modify templates, refer to the [documentation about revising templates.](manage-rke1-templates.md) There are several ways to share templates: diff --git a/docs/en/admin-settings/rke-templates/applying-templates/applying-templates.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/apply-templates.md similarity index 79% rename from docs/en/admin-settings/rke-templates/applying-templates/applying-templates.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/apply-templates.md index 5bac40a1b3b..ff81feee708 100644 --- a/docs/en/admin-settings/rke-templates/applying-templates/applying-templates.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/apply-templates.md @@ -3,7 +3,7 @@ title: Applying Templates weight: 50 --- -You can create a cluster from an RKE template that you created, or from a template that has been [shared with you.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing) +You can create a cluster from an RKE template that you created, or from a template that has been [shared with you.](access-or-share-templates.md) RKE templates can be applied to new clusters. @@ -19,7 +19,7 @@ This section covers the following topics: ### Creating a Cluster from an RKE Template -To add a cluster [hosted by an infrastructure provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters) using an RKE template, use these steps: +To add a cluster [hosted by an infrastructure provider](../../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) using an RKE template, use these steps: 1. In the upper left corner, click **☰ > Cluster Management**. 1. On the **Clusters** page, click **Create** and choose the infrastructure provider. @@ -33,7 +33,7 @@ To add a cluster [hosted by an infrastructure provider]({{}}/rancher/v2 When the template owner creates a template, each setting has a switch in the Rancher UI that indicates if users can override the setting. -- If the setting allows a user override, you can update these settings in the cluster by [editing the cluster.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/) +- If the setting allows a user override, you can update these settings in the cluster by [editing the cluster.](../../../../pages-for-subheaders/cluster-configuration.md) - If the switch is turned off, you cannot change these settings unless the cluster owner creates a template revision that lets you override them. If there are settings that you want to change, but don't have the option to, you will need to contact the template owner to get a new revision of the template. If a cluster was created from an RKE template, you can edit the cluster to update the cluster to a new revision of the template. @@ -50,7 +50,7 @@ You can't change the cluster to use a different RKE template. You can only updat This section describes how to create an RKE template from an existing cluster. -RKE templates cannot be applied to existing clusters, except if you save an existing cluster's settings as an RKE template. This exports the cluster's settings as a new RKE template, and also binds the cluster to that template. The result is that the cluster can only be changed if the [template is updated,]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#updating-a-template) and the cluster is upgraded to [use a newer version of the template.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#upgrading-a-cluster-to-use-a-new-template-revision) +RKE templates cannot be applied to existing clusters, except if you save an existing cluster's settings as an RKE template. This exports the cluster's settings as a new RKE template, and also binds the cluster to that template. The result is that the cluster can only be changed if the [template is updated,](manage-rke1-templates.md#updating-a-template) and the cluster is upgraded to [use a newer version of the template.](manage-rke1-templates.md#upgrading-a-cluster-to-use-a-new-template-revision) To convert an existing cluster to use an RKE template, @@ -62,4 +62,4 @@ To convert an existing cluster to use an RKE template, - A new RKE template is created. - The cluster is converted to use the new template. -- New clusters can be [created from the new template.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#creating-a-cluster-from-an-rke-template) \ No newline at end of file +- New clusters can be [created from the new template.](apply-templates.md#creating-a-cluster-from-an-rke-template) \ No newline at end of file diff --git a/docs/en/admin-settings/rke-templates/creator-permissions/creator-permissions.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/creator-permissions.md similarity index 93% rename from docs/en/admin-settings/rke-templates/creator-permissions/creator-permissions.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/creator-permissions.md index b3dba5b43b0..8326c06c401 100644 --- a/docs/en/admin-settings/rke-templates/creator-permissions/creator-permissions.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/creator-permissions.md @@ -5,7 +5,7 @@ weight: 10 Administrators have the permission to create RKE templates, and only administrators can give that permission to other users. -For more information on administrator permissions, refer to the [documentation on global permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/). +For more information on administrator permissions, refer to the [documentation on global permissions](../manage-role-based-access-control-rbac/global-permissions.md). # Giving Users Permission to Create Templates @@ -13,7 +13,7 @@ Templates can only be created by users who have the global permission **Create R Administrators have the global permission to create templates, and only administrators can give that permission to other users. -For information on allowing users to modify existing templates, refer to [Sharing Templates.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing) +For information on allowing users to modify existing templates, refer to [Sharing Templates.](access-or-share-templates.md) Administrators can give users permission to create RKE templates in two ways: diff --git a/docs/en/admin-settings/rke-templates/enforcement/enforcement.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/enforce-templates.md similarity index 69% rename from docs/en/admin-settings/rke-templates/enforcement/enforcement.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/enforce-templates.md index d012fb51fab..c4b1d9e7e95 100644 --- a/docs/en/admin-settings/rke-templates/enforcement/enforcement.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/enforce-templates.md @@ -11,13 +11,13 @@ By default, any standard user in Rancher can create clusters. But when RKE templ - All standard users must use an RKE template to create a new cluster. - Standard users cannot create a cluster without using a template. -Users can only create new templates if the administrator [gives them permission.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creator-permissions/#allowing-a-user-to-create-templates) +Users can only create new templates if the administrator [gives them permission.](creator-permissions.md#allowing-a-user-to-create-templates) -After a cluster is created with an RKE template, the cluster creator cannot edit settings that are defined in the template. The only way to change those settings after the cluster is created is to [upgrade the cluster to a new revision]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#updating-a-cluster-created-with-an-rke-template) of the same template. If cluster creators want to change template-defined settings, they would need to contact the template owner to get a new revision of the template. For details on how template revisions work, refer to the [documentation on revising templates.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#updating-a-template) +After a cluster is created with an RKE template, the cluster creator cannot edit settings that are defined in the template. The only way to change those settings after the cluster is created is to [upgrade the cluster to a new revision](apply-templates.md#updating-a-cluster-created-with-an-rke-template) of the same template. If cluster creators want to change template-defined settings, they would need to contact the template owner to get a new revision of the template. For details on how template revisions work, refer to the [documentation on revising templates.](manage-rke1-templates.md#updating-a-template) # Requiring New Clusters to Use an RKE Template -You might want to require new clusters to use a template to ensure that any cluster launched by a [standard user]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) will use the Kubernetes and/or Rancher settings that are vetted by administrators. +You might want to require new clusters to use a template to ensure that any cluster launched by a [standard user](../manage-role-based-access-control-rbac/global-permissions.md) will use the Kubernetes and/or Rancher settings that are vetted by administrators. To require new clusters to use an RKE template, administrators can turn on RKE template enforcement with the following steps: diff --git a/docs/en/admin-settings/rke-templates/example-scenarios/example-scenarios.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/example-use-cases.md similarity index 74% rename from docs/en/admin-settings/rke-templates/example-scenarios/example-scenarios.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/example-use-cases.md index 66631990aea..bf7bf15bec1 100644 --- a/docs/en/admin-settings/rke-templates/example-scenarios/example-scenarios.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/example-use-cases.md @@ -22,7 +22,7 @@ Let's say there is an organization in which the administrators decide that all n **Results:** - All Rancher users in the organization have access to the template. -- All new clusters created by [standard users]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) with this template will use Kubernetes 1.14 and they are unable to use a different Kubernetes version. By default, standard users don't have permission to create templates, so this template will be the only template they can use unless more templates are shared with them. +- All new clusters created by [standard users](../manage-role-based-access-control-rbac/global-permissions.md) with this template will use Kubernetes 1.14 and they are unable to use a different Kubernetes version. By default, standard users don't have permission to create templates, so this template will be the only template they can use unless more templates are shared with them. - All standard users must use a cluster template to create a new cluster. They cannot create a cluster without using a template. In this way, the administrators enforce the Kubernetes version across the organization, while still allowing end users to configure everything else. @@ -31,7 +31,7 @@ In this way, the administrators enforce the Kubernetes version across the organi Let's say an organization has both basic and advanced users. Administrators want the basic users to be required to use a template, while the advanced users and administrators create their clusters however they want. -1. First, an administrator turns on [RKE template enforcement.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/enforcement/#requiring-new-clusters-to-use-an-rke-template) This means that every [standard user]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) in Rancher will need to use an RKE template when they create a cluster. +1. First, an administrator turns on [RKE template enforcement.](enforce-templates.md#requiring-new-clusters-to-use-an-rke-template) This means that every [standard user](../manage-role-based-access-control-rbac/global-permissions.md) in Rancher will need to use an RKE template when they create a cluster. 1. The administrator then creates two templates: - One template for basic users, with almost every option specified except for access keys @@ -60,12 +60,12 @@ Let's say Alice is a Rancher administrator. She owns an RKE template that reflec Bob is an advanced user who can make informed decisions about cluster configuration. Alice trusts Bob to create new revisions of her template as the best practices get updated over time. Therefore, she decides to make Bob an owner of the template. -To share ownership of the template with Bob, Alice [adds Bob as an owner of her template.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing/#sharing-ownership-of-templates) +To share ownership of the template with Bob, Alice [adds Bob as an owner of her template.](access-or-share-templates.md#sharing-ownership-of-templates) The result is that as a template owner, Bob is in charge of version control for that template. Bob can now do all of the following: -- [Revise the template]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#updating-a-template) when the best practices change -- [Disable outdated revisions]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#disabling-a-template-revision) of the template so that no new clusters can be created with it -- [Delete the whole template]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#deleting-a-template) if the organization wants to go in a different direction -- [Set a certain revision as default]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#setting-a-template-revision-as-default) when users create a cluster with it. End users of the template will still be able to choose which revision they want to create the cluster with. -- [Share the template]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing) with specific users, make the template available to all Rancher users, or share ownership of the template with another user. \ No newline at end of file +- [Revise the template](manage-rke1-templates.md#updating-a-template) when the best practices change +- [Disable outdated revisions](manage-rke1-templates.md#disabling-a-template-revision) of the template so that no new clusters can be created with it +- [Delete the whole template](manage-rke1-templates.md#deleting-a-template) if the organization wants to go in a different direction +- [Set a certain revision as default](manage-rke1-templates.md#setting-a-template-revision-as-default) when users create a cluster with it. End users of the template will still be able to choose which revision they want to create the cluster with. +- [Share the template](access-or-share-templates.md) with specific users, make the template available to all Rancher users, or share ownership of the template with another user. \ No newline at end of file diff --git a/docs/en/admin-settings/rke-templates/rke-templates-and-hardware/rke-templates-and-hardware.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/infrastructure.md similarity index 90% rename from docs/en/admin-settings/rke-templates/rke-templates-and-hardware/rke-templates-and-hardware.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/infrastructure.md index 8e10bf7ea38..38524924ff6 100644 --- a/docs/en/admin-settings/rke-templates/rke-templates-and-hardware/rke-templates-and-hardware.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/infrastructure.md @@ -11,7 +11,7 @@ If you want to standardize the hardware in your clusters, use RKE templates conj ### Node Templates -[Node templates]({{}}/rancher/v2.6/en/user-settings/node-templates) are responsible for node configuration and node provisioning in Rancher. From your user profile, you can set up node templates to define which templates are used in each of your node pools. With node pools enabled, you can make sure you have the required number of nodes in each node pool, and ensure that all nodes in the pool are the same. +[Node templates](../../../../reference-guides/user-settings/manage-node-templates.md) are responsible for node configuration and node provisioning in Rancher. From your user profile, you can set up node templates to define which templates are used in each of your node pools. With node pools enabled, you can make sure you have the required number of nodes in each node pool, and ensure that all nodes in the pool are the same. ### Terraform @@ -55,7 +55,7 @@ When you need to make changes to your infrastructure, instead of manually updati This section describes one way that you can make security and compliance-related config files standard in your clusters. -When you create a [CIS benchmark compliant cluster,]({{}}/rancher/v2.6/en/security/) you have an encryption config file and an audit log config file. +When you create a [CIS benchmark compliant cluster,](../../../../pages-for-subheaders/rancher-security.md) you have an encryption config file and an audit log config file. Your infrastructure provisioning system can write those files to disk. Then in your RKE template, you would specify where those files will be, then add your encryption config file and audit log config file as extra mounts to the `kube-api-server`. diff --git a/docs/en/admin-settings/rke-templates/creating-and-revising/creating-and-revising.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/manage-rke1-templates.md similarity index 88% rename from docs/en/admin-settings/rke-templates/creating-and-revising/creating-and-revising.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/manage-rke1-templates.md index 99afcaa0a58..33e05445657 100644 --- a/docs/en/admin-settings/rke-templates/creating-and-revising/creating-and-revising.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/manage-rke1-templates.md @@ -28,9 +28,9 @@ This section covers the following topics: ### Prerequisites -You can create RKE templates if you have the **Create RKE Templates** permission, which can be [given by an administrator.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creator-permissions) +You can create RKE templates if you have the **Create RKE Templates** permission, which can be [given by an administrator.](creator-permissions.md) -You can revise, share, and delete a template if you are an owner of the template. For details on how to become an owner of a template, refer to [the documentation on sharing template ownership.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing/#sharing-ownership-of-templates) +You can revise, share, and delete a template if you are an owner of the template. For details on how to become an owner of a template, refer to [the documentation on sharing template ownership.](access-or-share-templates.md#sharing-ownership-of-templates) ### Creating a Template @@ -38,10 +38,10 @@ You can revise, share, and delete a template if you are an owner of the template 1. Click **RKE1 configuration > Node Templates**. 1. Click **Add Template**. 1. Provide a name for the template. An auto-generated name is already provided for the template' first version, which is created along with this template. -1. Optional: Share the template with other users or groups by [adding them as members.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing/#sharing-templates-with-specific-users-or-groups) You can also make the template public to share with everyone in the Rancher setup. +1. Optional: Share the template with other users or groups by [adding them as members.](access-or-share-templates.md#sharing-templates-with-specific-users-or-groups) You can also make the template public to share with everyone in the Rancher setup. 1. Then follow the form on screen to save the cluster configuration parameters as part of the template's revision. The revision can be marked as default for this template. -**Result:** An RKE template with one revision is configured. You can use this RKE template revision later when you [provision a Rancher-launched cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters). After a cluster is managed by an RKE template, it cannot be disconnected and the option to uncheck **Use an existing RKE Template and Revision** will be unavailable. +**Result:** An RKE template with one revision is configured. You can use this RKE template revision later when you [provision a Rancher-launched cluster](../../../../pages-for-subheaders/launch-kubernetes-with-rancher.md). After a cluster is managed by an RKE template, it cannot be disconnected and the option to uncheck **Use an existing RKE Template and Revision** will be unavailable. ### Updating a Template @@ -142,7 +142,7 @@ To permanently delete a revision, :::note -This section assumes that you already have a cluster that [has an RKE template applied.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates) +This section assumes that you already have a cluster that [has an RKE template applied.](apply-templates.md) This section also assumes that you have [updated the template that the cluster is using](#updating-a-template) so that a new template revision is available. @@ -161,7 +161,7 @@ To upgrade a cluster to use a new template revision, You can save an existing cluster's settings as an RKE template. -This exports the cluster's settings as a new RKE template, and also binds the cluster to that template. The result is that the cluster can only be changed if the [template is updated,]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#updating-a-template) and the cluster is upgraded to [use a newer version of the template.] +This exports the cluster's settings as a new RKE template, and also binds the cluster to that template. The result is that the cluster can only be changed if the [template is updated,](manage-rke1-templates.md#updating-a-template) and the cluster is upgraded to [use a newer version of the template.] To convert an existing cluster to use an RKE template, @@ -173,4 +173,4 @@ To convert an existing cluster to use an RKE template, - A new RKE template is created. - The cluster is converted to use the new template. -- New clusters can be [created from the new template and revision.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#creating-a-cluster-from-an-rke-template) \ No newline at end of file +- New clusters can be [created from the new template and revision.](apply-templates.md#creating-a-cluster-from-an-rke-template) \ No newline at end of file diff --git a/docs/en/admin-settings/rke-templates/overrides/overrides.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/override-template-settings.md similarity index 75% rename from docs/en/admin-settings/rke-templates/overrides/overrides.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/override-template-settings.md index bce495f617d..3efe34d5ea7 100644 --- a/docs/en/admin-settings/rke-templates/overrides/overrides.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/override-template-settings.md @@ -5,7 +5,7 @@ weight: 33 When a user creates an RKE template, each setting in the template has a switch in the Rancher UI that indicates if users can override the setting. This switch marks those settings as **Allow User Override**. -After a cluster is created with a template, end users can't update any of the settings defined in the template unless the template owner marked them as **Allow User Override**. However, if the template is [updated to a new revision]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising) that changes the settings or allows end users to change them, the cluster can be upgraded to a new revision of the template and the changes in the new revision will be applied to the cluster. +After a cluster is created with a template, end users can't update any of the settings defined in the template unless the template owner marked them as **Allow User Override**. However, if the template is [updated to a new revision](manage-rke1-templates.md) that changes the settings or allows end users to change them, the cluster can be upgraded to a new revision of the template and the changes in the new revision will be applied to the cluster. When any parameter is set as **Allow User Override** on the RKE template, it means that end users have to fill out those fields during cluster creation and they can edit those settings afterward at any time. diff --git a/docs/en/admin-settings/pod-security-policies/pod-security-policies.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies.md similarity index 96% rename from docs/en/admin-settings/pod-security-policies/pod-security-policies.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies.md index 9244102623d..043c7686b26 100644 --- a/docs/en/admin-settings/pod-security-policies/pod-security-policies.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies.md @@ -56,9 +56,9 @@ Using Rancher, you can create a Pod Security Policy using our GUI rather than cr ### Requirements -Rancher can only assign PSPs for clusters that are [launched using RKE]({{< baseurl >}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/). +Rancher can only assign PSPs for clusters that are [launched using RKE](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md). -You must enable PSPs at the cluster level before you can assign them to a project. This can be configured by [editing the cluster]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/). +You must enable PSPs at the cluster level before you can assign them to a project. This can be configured by [editing the cluster](../../../pages-for-subheaders/cluster-configuration.md). It is a best practice to set PSP at the cluster level. diff --git a/docs/en/admin-settings/branding/branding.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/custom-branding.md similarity index 99% rename from docs/en/admin-settings/branding/branding.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/custom-branding.md index 66ddb1ad3c5..32b4d89e6cd 100644 --- a/docs/en/admin-settings/branding/branding.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/custom-branding.md @@ -115,7 +115,7 @@ Optional. If not provided, the link appears standalone. Groups are displayed separately from standalone links, as shown below: -![Screenshot of group and standalone link]({{}}/img/rancher/grouped-vs-standalone-links.png) +![Screenshot of group and standalone link](/img/grouped-vs-standalone-links.png) ### `iconSrc` @@ -185,7 +185,7 @@ spec: Adding the above YAML results in a link to Grafana being created, as shown in the following screenshot: -![Screenshot of Grafana Link]({{< baseurl >}}/img/rancher/example-grafana-link.png) +![Screenshot of Grafana Link](/img/example-grafana-link.png) ### Example of Link with `toService` @@ -217,5 +217,5 @@ spec: Adding the `toService` parameters above results in a link to Grafana being created, as shown in the following screenshot: -![Screenshot of Grafana Link]({{< baseurl >}}/img/rancher/example-service-link.png) +![Screenshot of Grafana Link](/img/example-service-link.png) diff --git a/docs/en/admin-settings/config-private-registry/config-private-registry.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry.md similarity index 96% rename from docs/en/admin-settings/config-private-registry/config-private-registry.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry.md index bdac208ef0d..c1baf083b3f 100644 --- a/docs/en/admin-settings/config-private-registry/config-private-registry.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry.md @@ -9,7 +9,7 @@ There are two main ways to set up private registries in Rancher: by setting up t This section is about configuring the global default private registry, and focuses on how to configure the registry from the Rancher UI after Rancher is installed. -For instructions on setting up a private registry with command line options during the installation of Rancher, refer to the [air-gapped installation guide]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap). +For instructions on setting up a private registry with command line options during the installation of Rancher, refer to the [air-gapped installation guide](../../../pages-for-subheaders/air-gapped-helm-cli-install.md). If your private registry requires credentials, it cannot be used as the default registry. There is no global way to set up a private registry with authorization for every Rancher-provisioned cluster. Therefore, if you want a Rancher-provisioned cluster to pull images from a private registry with credentials, you will have to [pass in the registry credentials through the advanced cluster options](#setting-a-private-registry-with-credentials-when-deploying-a-cluster) every time you create a new cluster. diff --git a/docs/en/admin-settings/cluster-templates/cluster-templates.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-cluster-templates.md similarity index 100% rename from docs/en/admin-settings/cluster-templates/cluster-templates.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-cluster-templates.md diff --git a/docs/en/admin-settings/rbac/cluster-project-roles/cluster-project-roles.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md similarity index 95% rename from docs/en/admin-settings/rbac/cluster-project-roles/cluster-project-roles.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md index 71cafe71b8c..55908e358ae 100644 --- a/docs/en/admin-settings/rbac/cluster-project-roles/cluster-project-roles.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md @@ -85,7 +85,7 @@ When viewing the resources associated with default roles created by Rancher, if ### Giving a Custom Cluster Role to a Cluster Member -After an administrator [sets up a custom cluster role,]({{}}/rancher/v2.6/en/admin-settings/rbac/default-custom-roles/) cluster owners and admins can then assign those roles to cluster members. +After an administrator [sets up a custom cluster role,](custom-roles.md) cluster owners and admins can then assign those roles to cluster members. To assign a custom role to a new cluster member, you can use the Rancher UI. To modify the permissions of an existing member, you will need to use the Rancher API view. @@ -202,7 +202,7 @@ By default, when a standard user creates a new cluster or project, they are auto There are two methods for changing default cluster/project roles: -- **Assign Custom Roles**: Create a [custom role]({{}}/rancher/v2.6/en/admin-settings/rbac/default-custom-roles) for either your [cluster](#custom-cluster-roles) or [project](#custom-project-roles), and then set the custom role as default. +- **Assign Custom Roles**: Create a [custom role](custom-roles.md) for either your [cluster](#custom-cluster-roles) or [project](#custom-project-roles), and then set the custom role as default. - **Assign Individual Roles**: Configure multiple [cluster](#cluster-role-reference)/[project](#project-role-reference) roles as default for assignment to the creating user. @@ -210,7 +210,7 @@ There are two methods for changing default cluster/project roles: :::note -- Although you can [lock]({{}}/rancher/v2.6/en/admin-settings/rbac/locked-roles/) a default role, the system still assigns the role to users who create a cluster/project. +- Although you can [lock](locked-roles.md) a default role, the system still assigns the role to users who create a cluster/project. - Only users that create clusters/projects inherit their roles. Users added to the cluster/project membership afterward must be explicitly assigned their roles. ::: diff --git a/docs/en/admin-settings/rbac/default-custom-roles/default-custom-roles.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/custom-roles.md similarity index 92% rename from docs/en/admin-settings/rbac/default-custom-roles/default-custom-roles.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/custom-roles.md index 8326fc3a3fd..414cfea5707 100644 --- a/docs/en/admin-settings/rbac/default-custom-roles/default-custom-roles.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/custom-roles.md @@ -26,8 +26,8 @@ This section covers the following topics: To complete the tasks on this page, one of the following permissions are required: - - [Administrator Global Permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/). - - [Custom Global Permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/#custom-global-permissions) with the [Manage Roles]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) role assigned. + - [Administrator Global Permissions](global-permissions.md). + - [Custom Global Permissions](global-permissions.md#custom-global-permissions) with the [Manage Roles](global-permissions.md) role assigned. # Creating A Custom Role @@ -107,8 +107,8 @@ If a user is removed from the external authentication provider group, they would You can only assign a global role to a group if: -* You have set up an [external authentication provider]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-vs-local-authentication) -* The external authentication provider supports [user groups]({{}}/rancher/v2.6/en/admin-settings/authentication/user-groups/) +* You have set up an [external authentication provider](../../../../pages-for-subheaders/about-authentication.md#external-vs-local-authentication) +* The external authentication provider supports [user groups](../about-authentication/authentication-config/manage-users-and-groups.md) * You have already set up at least one user group with the authentication provider ::: diff --git a/docs/en/admin-settings/rbac/global-permissions/global-permissions.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md similarity index 95% rename from docs/en/admin-settings/rbac/global-permissions/global-permissions.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md index 865e1d3af55..ccbaa2ebc4b 100644 --- a/docs/en/admin-settings/rbac/global-permissions/global-permissions.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md @@ -140,7 +140,7 @@ You can [assign a role to everyone in the group at the same time](#configuring-g Using custom permissions is convenient for providing users with narrow or specialized access to Rancher. -When a user from an [external authentication source]({{}}/rancher/v2.6/en/admin-settings/authentication/) 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. +When a user from an [external authentication source](../../../../pages-for-subheaders/about-authentication.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. @@ -231,8 +231,8 @@ If a user is removed from the external authentication provider group, they would You can only assign a global role to a group if: -* You have set up an [external authentication provider]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-vs-local-authentication) -* The external authentication provider supports [user groups]({{}}/rancher/v2.6/en/admin-settings/authentication/user-groups/) +* You have set up an [external authentication provider](../../../../pages-for-subheaders/about-authentication.md#external-vs-local-authentication) +* The external authentication provider supports [user groups](../about-authentication/authentication-config/manage-users-and-groups.md) * You have already set up at least one user group with the authentication provider ::: diff --git a/docs/en/admin-settings/rbac/locked-roles/locked-roles.md b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/locked-roles.md similarity index 94% rename from docs/en/admin-settings/rbac/locked-roles/locked-roles.md rename to docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/locked-roles.md index 8964fee2000..e91770b429a 100644 --- a/docs/en/admin-settings/rbac/locked-roles/locked-roles.md +++ b/docs/en/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/locked-roles.md @@ -27,7 +27,7 @@ If you want to prevent a role from being assigned to users, you can set it to a You can lock roles in two contexts: -- When you're [adding a custom role]({{}}/rancher/v2.6/en/admin-settings/rbac/default-custom-roles/). +- When you're [adding a custom role](custom-roles.md). - When you editing an existing role (see below). Cluster roles and project/namespace roles can be locked, but global roles cannot. diff --git a/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/configure-alerts-for-periodic-scan-on-a-schedule.md b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/configure-alerts-for-periodic-scan-on-a-schedule.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/configure-alerts-for-periodic-scan-on-a-schedule.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/create-a-custom-benchmark-version-to-run.md b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/create-a-custom-benchmark-version-to-run.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/create-a-custom-benchmark-version-to-run.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/enable-alerting-for-rancher-cis-benchmark.md b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/enable-alerting-for-rancher-cis-benchmark.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/enable-alerting-for-rancher-cis-benchmark.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/install-rancher-cis-benchmark.md b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/install-rancher-cis-benchmark.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/install-rancher-cis-benchmark.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan-periodically-on-a-schedule.md b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan-periodically-on-a-schedule.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan-periodically-on-a-schedule.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan.md b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/skip-tests.md b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/skip-tests.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/skip-tests.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/uninstall-rancher-cis-benchmark.md b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/uninstall-rancher-cis-benchmark.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/uninstall-rancher-cis-benchmark.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/view-reports.md b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/view-reports.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/how-to-guides/advanced-user-guides/cis-scan-guides/view-reports.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/istio/setup/enable-istio-in-cluster/enable-istio-in-cluster.md b/docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md similarity index 60% rename from docs/en/istio/setup/enable-istio-in-cluster/enable-istio-in-cluster.md rename to docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md index 8d2771b4418..9c438d9b2b2 100644 --- a/docs/en/istio/setup/enable-istio-in-cluster/enable-istio-in-cluster.md +++ b/docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md @@ -6,9 +6,9 @@ weight: 1 :::note Prerequisites: - Only a user with the `cluster-admin` [Kubernetes default role](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles) assigned can configure and install Istio in a Kubernetes cluster. -- If you have pod security policies, you will need to install Istio with the CNI enabled. For details, see [this section.]({{}}/rancher/v2.6/en/istio/configuration-reference/enable-istio-with-psp) -- To install Istio on an RKE2 cluster, additional steps are required. For details, see [this section.]({{}}/rancher/v2.6/en/istio/configuration-reference/rke2/) -- To install Istio in a cluster where project network isolation is enabled, additional steps are required. For details, see [this section.]({{}}/rancher/v2.6/en/istio/configuration-reference/canal-and-project-network) +- If you have pod security policies, you will need to install Istio with the CNI enabled. For details, see [this section.](../../../explanations/integrations-in-rancher/istio/configuration-options/pod-security-policies.md) +- To install Istio on an RKE2 cluster, additional steps are required. For details, see [this section.](../../../explanations/integrations-in-rancher/istio/configuration-options/install-istio-on-rke2-cluster.md) +- To install Istio in a cluster where project network isolation is enabled, additional steps are required. For details, see [this section.](../../../explanations/integrations-in-rancher/istio/configuration-options/project-network-isolation.md) ::: @@ -18,13 +18,13 @@ weight: 1 1. Click **Charts**. 1. Click **Istio**. 1. If you have not already installed your own monitoring app, you will be prompted to install the rancher-monitoring app. Optional: Set your Selector or Scrape config options on rancher-monitoring app install. -1. Optional: Configure member access and [resource limits]({{}}/rancher/v2.6/en/istio/resources/) for the Istio components. Ensure you have enough resources on your worker nodes to enable Istio. +1. Optional: Configure member access and [resource limits](../../../explanations/integrations-in-rancher/istio/cpu-and-memory-allocations.md) for the Istio components. Ensure you have enough resources on your worker nodes to enable Istio. 1. Optional: Make additional configuration changes to values.yaml if needed. -1. Optional: Add additional resources or configuration via the [overlay file.]({{}}/rancher/v2.6/en/istio/configuration-reference/#overlay-file) +1. Optional: Add additional resources or configuration via the [overlay file.](../../../pages-for-subheaders/configuration-options.md#overlay-file) 1. Click **Install**. **Result:** Istio is installed at the cluster level. # Additional Config Options -For more information on configuring Istio, refer to the [configuration reference.]({{}}/rancher/v2.6/en/istio/configuration-reference) +For more information on configuring Istio, refer to the [configuration reference.](../../../pages-for-subheaders/configuration-options.md) diff --git a/docs/en/istio/setup/enable-istio-in-namespace/enable-istio-in-namespace.md b/docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md similarity index 95% rename from docs/en/istio/setup/enable-istio-in-namespace/enable-istio-in-namespace.md rename to docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md index 4ebf10ad23b..ed6c93471b1 100644 --- a/docs/en/istio/setup/enable-istio-in-namespace/enable-istio-in-namespace.md +++ b/docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md @@ -50,4 +50,4 @@ If you are having issues with a Job you deployed not completing, you will need t ::: -### [Next: Add Deployments with the Istio Sidecar ]({{}}/rancher/v2.6/en/istio/setup/deploy-workloads) \ No newline at end of file +### [Next: Add Deployments with the Istio Sidecar ](use-istio-sidecar.md) \ No newline at end of file diff --git a/docs/en/istio/setup/view-traffic/view-traffic.md b/docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md similarity index 89% rename from docs/en/istio/setup/view-traffic/view-traffic.md rename to docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md index 620e3ef9644..da00a48ea04 100644 --- a/docs/en/istio/setup/view-traffic/view-traffic.md +++ b/docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md @@ -11,7 +11,7 @@ The Istio overview page provides a link to the Kiali dashboard. From the Kiali d :::note Prerequisites: -To enable traffic to show up in the graph, ensure you have prometheus installed in the cluster. Rancher-istio installs Kiali configured by default to work with the rancher-monitoring chart. You can use rancher-monitoring or install your own monitoring solution. Optional: you can change configuration on how data scraping occurs by setting the [Selectors & Scrape Configs]({{}}/rancher/v2.6/en/istio/configuration-reference/selectors-and-scrape) options. +To enable traffic to show up in the graph, ensure you have prometheus installed in the cluster. Rancher-istio installs Kiali configured by default to work with the rancher-monitoring chart. You can use rancher-monitoring or install your own monitoring solution. Optional: you can change configuration on how data scraping occurs by setting the [Selectors & Scrape Configs](../../../explanations/integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations.md) options. ::: diff --git a/docs/en/istio/setup/gateway/gateway.md b/docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md similarity index 96% rename from docs/en/istio/setup/gateway/gateway.md rename to docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md index 5cd58e34e0e..d80ea26e648 100644 --- a/docs/en/istio/setup/gateway/gateway.md +++ b/docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md @@ -15,7 +15,7 @@ You can route traffic into the service mesh with a load balancer or use Istio's For more information on the Istio gateway, refer to the [Istio documentation.](https://istio.io/docs/reference/config/networking/v1alpha3/gateway/) -![In an Istio-enabled cluster, you can have two Ingresses: the default Nginx Ingress, and the default Istio controller.]({{}}/img/rancher/istio-ingress.svg) +![In an Istio-enabled cluster, you can have two Ingresses: the default Nginx Ingress, and the default Istio controller.](/img/istio-ingress.svg) # Enable an Istio Gateway @@ -144,4 +144,4 @@ In the gateway resource, the selector refers to Istio's default ingress controll 1. Scroll down to the `istio-system` namespace. 1. Within `istio-system`, there is a workload named `istio-ingressgateway`. Click the name of this workload and go to the **Labels and Annotations** section. You should see that it has the key `istio` and the value `ingressgateway`. This confirms that the selector in the Gateway resource matches Istio's default ingress controller. -### [Next: Set up Istio's Components for Traffic Management]({{}}/rancher/v2.6/en/istio/setup/set-up-traffic-management) +### [Next: Set up Istio's Components for Traffic Management](set-up-traffic-management.md) diff --git a/docs/en/istio/setup/set-up-traffic-management/set-up-traffic-management.md b/docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md similarity index 97% rename from docs/en/istio/setup/set-up-traffic-management/set-up-traffic-management.md rename to docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md index a323135e3d5..8b7bd4c233c 100644 --- a/docs/en/istio/setup/set-up-traffic-management/set-up-traffic-management.md +++ b/docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md @@ -73,4 +73,4 @@ spec: **Result:** When you generate traffic to this service (for example, by refreshing the ingress gateway URL), the Kiali traffic graph will reflect that traffic to the `reviews` service is divided evenly between `v1` and `v3`. -### [Next: Generate and View Traffic]({{}}/rancher/v2.6/en/istio/setup/view-traffic) +### [Next: Generate and View Traffic](generate-and-view-traffic.md) diff --git a/docs/en/istio/setup/deploy-workloads/deploy-workloads.md b/docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md similarity index 99% rename from docs/en/istio/setup/deploy-workloads/deploy-workloads.md rename to docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md index c2a7d2fbc5b..9eb7ed930c0 100644 --- a/docs/en/istio/setup/deploy-workloads/deploy-workloads.md +++ b/docs/en/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md @@ -357,4 +357,4 @@ spec: --- ``` -### [Next: Set up the Istio Gateway]({{}}/rancher/v2.6/en/istio/setup/gateway) +### [Next: Set up the Istio Gateway](set-up-istio-gateway.md) diff --git a/docs/en/cluster-admin/cluster-access/cluster-members/cluster-members.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/access-clusters/add-users-to-clusters.md similarity index 63% rename from docs/en/cluster-admin/cluster-access/cluster-members/cluster-members.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/access-clusters/add-users-to-clusters.md index ecc0d45fd02..7b0b69cffb6 100644 --- a/docs/en/cluster-admin/cluster-access/cluster-members/cluster-members.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/access-clusters/add-users-to-clusters.md @@ -7,7 +7,7 @@ If you want to provide a user with access and permissions to _all_ projects, nod :::tip -Want to provide a user with access to a _specific_ project within a cluster? See [Adding Project Members]({{}}/rancher/v2.6/en/cluster-admin/projects-and-namespaces/project-members/) instead. +Want to provide a user with access to a _specific_ project within a cluster? See [Adding Project Members](cluster-admin/projects-and-namespaces/project-members/) instead. ::: @@ -32,11 +32,11 @@ Cluster administrators can edit the membership for a cluster, controlling which If external authentication is configured: - - Rancher returns users from your [external authentication]({{}}/rancher/v2.6/en/admin-settings/authentication/) source as you type. + - Rancher returns users from your [external authentication](../../../../pages-for-subheaders/about-authentication.md) source as you type. :::note Using AD but can't find your users? - There may be an issue with your search attribute configuration. See [Configuring Active Directory Authentication: Step 5]({{}}/rancher/v2.6/en/admin-settings/authentication/ad/). + There may be an issue with your search attribute configuration. See [Configuring Active Directory Authentication: Step 5](../../authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-active-directory.md). ::: @@ -44,20 +44,20 @@ Cluster administrators can edit the membership for a cluster, controlling which :::note - If you are logged in as a local user, external users do not display in your search results. For more information, see [External Authentication Configuration and Principal Users]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). + If you are logged in as a local user, external users do not display in your search results. For more information, see [External Authentication Configuration and Principal Users](../../../../pages-for-subheaders/about-authentication.md#external-authentication-configuration-and-principal-users). ::: 1. Assign the user or group **Cluster** roles. - [What are Cluster Roles?]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/) + [What are Cluster Roles?](../../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md) :::tip For Custom Roles, you can modify the list of individual roles available for assignment. - - To add roles to the list, [Add a Custom Role]({{}}/rancher/v2.6/en/admin-settings/rbac/default-custom-roles/). - - To remove roles from the list, [Lock/Unlock Roles]({{}}/rancher/v2.6/en/admin-settings/rbac/locked-roles). + - To add roles to the list, [Add a Custom Role](../../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/custom-roles.md). + - To remove roles from the list, [Lock/Unlock Roles](../../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/locked-roles.md). ::: diff --git a/docs/en/cluster-admin/cluster-access/ace/ace.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/access-clusters/authorized-cluster-endpoint.md similarity index 71% rename from docs/en/cluster-admin/cluster-access/ace/ace.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/access-clusters/authorized-cluster-endpoint.md index c7776bb0543..d1c74d7274d 100644 --- a/docs/en/cluster-admin/cluster-access/ace/ace.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/access-clusters/authorized-cluster-endpoint.md @@ -3,7 +3,7 @@ title: How the Authorized Cluster Endpoint Works weight: 2015 --- -This section describes how the kubectl CLI, the kubeconfig file, and the authorized cluster endpoint work together to allow you to access a downstream Kubernetes cluster directly, without authenticating through the Rancher server. It is intended to provide background information and context to the instructions for [how to set up kubectl to directly access a cluster.](../kubectl/#authenticating-directly-with-a-downstream-cluster) +This section describes how the kubectl CLI, the kubeconfig file, and the authorized cluster endpoint work together to allow you to access a downstream Kubernetes cluster directly, without authenticating through the Rancher server. It is intended to provide background information and context to the instructions for [how to set up kubectl to directly access a cluster.](use-kubectl-and-kubeconfig.md#authenticating-directly-with-a-downstream-cluster) ### About the kubeconfig File @@ -13,12 +13,12 @@ This kubeconfig file and its contents are specific to the cluster you are viewin After you download the kubeconfig file, you will be able to use the kubeconfig file and its Kubernetes [contexts](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#kubectl-context-and-configuration) to access your downstream cluster. -If admins have [enforced TTL on kubeconfig tokens]({{}}/rancher/v2.6/en/api/api-tokens/#setting-ttl-on-kubeconfig-tokens), the kubeconfig file requires [rancher cli]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/ace) to be present in your PATH. +If admins have [enforced TTL on kubeconfig tokens](../../../../reference-guides/about-the-api/api-tokens.md#setting-ttl-on-kubeconfig-tokens), the kubeconfig file requires [rancher cli](authorized-cluster-endpoint.md) to be present in your PATH. ### Two Authentication Methods for RKE Clusters -If the cluster is not an [RKE cluster,]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) the kubeconfig file allows you to access the cluster in only one way: it lets you be authenticated with the Rancher server, then Rancher allows you to run kubectl commands on the cluster. +If the cluster is not an [RKE cluster,](../../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) the kubeconfig file allows you to access the cluster in only one way: it lets you be authenticated with the Rancher server, then Rancher allows you to run kubectl commands on the cluster. For RKE clusters, the kubeconfig file allows you to be authenticated in two ways: @@ -27,13 +27,13 @@ For RKE clusters, the kubeconfig file allows you to be authenticated in two ways This second method, the capability to connect directly to the cluster's Kubernetes API server, is important because it lets you access your downstream cluster if you can't connect to Rancher. -To use the authorized cluster endpoint, you will need to configure kubectl to use the extra kubectl context in the kubeconfig file that Rancher generates for you when the RKE cluster is created. This file can be downloaded from the cluster view in the Rancher UI, and the instructions for configuring kubectl are on [this page.](../kubectl/#authenticating-directly-with-a-downstream-cluster) +To use the authorized cluster endpoint, you will need to configure kubectl to use the extra kubectl context in the kubeconfig file that Rancher generates for you when the RKE cluster is created. This file can be downloaded from the cluster view in the Rancher UI, and the instructions for configuring kubectl are on [this page.](use-kubectl-and-kubeconfig.md#authenticating-directly-with-a-downstream-cluster) -These methods of communicating with downstream Kubernetes clusters are also explained in the [architecture page]({{}}/rancher/v2.6/en/overview/architecture/#communicating-with-downstream-user-clusters) in the larger context of explaining how Rancher works and how Rancher communicates with downstream clusters. +These methods of communicating with downstream Kubernetes clusters are also explained in the [architecture page](../../../../pages-for-subheaders/rancher-manager-architecture.md#communicating-with-downstream-user-clusters) in the larger context of explaining how Rancher works and how Rancher communicates with downstream clusters. ### About the kube-api-auth Authentication Webhook -The `kube-api-auth` microservice is deployed to provide the user authentication functionality for the [authorized cluster endpoint,]({{}}/rancher/v2.6/en/overview/architecture/#4-authorized-cluster-endpoint) which is only available for [RKE clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) When you access the user cluster using `kubectl`, the cluster's Kubernetes API server authenticates you by using the `kube-api-auth` service as a webhook. +The `kube-api-auth` microservice is deployed to provide the user authentication functionality for the [authorized cluster endpoint,](../../../../pages-for-subheaders/rancher-manager-architecture.md#4-authorized-cluster-endpoint) which is only available for [RKE clusters.](../../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) When you access the user cluster using `kubectl`, the cluster's Kubernetes API server authenticates you by using the `kube-api-auth` service as a webhook. During cluster provisioning, the file `/etc/kubernetes/kube-api-authn-webhook.yaml` is deployed and `kube-apiserver` is configured with `--authentication-token-webhook-config-file=/etc/kubernetes/kube-api-authn-webhook.yaml`. This configures the `kube-apiserver` to query `http://127.0.0.1:6440/v1/authenticate` to determine authentication for bearer tokens. diff --git a/docs/en/cluster-admin/cluster-access/kubectl/kubectl.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md similarity index 89% rename from docs/en/cluster-admin/cluster-access/kubectl/kubectl.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md index 1b770f1c248..fe8062263d4 100644 --- a/docs/en/cluster-admin/cluster-access/kubectl/kubectl.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md @@ -52,9 +52,9 @@ Rancher will discover and show resources created by `kubectl`. However, these re # Authenticating Directly with a Downstream Cluster -This section intended to help you set up an alternative method to access an [RKE cluster.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters) +This section intended to help you set up an alternative method to access an [RKE cluster.](../../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) -This method is only available for RKE clusters that have the [authorized cluster endpoint]({{}}/rancher/v2.6/en/overview/architecture/#4-authorized-cluster-endpoint) enabled. When Rancher creates this RKE cluster, it generates a kubeconfig file that includes additional kubectl context(s) for accessing your cluster. This additional context allows you to use kubectl to authenticate with the downstream cluster without authenticating through Rancher. For a longer explanation of how the authorized cluster endpoint works, refer to [this page.](../ace) +This method is only available for RKE clusters that have the [authorized cluster endpoint](../../../../pages-for-subheaders/rancher-manager-architecture.md#4-authorized-cluster-endpoint) enabled. When Rancher creates this RKE cluster, it generates a kubeconfig file that includes additional kubectl context(s) for accessing your cluster. This additional context allows you to use kubectl to authenticate with the downstream cluster without authenticating through Rancher. For a longer explanation of how the authorized cluster endpoint works, refer to [this page.](authorized-cluster-endpoint.md) We recommend that as a best practice, you should set up this method to access your RKE cluster, so that just in case you can’t connect to Rancher, you can still access the cluster. @@ -77,7 +77,7 @@ In this example, when you use `kubectl` with the first context, `my-cluster`, yo With the second context, `my-cluster-controlplane-1`, you would authenticate with the authorized cluster endpoint, communicating with an downstream RKE cluster directly. -We recommend using a load balancer with the authorized cluster endpoint. For details, refer to the [recommended architecture section.]({{}}/rancher/v2.6/en/overview/architecture-recommendations/#architecture-for-an-authorized-cluster-endpoint) +We recommend using a load balancer with the authorized cluster endpoint. For details, refer to the [recommended architecture section.](../../../../reference-guides/rancher-manager-architecture/architecture-recommendations.md#architecture-for-an-authorized-cluster-endpoint) Now that you have the name of the context needed to authenticate directly with the cluster, you can pass the name of the context in as an option when running kubectl commands. The commands will differ depending on whether your cluster has an FQDN defined. Examples are provided in the sections below. diff --git a/docs/en/cluster-admin/pod-security-policy/pod-security-policy.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/add-a-pod-security-policy.md similarity index 60% rename from docs/en/cluster-admin/pod-security-policy/pod-security-policy.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/add-a-pod-security-policy.md index 24d2e3d9625..823e00ae321 100644 --- a/docs/en/cluster-admin/pod-security-policy/pod-security-policy.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/add-a-pod-security-policy.md @@ -5,11 +5,11 @@ weight: 80 :::note Prerequisite: -The options below are available only for clusters that are [launched using RKE.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) +The options below are available only for clusters that are [launched using RKE.](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) ::: -When your cluster is running pods with security-sensitive configurations, assign it a [pod security policy]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/), which is a set of rules that monitors the conditions and settings in your pods. If a pod doesn't meet the rules specified in your policy, the policy stops it from running. +When your cluster is running pods with security-sensitive configurations, assign it a [pod security policy](../authentication-permissions-and-global-configuration/create-pod-security-policies.md), which is a set of rules that monitors the conditions and settings in your pods. If a pod doesn't meet the rules specified in your policy, the policy stops it from running. You can assign a pod security policy when you provision a cluster. However, if you need to relax or restrict security for your pods later, you can update the policy while editing your cluster. @@ -19,13 +19,13 @@ You can assign a pod security policy when you provision a cluster. However, if y :::note - This option is only available for clusters [provisioned by RKE]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/). + This option is only available for clusters [provisioned by RKE](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md). ::: 4. From the **Default Pod Security Policy** drop-down, select the policy you want to apply to the cluster. - Rancher ships with [policies]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/#default-pod-security-policies) of `restricted` and `unrestricted`, although you can [create custom policies]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/#default-pod-security-policies) as well. + Rancher ships with [policies](../authentication-permissions-and-global-configuration/create-pod-security-policies.md#default-pod-security-policies) of `restricted` and `unrestricted`, although you can [create custom policies](../authentication-permissions-and-global-configuration/create-pod-security-policies.md#default-pod-security-policies) as well. 5. Click **Save**. diff --git a/docs/en/cluster-admin/pod-security-policies/pod-security-policies.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/assign-pod-security-policies.md similarity index 91% rename from docs/en/cluster-admin/pod-security-policies/pod-security-policies.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/assign-pod-security-policies.md index 47eec54e59c..a26b152f502 100644 --- a/docs/en/cluster-admin/pod-security-policies/pod-security-policies.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/assign-pod-security-policies.md @@ -11,7 +11,7 @@ When you create a new cluster with RKE, you can configure it to apply a PSP imme :::Prerequisite: -Create a Pod Security Policy within Rancher. Before you can assign a default PSP to a new cluster, you must have a PSP available for assignment. For instruction, see [Creating Pod Security Policies]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/). +Create a Pod Security Policy within Rancher. Before you can assign a default PSP to a new cluster, you must have a PSP available for assignment. For instruction, see [Creating Pod Security Policies](../authentication-permissions-and-global-configuration/create-pod-security-policies.md). ::: diff --git a/docs/en/cluster-admin/cleaning-cluster-nodes/cleaning-cluster-nodes.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/clean-cluster-nodes.md similarity index 97% rename from docs/en/cluster-admin/cleaning-cluster-nodes/cleaning-cluster-nodes.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/clean-cluster-nodes.md index 3fb6ace9bec..17dc6e3ebbe 100644 --- a/docs/en/cluster-admin/cleaning-cluster-nodes/cleaning-cluster-nodes.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/clean-cluster-nodes.md @@ -27,10 +27,10 @@ When cleaning nodes provisioned using Rancher, the following components are dele | All resources create under the `management.cattle.io` API Group | ✓ | ✓ | ✓ | | | All CRDs created by Rancher v2.x | ✓ | ✓ | ✓ | | -[1]: {{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ -[2]: {{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/ -[3]: {{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/ -[4]: {{}}/rancher/v2.6/en/cluster-provisioning/registered-clusters/ +[1]: cluster-provisioning/rke-clusters/node-pools/ +[2]: cluster-provisioning/rke-clusters/custom-nodes/ +[3]: cluster-provisioning/hosted-kubernetes-clusters/ +[4]: cluster-provisioning/registered-clusters/ ## Removing a Node from a Cluster by Rancher UI diff --git a/docs/en/cluster-admin/cloning-clusters/cloning-clusters.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/clone-cluster-configuration.md similarity index 82% rename from docs/en/cluster-admin/cloning-clusters/cloning-clusters.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/clone-cluster-configuration.md index 26659e11030..bf2bbe6640e 100644 --- a/docs/en/cluster-admin/cloning-clusters/cloning-clusters.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/clone-cluster-configuration.md @@ -9,10 +9,10 @@ Duplication of registered clusters is not supported. | Cluster Type | Cloneable? | |----------------------------------|---------------| -| [Nodes Hosted by Infrastructure Provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/) | ✓ | -| [Hosted Kubernetes Providers]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/) | ✓ | -| [Custom Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes) | ✓ | -| [Registered Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/registered-clusters/) | | +| [Nodes Hosted by Infrastructure Provider](../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md) | ✓ | +| [Hosted Kubernetes Providers](../../../pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers.md) | ✓ | +| [Custom Cluster](../../../pages-for-subheaders/use-existing-nodes.md) | ✓ | +| [Registered Cluster](../../new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md) | | :::caution @@ -22,7 +22,7 @@ During the process of duplicating a cluster, you will edit a config file full of ## Prerequisites -Download and install [Rancher CLI]({{}}/rancher/v2.6/en/cli). Remember to [create an API bearer token]({{}}/rancher/v2.6/en/user-settings/api-keys) if necessary. +Download and install [Rancher CLI](../../../pages-for-subheaders/cli-with-rancher.md). Remember to [create an API bearer token](../../../reference-guides/user-settings/api-keys.md) if necessary. ## 1. Export Cluster Config @@ -55,7 +55,7 @@ Use your favorite text editor to modify the cluster configuration in `cluster-te :::note -Cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure in Rancher v2.3.0+.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#config-file-structure-in-rancher-v2-3-0) +Cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure in Rancher v2.3.0+.](cluster-provisioning/rke-clusters/options/#config-file-structure-in-rancher-v2-3-0) ::: diff --git a/docs/en/cluster-admin/volumes-and-storage/glusterfs-volumes/glusterfs-volumes.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-glusterfs-volumes.md similarity index 93% rename from docs/en/cluster-admin/volumes-and-storage/glusterfs-volumes/glusterfs-volumes.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-glusterfs-volumes.md index 6d06f06d837..29d5a38aa93 100644 --- a/docs/en/cluster-admin/volumes-and-storage/glusterfs-volumes/glusterfs-volumes.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-glusterfs-volumes.md @@ -5,7 +5,7 @@ weight: 5000 :::note -This section only applies to [RKE clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) +This section only applies to [RKE clusters.](../../../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) ::: diff --git a/docs/en/cluster-admin/volumes-and-storage/how-storage-works/how-storage-works.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-persistent-storage.md similarity index 98% rename from docs/en/cluster-admin/volumes-and-storage/how-storage-works/how-storage-works.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-persistent-storage.md index 6f69bfdc83b..0a0f6a2b32f 100644 --- a/docs/en/cluster-admin/volumes-and-storage/how-storage-works/how-storage-works.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-persistent-storage.md @@ -14,7 +14,7 @@ To use an existing PV, your application will need to use a PVC that is bound to For dynamic storage provisioning, your application will need to use a PVC that is bound to a storage class. The storage class contains the authorization to provision new persistent volumes. -![Setting Up New and Existing Persistent Storage]({{}}/img/rancher/rancher-storage.svg) +![Setting Up New and Existing Persistent Storage](/img/rancher-storage.svg) For more information, refer to the [official Kubernetes documentation on storage](https://kubernetes.io/docs/concepts/storage/volumes/) diff --git a/docs/en/cluster-admin/volumes-and-storage/provisioning-new-storage/provisioning-new-storage.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/dynamically-provision-new-storage.md similarity index 89% rename from docs/en/cluster-admin/volumes-and-storage/provisioning-new-storage/provisioning-new-storage.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/dynamically-provision-new-storage.md index 52b13e5d662..232511bb339 100644 --- a/docs/en/cluster-admin/volumes-and-storage/provisioning-new-storage/provisioning-new-storage.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/dynamically-provision-new-storage.md @@ -5,11 +5,11 @@ weight: 2 This section describes how to provision new persistent storage for workloads in Rancher. -This section assumes that you understand the Kubernetes concepts of storage classes and persistent volume claims. For more information, refer to the section on [how storage works.](../how-storage-works) +This section assumes that you understand the Kubernetes concepts of storage classes and persistent volume claims. For more information, refer to the section on [how storage works.](about-persistent-storage.md) New storage is often provisioned by a cloud provider such as Amazon EBS. However, new storage doesn't have to be in the cloud. -If you have a pool of block storage, and you don't want to use a cloud provider, Longhorn could help you provide persistent storage to your Kubernetes cluster. For more information, see [this page.]({{}}/rancher/v2.6/en/longhorn) +If you have a pool of block storage, and you don't want to use a cloud provider, Longhorn could help you provide persistent storage to your Kubernetes cluster. For more information, see [this page.](../../../../../explanations/integrations-in-rancher/longhorn.md) To provision new storage for your workloads, follow these steps: @@ -18,9 +18,9 @@ To provision new storage for your workloads, follow these steps: ### Prerequisites -- To set up persistent storage, the `Manage Volumes` [role]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-role-reference) is required. +- To set up persistent storage, the `Manage Volumes` [role](../../../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#project-role-reference) is required. - If you are provisioning storage for a cluster hosted in the cloud, the storage and cluster hosts must have the same cloud provider. -- The cloud provider must be enabled. For details on enabling cloud providers, refer to [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/) +- The cloud provider must be enabled. For details on enabling cloud providers, refer to [this page.](../../../../../pages-for-subheaders/set-up-cloud-providers.md) - Make sure your storage provisioner is available to be enabled. The following storage provisioners are enabled by default: @@ -37,7 +37,7 @@ Local | `local` Network File System | `nfs` hostPath | `host-path` -To use a storage provisioner that is not on the above list, you will need to use a [feature flag to enable unsupported storage drivers.]({{}}/rancher/v2.6/en/installation/resources/feature-flags/enable-not-default-storage-drivers/) +To use a storage provisioner that is not on the above list, you will need to use a [feature flag to enable unsupported storage drivers.](../../../../../getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/unsupported-storage-drivers.md) ### 1. Add a storage class and configure it to use your storage diff --git a/docs/en/cluster-admin/volumes-and-storage/iscsi-volumes/iscsi-volumes.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/install-iscsi-volumes.md similarity index 83% rename from docs/en/cluster-admin/volumes-and-storage/iscsi-volumes/iscsi-volumes.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/install-iscsi-volumes.md index d48eb80e214..12f8d0f8e22 100644 --- a/docs/en/cluster-admin/volumes-and-storage/iscsi-volumes/iscsi-volumes.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/install-iscsi-volumes.md @@ -3,7 +3,7 @@ title: iSCSI Volumes weight: 6000 --- -In [Rancher Launched Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) that store data on iSCSI volumes, you may experience an issue where kubelets fail to automatically connect with iSCSI volumes. This failure is likely due to an incompatibility issue involving the iSCSI initiator tool. You can resolve this issue by installing the iSCSI initiator tool on each of your cluster nodes. +In [Rancher Launched Kubernetes clusters](../../../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) that store data on iSCSI volumes, you may experience an issue where kubelets fail to automatically connect with iSCSI volumes. This failure is likely due to an incompatibility issue involving the iSCSI initiator tool. You can resolve this issue by installing the iSCSI initiator tool on each of your cluster nodes. Rancher Launched Kubernetes clusters storing data on iSCSI volumes leverage the [iSCSI initiator tool](http://www.open-iscsi.com/), which is embedded in the kubelet's `rancher/hyperkube` Docker image. From each kubelet (i.e., the _initiator_), the tool discovers and launches sessions with an iSCSI volume (i.e., the _target_). However, in some instances, the versions of the iSCSI initiator tool installed on the initiator and the target may not match, resulting in a connection failure. diff --git a/docs/en/cluster-admin/volumes-and-storage/attaching-existing-storage/attaching-existing-storage.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/set-up-existing-storage.md similarity index 91% rename from docs/en/cluster-admin/volumes-and-storage/attaching-existing-storage/attaching-existing-storage.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/set-up-existing-storage.md index 01d403cdb8d..53fe7c9297b 100644 --- a/docs/en/cluster-admin/volumes-and-storage/attaching-existing-storage/attaching-existing-storage.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/set-up-existing-storage.md @@ -7,7 +7,7 @@ This section describes how to set up existing persistent storage for workloads i :::note -This section assumes that you understand the Kubernetes concepts of persistent volumes and persistent volume claims. For more information, refer to the section on [how storage works.](../how-storage-works) +This section assumes that you understand the Kubernetes concepts of persistent volumes and persistent volume claims. For more information, refer to the section on [how storage works.](about-persistent-storage.md) ::: @@ -19,16 +19,16 @@ To set up storage, follow these steps: ### Prerequisites -- To create a persistent volume as a Kubernetes resource, you must have the `Manage Volumes` [role.]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-role-reference) +- To create a persistent volume as a Kubernetes resource, you must have the `Manage Volumes` [role.](../../../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#project-role-reference) - If you are provisioning storage for a cluster hosted in the cloud, the storage and cluster hosts must have the same cloud provider. ### 1. Set up persistent storage Creating a persistent volume in Rancher will not create a storage volume. It only creates a Kubernetes resource that maps to an existing volume. Therefore, before you can create a persistent volume as a Kubernetes resource, you must have storage provisioned. -The steps to set up a persistent storage device will differ based on your infrastructure. We provide examples of how to set up storage using [vSphere,](../examples/vsphere) [NFS,](../examples/nfs) or Amazon's [EBS.](../examples/ebs) +The steps to set up a persistent storage device will differ based on your infrastructure. We provide examples of how to set up storage using [vSphere,](../provisioning-storage-examples/vsphere-storage.md) [NFS,](../provisioning-storage-examples/nfs-storage.md) or Amazon's [EBS.](../provisioning-storage-examples/persistent-storage-in-amazon-ebs.md) -If you have a pool of block storage, and you don't want to use a cloud provider, Longhorn could help you provide persistent storage to your Kubernetes cluster. For more information, see [this page.]({{}}/rancher/v2.6/en/longhorn) +If you have a pool of block storage, and you don't want to use a cloud provider, Longhorn could help you provide persistent storage to your Kubernetes cluster. For more information, see [this page.](../../../../../explanations/integrations-in-rancher/longhorn.md) ### 2. Add a PersistentVolume that refers to the persistent storage diff --git a/docs/en/cluster-admin/volumes-and-storage/ceph/ceph.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/use-external-ceph-driver.md similarity index 99% rename from docs/en/cluster-admin/volumes-and-storage/ceph/ceph.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/use-external-ceph-driver.md index a3a6dcb0a2b..9fe5c3a2146 100644 --- a/docs/en/cluster-admin/volumes-and-storage/ceph/ceph.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/use-external-ceph-driver.md @@ -43,7 +43,7 @@ services: - '/lib/modules:/lib/modules:ro' ``` -For more information about the `extra_binds` directive, refer to [this section.]({{}}/rke/latest/en/config-options/services/services-extras/#extra-binds) +For more information about the `extra_binds` directive, refer to [this section.](https://rancher.com/docs/rke/latest/en/config-options/services/services-extras/#extra-binds) # Installing the ceph-csi driver on an RKE2 cluster diff --git a/docs/en/cluster-admin/volumes-and-storage/examples/nfs/nfs.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/nfs-storage.md similarity index 97% rename from docs/en/cluster-admin/volumes-and-storage/examples/nfs/nfs.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/nfs-storage.md index 3a22ba0988b..ff3707aa1cd 100644 --- a/docs/en/cluster-admin/volumes-and-storage/examples/nfs/nfs.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/nfs-storage.md @@ -7,7 +7,7 @@ Before you can use the NFS storage volume plug-in with Rancher deployments, you :::note -- If you already have an NFS share, you don't need to provision a new NFS server to use the NFS volume plugin within Rancher. Instead, skip the rest of this procedure and complete [adding storage]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/). +- If you already have an NFS share, you don't need to provision a new NFS server to use the NFS volume plugin within Rancher. Instead, skip the rest of this procedure and complete [adding storage](../../../../../pages-for-subheaders/create-kubernetes-persistent-storage.md). - This procedure demonstrates how to set up an NFS server using Ubuntu, although you should be able to use these instructions for other Linux distros (e.g. Debian, RHEL, Arch Linux, etc.). For official instruction on how to create an NFS server using another Linux distro, consult the distro's documentation. diff --git a/docs/en/cluster-admin/volumes-and-storage/examples/ebs/ebs.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/persistent-storage-in-amazon-ebs.md similarity index 80% rename from docs/en/cluster-admin/volumes-and-storage/examples/ebs/ebs.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/persistent-storage-in-amazon-ebs.md index 2a08d957fda..97b725a39f9 100644 --- a/docs/en/cluster-admin/volumes-and-storage/examples/ebs/ebs.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/persistent-storage-in-amazon-ebs.md @@ -13,4 +13,4 @@ This section describes how to set up Amazon's Elastic Block Store in EC2. **Result:** Persistent storage has been created. -For details on how to set up the newly created storage in Rancher, refer to the section on [setting up existing storage.]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/attaching-existing-storage/) \ No newline at end of file +For details on how to set up the newly created storage in Rancher, refer to the section on [setting up existing storage.](../manage-persistent-storage/set-up-existing-storage.md) \ No newline at end of file diff --git a/docs/en/cluster-admin/volumes-and-storage/examples/vsphere/vsphere.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/vsphere-storage.md similarity index 87% rename from docs/en/cluster-admin/volumes-and-storage/examples/vsphere/vsphere.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/vsphere-storage.md index b2734c6624f..1cc35b24e83 100644 --- a/docs/en/cluster-admin/volumes-and-storage/examples/vsphere/vsphere.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/vsphere-storage.md @@ -5,7 +5,7 @@ weight: 3055 To provide stateful workloads with vSphere storage, we recommend creating a vSphereVolume StorageClass. This practice dynamically provisions vSphere storage when workloads request volumes through a PersistentVolumeClaim. -In order to dynamically provision storage in vSphere, the vSphere provider must be [enabled.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere) +In order to dynamically provision storage in vSphere, the vSphere provider must be [enabled.](../../../../../pages-for-subheaders/vsphere-cloud-provider.md) - [Prerequisites](#prerequisites) - [Creating a StorageClass](#creating-a-storageclass) @@ -15,7 +15,7 @@ In order to dynamically provision storage in vSphere, the vSphere provider must ### Prerequisites -In order to provision vSphere volumes in a cluster created with the [Rancher Kubernetes Engine (RKE)]({{< baseurl>}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/), the [vSphere cloud provider]({{}}/rke/latest/en/config-options/cloud-providers/vsphere) must be explicitly enabled in the [cluster options]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/). +In order to provision vSphere volumes in a cluster created with the [Rancher Kubernetes Engine (RKE)](../../../../../pages-for-subheaders/launch-kubernetes-with-rancher.md), the [vSphere cloud provider](https://rancher.com/docs/rke/latest/en/config-options/cloud-providers/vsphere) must be explicitly enabled in the [cluster options](cluster-provisioning/rke-clusters/options/). ### Creating a StorageClass @@ -32,7 +32,7 @@ The following steps can also be performed using the `kubectl` command line tool. 3. Enter a **Name** for the StorageClass. 4. Under **Provisioner**, select **VMWare vSphere Volume**. - {{< img "/img/rancher/vsphere-storage-class.png" "vsphere-storage-class">}} + ![](/img/vsphere-storage-class.png) 5. Optionally, specify additional properties for this storage class under **Parameters**. Refer to the [vSphere storage documentation](https://vmware.github.io/vsphere-storage-for-kubernetes/documentation/storageclass.html) for details. 5. Click **Create**. @@ -62,7 +62,7 @@ The following steps can also be performed using the `kubectl` command line tool. 9. Once the replacement pod is running, click **Execute Shell**. 10. Inspect the contents of the directory where the volume is mounted by entering `ls -l /`. Note that the file you created earlier is still present. - ![workload-persistent-data]({{}}/img/rancher/workload-persistent-data.png) + ![workload-persistent-data](/img/workload-persistent-data.png) ### Why to Use StatefulSets Instead of Deployments diff --git a/docs/en/cluster-admin/cluster-autoscaler/amazon/amazon.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/install-cluster-autoscaler/use-aws-ec2-auto-scaling-groups.md similarity index 97% rename from docs/en/cluster-admin/cluster-autoscaler/amazon/amazon.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/install-cluster-autoscaler/use-aws-ec2-auto-scaling-groups.md index db9e80fd102..00e1e08014c 100644 --- a/docs/en/cluster-admin/cluster-autoscaler/amazon/amazon.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/install-cluster-autoscaler/use-aws-ec2-auto-scaling-groups.md @@ -149,7 +149,7 @@ On AWS EC2, we should create a few objects to configure our system. We've define ``` * IAM role: `K8sMasterRole: [K8sMasterProfile,K8sAutoscalerProfile]` - * Security group: `K8sMasterSg` More info at[RKE ports (custom nodes tab)]({{}}/rancher/v2.6/en/installation/requirements/ports/#downstream-kubernetes-cluster-nodes) + * Security group: `K8sMasterSg` More info at[RKE ports (custom nodes tab)](../../../../getting-started/installation-and-upgrade/installation-requirements/port-requirements.md#downstream-kubernetes-cluster-nodes) * Tags: `kubernetes.io/cluster/: owned` * User data: `K8sMasterUserData` Ubuntu 18.04(ami-0e11cbb34015ff725), installs docker and add etcd+controlplane node to the k8s cluster @@ -206,7 +206,7 @@ On AWS EC2, we should create a few objects to configure our system. We've define ``` * IAM role: `K8sWorkerRole: [K8sWorkerProfile]` - * Security group: `K8sWorkerSg` More info at [RKE ports (custom nodes tab)]({{}}/rancher/v2.6/en/installation/requirements/ports/#downstream-kubernetes-cluster-nodes) + * Security group: `K8sWorkerSg` More info at [RKE ports (custom nodes tab)](../../../../getting-started/installation-and-upgrade/installation-requirements/port-requirements.md#downstream-kubernetes-cluster-nodes) * Tags: * `kubernetes.io/cluster/: owned` * `k8s.io/cluster-autoscaler/: true` @@ -237,13 +237,13 @@ On AWS EC2, we should create a few objects to configure our system. We've define sudo docker run -d --privileged --restart=unless-stopped --net=host -v /etc/kubernetes:/etc/kubernetes -v /var/run:/var/run rancher/rancher-agent: --server https:// --token --ca-checksum --address ${PUBLIC_IP} --internal-address ${PRIVATE_IP} ${K8S_ROLES} ``` -More info is at [RKE clusters on AWS]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/) and [Cluster Autoscaler on AWS.](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/aws/README.md) +More info is at [RKE clusters on AWS](../../../new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/amazon.md) and [Cluster Autoscaler on AWS.](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/aws/README.md) ### 3. Deploy Nodes Once we've configured AWS, let's create VMs to bootstrap our cluster: -* master (etcd+controlplane): Depending your needs, deploy three master instances with proper size. More info is at [the recommendations for production-ready clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/production/) +* master (etcd+controlplane): Depending your needs, deploy three master instances with proper size. More info is at [the recommendations for production-ready clusters.](../../../../pages-for-subheaders/checklist-for-production-ready-clusters.md) * IAM role: `K8sMasterRole` * Security group: `K8sMasterSg` * Tags: diff --git a/docs/en/cluster-admin/nodes/nodes.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/nodes-and-node-pools.md similarity index 80% rename from docs/en/cluster-admin/nodes/nodes.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/nodes-and-node-pools.md index 4bd5167b9aa..649a20e6bd3 100644 --- a/docs/en/cluster-admin/nodes/nodes.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/nodes-and-node-pools.md @@ -3,11 +3,11 @@ title: Nodes and Node Pools weight: 2030 --- -After you launch a Kubernetes cluster in Rancher, you can manage individual nodes from the cluster's **Node** tab. Depending on the [option used]({{}}/rancher/v2.6/en/cluster-provisioning/) to provision the cluster, there are different node options available. +After you launch a Kubernetes cluster in Rancher, you can manage individual nodes from the cluster's **Node** tab. Depending on the [option used](../../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md) to provision the cluster, there are different node options available. :::note -If you want to manage the _cluster_ and not individual nodes, see [Editing Clusters]({{< baseurl >}}/rancher/v2.6/en/cluster-admin/editing-clusters). +If you want to manage the _cluster_ and not individual nodes, see [Editing Clusters](../../../pages-for-subheaders/cluster-configuration.md). ::: @@ -44,32 +44,32 @@ The following table lists which node options are available for each type of clus | [Download Keys](#ssh-into-a-node-hosted-by-an-infrastructure-provider) | ✓ | | | | | Download SSH key in order to SSH into the node. | | [Node Scaling](#scaling-nodes) | ✓ | | | ✓ | | Scale the number of nodes in the node pool up or down. | -[1]: {{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ -[2]: {{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/ -[3]: {{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/ -[4]: {{}}/rancher/v2.6/en/cluster-provisioning/registered-clusters/ -[5]: {{}}/rancher/v2.6/en/cluster-provisioning/registered-clusters/ +[1]: cluster-provisioning/rke-clusters/node-pools/ +[2]: cluster-provisioning/rke-clusters/custom-nodes/ +[3]: cluster-provisioning/hosted-kubernetes-clusters/ +[4]: cluster-provisioning/registered-clusters/ +[5]: cluster-provisioning/registered-clusters/ \* Delete option accessible via View API ### Nodes Hosted by an Infrastructure Provider -Node pools are available when you provision Rancher-launched Kubernetes clusters on nodes that are [hosted in an infrastructure provider.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/) +Node pools are available when you provision Rancher-launched Kubernetes clusters on nodes that are [hosted in an infrastructure provider.](../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md) -Clusters provisioned using [one of the node pool options]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-pools) can be scaled up or down if the node pool is edited. +Clusters provisioned using [one of the node pool options](../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-pools) can be scaled up or down if the node pool is edited. -A node pool can also automatically maintain the node scale that's set during the initial cluster provisioning if [node auto-replace is enabled.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#about-node-auto-replace) This scale determines the number of active nodes that Rancher maintains for the cluster. +A node pool can also automatically maintain the node scale that's set during the initial cluster provisioning if [node auto-replace is enabled.](../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#about-node-auto-replace) This scale determines the number of active nodes that Rancher maintains for the cluster. -Rancher uses [node templates]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) to replace nodes in the node pool. Each node template uses cloud provider credentials to allow Rancher to set up the node in the infrastructure provider. +Rancher uses [node templates](../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-templates) to replace nodes in the node pool. Each node template uses cloud provider credentials to allow Rancher to set up the node in the infrastructure provider. ### Nodes Provisioned by Hosted Kubernetes Providers -Options for managing nodes [hosted by a Kubernetes provider]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/) are somewhat limited in Rancher. Rather than using the Rancher UI to make edits such as scaling the number of nodes up or down, edit the cluster directly. +Options for managing nodes [hosted by a Kubernetes provider](../../../pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers.md) are somewhat limited in Rancher. Rather than using the Rancher UI to make edits such as scaling the number of nodes up or down, edit the cluster directly. ### Registered Nodes -Although you can deploy workloads to a [registered cluster]({{< baseurl >}}/rancher/v2.6/en/cluster-provisioning/registered-clusters/) using Rancher, you cannot manage individual cluster nodes. All management of imported cluster nodes must take place outside of Rancher. +Although you can deploy workloads to a [registered cluster](../../new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md) using Rancher, you cannot manage individual cluster nodes. All management of imported cluster nodes must take place outside of Rancher. # Managing and Editing Individual Nodes @@ -84,13 +84,13 @@ To manage individual nodes, browse to the cluster that you want to manage and th # Viewing a Node in the Rancher API -Select this option to view the node's [API endpoints]({{< baseurl >}}/rancher/v2.6/en/api/). +Select this option to view the node's [API endpoints](../../../pages-for-subheaders/about-the-api.md). # Deleting a Node Use **Delete** to remove defective nodes from the cloud provider. -When you the delete a defective node, Rancher can automatically replace it with an identically provisioned node if the node is in a node pool and [node auto-replace is enabled.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#about-node-auto-replace) +When you the delete a defective node, Rancher can automatically replace it with an identically provisioned node if the node is in a node pool and [node auto-replace is enabled.](../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#about-node-auto-replace) :::tip @@ -100,11 +100,11 @@ If your cluster is hosted by an infrastructure provider, and you want to scale y # Scaling Nodes -For nodes hosted by an infrastructure provider, you can scale the number of nodes in each [node pool]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-pools) by using the scale controls. This option isn't available for other cluster types. +For nodes hosted by an infrastructure provider, you can scale the number of nodes in each [node pool](../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-pools) by using the scale controls. This option isn't available for other cluster types. # SSH into a Node Hosted by an Infrastructure Provider -For [nodes hosted by an infrastructure provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/), you have the option of downloading its SSH key so that you can connect to it remotely from your desktop. +For [nodes hosted by an infrastructure provider](../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md), you have the option of downloading its SSH key so that you can connect to it remotely from your desktop. 1. In the upper left corner, click **☰ > Cluster Management**. 1. On the **Clusters** page, go to the cluster where you want to SSH into a node and click the name of the cluster. diff --git a/docs/en/cluster-admin/projects-and-namespaces/projects-and-namespaces.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/projects-and-namespaces.md similarity index 84% rename from docs/en/cluster-admin/projects-and-namespaces/projects-and-namespaces.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/projects-and-namespaces.md index 2af182a7594..8ca8666898c 100644 --- a/docs/en/cluster-admin/projects-and-namespaces/projects-and-namespaces.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/projects-and-namespaces.md @@ -10,7 +10,7 @@ A project is a group of namespaces, and it is a concept introduced by Rancher. P :::note -As of Rancher v2.6, projects are de-emphasized on the UI because it is no longer required to create any Kubernetes resources within a project scope. However, resources such as [Secrets]({{}}/rancher/v2.6/en/k8s-in-rancher/secrets/#creating-secrets-in-projects) can still be created in a project scope if the legacy feature flag is enabled. +As of Rancher v2.6, projects are de-emphasized on the UI because it is no longer required to create any Kubernetes resources within a project scope. However, resources such as [Secrets](../../new-user-guides/kubernetes-resources-setup/secrets.md#creating-secrets-in-projects) can still be created in a project scope if the legacy feature flag is enabled. ::: @@ -44,18 +44,18 @@ You can assign resources at the project level so that each namespace in the proj You can assign the following resources directly to namespaces: -- [Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/) -- [Load Balancers/Ingress]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/) -- [Service Discovery Records]({{}}/rancher/v2.6/en/k8s-in-rancher/service-discovery/) -- [Persistent Volume Claims]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/) -- [Certificates]({{}}/rancher/v2.6/en/k8s-in-rancher/certificates/) -- [ConfigMaps]({{}}/rancher/v2.6/en/k8s-in-rancher/configmaps/) -- [Registries]({{}}/rancher/v2.6/en/k8s-in-rancher/registries/) -- [Secrets]({{}}/rancher/v2.6/en/k8s-in-rancher/secrets/) +- [Workloads](../../../pages-for-subheaders/workloads-and-pods.md) +- [Load Balancers/Ingress](../../../pages-for-subheaders/load-balancer-and-ingress-controller.md) +- [Service Discovery Records](../../new-user-guides/kubernetes-resources-setup/create-services.md) +- [Persistent Volume Claims](../../../pages-for-subheaders/create-kubernetes-persistent-storage.md) +- [Certificates](../../new-user-guides/kubernetes-resources-setup/encrypt-http-communication.md) +- [ConfigMaps](../../new-user-guides/kubernetes-resources-setup/configmaps.md) +- [Registries](../../new-user-guides/kubernetes-resources-setup/kubernetes-and-docker-registries.md) +- [Secrets](../../new-user-guides/kubernetes-resources-setup/secrets.md) To manage permissions in a vanilla Kubernetes cluster, cluster admins configure role-based access policies for each namespace. With Rancher, user permissions are assigned on the project level instead, and permissions are automatically inherited by any namespace owned by the particular project. -For more information on creating and moving namespaces, see [Namespaces]({{}}/rancher/v2.6/en/project-admin/namespaces/). +For more information on creating and moving namespaces, see [Namespaces](../manage-projects/manage-namespaces.md). ### Role-based access control issues with namespaces and kubectl @@ -63,7 +63,7 @@ Because projects are a concept introduced by Rancher, kubectl does not have the This means that when standard users with project-scoped permissions create a namespaces with `kubectl`, it may be unusable because `kubectl` doesn't require the new namespace to be scoped within a certain project. -If your permissions are restricted to the project level, it is better to [create a namespace through Rancher]({{}}/rancher/v2.6/en/project-admin/namespaces/) to ensure that you will have permission to access the namespace. +If your permissions are restricted to the project level, it is better to [create a namespace through Rancher](../manage-projects/manage-namespaces.md) to ensure that you will have permission to access the namespace. If a standard user is a project owner, the user will be able to create namespaces within that project. The Rancher UI will prevent that user from creating namespaces outside the scope of the projects they have access to. @@ -80,8 +80,8 @@ In the base version of Kubernetes, features like role-based access rights or clu You can use projects to perform actions such as: -- Assign users to a group of namespaces (i.e., [project membership]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles)). -- Assign users specific roles in a project. A role can be owner, member, read-only, or [custom]({{}}/rancher/v2.6/en/admin-settings/rbac/default-custom-roles/). +- Assign users to a group of namespaces (i.e., [project membership](../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md)). +- Assign users specific roles in a project. A role can be owner, member, read-only, or [custom](../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/custom-roles.md). - Assign resources to the project. - Assign Pod Security Policies. @@ -147,7 +147,7 @@ This section describes how to create a new project with a name and with optional ### 2. Optional: Select a Pod Security Policy -This option is only available if you've already created a Pod Security Policy. For instruction, see [Creating Pod Security Policies]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/). +This option is only available if you've already created a Pod Security Policy. For instruction, see [Creating Pod Security Policies](../authentication-permissions-and-global-configuration/create-pod-security-policies.md). Assigning a PSP to a project will: @@ -167,7 +167,7 @@ By default, your user is added as the project `Owner`. - By default, the Rancher role of `project-member` inherits from the `Kubernetes-edit` role, and the `project-owner` role inherits from the `Kubernetes-admin` role. As such, both `project-member` and `project-owner` roles will allow for namespace management, including the ability to create and delete namespaces. -- Choose `Custom` to create a custom role on the fly: [Custom Project Roles]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#custom-project-roles). +- Choose `Custom` to create a custom role on the fly: [Custom Project Roles](../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#custom-project-roles). ::: @@ -175,18 +175,18 @@ To add members: 1. In the **Members** tab, click **Add**. 1. From the **Select Member** field, search for a user or group that you want to assign project access. Note: You can only search for groups if external authentication is enabled. -1. In the **Project Permissions** section, choose a role. For more information, refer to the [documentation on project roles.]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/) +1. In the **Project Permissions** section, choose a role. For more information, refer to the [documentation on project roles.](../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md) ### 4. Optional: Add Resource Quotas -Resource quotas limit the resources that a project (and its namespaces) can consume. For more information, see [Resource Quotas]({{}}/rancher/v2.6/en/cluster-admin/projects-and-namespaces/). +Resource quotas limit the resources that a project (and its namespaces) can consume. For more information, see [Resource Quotas](projects-and-namespaces.md). To add a resource quota, 1. In the **Resource Quotas** tab, click **Add Resource**. -1. Select a **Resource Type**. For more information, see [Resource Quotas.]({{}}/rancher/v2.6/en/cluster-admin/projects-and-namespaces/). +1. Select a **Resource Type**. For more information, see [Resource Quotas.](projects-and-namespaces.md). 1. Enter values for the **Project Limit** and the **Namespace Default Limit**. -1. **Optional:** Specify **Container Default Resource Limit**, which will be applied to every container started in the project. The parameter is recommended if you have CPU or Memory limits set by the Resource Quota. It can be overridden on per an individual namespace or a container level. For more information, see [Container Default Resource Limit]({{}}/rancher/v2.6/en/project-admin/resource-quotas/) +1. **Optional:** Specify **Container Default Resource Limit**, which will be applied to every container started in the project. The parameter is recommended if you have CPU or Memory limits set by the Resource Quota. It can be overridden on per an individual namespace or a container level. For more information, see [Container Default Resource Limit](../../../pages-for-subheaders/manage-project-resource-quotas.md) 1. Click **Create**. **Result:** Your project is created. You can view it from the cluster's **Projects/Namespaces** view. diff --git a/docs/en/cluster-admin/certificate-rotation/certificate-rotation.md b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/rotate-certificates.md similarity index 90% rename from docs/en/cluster-admin/certificate-rotation/certificate-rotation.md rename to docs/en/how-to-guides/advanced-user-guides/manage-clusters/rotate-certificates.md index acc9ab463ff..e4bf50dad49 100644 --- a/docs/en/cluster-admin/certificate-rotation/certificate-rotation.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-clusters/rotate-certificates.md @@ -21,7 +21,7 @@ Certificates can be rotated for the following services: - etcd - kubelet (node certificate) -- kubelet (serving certificate, if [enabled]({{}}/rke/latest/en/config-options/services/#kubelet-options)) +- kubelet (serving certificate, if [enabled](https://rancher.com/docs/rke/latest/en/config-options/services/#kubelet-options)) - kube-apiserver - kube-proxy - kube-scheduler @@ -47,7 +47,7 @@ Certificates can be rotated for the following services: :::note -For users who didn't rotate their webhook certificates, and they have expired after one year, please see this [page]({{}}/rancher/v2.6/en/troubleshooting/expired-webhook-certificates/) for help. +For users who didn't rotate their webhook certificates, and they have expired after one year, please see this [page](../../../troubleshooting/other-troubleshooting-tips/expired-webhook-certificate-rotation.md) for help. ::: diff --git a/docs/en/project-admin/project-members/project-members.md b/docs/en/how-to-guides/advanced-user-guides/manage-projects/add-users-to-projects.md similarity index 79% rename from docs/en/project-admin/project-members/project-members.md rename to docs/en/how-to-guides/advanced-user-guides/manage-projects/add-users-to-projects.md index a6a639b146c..6f798aca624 100644 --- a/docs/en/project-admin/project-members/project-members.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-projects/add-users-to-projects.md @@ -9,13 +9,13 @@ You can add members to a project as it is created, or add them to an existing pr :::tip -Want to provide a user with access to _all_ projects within a cluster? See [Adding Cluster Members]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/) instead. +Want to provide a user with access to _all_ projects within a cluster? See [Adding Cluster Members](../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md) instead. ::: ### Adding Members to a New Project -You can add members to a project as you create it (recommended if possible). For details on creating a new project, refer to the [cluster administration section.]({{}}/rancher/v2.6/en/cluster-admin/projects-and-namespaces/) +You can add members to a project as you create it (recommended if possible). For details on creating a new project, refer to the [cluster administration section.](../manage-clusters/projects-and-namespaces.md) ### Adding Members to an Existing Project @@ -42,7 +42,7 @@ Following project creation, you can add users as project members so that they ca 1. Assign the user or group **Project** roles. - [What are Project Roles?]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/) + [What are Project Roles?](../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md) :::note Notes: @@ -52,8 +52,8 @@ Following project creation, you can add users as project members so that they ca - For `Custom` roles, you can modify the list of individual roles available for assignment. - - To add roles to the list, [Add a Custom Role]({{}}/rancher/v2.6/en/admin-settings/rbac/default-custom-roles). - - To remove roles from the list, [Lock/Unlock Roles]({{}}/rancher/v2.6/en/admin-settings/rbac/locked-roles/). + - To add roles to the list, [Add a Custom Role](../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/custom-roles.md). + - To remove roles from the list, [Lock/Unlock Roles](../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/locked-roles.md). ::: diff --git a/docs/en/project-admin/pipelines/pipelines.md b/docs/en/how-to-guides/advanced-user-guides/manage-projects/ci-cd-pipelines.md similarity index 86% rename from docs/en/project-admin/pipelines/pipelines.md rename to docs/en/how-to-guides/advanced-user-guides/manage-projects/ci-cd-pipelines.md index a64a73e6dcc..91216961798 100644 --- a/docs/en/project-admin/pipelines/pipelines.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-projects/ci-cd-pipelines.md @@ -13,4 +13,4 @@ After configuring Rancher and GitHub, you can deploy containers running Jenkins - Run unit tests. - Run regression tests. -For details, refer to the [pipelines]({{}}/rancher/v2.6/en/pipelines) section. \ No newline at end of file +For details, refer to the [pipelines](../../../pages-for-subheaders/pipelines.md) section. \ No newline at end of file diff --git a/docs/en/project-admin/namespaces/namespaces.md b/docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-namespaces.md similarity index 69% rename from docs/en/project-admin/namespaces/namespaces.md rename to docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-namespaces.md index a7d6c18d5c4..6fd40501674 100644 --- a/docs/en/project-admin/namespaces/namespaces.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-namespaces.md @@ -9,20 +9,20 @@ Although you assign resources at the project level so that each namespace in the Resources that you can assign directly to namespaces include: -- [Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/) -- [Load Balancers/Ingress]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/) -- [Service Discovery Records]({{}}/rancher/v2.6/en/k8s-in-rancher/service-discovery/) -- [Persistent Volume Claims]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/) -- [Certificates]({{}}/rancher/v2.6/en/k8s-in-rancher/certificates/) -- [ConfigMaps]({{}}/rancher/v2.6/en/k8s-in-rancher/configmaps/) -- [Registries]({{}}/rancher/v2.6/en/k8s-in-rancher/registries/) -- [Secrets]({{}}/rancher/v2.6/en/k8s-in-rancher/secrets/) +- [Workloads](../../../pages-for-subheaders/workloads-and-pods.md) +- [Load Balancers/Ingress](../../../pages-for-subheaders/load-balancer-and-ingress-controller.md) +- [Service Discovery Records](../../new-user-guides/kubernetes-resources-setup/create-services.md) +- [Persistent Volume Claims](../../../pages-for-subheaders/create-kubernetes-persistent-storage.md) +- [Certificates](../../new-user-guides/kubernetes-resources-setup/encrypt-http-communication.md) +- [ConfigMaps](../../new-user-guides/kubernetes-resources-setup/configmaps.md) +- [Registries](../../new-user-guides/kubernetes-resources-setup/kubernetes-and-docker-registries.md) +- [Secrets](../../new-user-guides/kubernetes-resources-setup/secrets.md) To manage permissions in a vanilla Kubernetes cluster, cluster admins configure role-based access policies for each namespace. With Rancher, user permissions are assigned on the project level instead, and permissions are automatically inherited by any namespace owned by the particular project. :::note -If you create a namespace with `kubectl`, it may be unusable because `kubectl` doesn't require your new namespace to be scoped within a project that you have access to. If your permissions are restricted to the project level, it is better to [create a namespace through Rancher]({{}}/rancher/v2.6/en/project-admin/namespaces) to ensure that you will have permission to access the namespace. +If you create a namespace with `kubectl`, it may be unusable because `kubectl` doesn't require your new namespace to be scoped within a project that you have access to. If your permissions are restricted to the project level, it is better to [create a namespace through Rancher](manage-namespaces.md) to ensure that you will have permission to access the namespace. ::: @@ -32,7 +32,7 @@ Create a new namespace to isolate apps and resources in a project. :::tip -When working with project resources that you can assign to a namespace (i.e., [workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/deploy-workloads/), [certificates]({{}}/rancher/v2.6/en/k8s-in-rancher/certificates/), [ConfigMaps]({{}}/rancher/v2.6/en/k8s-in-rancher/configmaps), etc.) you can create a namespace on the fly. +When working with project resources that you can assign to a namespace (i.e., [workloads](../../new-user-guides/kubernetes-resources-setup/workloads-and-pods/deploy-workloads.md), [certificates](../../new-user-guides/kubernetes-resources-setup/encrypt-http-communication.md), [ConfigMaps](../../new-user-guides/kubernetes-resources-setup/configmaps.md), etc.) you can create a namespace on the fly. ::: @@ -41,7 +41,7 @@ When working with project resources that you can assign to a namespace (i.e., [w 1. Click **Cluster > Projects/Namespaces**. 1. Go to the project where you want to add a namespace and click **Create Namespace**. Alternately, go to **Not in a Project** to create a namespace not associated with a project. -1. **Optional:** If your project has [Resource Quotas]({{}}/rancher/v2.6/en/project-admin/resource-quotas) in effect, you can override the default resource **Limits** (which places a cap on the resources that the namespace can consume). +1. **Optional:** If your project has [Resource Quotas](../../../pages-for-subheaders/manage-project-resource-quotas.md) in effect, you can override the default resource **Limits** (which places a cap on the resources that the namespace can consume). 1. Enter a **Name** and then click **Create**. @@ -61,7 +61,7 @@ Cluster admins and members may occasionally need to move a namespace to another :::note Notes: - Don't move the namespaces in the `System` project. Moving these namespaces can adversely affect cluster networking. - - You cannot move a namespace into a project that already has a [resource quota]({{}}/rancher/v2.6/en/project-admin/resource-quotas)configured. + - You cannot move a namespace into a project that already has a [resource quota](../../../pages-for-subheaders/manage-project-resource-quotas.md)configured. - If you move a namespace from a project that has a quota set to a project with no quota set, the quota is removed from the namespace. 1. Choose a new project for the new namespace and then click **Move**. Alternatively, you can remove the namespace from all projects by selecting **None**. @@ -72,4 +72,4 @@ Cluster admins and members may occasionally need to move a namespace to another You can always override the namespace default limit to provide a specific namespace with access to more (or less) project resources. -For more information, see how to [edit namespace resource quotas]({{}}/rancher/v2.6/en/project-admin//resource-quotas/override-namespace-default/). \ No newline at end of file +For more information, see how to [edit namespace resource quotas](project-admin//resource-quotas/override-namespace-default/). \ No newline at end of file diff --git a/docs/en/project-admin/pod-security-policies/pod-security-policies.md b/docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-pod-security-policies.md similarity index 84% rename from docs/en/project-admin/pod-security-policies/pod-security-policies.md rename to docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-pod-security-policies.md index faf681dbebf..6fa3506c692 100644 --- a/docs/en/project-admin/pod-security-policies/pod-security-policies.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-pod-security-policies.md @@ -5,7 +5,7 @@ weight: 5600 :::note -These cluster options are only available for [clusters in which Rancher has launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/). +These cluster options are only available for [clusters in which Rancher has launched Kubernetes](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md). ::: @@ -13,8 +13,8 @@ You can always assign a pod security policy (PSP) to an existing project if you ### Prerequisites -- Create a Pod Security Policy within Rancher. Before you can assign a default PSP to an existing project, you must have a PSP available for assignment. For instruction, see [Creating Pod Security Policies]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/). -- Assign a default Pod Security Policy to the project's cluster. You can't assign a PSP to a project until one is already applied to the cluster. For more information, see [the documentation about adding a pod security policy to a cluster]({{}}/rancher/v2.6/en/cluster-admin/pod-security-policy). +- Create a Pod Security Policy within Rancher. Before you can assign a default PSP to an existing project, you must have a PSP available for assignment. For instruction, see [Creating Pod Security Policies](../authentication-permissions-and-global-configuration/create-pod-security-policies.md). +- Assign a default Pod Security Policy to the project's cluster. You can't assign a PSP to a project until one is already applied to the cluster. For more information, see [the documentation about adding a pod security policy to a cluster](../manage-clusters/add-a-pod-security-policy.md). ### Applying a Pod Security Policy diff --git a/docs/en/project-admin/resource-quotas/quotas-for-projects/quotas-for-projects.md b/docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/about-project-resource-quotas.md similarity index 96% rename from docs/en/project-admin/resource-quotas/quotas-for-projects/quotas-for-projects.md rename to docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/about-project-resource-quotas.md index 7e2aaf3e869..a061b338312 100644 --- a/docs/en/project-admin/resource-quotas/quotas-for-projects/quotas-for-projects.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/about-project-resource-quotas.md @@ -10,7 +10,7 @@ In a standard Kubernetes deployment, resource quotas are applied to individual n In the following diagram, a Kubernetes administrator is trying to enforce a resource quota without Rancher. The administrator wants to apply a resource quota that sets the same CPU and memory limit to every namespace in his cluster (`Namespace 1-4`) . However, in the base version of Kubernetes, each namespace requires a unique resource quota. The administrator has to create four different resource quotas that have the same specs configured (`Resource Quota 1-4`) and apply them individually. Base Kubernetes: Unique Resource Quotas Being Applied to Each Namespace -![Native Kubernetes Resource Quota Implementation]({{}}/img/rancher/kubernetes-resource-quota.svg) +![Native Kubernetes Resource Quota Implementation](/img/kubernetes-resource-quota.svg) Resource quotas are a little different in Rancher. In Rancher, you apply a resource quota to the project, and then the quota propagates to each namespace, whereafter Kubernetes enforces your limits using the native version of resource quotas. If you want to change the quota for a specific namespace, you can override it. @@ -30,7 +30,7 @@ The resource quota includes two limits, which you set while creating or editing In the following diagram, a Rancher administrator wants to apply a resource quota that sets the same CPU and memory limit for every namespace in their project (`Namespace 1-4`). However, in Rancher, the administrator can set a resource quota for the project (`Project Resource Quota`) rather than individual namespaces. This quota includes resource limits for both the entire project (`Project Limit`) and individual namespaces (`Namespace Default Limit`). Rancher then propagates the `Namespace Default Limit` quotas to each namespace (`Namespace Resource Quota`) when created. Rancher: Resource Quotas Propagating to Each Namespace -![Rancher Resource Quota Implementation]({{}}/img/rancher/rancher-resource-quota.png) +![Rancher Resource Quota Implementation](/img/rancher-resource-quota.png) Let's highlight some more nuanced functionality for namespaces created **_within_** the Rancher UI. If a quota is deleted at the project level, it will also be removed from all namespaces contained within that project, despite any overrides that may exist. Further, updating an existing namespace default limit for a quota at the project level will not result in that value being propagated to existing namespaces in the project; the updated value will only be applied to newly created namespaces in that project. To update a namespace default limit for existing namespaces you can delete and subsequently recreate the quota at the project level with the new default value. This will result in the new default value being applied to all existing namespaces in the project. diff --git a/docs/en/project-admin/resource-quotas/override-namespace-default/override-namespace-default.md b/docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/override-default-limit-in-namespaces.md similarity index 78% rename from docs/en/project-admin/resource-quotas/override-namespace-default/override-namespace-default.md rename to docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/override-default-limit-in-namespaces.md index 208f4788786..05f4c3b682c 100644 --- a/docs/en/project-admin/resource-quotas/override-namespace-default/override-namespace-default.md +++ b/docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/override-default-limit-in-namespaces.md @@ -5,12 +5,12 @@ weight: 2 Although the **Namespace Default Limit** propagates from the project to each namespace when created, in some cases, you may need to increase (or decrease) the quotas for a specific namespace. In this situation, you can override the default limits by editing the namespace. -In the diagram below, the Rancher administrator has a resource quota in effect for their project. However, the administrator wants to override the namespace limits for `Namespace 3` so that it has more resources available. Therefore, the administrator [raises the namespace limits]({{}}/rancher/v2.6/en/cluster-admin/projects-and-namespaces/) for `Namespace 3` so that the namespace can access more resources. +In the diagram below, the Rancher administrator has a resource quota in effect for their project. However, the administrator wants to override the namespace limits for `Namespace 3` so that it has more resources available. Therefore, the administrator [raises the namespace limits](../../manage-clusters/projects-and-namespaces.md) for `Namespace 3` so that the namespace can access more resources. Namespace Default Limit Override -![Namespace Default Limit Override]({{}}/img/rancher/rancher-resource-quota-override.svg) +![Namespace Default Limit Override](/img/rancher-resource-quota-override.svg) -How to: [Editing Namespace Resource Quotas]({{}}/rancher/v2.6/en/cluster-admin/projects-and-namespaces/) +How to: [Editing Namespace Resource Quotas](../../manage-clusters/projects-and-namespaces.md) ### Editing Namespace Resource Quotas @@ -22,7 +22,7 @@ If there is a resource quota configured for a project, you can override the name 1. Find the namespace for which you want to edit the resource quota. Click **⋮ > Edit Config**. 1. Edit the resource limits. These limits determine the resources available to the namespace. The limits must be set within the configured project limits. - For more information about each **Resource Type**, see [the type reference]({{}}/rancher/v2.6/en/project-admin/resource-quotas/quota-type-reference/). + For more information about each **Resource Type**, see [the type reference](resource-quota-types.md). :::note diff --git a/docs/en/project-admin/resource-quotas/quota-type-reference/quota-type-reference.md b/docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/resource-quota-types.md similarity index 100% rename from docs/en/project-admin/resource-quotas/quota-type-reference/quota-type-reference.md rename to docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/resource-quota-types.md diff --git a/docs/en/project-admin/resource-quotas/override-container-default/override-container-default.md b/docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/set-container-default-resource-limits.md similarity index 100% rename from docs/en/project-admin/resource-quotas/override-container-default/override-container-default.md rename to docs/en/how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/set-container-default-resource-limits.md diff --git a/docs/en/monitoring-alerting/guides/persist-grafana/persist-grafana.md b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md similarity index 98% rename from docs/en/monitoring-alerting/guides/persist-grafana/persist-grafana.md rename to docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md index 559a183c2c6..a0bc1a29949 100644 --- a/docs/en/monitoring-alerting/guides/persist-grafana/persist-grafana.md +++ b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md @@ -20,7 +20,7 @@ To allow the Grafana dashboard to persist after the Grafana instance restarts, a - The monitoring application needs to be installed. - To create the persistent dashboard, you must have at least the **Manage Config Maps** Rancher RBAC permissions assigned to you in the project or namespace that contains the Grafana Dashboards. This correlates to the `monitoring-dashboard-edit` or `monitoring-dashboard-admin` Kubernetes native RBAC Roles exposed by the Monitoring chart. -- To see the links to the external monitoring UIs, including Grafana dashboards, you will need at least a [project-member role.]({{}}/rancher/v2.6/en/monitoring-alerting/rbac/#users-with-rancher-cluster-manager-based-permissions) +- To see the links to the external monitoring UIs, including Grafana dashboards, you will need at least a [project-member role.](../../../explanations/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md#users-with-rancher-cluster-manager-based-permissions) ::: diff --git a/docs/en/monitoring-alerting/guides/customize-grafana/customize-grafana.md b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/customize-grafana-dashboard.md similarity index 90% rename from docs/en/monitoring-alerting/guides/customize-grafana/customize-grafana.md rename to docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/customize-grafana-dashboard.md index c6154f6ff50..ad266ba8c19 100644 --- a/docs/en/monitoring-alerting/guides/customize-grafana/customize-grafana.md +++ b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/customize-grafana-dashboard.md @@ -9,7 +9,7 @@ In this section, you'll learn how to customize the Grafana dashboard to show met Before you can customize a Grafana dashboard, the `rancher-monitoring` application must be installed. -To see the links to the external monitoring UIs, including Grafana dashboards, you will need at least a [project-member role.]({{}}/rancher/v2.6/en/monitoring-alerting/rbac/#users-with-rancher-cluster-manager-based-permissions) +To see the links to the external monitoring UIs, including Grafana dashboards, you will need at least a [project-member role.](../../../explanations/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md#users-with-rancher-cluster-manager-based-permissions) ### Signing in to Grafana diff --git a/docs/en/monitoring-alerting/guides/memory-usage/memory-usage.md b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/debug-high-memory-usage.md similarity index 100% rename from docs/en/monitoring-alerting/guides/memory-usage/memory-usage.md rename to docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/debug-high-memory-usage.md diff --git a/docs/en/monitoring-alerting/guides/enable-monitoring/enable-monitoring.md b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/enable-monitoring.md similarity index 69% rename from docs/en/monitoring-alerting/guides/enable-monitoring/enable-monitoring.md rename to docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/enable-monitoring.md index 715a16782f1..2244470709f 100644 --- a/docs/en/monitoring-alerting/guides/enable-monitoring/enable-monitoring.md +++ b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/enable-monitoring.md @@ -3,7 +3,7 @@ title: Enable Monitoring weight: 1 --- -As an [administrator]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) or [cluster owner]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#cluster-roles), you can configure Rancher to deploy Prometheus to monitor your Kubernetes cluster. +As an [administrator](../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md) or [cluster owner](../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#cluster-roles), you can configure Rancher to deploy Prometheus to monitor your Kubernetes cluster. This page describes how to enable monitoring and alerting within a cluster using the new monitoring application. @@ -12,7 +12,7 @@ You can enable monitoring with or without SSL. # Requirements - Make sure that you are allowing traffic on port 9796 for each of your nodes because Prometheus will scrape metrics from here. -- Make sure your cluster fulfills the resource requirements. The cluster should have at least 1950Mi memory available, 2700m CPU, and 50Gi storage. A breakdown of the resource limits and requests is [here.]({{}}/rancher/v2.6/en/monitoring-alerting/configuration/helm-chart-options/#configuring-resource-limits-and-requests) +- Make sure your cluster fulfills the resource requirements. The cluster should have at least 1950Mi memory available, 2700m CPU, and 50Gi storage. A breakdown of the resource limits and requests is [here.](../../../reference-guides/monitoring-v2-configuration/helm-chart-options.md#configuring-resource-limits-and-requests) - When installing monitoring on an RKE cluster using RancherOS or Flatcar Linux nodes, change the etcd node certificate directory to `/opt/rke/etc/kubernetes/ssl`. - For clusters provisioned with the RKE CLI and the address is set to a hostname instead of an IP address, set `rkeEtcd.clients.useLocalhost` to `true` during the Values configuration step of the installation. The YAML snippet will look like the following: @@ -32,7 +32,7 @@ If you want to set up Alertmanager, Grafana or Ingress, it has to be done with t The resource requests and limits can be configured when installing `rancher-monitoring`. To configure Prometheus resources from the Rancher UI, click **Apps & Marketplace > Monitoring** in the upper left corner. -For more information about the default limits, see [this page.]({{}}/rancher/v2.6/en/monitoring-alerting/configuration/helm-chart-options/#configuring-resource-limits-and-requests) +For more information about the default limits, see [this page.](../../../reference-guides/monitoring-v2-configuration/helm-chart-options.md#configuring-resource-limits-and-requests) # Install the Monitoring Application @@ -42,13 +42,13 @@ For more information about the default limits, see [this page.]({{}}/ra 1. Go to the cluster that you created and click **Explore**. 1. Click **Cluster Tools** (bottom left corner). 1. Click **Install** by Monitoring. -1. Optional: Customize requests, limits and more for Alerting, Prometheus, and Grafana in the Values step. For help, refer to the [configuration reference.]({{}}/rancher/v2.6/en/monitoring-alerting/configuration/helm-chart-options/) +1. Optional: Customize requests, limits and more for Alerting, Prometheus, and Grafana in the Values step. For help, refer to the [configuration reference.](../../../reference-guides/monitoring-v2-configuration/helm-chart-options.md) **Result:** The monitoring app is deployed in the `cattle-monitoring-system` namespace. ### Enable Monitoring for use with SSL -1. Follow the steps on [this page]({{}}/rancher/v2.6/en/k8s-in-rancher/secrets/) to create a secret in order for SSL to be used for alerts. +1. Follow the steps on [this page](../../new-user-guides/kubernetes-resources-setup/secrets.md) to create a secret in order for SSL to be used for alerts. - The secret should be created in the `cattle-monitoring-system` namespace. If it doesn't exist, create it first. - Add the `ca`, `cert`, and `key` files to the secret. 1. In the upper left corner, click **☰ > Cluster Management**. @@ -62,7 +62,7 @@ For more information about the default limits, see [this page.]({{}}/ra **Result:** The monitoring app is deployed in the `cattle-monitoring-system` namespace. -When [creating a receiver,]({{}}/rancher/v2.6/en/monitoring-alerting/configuration/advanced/alertmanager/#creating-receivers-in-the-rancher-ui) SSL-enabled receivers such as email or webhook will have a **SSL** section with fields for **CA File Path**, **Cert File Path**, and **Key File Path**. Fill in these fields with the paths to each of `ca`, `cert`, and `key`. The path will be of the form `/etc/alertmanager/secrets/name-of-file-in-secret`. +When [creating a receiver,](../monitoring-v2-configuration-guides/advanced-configuration/alertmanager.md#creating-receivers-in-the-rancher-ui) SSL-enabled receivers such as email or webhook will have a **SSL** section with fields for **CA File Path**, **Cert File Path**, and **Key File Path**. Fill in these fields with the paths to each of `ca`, `cert`, and `key`. The path will be of the form `/etc/alertmanager/secrets/name-of-file-in-secret`. For example, if you created a secret with these key-value pairs: diff --git a/docs/en/monitoring-alerting/guides/migrating/migrating.md b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/migrate-to-rancher-v2.5+-monitoring.md similarity index 94% rename from docs/en/monitoring-alerting/guides/migrating/migrating.md rename to docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/migrate-to-rancher-v2.5+-monitoring.md index 09178d20d66..76478d44f7f 100644 --- a/docs/en/monitoring-alerting/guides/migrating/migrating.md +++ b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/migrate-to-rancher-v2.5+-monitoring.md @@ -32,13 +32,13 @@ Unlike in Monitoring & Alerting V1, both features are packaged in a single Helm Monitoring V2 can only be configured on the cluster level. Project-level monitoring and alerting is no longer supported. -For more information on how to configure Monitoring & Alerting V2, see [this page.]({{}}/rancher/v2.6/en/monitoring-alerting/configuration) +For more information on how to configure Monitoring & Alerting V2, see [this page.](../../../pages-for-subheaders/monitoring-v2-configuration-guides.md) # Changes to Role-based Access Control Project owners and members no longer get access to Grafana or Prometheus by default. If view-only users had access to Grafana, they would be able to see data from any namespace. For Kiali, any user can edit things they don’t own in any namespace. -For more information about role-based access control in `rancher-monitoring`, refer to [this page.]({{}}/rancher/v2.6/en/monitoring-alerting/rbac) +For more information about role-based access control in `rancher-monitoring`, refer to [this page.](../../../explanations/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md) # Migrating from Monitoring V1 to Monitoring V2 @@ -99,7 +99,7 @@ It is only possible to directly migrate expression-based alerts to Monitoring V2 To migrate the following expression alert -{{< img "/img/rancher/monitoring/migration/alert_2.4_to_2.5_source.png" "">}} +![](/img/monitoring/migration/alert_2.4_to_2.5_source.png) you have to either create a PrometheusRule configuration like this in any namespace @@ -124,9 +124,9 @@ spec: or add the Prometheus Rule through the Cluster Explorer -{{< img "/img/rancher/monitoring/migration/alert_2.4_to_2.5_target.png" "">}} +![](/img/monitoring/migration/alert_2.4_to_2.5_target.png) -For more details on how to configure PrometheusRules in Monitoring V2 see [Monitoring Configuration]({{}}/rancher/v2.6/en/monitoring-alerting/configuration/). +For more details on how to configure PrometheusRules in Monitoring V2 see [Monitoring Configuration](../../../pages-for-subheaders/monitoring-v2-configuration-guides.md). ### Migrating Notifiers diff --git a/docs/en/monitoring-alerting/prometheus-federator/guides/customizing-grafana/customizing-grafana.md b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/customize-grafana-dashboards.md similarity index 69% rename from docs/en/monitoring-alerting/prometheus-federator/guides/customizing-grafana/customizing-grafana.md rename to docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/customize-grafana-dashboards.md index f5cc1e5653d..fa13cc4c523 100644 --- a/docs/en/monitoring-alerting/prometheus-federator/guides/customizing-grafana/customizing-grafana.md +++ b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/customize-grafana-dashboards.md @@ -5,4 +5,4 @@ weight: 3 Grafana dashboards are customized the same way whether it's for rancher-monitoring or for Prometheus Federator. -For instructions, refer to [this page](../../../guides/customize-grafana/). \ No newline at end of file +For instructions, refer to [this page](../customize-grafana-dashboard.md). \ No newline at end of file diff --git a/docs/en/monitoring-alerting/prometheus-federator/guides/enable-prom-fed/enable-prom-fed.md b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/enable-prometheus-federator.md similarity index 99% rename from docs/en/monitoring-alerting/prometheus-federator/guides/enable-prom-fed/enable-prom-fed.md rename to docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/enable-prometheus-federator.md index 963c38ea9d3..6264d66c42f 100644 --- a/docs/en/monitoring-alerting/prometheus-federator/guides/enable-prom-fed/enable-prom-fed.md +++ b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/enable-prometheus-federator.md @@ -10,7 +10,7 @@ weight: 1 By default, Prometheus Federator is configured and intended to be deployed alongside [rancher-monitoring](https://rancher.com/docs/rancher/v2.6/en/monitoring-alerting/), which deploys Prometheus Operator alongside a Cluster Prometheus that each Project Monitoring Stack is configured to federate namespace-scoped metrics from by default. -For instructions on installing rancher-monitoring, refer to [this page](../../../guides/enable-monitoring/). +For instructions on installing rancher-monitoring, refer to [this page](../enable-monitoring.md). The default configuration should already be compatible with your rancher-monitoring stack. However, to optimize the security and usability of Prometheus Federator in your cluster, we recommend making these additional configurations to rancher-monitoring: diff --git a/docs/en/monitoring-alerting/prometheus-federator/guides/prom-fed-workloads/prom-fed-workloads.md b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/set-up-workloads.md similarity index 77% rename from docs/en/monitoring-alerting/prometheus-federator/guides/prom-fed-workloads/prom-fed-workloads.md rename to docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/set-up-workloads.md index 1b2025f31b6..014724b3b7d 100644 --- a/docs/en/monitoring-alerting/prometheus-federator/guides/prom-fed-workloads/prom-fed-workloads.md +++ b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/set-up-workloads.md @@ -9,10 +9,10 @@ weight: 4 ### Display CPU and Memory Metrics for a Workload -Displaying CPU and memory metrics with Prometheus Federator is done the same way as with rancher-monitoring. For instructions, refer [here](../../../guides/monitoring-workloads#display-cpu-and-memory-metrics-for-a-workload). +Displaying CPU and memory metrics with Prometheus Federator is done the same way as with rancher-monitoring. For instructions, refer [here](../set-up-monitoring-for-workloads.md#display-cpu-and-memory-metrics-for-a-workload). ### Setting up Metrics Beyond CPU and Memory -Setting up metrics beyond CPU and memory with Prometheus Federator is done the same way as with rancher-monitoring. For instructions, refer [here](../../../guides/monitoring-workloads#setting-up-metrics-beyond-cpu-and-memory). +Setting up metrics beyond CPU and memory with Prometheus Federator is done the same way as with rancher-monitoring. For instructions, refer [here](../set-up-monitoring-for-workloads.md#setting-up-metrics-beyond-cpu-and-memory). diff --git a/docs/en/monitoring-alerting/prometheus-federator/guides/uninstall-prom-fed/uninstall-prom-fed.md b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/uninstall-prometheus-federator.md similarity index 100% rename from docs/en/monitoring-alerting/prometheus-federator/guides/uninstall-prom-fed/uninstall-prom-fed.md rename to docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/uninstall-prometheus-federator.md diff --git a/docs/en/monitoring-alerting/guides/monitoring-workloads/monitoring-workloads.md b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/set-up-monitoring-for-workloads.md similarity index 100% rename from docs/en/monitoring-alerting/guides/monitoring-workloads/monitoring-workloads.md rename to docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/set-up-monitoring-for-workloads.md diff --git a/docs/en/monitoring-alerting/guides/uninstall/uninstall.md b/docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/uninstall-monitoring.md similarity index 100% rename from docs/en/monitoring-alerting/guides/uninstall/uninstall.md rename to docs/en/how-to-guides/advanced-user-guides/monitoring-alerting-guides/uninstall-monitoring.md diff --git a/docs/en/monitoring-alerting/configuration/advanced/alertmanager/alertmanager.md b/docs/en/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager.md similarity index 95% rename from docs/en/monitoring-alerting/configuration/advanced/alertmanager/alertmanager.md rename to docs/en/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager.md index 9dd2ca29608..c532bee5600 100644 --- a/docs/en/monitoring-alerting/configuration/advanced/alertmanager/alertmanager.md +++ b/docs/en/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager.md @@ -9,7 +9,7 @@ When Receivers and Routes are updated, the monitoring application will automatic :::note -This section assumes familiarity with how monitoring components work together. For more information about Alertmanager, see [this section.](../../../how-monitoring-works/#3-how-alertmanager-works) +This section assumes familiarity with how monitoring components work together. For more information about Alertmanager, see [this section.](../../../../explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works.md#3-how-alertmanager-works) ::: diff --git a/docs/en/monitoring-alerting/configuration/advanced/prometheus/prometheus.md b/docs/en/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheus.md similarity index 91% rename from docs/en/monitoring-alerting/configuration/advanced/prometheus/prometheus.md rename to docs/en/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheus.md index 136d58de064..da04c259320 100644 --- a/docs/en/monitoring-alerting/configuration/advanced/prometheus/prometheus.md +++ b/docs/en/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheus.md @@ -7,7 +7,7 @@ It is usually not necessary to directly edit the Prometheus custom resource beca :::note -This section assumes familiarity with how monitoring components work together. For more information, see [this section.](../../../how-monitoring-works/) +This section assumes familiarity with how monitoring components work together. For more information, see [this section.](../../../../explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works.md) ::: diff --git a/docs/en/monitoring-alerting/configuration/advanced/prometheusrules/prometheusrules.md b/docs/en/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheusrules.md similarity index 93% rename from docs/en/monitoring-alerting/configuration/advanced/prometheusrules/prometheusrules.md rename to docs/en/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheusrules.md index 6e4a82344ed..1e884534062 100644 --- a/docs/en/monitoring-alerting/configuration/advanced/prometheusrules/prometheusrules.md +++ b/docs/en/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheusrules.md @@ -7,7 +7,7 @@ A PrometheusRule defines a group of Prometheus alerting and/or recording rules. :::note -This section assumes familiarity with how monitoring components work together. For more information, see [this section.]({{}}/rancher/v2.6/en/monitoring-alerting/how-monitoring-works) +This section assumes familiarity with how monitoring components work together. For more information, see [this section.](../../../../explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works.md) ::: @@ -64,7 +64,7 @@ For examples, refer to the Prometheus documentation on [recording rules](https:/ |-------|----------------| | Alert Name | The name of the alert. Must be a valid label value. | | Wait To Fire For | Duration in seconds. Alerts are considered firing once they have been returned for this long. Alerts which have not yet fired for long enough are considered pending. | -| PromQL Expression | The PromQL expression to evaluate. Prometheus will evaluate the current value of this PromQL expression on every evaluation cycle and all resultant time series will become pending/firing alerts. For more information, refer to the [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/querying/basics/) or our [example PromQL expressions.](../../../expression) | +| PromQL Expression | The PromQL expression to evaluate. Prometheus will evaluate the current value of this PromQL expression on every evaluation cycle and all resultant time series will become pending/firing alerts. For more information, refer to the [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/querying/basics/) or our [example PromQL expressions.](monitoring-alertimonitoring-alerting/configuration/advanced/expression) | | Labels | Labels to add or overwrite for each alert. | | Severity | When enabled, labels are attached to the alert or record that identify it by the severity level. | | Severity Label Value | Critical, warning, or none | @@ -77,5 +77,5 @@ For examples, refer to the Prometheus documentation on [recording rules](https:/ | Field | Description | |-------|----------------| | Time Series Name | The name of the time series to output to. Must be a valid metric name. | -| PromQL Expression | The PromQL expression to evaluate. Prometheus will evaluate the current value of this PromQL expression on every evaluation cycle and the result will be recorded as a new set of time series with the metric name as given by 'record'. For more information about expressions, refer to the [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/querying/basics/) or our [example PromQL expressions.](../expression) | +| PromQL Expression | The PromQL expression to evaluate. Prometheus will evaluate the current value of this PromQL expression on every evaluation cycle and the result will be recorded as a new set of time series with the metric name as given by 'record'. For more information about expressions, refer to the [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/querying/basics/) or our [example PromQL expressions.](monitoring-alerting/configuration/advanced/expression) | | Labels | Labels to add or overwrite before storing the result. | diff --git a/docs/en/backups/docker-installs/docker-backups/docker-backups.md b/docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-docker-installed-rancher.md similarity index 94% rename from docs/en/backups/docker-installs/docker-backups/docker-backups.md rename to docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-docker-installed-rancher.md index 274a0ece9ea..261a1a86f68 100644 --- a/docs/en/backups/docker-installs/docker-backups/docker-backups.md +++ b/docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-docker-installed-rancher.md @@ -20,7 +20,7 @@ Cross reference the image and reference table below to learn how to obtain this Terminal docker ps Command, Displaying Where to Find <RANCHER_CONTAINER_TAG> and <RANCHER_CONTAINER_NAME> -![Placeholder Reference]({{}}/img/rancher/placeholder-ref.png) +![Placeholder Reference](/img/placeholder-ref.png) | Placeholder | Example | Description | | -------------------------- | -------------------------- | --------------------------------------------------------- | @@ -68,4 +68,4 @@ This procedure creates a backup that you can restore if Rancher encounters a dis docker start ``` -**Result:** A backup tarball of your Rancher Server data is created. See [Restoring Backups: Docker Installs]({{}}/rancher/v2.6/en/backups/docker-installs/docker-restores) if you need to restore backup data. +**Result:** A backup tarball of your Rancher Server data is created. See [Restoring Backups: Docker Installs](restore-docker-installed-rancher.md) if you need to restore backup data. diff --git a/docs/en/cluster-admin/backing-up-etcd/backing-up-etcd.md b/docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher-launched-kubernetes-clusters.md similarity index 89% rename from docs/en/cluster-admin/backing-up-etcd/backing-up-etcd.md rename to docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher-launched-kubernetes-clusters.md index 7602c62450a..94774115f1c 100644 --- a/docs/en/cluster-admin/backing-up-etcd/backing-up-etcd.md +++ b/docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher-launched-kubernetes-clusters.md @@ -3,7 +3,7 @@ title: Backing up a Cluster weight: 2045 --- -In the Rancher UI, etcd backup and recovery for [Rancher launched Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) can be easily performed. +In the Rancher UI, etcd backup and recovery for [Rancher launched Kubernetes clusters](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) can be easily performed. Rancher recommends configuring recurrent `etcd` snapshots for all production clusters. Additionally, one-time snapshots can easily be taken as well. @@ -83,7 +83,7 @@ On restore, the following process is used: Select how often you want recurring snapshots to be taken as well as how many snapshots to keep. The amount of time is measured in hours. With timestamped snapshots, the user has the ability to do a point-in-time recovery. -By default, [Rancher launched Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) are configured to take recurring snapshots (saved to local disk). To protect against local disk failure, using the [S3 Target](#s3-backup-target) or replicating the path on disk is advised. +By default, [Rancher launched Kubernetes clusters](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) are configured to take recurring snapshots (saved to local disk). To protect against local disk failure, using the [S3 Target](#s3-backup-target) or replicating the path on disk is advised. During cluster provisioning or editing the cluster, the configuration for snapshots can be found in the advanced section for **Cluster Options**. Click on **Show advanced options**. @@ -115,7 +115,7 @@ Rancher supports two different backup targets: ### Local Backup Target -By default, the `local` backup target is selected. The benefits of this option is that there is no external configuration. Snapshots are automatically saved locally to the etcd nodes in the [Rancher launched Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) in `/opt/rke/etcd-snapshots`. All recurring snapshots are taken at configured intervals. The downside of using the `local` backup target is that if there is a total disaster and _all_ etcd nodes are lost, there is no ability to restore the cluster. +By default, the `local` backup target is selected. The benefits of this option is that there is no external configuration. Snapshots are automatically saved locally to the etcd nodes in the [Rancher launched Kubernetes clusters](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) in `/opt/rke/etcd-snapshots`. All recurring snapshots are taken at configured intervals. The downside of using the `local` backup target is that if there is a total disaster and _all_ etcd nodes are lost, there is no ability to restore the cluster. ### S3 Backup Target @@ -163,4 +163,4 @@ This option is not available directly in the UI, and is only available through t # Enabling Snapshot Features for Clusters Created Before Rancher v2.2.0 -If you have any Rancher launched Kubernetes clusters that were created before v2.2.0, after upgrading Rancher, you must [edit the cluster]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/) and _save_ it, in order to enable the updated snapshot features. Even if you were already creating snapshots before v2.2.0, you must do this step as the older snapshots will not be available to use to [back up and restore etcd through the UI]({{}}/rancher/v2.6/en/cluster-admin/restoring-etcd/). +If you have any Rancher launched Kubernetes clusters that were created before v2.2.0, after upgrading Rancher, you must [edit the cluster](../../../pages-for-subheaders/cluster-configuration.md) and _save_ it, in order to enable the updated snapshot features. Even if you were already creating snapshots before v2.2.0, you must do this step as the older snapshots will not be available to use to [back up and restore etcd through the UI](restore-rancher-launched-kubernetes-clusters-from-backup.md). diff --git a/docs/en/backups/back-up-rancher/back-up-rancher.md b/docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md similarity index 80% rename from docs/en/backups/back-up-rancher/back-up-rancher.md rename to docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md index 2f4fc3880cd..2142323dd13 100644 --- a/docs/en/backups/back-up-rancher/back-up-rancher.md +++ b/docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md @@ -3,7 +3,7 @@ title: Backing up Rancher weight: 1 --- -In this section, you'll learn how to back up Rancher running on any Kubernetes cluster. To backup Rancher installed with Docker, refer the instructions for [single node backups]({{}}/rancher/v2.6/en/backups/docker-installs/docker-backups) +In this section, you'll learn how to back up Rancher running on any Kubernetes cluster. To backup Rancher installed with Docker, refer the instructions for [single node backups](back-up-docker-installed-rancher.md) The backup-restore operator needs to be installed in the local cluster, and only backs up the Rancher app. The backup and restore operations are performed only in the local Kubernetes cluster. @@ -19,7 +19,7 @@ When restoring a backup into a new Rancher setup, the version of the new setup s The Rancher version must be v2.5.0 and up. -Refer [here]({{}}/rancher/v2.6/en/backups/migrating-rancher/#2-restore-from-backup-using-a-restore-custom-resource) for help on restoring an existing backup file into a v1.22 cluster in Rancher v2.6.3. +Refer [here](migrate-rancher-to-new-cluster.md#2-restore-from-backup-using-a-restore-custom-resource) for help on restoring an existing backup file into a v1.22 cluster in Rancher v2.6.3. ### 1. Install the Rancher Backups operator @@ -32,12 +32,12 @@ Backups are created as .tar.gz files. These files can be pushed to S3 or Minio, 1. Click **Apps & Marketplace > Charts**. 1. Click **Rancher Backups**. 1. Click **Install**. -1. Configure the default storage location. For help, refer to the [storage configuration section.](../configuration/storage-config) +1. Configure the default storage location. For help, refer to the [storage configuration section.](../../../reference-guides/backup-restore-configuration/storage-configuration.md) 1. Click **Install**. :::note -There is a known issue in Fleet that occurs after performing a restoration using the backup-restore-operator: Secrets used for clientSecretName and helmSecretName are not included in Fleet gitrepos. Refer [here]({{}}/rancher/v2.6/en/deploy-across-clusters/fleet/#troubleshooting) for a workaround. +There is a known issue in Fleet that occurs after performing a restoration using the backup-restore-operator: Secrets used for clientSecretName and helmSecretName are not included in Fleet gitrepos. Refer [here](../deploy-apps-across-clusters/fleet.md#troubleshooting) for a workaround. ::: @@ -50,7 +50,7 @@ To perform a backup, a custom resource of type Backup must be created. 1. In the left navigation bar, click **Rancher Backups > Backups**. 1. Click **Create**. 1. Create the Backup with the form, or with the YAML editor. -1. For configuring the Backup details using the form, click **Create** and refer to the [configuration reference](../configuration/backup-config) and to the [examples.](../examples/#backup) +1. For configuring the Backup details using the form, click **Create** and refer to the [configuration reference](../../../reference-guides/backup-restore-configuration/backup-configuration.md) and to the [examples.](../../../reference-guides/backup-restore-configuration/examples.md#backup) 1. For using the YAML editor, we can click **Create > Create from YAML**. Enter the Backup YAML. This example Backup custom resource would create encrypted recurring backups in S3. The app uses the `credentialSecretNamespace` value to determine where to look for the S3 backup secret: ```yaml @@ -79,7 +79,7 @@ To perform a backup, a custom resource of type Backup must be created. ::: - For help configuring the Backup, refer to the [configuration reference](../configuration/backup-config) and to the [examples.](../examples/#backup) + For help configuring the Backup, refer to the [configuration reference](../../../reference-guides/backup-restore-configuration/backup-configuration.md) and to the [examples.](../../../reference-guides/backup-restore-configuration/examples.md#backup) :::caution diff --git a/docs/en/backups/migrating-rancher/migrating-rancher.md b/docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md similarity index 91% rename from docs/en/backups/migrating-rancher/migrating-rancher.md rename to docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md index e18f04fcf16..b3ac971ca91 100644 --- a/docs/en/backups/migrating-rancher/migrating-rancher.md +++ b/docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md @@ -7,7 +7,7 @@ If you are migrating Rancher to a new Kubernetes cluster, you don't need to inst ### Prerequisites -These instructions assume you have [created a backup](../back-up-rancher) and you have already installed a new Kubernetes cluster where Rancher will be deployed. +These instructions assume you have [created a backup](back-up-rancher.md) and you have already installed a new Kubernetes cluster where Rancher will be deployed. :::caution @@ -19,8 +19,8 @@ Rancher version must be v2.5.0 and up Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes clusters such as Amazon EKS clusters. For help installing Kubernetes, refer to the documentation of the Kubernetes distribution. One of Rancher's Kubernetes distributions may also be used: -- [RKE Kubernetes installation docs]({{}}/rke/latest/en/installation/) -- [K3s Kubernetes installation docs]({{}}/k3s/latest/en/installation/) +- [RKE Kubernetes installation docs](https://rancher.com/docs/rke/latest/en/installation/) +- [K3s Kubernetes installation docs](https://rancher.com/docs/k3s/latest/en/installation/) ### 1. Install the rancher-backup Helm chart Install version 2.x.x of the rancher-backup chart. The following assumes a connected environment with access to DockerHub: @@ -128,7 +128,7 @@ Once the Restore resource has the status `Completed`, you can continue the Ranch ### 3. Install cert-manager -Follow the steps to [install cert-manager]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#5-install-cert-manager) in the documentation about installing cert-manager on Kubernetes. +Follow the steps to [install cert-manager](../../../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md#5-install-cert-manager) in the documentation about installing cert-manager on Kubernetes. ### 4. Bring up Rancher with Helm diff --git a/docs/en/backups/docker-installs/docker-restores/docker-restores.md b/docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-docker-installed-rancher.md similarity index 84% rename from docs/en/backups/docker-installs/docker-restores/docker-restores.md rename to docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-docker-installed-rancher.md index 3413be1bb9b..d5ca32d6afc 100644 --- a/docs/en/backups/docker-installs/docker-restores/docker-restores.md +++ b/docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-docker-installed-rancher.md @@ -22,7 +22,7 @@ Cross reference the image and reference table below to learn how to obtain this Terminal docker ps Command, Displaying Where to Find <RANCHER_CONTAINER_TAG> and <RANCHER_CONTAINER_NAME> -![Placeholder Reference]({{}}/img/rancher/placeholder-ref.png) +![Placeholder Reference](/img/placeholder-ref.png) | Placeholder | Example | Description | | -------------------------- | -------------------------- | --------------------------------------------------------- | @@ -36,7 +36,7 @@ You can obtain `` and `` by loggi ## Restoring Backups -Using a [backup]({{}}/rancher/v2.6/en/backups/docker-installs/docker-backups) that you created earlier, restore Rancher to its last known healthy state. +Using a [backup](back-up-docker-installed-rancher.md) that you created earlier, restore Rancher to its last known healthy state. 1. Using a remote Terminal connection, log into the node running your Rancher Server. @@ -45,9 +45,9 @@ Using a [backup]({{}}/rancher/v2.6/en/backups/docker-installs/docker-ba ``` docker stop ``` -1. Move the backup tarball that you created during completion of [Creating Backups—Docker Installs]({{}}/rancher/v2.6/en/backups/docker-installs/docker-backups) onto your Rancher Server. Change to the directory that you moved it to. Enter `dir` to confirm that it's there. +1. Move the backup tarball that you created during completion of [Creating Backups—Docker Installs](back-up-docker-installed-rancher.md) onto your Rancher Server. Change to the directory that you moved it to. Enter `dir` to confirm that it's there. - If you followed the naming convention we suggested in [Creating Backups—Docker Installs]({{}}/rancher/v2.6/en/backups/docker-installs/docker-backups/), it will have a name similar to `rancher-data-backup--.tar.gz`. + If you followed the naming convention we suggested in [Creating Backups—Docker Installs](back-up-docker-installed-rancher.md), it will have a name similar to `rancher-data-backup--.tar.gz`. 1. Enter the following command to delete your current state data and replace it with your backup data, replacing the placeholders. Don't forget to close the quotes. diff --git a/docs/en/cluster-admin/restoring-etcd/restoring-etcd.md b/docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup.md similarity index 68% rename from docs/en/cluster-admin/restoring-etcd/restoring-etcd.md rename to docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup.md index cbf52047c39..dc28c051d1f 100644 --- a/docs/en/cluster-admin/restoring-etcd/restoring-etcd.md +++ b/docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup.md @@ -3,9 +3,9 @@ title: Restoring a Cluster from Backup weight: 2050 --- -etcd backup and recovery for [Rancher launched Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) can be easily performed. Snapshots of the etcd database are taken and saved either locally onto the etcd nodes or to a S3 compatible target. The advantages of configuring S3 is that if all etcd nodes are lost, your snapshot is saved remotely and can be used to restore the cluster. +etcd backup and recovery for [Rancher launched Kubernetes clusters](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) can be easily performed. Snapshots of the etcd database are taken and saved either locally onto the etcd nodes or to a S3 compatible target. The advantages of configuring S3 is that if all etcd nodes are lost, your snapshot is saved remotely and can be used to restore the cluster. -Rancher recommends enabling the [ability to set up recurring snapshots of etcd]({{}}/rancher/v2.6/en/cluster-admin/backing-up-etcd/#configuring-recurring-snapshots), but [one-time snapshots]({{}}/rancher/v2.6/en/cluster-admin/backing-up-etcd/#one-time-snapshots) can easily be taken as well. Rancher allows restore from [saved snapshots](#restoring-a-cluster-from-a-snapshot) or if you don't have any snapshots, you can still [restore etcd](#recovering-etcd-without-a-snapshot). +Rancher recommends enabling the [ability to set up recurring snapshots of etcd](back-up-rancher-launched-kubernetes-clusters.md#configuring-recurring-snapshots), but [one-time snapshots](back-up-rancher-launched-kubernetes-clusters.md#one-time-snapshots) can easily be taken as well. Rancher allows restore from [saved snapshots](#restoring-a-cluster-from-a-snapshot) or if you don't have any snapshots, you can still [restore etcd](#recovering-etcd-without-a-snapshot). Clusters can also be restored to a prior Kubernetes version and cluster configuration. @@ -34,11 +34,11 @@ Snapshots are composed of the cluster data in etcd, the Kubernetes version, and - **Restore etcd and Kubernetes version:** This option should be used if a Kubernetes upgrade is the reason that your cluster is failing, and you haven't made any cluster configuration changes. - **Restore etcd, Kubernetes versions and cluster configuration:** This option should be used if you changed both the Kubernetes version and cluster configuration when upgrading. -When rolling back to a prior Kubernetes version, the [upgrade strategy options]({{}}/rancher/v2.6/en/cluster-admin/upgrading-kubernetes/#configuring-the-upgrade-strategy) are ignored. Worker nodes are not cordoned or drained before being reverted to the older Kubernetes version, so that an unhealthy cluster can be more quickly restored to a healthy state. +When rolling back to a prior Kubernetes version, the [upgrade strategy options](../../../getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes.md#configuring-the-upgrade-strategy) are ignored. Worker nodes are not cordoned or drained before being reverted to the older Kubernetes version, so that an unhealthy cluster can be more quickly restored to a healthy state. :::note Prerequisite: -To restore snapshots from S3, the cluster needs to be configured to [take recurring snapshots on S3.]({{}}/rancher/v2.6/en/cluster-admin/backing-up-etcd/#configuring-recurring-snapshots) +To restore snapshots from S3, the cluster needs to be configured to [take recurring snapshots on S3.](back-up-rancher-launched-kubernetes-clusters.md#configuring-recurring-snapshots) ::: @@ -78,8 +78,8 @@ If the group of etcd nodes loses quorum, the Kubernetes cluster will report a fa 5. Run the revised command. -6. After the single nodes is up and running, Rancher recommends adding additional etcd nodes to your cluster. If you have a [custom cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes) and you want to reuse an old node, you are required to [clean up the nodes]({{}}/rancher/v2.6/en/cluster-admin/cleaning-cluster-nodes/) before attempting to add them back into a cluster. +6. After the single nodes is up and running, Rancher recommends adding additional etcd nodes to your cluster. If you have a [custom cluster](../../../pages-for-subheaders/use-existing-nodes.md) and you want to reuse an old node, you are required to [clean up the nodes](../../advanced-user-guides/manage-clusters/clean-cluster-nodes.md) before attempting to add them back into a cluster. # Enabling Snapshot Features for Clusters Created Before Rancher v2.2.0 -If you have any Rancher launched Kubernetes clusters that were created before v2.2.0, after upgrading Rancher, you must [edit the cluster]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/) and _save_ it, in order to enable the updated snapshot features. Even if you were already creating snapshots before v2.2.0, you must do this step as the older snapshots will not be available to use to [back up and restore etcd through the UI]({{}}/rancher/v2.6/en/cluster-admin/restoring-etcd/). +If you have any Rancher launched Kubernetes clusters that were created before v2.2.0, after upgrading Rancher, you must [edit the cluster](../../../pages-for-subheaders/cluster-configuration.md) and _save_ it, in order to enable the updated snapshot features. Even if you were already creating snapshots before v2.2.0, you must do this step as the older snapshots will not be available to use to [back up and restore etcd through the UI](restore-rancher-launched-kubernetes-clusters-from-backup.md). diff --git a/docs/en/backups/restoring-rancher/restoring-rancher.md b/docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher.md similarity index 89% rename from docs/en/backups/restoring-rancher/restoring-rancher.md rename to docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher.md index b679c5f21c6..91c6d765490 100644 --- a/docs/en/backups/restoring-rancher/restoring-rancher.md +++ b/docs/en/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher.md @@ -7,9 +7,9 @@ This page outlines how to perform a restore with Rancher. :::note Important: -* Follow the instructions from this page for restoring rancher on the same cluster where it was backed up from. In order to migrate rancher to a new cluster, follow the steps to [migrate rancher.]({{}}/rancher/v2.6/en/backups/migrating-rancher) +* Follow the instructions from this page for restoring rancher on the same cluster where it was backed up from. In order to migrate rancher to a new cluster, follow the steps to [migrate rancher.](migrate-rancher-to-new-cluster.md) * While restoring rancher on the same setup, the operator will scale down the rancher deployment when restore starts, and it will scale back up the deployment once restore completes. So Rancher will be unavailable during the restore. -* If you need to restore Rancher to a previous version after an upgrade, see the [rollback documentation.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/rollbacks/) +* If you need to restore Rancher to a previous version after an upgrade, see the [rollback documentation.](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md) ::: @@ -40,7 +40,7 @@ A restore is performed by creating a Restore custom resource. 1. On the **Clusters** page, go to the `local` cluster and click **Explore**. The `local` cluster runs the Rancher server. 1. In the left navigation bar, click **Rancher Backups > Restores**. 1. Click **Create**. -1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [configuration reference]({{}}/rancher/v2.6/en/backups/configuration/restore-config) and to the [examples.]({{}}/rancher/v2.6/en/backups/examples) +1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [configuration reference](../../../reference-guides/backup-restore-configuration/restore-configuration.md) and to the [examples.](../../../reference-guides/backup-restore-configuration/examples.md) 1. For using the YAML editor, we can click **Create > Create from YAML**. Enter the Restore YAML. ```yaml @@ -61,7 +61,7 @@ A restore is performed by creating a Restore custom resource. endpoint: s3.us-west-2.amazonaws.com ``` - For help configuring the Restore, refer to the [configuration reference]({{}}/rancher/v2.6/en/backups/configuration/restore-config) and to the [examples.]({{}}/rancher/v2.6/en/backups/examples) + For help configuring the Restore, refer to the [configuration reference](../../../reference-guides/backup-restore-configuration/restore-configuration.md) and to the [examples.](../../../reference-guides/backup-restore-configuration/examples.md) 1. Click **Create**. diff --git a/docs/en/deploy-across-clusters/fleet/fleet.md b/docs/en/how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md similarity index 87% rename from docs/en/deploy-across-clusters/fleet/fleet.md rename to docs/en/how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md index c1502c71664..770773157d8 100644 --- a/docs/en/deploy-across-clusters/fleet/fleet.md +++ b/docs/en/how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md @@ -18,7 +18,7 @@ Fleet is a separate project from Rancher, and can be installed on any Kubernetes # Architecture -For information about how Fleet works, see [this page.](./architecture) +For information about how Fleet works, see [this page.](../../../explanations/integrations-in-rancher/fleet-gitops-at-scale/architecture.md) # Accessing Fleet in the Rancher UI @@ -43,7 +43,7 @@ Follow the steps below to access Continuous Delivery in the Rancher UI: # Windows Support -For details on support for clusters with Windows nodes, see [this page.](./windows) +For details on support for clusters with Windows nodes, see [this page.](../../../explanations/integrations-in-rancher/fleet-gitops-at-scale/windows-support.md) # GitHub Repository @@ -53,7 +53,7 @@ The Fleet Helm charts are available [here.](https://github.com/rancher/fleet/rel # Using Fleet Behind a Proxy -For details on using Fleet behind a proxy, see [this page.](./proxy) +For details on using Fleet behind a proxy, see [this page.](../../../explanations/integrations-in-rancher/fleet-gitops-at-scale/use-fleet-behind-a-proxy.md) # Helm Chart Dependencies @@ -64,7 +64,7 @@ The Helm chart in the git repository must include its dependencies in the charts # Troubleshooting --- -* **Known Issue:** clientSecretName and helmSecretName secrets for Fleet gitrepos are not included in the backup nor restore created by the [backup-restore-operator]({{}}/rancher/v2.6/en/backups/back-up-rancher/#1-install-the-rancher-backups-operator). We will update the community once a permanent solution is in place. +* **Known Issue:** clientSecretName and helmSecretName secrets for Fleet gitrepos are not included in the backup nor restore created by the [backup-restore-operator](../backup-restore-and-disaster-recovery/back-up-rancher.md#1-install-the-rancher-backups-operator). We will update the community once a permanent solution is in place. * **Temporary Workaround:**
By default, user-defined secrets are not backed up in Fleet. It is necessary to recreate secrets if performing a disaster recovery restore or migration of Rancher into a fresh cluster. To modify resourceSet to include extra resources you want to backup, refer to docs [here](https://github.com/rancher/backup-restore-operator#user-flow). diff --git a/docs/en/deploy-across-clusters/multi-cluster-apps/multi-cluster-apps.md b/docs/en/how-to-guides/new-user-guides/deploy-apps-across-clusters/multi-cluster-apps.md similarity index 82% rename from docs/en/deploy-across-clusters/multi-cluster-apps/multi-cluster-apps.md rename to docs/en/how-to-guides/new-user-guides/deploy-apps-across-clusters/multi-cluster-apps.md index b6a446453c3..3911d56a63a 100644 --- a/docs/en/deploy-across-clusters/multi-cluster-apps/multi-cluster-apps.md +++ b/docs/en/how-to-guides/new-user-guides/deploy-apps-across-clusters/multi-cluster-apps.md @@ -3,7 +3,7 @@ title: Multi-cluster Apps weight: 2 --- -> As of Rancher v2.5, multi-cluster apps are deprecated. We now recommend using [Fleet]({{}}/rancher/v2.6/en/deploy-across-clusters/fleet) for deploying apps across clusters. +> As of Rancher v2.5, multi-cluster apps are deprecated. We now recommend using [Fleet](fleet.md) for deploying apps across clusters. Typically, most applications are deployed on a single Kubernetes cluster, but there will be times you might want to deploy multiple copies of the same application across different clusters and/or projects. In Rancher, a _multi-cluster application_, is an application deployed using a Helm chart across multiple clusters. With the ability to deploy the same application across multiple clusters, it avoids the repetition of the same action on each cluster, which could introduce user error during application configuration. With multi-cluster applications, you can customize to have the same configuration across all projects/clusters as well as have the ability to change the configuration based on your target project. Since multi-cluster application is considered a single application, it's easy to manage and maintain this application. @@ -32,8 +32,8 @@ After creating a multi-cluster application, you can program a global DNS entry t To create a multi-cluster app in Rancher, you must have at least one of the following permissions: -- A [project-member role]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles) in the target cluster(s), which gives you the ability to create, read, update, and delete the workloads -- A [cluster owner role]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#cluster-roles) for the clusters(s) that include the target project(s) +- A [project-member role](../../advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#project-roles) in the target cluster(s), which gives you the ability to create, read, update, and delete the workloads +- A [cluster owner role](../../advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#cluster-roles) for the clusters(s) that include the target project(s) ### Enable Legacy Features @@ -76,15 +76,15 @@ In the **Upgrades** section, select the upgrade strategy to use, when you decide ### Roles -In the **Roles** section, you define the role of the multi-cluster application. Typically, when a user [launches catalog applications]({{}}/rancher/v2.6/en/helm-charts), that specific user's permissions are used for creation of all workloads/resources that is required by the app. +In the **Roles** section, you define the role of the multi-cluster application. Typically, when a user [launches catalog applications](../../../pages-for-subheaders/helm-charts-in-rancher.md), that specific user's permissions are used for creation of all workloads/resources that is required by the app. For multi-cluster applications, the application is deployed by a _system user_ and is assigned as the creator of all underlying resources. A _system user_ is used instead of the actual user due to the fact that the actual user could be removed from one of the target projects. If the actual user was removed from one of the projects, then that user would no longer be able to manage the application for the other projects. Rancher will let you select from two options for Roles, **Project** and **Cluster**. Rancher will allow creation using any of these roles based on the user's permissions. -- **Project** - This is the equivalent of a [project member]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles). If you select this role, Rancher will check that in all the target projects, the user has minimally the [project member]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles) role. While the user might not be explicitly granted the _project member_ role, if the user is an [administrator]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/), a [cluster owner]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#cluster-roles), or a [project owner]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles), then the user is considered to have the appropriate level of permissions. +- **Project** - This is the equivalent of a [project member](../../advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#project-roles). If you select this role, Rancher will check that in all the target projects, the user has minimally the [project member](../../advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#project-roles) role. While the user might not be explicitly granted the _project member_ role, if the user is an [administrator](../../advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md), a [cluster owner](../../advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#cluster-roles), or a [project owner](../../advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#project-roles), then the user is considered to have the appropriate level of permissions. -- **Cluster** - This is the equivalent of a [cluster owner]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#cluster-roles). If you select this role, Rancher will check that in all the target projects, the user has minimally the [cluster owner]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles) role. While the user might not be explicitly granted the _cluster owner_ role, if the user is an [administrator]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/), then the user is considered to have the appropriate level of permissions. +- **Cluster** - This is the equivalent of a [cluster owner](../../advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#cluster-roles). If you select this role, Rancher will check that in all the target projects, the user has minimally the [cluster owner](../../advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#project-roles) role. While the user might not be explicitly granted the _cluster owner_ role, if the user is an [administrator](../../advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md), then the user is considered to have the appropriate level of permissions. When launching the application, Rancher will confirm if you have these permissions in the target projects before launching the application. diff --git a/docs/en/helm-charts/creating-apps/creating-apps.md b/docs/en/how-to-guides/new-user-guides/helm-charts-in-rancher/create-apps.md similarity index 98% rename from docs/en/helm-charts/creating-apps/creating-apps.md rename to docs/en/how-to-guides/new-user-guides/helm-charts-in-rancher/create-apps.md index df86cbd87c8..a5c38f42068 100644 --- a/docs/en/helm-charts/creating-apps/creating-apps.md +++ b/docs/en/how-to-guides/new-user-guides/helm-charts-in-rancher/create-apps.md @@ -72,8 +72,8 @@ Before you create your own custom catalog, you should have a basic understanding
Rancher Chart with questions.yml (top) vs. Helm Chart without (bottom)
- ![questions.yml]({{}}/img/rancher/rancher-app-2.6.png) - ![values.yaml]({{}}/img/rancher/helm-app-2.6.png) + ![questions.yml](/img/rancher-app-2.6.png) + ![values.yaml](/img/helm-app-2.6.png) ### Chart.yaml annotations diff --git a/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/nlb.md b/docs/en/how-to-guides/new-user-guides/infrastructure-setup/amazon-elb-load-balancer.md similarity index 96% rename from docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/nlb.md rename to docs/en/how-to-guides/new-user-guides/infrastructure-setup/amazon-elb-load-balancer.md index 77929cea1a7..7a89f169b8f 100644 --- a/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/nlb.md +++ b/docs/en/how-to-guides/new-user-guides/infrastructure-setup/amazon-elb-load-balancer.md @@ -97,19 +97,19 @@ Next, add your Linux nodes to both target groups. Select the target group named **rancher-tcp-443**, click the tab **Targets** and choose **Edit**. -{{< img "/img/rancher/ha/nlb/edit-targetgroup-443.png" "Edit target group 443">}} +![](/img/ha/nlb/edit-targetgroup-443.png) Select the instances (Linux nodes) you want to add, and click **Add to registered**. *** **Screenshot Add targets to target group TCP port 443**
-{{< img "/img/rancher/ha/nlb/add-targets-targetgroup-443.png" "Add targets to target group 443">}} +![](/img/ha/nlb/add-targets-targetgroup-443.png) *** **Screenshot Added targets to target group TCP port 443**
-{{< img "/img/rancher/ha/nlb/added-targets-targetgroup-443.png" "Added targets to target group 443">}} +![](/img/ha/nlb/added-targets-targetgroup-443.png) When the instances are added, click **Save** on the bottom right of the screen. diff --git a/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/infra-for-ha-with-external-db.md b/docs/en/how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster.md similarity index 85% rename from docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/infra-for-ha-with-external-db.md rename to docs/en/how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster.md index ed15d32b80f..0d9131097f8 100644 --- a/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/infra-for-ha-with-external-db.md +++ b/docs/en/how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster.md @@ -7,7 +7,7 @@ This tutorial is intended to help you provision the underlying infrastructure fo The recommended infrastructure for the Rancher-only Kubernetes cluster differs depending on whether Rancher will be installed on a K3s Kubernetes cluster, an RKE Kubernetes cluster, or a single Docker container. -For more information about each installation option, refer to [this page.]({{}}/rancher/v2.6/en/installation) +For more information about each installation option, refer to [this page.](../../../pages-for-subheaders/installation-and-upgrade.md) :::note Important: @@ -24,9 +24,9 @@ To install the Rancher management server on a high-availability K3s cluster, we ### 1. Set up Linux Nodes -Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.6/en/installation/requirements/) +Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.](../../../pages-for-subheaders/installation-requirements.md) -For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node) for setting up nodes as instances in Amazon EC2. +For an example of one way to set up Linux nodes, refer to this [tutorial](nodes-in-amazon-ec2.md) for setting up nodes as instances in Amazon EC2. ### 2. Set up External Datastore @@ -36,9 +36,9 @@ For a high-availability K3s installation, you will need to set a [MySQL](https:/ When you install Kubernetes using the K3s installation script, you will pass in details for K3s to connect to the database. -For an example of one way to set up the MySQL database, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds/) for setting up MySQL on Amazon's RDS service. +For an example of one way to set up the MySQL database, refer to this [tutorial](mysql-database-in-amazon-rds.md) for setting up MySQL on Amazon's RDS service. -For the complete list of options that are available for configuring a K3s cluster datastore, refer to the [K3s documentation.]({{}}/k3s/latest/en/installation/datastore/) +For the complete list of options that are available for configuring a K3s cluster datastore, refer to the [K3s documentation.](https://rancher.com/docs/k3s/latest/en/installation/datastore/) ### 3. Set up the Load Balancer @@ -51,11 +51,11 @@ When Rancher is installed (also in a later step), the Rancher system creates an For your implementation, consider if you want or need to use a Layer-4 or Layer-7 load balancer: - **A layer-4 load balancer** is the simpler of the two choices, in which you are forwarding TCP traffic to your nodes. We recommend configuring your load balancer as a Layer 4 balancer, forwarding traffic to ports TCP/80 and TCP/443 to the Rancher management cluster nodes. The Ingress controller on the cluster will redirect HTTP traffic to HTTPS and terminate SSL/TLS on port TCP/443. The Ingress controller will forward traffic to port TCP/80 to the Ingress pod in the Rancher deployment. -- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.6/en/installation/resources/chart-options/#external-tls-termination) +- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.](installation/resources/chart-options/#external-tls-termination) -For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/) +For an example showing how to set up an NGINX load balancer, refer to [this page.](nginx-load-balancer.md) -For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/) +For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.](amazon-elb-load-balancer.md) :::caution diff --git a/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/infra-for-ha.md b/docs/en/how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster.md similarity index 89% rename from docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/infra-for-ha.md rename to docs/en/how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster.md index 5c3098e9713..e92a97efdaf 100644 --- a/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/infra-for-ha.md +++ b/docs/en/how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster.md @@ -27,9 +27,9 @@ The etcd database requires an odd number of nodes so that it can always elect a ### 1. Set up Linux Nodes -Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.6/en/installation/requirements/) +Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.](../../../pages-for-subheaders/installation-requirements.md) -For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/) for setting up nodes as instances in Amazon EC2. +For an example of one way to set up Linux nodes, refer to this [tutorial](nodes-in-amazon-ec2.md) for setting up nodes as instances in Amazon EC2. ### 2. Set up the Load Balancer @@ -42,11 +42,11 @@ When Rancher is installed (also in a later step), the Rancher system creates an For your implementation, consider if you want or need to use a Layer-4 or Layer-7 load balancer: - **A layer-4 load balancer** is the simpler of the two choices, in which you are forwarding TCP traffic to your nodes. We recommend configuring your load balancer as a Layer 4 balancer, forwarding traffic to ports TCP/80 and TCP/443 to the Rancher management cluster nodes. The Ingress controller on the cluster will redirect HTTP traffic to HTTPS and terminate SSL/TLS on port TCP/443. The Ingress controller will forward traffic to port TCP/80 to the Ingress pod in the Rancher deployment. -- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.6/en/installation/resources/chart-options/#external-tls-termination) +- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.](installation/resources/chart-options/#external-tls-termination) -For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/) +For an example showing how to set up an NGINX load balancer, refer to [this page.](nginx-load-balancer.md) -For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/) +For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.](amazon-elb-load-balancer.md) :::caution diff --git a/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha/infra-for-rke2-ha.md b/docs/en/how-to-guides/new-user-guides/infrastructure-setup/ha-rke2-kubernetes-cluster.md similarity index 88% rename from docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha/infra-for-rke2-ha.md rename to docs/en/how-to-guides/new-user-guides/infrastructure-setup/ha-rke2-kubernetes-cluster.md index a07f1c18f54..5ac0c71493e 100644 --- a/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha/infra-for-rke2-ha.md +++ b/docs/en/how-to-guides/new-user-guides/infrastructure-setup/ha-rke2-kubernetes-cluster.md @@ -21,9 +21,9 @@ To install the Rancher management server on a high-availability RKE2 cluster, we ### 1. Set up Linux Nodes -Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.6/en/installation/requirements/) +Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.](../../../pages-for-subheaders/installation-requirements.md) -For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node) for setting up nodes as instances in Amazon EC2. +For an example of one way to set up Linux nodes, refer to this [tutorial](nodes-in-amazon-ec2.md) for setting up nodes as instances in Amazon EC2. ### 2. Set up the Load Balancer @@ -36,11 +36,11 @@ When Rancher is installed (also in a later step), the Rancher system creates an For your implementation, consider if you want or need to use a Layer-4 or Layer-7 load balancer: - **A layer-4 load balancer** is the simpler of the two choices, in which you are forwarding TCP traffic to your nodes. We recommend configuring your load balancer as a Layer 4 balancer, forwarding traffic to ports TCP/80 and TCP/443 to the Rancher management cluster nodes. The Ingress controller on the cluster will redirect HTTP traffic to HTTPS and terminate SSL/TLS on port TCP/443. The Ingress controller will forward traffic to port TCP/80 to the Ingress pod in the Rancher deployment. -- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.6/en/installation/resources/chart-options/#external-tls-termination) +- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.](installation/resources/chart-options/#external-tls-termination) -For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/) +For an example showing how to set up an NGINX load balancer, refer to [this page.](nginx-load-balancer.md) -For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/) +For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.](amazon-elb-load-balancer.md) :::caution diff --git a/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds/rds.md b/docs/en/how-to-guides/new-user-guides/infrastructure-setup/mysql-database-in-amazon-rds.md similarity index 95% rename from docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds/rds.md rename to docs/en/how-to-guides/new-user-guides/infrastructure-setup/mysql-database-in-amazon-rds.md index 80144a68e0d..f05998b800b 100644 --- a/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds/rds.md +++ b/docs/en/how-to-guides/new-user-guides/infrastructure-setup/mysql-database-in-amazon-rds.md @@ -31,4 +31,4 @@ This information will be used to connect to the database in the following format mysql://username:password@tcp(hostname:3306)/database-name ``` -For more information on configuring the datastore for K3s, refer to the [K3s documentation.]({{}}/k3s/latest/en/installation/datastore/) +For more information on configuring the datastore for K3s, refer to the [K3s documentation.](https://rancher.com/docs/k3s/latest/en/installation/datastore/) diff --git a/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/nginx.md b/docs/en/how-to-guides/new-user-guides/infrastructure-setup/nginx-load-balancer.md similarity index 100% rename from docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/nginx.md rename to docs/en/how-to-guides/new-user-guides/infrastructure-setup/nginx-load-balancer.md diff --git a/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/ec2-node.md b/docs/en/how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2.md similarity index 91% rename from docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/ec2-node.md rename to docs/en/how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2.md index 953e2345f01..a244f996428 100644 --- a/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/ec2-node.md +++ b/docs/en/how-to-guides/new-user-guides/infrastructure-setup/nodes-in-amazon-ec2.md @@ -3,7 +3,7 @@ title: Setting up Nodes in Amazon EC2 weight: 3 --- -In this tutorial, you will learn one way to set up Linux nodes for the Rancher management server. These nodes will fulfill the node requirements for [OS, Docker, hardware, and networking.]({{}}/rancher/v2.6/en/installation/requirements/) +In this tutorial, you will learn one way to set up Linux nodes for the Rancher management server. These nodes will fulfill the node requirements for [OS, Docker, hardware, and networking.](../../../pages-for-subheaders/installation-requirements.md) If the Rancher server will be installed on an RKE Kubernetes cluster, you should provision three instances. @@ -13,8 +13,8 @@ If the Rancher server is installed in a single Docker container, you only need o ### 1. Optional Preparation -- **Create IAM role:** To allow Rancher to manipulate AWS resources, such as provisioning new storage or new nodes, you will need to configure Amazon as a cloud provider. There are several things you'll need to do to set up the cloud provider on EC2, but part of this process is setting up an IAM role for the Rancher server nodes. For the full details on setting up the cloud provider, refer to this [page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/) -- **Create security group:** We also recommend setting up a security group for the Rancher nodes that complies with the [port requirements for Rancher nodes.]({{}}/rancher/v2.6/en/installation/requirements/#port-requirements) +- **Create IAM role:** To allow Rancher to manipulate AWS resources, such as provisioning new storage or new nodes, you will need to configure Amazon as a cloud provider. There are several things you'll need to do to set up the cloud provider on EC2, but part of this process is setting up an IAM role for the Rancher server nodes. For the full details on setting up the cloud provider, refer to this [page.](../../../pages-for-subheaders/set-up-cloud-providers.md) +- **Create security group:** We also recommend setting up a security group for the Rancher nodes that complies with the [port requirements for Rancher nodes.](../../../pages-for-subheaders/installation-requirements.md#port-requirements) ### 2. Provision Instances @@ -27,7 +27,7 @@ If the Rancher server is installed in a single Docker container, you only need o 1. In the **Number of instances** field, enter the number of instances. A high-availability K3s cluster requires only two instances, while a high-availability RKE cluster requires three instances. 1. Optional: If you created an IAM role for Rancher to manipulate AWS resources, select the new IAM role in the **IAM role** field. 1. Click **Next: Add Storage,** **Next: Add Tags,** and **Next: Configure Security Group**. -1. In **Step 6: Configure Security Group,** select a security group that complies with the [port requirements]({{}}/rancher/v2.6/en/installation/requirements/#port-requirements) for Rancher nodes. +1. In **Step 6: Configure Security Group,** select a security group that complies with the [port requirements](../../../pages-for-subheaders/installation-requirements.md#port-requirements) for Rancher nodes. 1. Click **Review and Launch**. 1. Click **Launch**. 1. Choose a new or existing key pair that you will use to connect to your instance later. If you are using an existing key pair, make sure you already have access to the private key. diff --git a/docs/en/installation/resources/k8s-tutorials/how-ha-works/how-ha-works.md b/docs/en/how-to-guides/new-user-guides/kubernetes-cluster-setup/high-availability-installs.md similarity index 89% rename from docs/en/installation/resources/k8s-tutorials/how-ha-works/how-ha-works.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-cluster-setup/high-availability-installs.md index 796e300cfbb..f275fe2ab5d 100644 --- a/docs/en/installation/resources/k8s-tutorials/how-ha-works/how-ha-works.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-cluster-setup/high-availability-installs.md @@ -11,7 +11,7 @@ Then Helm is used to install Rancher on top of the Kubernetes cluster. Helm uses The Rancher server data is stored on etcd. This etcd database also runs on all three nodes, and requires an odd number of nodes so that it can always elect a leader with a majority of the etcd cluster. If the etcd database cannot elect a leader, etcd can fail, requiring the cluster to be restored from backup. -For information on how Rancher works, regardless of the installation method, refer to the [architecture section.]({{}}/rancher/v2.6/en/overview/architecture) +For information on how Rancher works, regardless of the installation method, refer to the [architecture section.](../../../pages-for-subheaders/rancher-manager-architecture.md) ### Recommended Architecture @@ -21,5 +21,5 @@ For information on how Rancher works, regardless of the installation method, ref - The Ingress controller will forward traffic to port TCP/80 on the pod in the Rancher deployment.
Kubernetes Rancher install with layer 4 load balancer, depicting SSL termination at ingress controllers
-![High-availability Kubernetes Installation of Rancher]({{}}/img/rancher/ha/rancher2ha.svg) +![High-availability Kubernetes Installation of Rancher](/img/ha/rancher2ha.svg) Kubernetes Rancher install with Layer 4 load balancer (TCP), depicting SSL termination at ingress controllers diff --git a/docs/en/installation/resources/k8s-tutorials/ha-with-external-db/ha-with-external-db.md b/docs/en/how-to-guides/new-user-guides/kubernetes-cluster-setup/k3s-for-rancher.md similarity index 91% rename from docs/en/installation/resources/k8s-tutorials/ha-with-external-db/ha-with-external-db.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-cluster-setup/k3s-for-rancher.md index 1b269fb2697..3f1110dcac4 100644 --- a/docs/en/installation/resources/k8s-tutorials/ha-with-external-db/ha-with-external-db.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-cluster-setup/k3s-for-rancher.md @@ -4,7 +4,7 @@ shortTitle: Set up K3s for Rancher weight: 2 --- -This section describes how to install a Kubernetes cluster according to the [best practices for the Rancher server environment.]({{}}/rancher/v2.6/en/overview/architecture-recommendations/#environment-for-kubernetes-installations) +This section describes how to install a Kubernetes cluster according to the [best practices for the Rancher server environment.](../../../reference-guides/rancher-manager-architecture/architecture-recommendations.md#environment-for-kubernetes-installations) For systems without direct internet access, refer to the air gap installation instructions. @@ -20,7 +20,7 @@ In both single-node setups, Rancher can be installed with Helm on the Kubernetes # Prerequisites -These instructions assume you have set up two nodes, a load balancer, a DNS record, and an external MySQL database as described in [this section.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/) +These instructions assume you have set up two nodes, a load balancer, a DNS record, and an external MySQL database as described in [this section.](../infrastructure-setup/ha-k3s-kubernetes-cluster.md) Rancher needs to be installed on a supported Kubernetes version. To find out which versions of Kubernetes are supported for your Rancher version, refer to the [support maintenance terms.](https://rancher.com/support-maintenance-terms/) To specify the K3s version, use the INSTALL_K3S_VERSION environment variable when running the K3s installation script. # Installing Kubernetes @@ -109,7 +109,7 @@ users: kubectl --kubeconfig ~/.kube/config/k3s.yaml get pods --all-namespaces ``` -For more information about the `kubeconfig` file, refer to the [K3s documentation]({{}}/k3s/latest/en/cluster-access/) or the [official Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) about organizing cluster access using `kubeconfig` files. +For more information about the `kubeconfig` file, refer to the [K3s documentation](https://rancher.com/docs/k3s/latest/en/cluster-access/) or the [official Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) about organizing cluster access using `kubeconfig` files. ### 4. Check the Health of Your Cluster Pods diff --git a/docs/en/installation/resources/k8s-tutorials/ha-RKE/ha-RKE.md b/docs/en/how-to-guides/new-user-guides/kubernetes-cluster-setup/rke1-for-rancher.md similarity index 86% rename from docs/en/installation/resources/k8s-tutorials/ha-RKE/ha-RKE.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-cluster-setup/rke1-for-rancher.md index 34c133ea7d5..4971baba200 100644 --- a/docs/en/installation/resources/k8s-tutorials/ha-RKE/ha-RKE.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-cluster-setup/rke1-for-rancher.md @@ -13,7 +13,7 @@ Rancher can run on any Kubernetes cluster, included hosted Kubernetes solutions ::: -For systems without direct internet access, refer to [Air Gap: Kubernetes install.]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/) +For systems without direct internet access, refer to [Air Gap: Kubernetes install.](../../../pages-for-subheaders/air-gapped-helm-cli-install.md) :::tip Single-node Installation Tip: @@ -31,7 +31,7 @@ In both single-node setups, Rancher can be installed with Helm on the Kubernetes Install [kubectl,](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) a Kubernetes command-line tool. -Also install [RKE,]({{}}/rke/latest/en/installation/) the Rancher Kubernetes Engine, a Kubernetes distribution and command-line tool. +Also install [RKE,](https://rancher.com/docs/rke/latest/en/installation/) the Rancher Kubernetes Engine, a Kubernetes distribution and command-line tool. ### 1. Create the cluster configuration file @@ -86,11 +86,11 @@ ingress: RKE has many configuration options for customizing the install to suit your specific environment. -Please see the [RKE Documentation]({{}}/rke/latest/en/config-options/) for the full list of options and capabilities. +Please see the [RKE Documentation](https://rancher.com/docs/rke/latest/en/config-options/) for the full list of options and capabilities. -For tuning your etcd cluster for larger Rancher installations, see the [etcd settings guide]({{}}/rancher/v2.6/en/installation/resources/advanced/etcd/). +For tuning your etcd cluster for larger Rancher installations, see the [etcd settings guide](../../../getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/tune-etcd-for-large-installs.md). -For more information regarding Dockershim support, refer to [this page]({{}}/rancher/v2.6/en/installation/requirements/dockershim/) +For more information regarding Dockershim support, refer to [this page](../../../getting-started/installation-and-upgrade/installation-requirements/dockershim.md) ::: @@ -173,8 +173,8 @@ The files mentioned below are needed to maintain, troubleshoot and upgrade your Save a copy of the following files in a secure location: - `rancher-cluster.yml`: The RKE cluster configuration file. -- `kube_config_cluster.yml`: The [Kubeconfig file]({{}}/rke/latest/en/kubeconfig/) for the cluster, this file contains credentials for full access to the cluster. -- `rancher-cluster.rkestate`: The [Kubernetes Cluster State file]({{}}/rke/latest/en/installation/#kubernetes-cluster-state), this file contains credentials for full access to the cluster.

_The Kubernetes Cluster State file is only created when using RKE v0.2.0 or higher._ +- `kube_config_cluster.yml`: The [Kubeconfig file](https://rancher.com/docs/rke/latest/en/kubeconfig/) for the cluster, this file contains credentials for full access to the cluster. +- `rancher-cluster.rkestate`: The [Kubernetes Cluster State file](https://rancher.com/docs/rke/latest/en/installation/#kubernetes-cluster-state), this file contains credentials for full access to the cluster.

_The Kubernetes Cluster State file is only created when using RKE v0.2.0 or higher._ :::note @@ -184,8 +184,8 @@ The "rancher-cluster" parts of the two latter file names are dependent on how yo ### Issues or errors? -See the [Troubleshooting]({{}}/rancher/v2.6/en/installation/resources/troubleshooting/) page. +See the [Troubleshooting](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/troubleshooting.md) page. -### [Next: Install Rancher]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) +### [Next: Install Rancher](../../../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md) diff --git a/docs/en/installation/resources/k8s-tutorials/ha-rke2/ha-rke2.md b/docs/en/how-to-guides/new-user-guides/kubernetes-cluster-setup/rke2-for-rancher.md similarity index 97% rename from docs/en/installation/resources/k8s-tutorials/ha-rke2/ha-rke2.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-cluster-setup/rke2-for-rancher.md index f69c494b175..67e44d88f65 100644 --- a/docs/en/installation/resources/k8s-tutorials/ha-rke2/ha-rke2.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-cluster-setup/rke2-for-rancher.md @@ -5,11 +5,11 @@ weight: 2 --- _Tested on v2.5.6_ -This section describes how to install a Kubernetes cluster according to the [best practices for the Rancher server environment.]({{}}/rancher/v2.6/en/overview/architecture-recommendations/#environment-for-kubernetes-installations) +This section describes how to install a Kubernetes cluster according to the [best practices for the Rancher server environment.](../../../reference-guides/rancher-manager-architecture/architecture-recommendations.md#environment-for-kubernetes-installations) # Prerequisites -These instructions assume you have set up three nodes, a load balancer, and a DNS record, as described in [this section.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha) +These instructions assume you have set up three nodes, a load balancer, and a DNS record, as described in [this section.](../infrastructure-setup/ha-rke2-kubernetes-cluster.md) Note that in order for RKE2 to work correctly with the load balancer, you need to set up two listeners: one for the supervisor on port 9345, and one for the Kubernetes API on port 6443. diff --git a/docs/en/cluster-provisioning/production/recommended-architecture/recommended-architecture.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/recommended-cluster-architecture.md similarity index 84% rename from docs/en/cluster-provisioning/production/recommended-architecture/recommended-architecture.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/recommended-cluster-architecture.md index f9d4eb5e427..bbb9851ed5b 100644 --- a/docs/en/cluster-provisioning/production/recommended-architecture/recommended-architecture.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/recommended-cluster-architecture.md @@ -9,7 +9,7 @@ There are three roles that can be assigned to nodes: `etcd`, `controlplane` and When designing your cluster(s), you have two options: -* Use dedicated nodes for each role. This ensures resource availability for the components needed for the specified role. It also strictly isolates network traffic between each of the roles according to the [port requirements]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements). +* Use dedicated nodes for each role. This ensures resource availability for the components needed for the specified role. It also strictly isolates network traffic between each of the roles according to the [port requirements](../node-requirements-for-rancher-managed-clusters.md#networking-requirements). * Assign the `etcd` and `controlplane` roles to the same nodes. These nodes must meet the hardware requirements for both roles. In either case, the `worker` role should not be used or added to nodes with the `etcd` or `controlplane` role. @@ -29,7 +29,7 @@ The cluster should have: - At least two nodes with the role `controlplane` for master component high availability. - At least two nodes with the role `worker` for workload rescheduling upon node failure. -For more information on what each role is used for, refer to the [section on roles for nodes in Kubernetes.]({{}}/rancher/v2.6/en/cluster-provisioning/production/nodes-and-roles) +For more information on what each role is used for, refer to the [section on roles for nodes in Kubernetes.](roles-for-nodes-in-kubernetes.md) ### Number of Controlplane Nodes @@ -63,7 +63,7 @@ Adding more than one node with the `worker` role will make sure your workloads c ### Why Production Requirements are Different for the Rancher Cluster and the Clusters Running Your Applications -You may have noticed that our [Kubernetes Install]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) instructions do not meet our definition of a production-ready cluster, as there are no dedicated nodes for the `worker` role. However, for your Rancher installation, this three node cluster is valid, because: +You may have noticed that our [Kubernetes Install](../../../../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md) instructions do not meet our definition of a production-ready cluster, as there are no dedicated nodes for the `worker` role. However, for your Rancher installation, this three node cluster is valid, because: * It allows one `etcd` node failure. * It maintains multiple instances of the master components by having multiple `controlplane` nodes. diff --git a/docs/en/cluster-provisioning/production/nodes-and-roles/nodes-and-roles.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/roles-for-nodes-in-kubernetes.md similarity index 94% rename from docs/en/cluster-provisioning/production/nodes-and-roles/nodes-and-roles.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/roles-for-nodes-in-kubernetes.md index ec7d5bd67d2..f0f3b877034 100644 --- a/docs/en/cluster-provisioning/production/nodes-and-roles/nodes-and-roles.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/roles-for-nodes-in-kubernetes.md @@ -5,9 +5,9 @@ weight: 1 This section describes the roles for etcd nodes, controlplane nodes, and worker nodes in Kubernetes, and how the roles work together in a cluster. -This diagram is applicable to Kubernetes clusters [launched with Rancher using RKE.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/). +This diagram is applicable to Kubernetes clusters [launched with Rancher using RKE.](../../../../pages-for-subheaders/launch-kubernetes-with-rancher.md). -![Cluster diagram]({{}}/img/rancher/clusterdiagram.svg)
+![Cluster diagram](/img/clusterdiagram.svg)
Lines show the traffic flow between components. Colors are used purely for visual aid # etcd diff --git a/docs/en/cluster-provisioning/rke-clusters/rancher-agents/rancher-agents.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/about-rancher-agents.md similarity index 74% rename from docs/en/cluster-provisioning/rke-clusters/rancher-agents/rancher-agents.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/about-rancher-agents.md index 225dc2402f2..57320cc1b2b 100644 --- a/docs/en/cluster-provisioning/rke-clusters/rancher-agents/rancher-agents.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/about-rancher-agents.md @@ -8,15 +8,15 @@ There are two different agent resources deployed on Rancher managed clusters: - [cattle-cluster-agent](#cattle-cluster-agent) - [cattle-node-agent](#cattle-node-agent) -For a conceptual overview of how the Rancher server provisions clusters and communicates with them, refer to the [architecture]({{}}/rancher/v2.6/en/overview/architecture/) +For a conceptual overview of how the Rancher server provisions clusters and communicates with them, refer to the [architecture](../../../../pages-for-subheaders/rancher-manager-architecture.md) ### cattle-cluster-agent -The `cattle-cluster-agent` is used to connect to the Kubernetes API of [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) clusters. The `cattle-cluster-agent` is deployed using a Deployment resource. +The `cattle-cluster-agent` is used to connect to the Kubernetes API of [Rancher Launched Kubernetes](../../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) clusters. The `cattle-cluster-agent` is deployed using a Deployment resource. ### cattle-node-agent -The `cattle-node-agent` is used to interact with nodes in a [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) cluster when performing cluster operations. Examples of cluster operations are upgrading Kubernetes version and creating/restoring etcd snapshots. The `cattle-node-agent` is deployed using a DaemonSet resource to make sure it runs on every node. The `cattle-node-agent` is used as fallback option to connect to the Kubernetes API of [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) clusters when `cattle-cluster-agent` is unavailable. +The `cattle-node-agent` is used to interact with nodes in a [Rancher Launched Kubernetes](../../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) cluster when performing cluster operations. Examples of cluster operations are upgrading Kubernetes version and creating/restoring etcd snapshots. The `cattle-node-agent` is deployed using a DaemonSet resource to make sure it runs on every node. The `cattle-node-agent` is used as fallback option to connect to the Kubernetes API of [Rancher Launched Kubernetes](../../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) clusters when `cattle-cluster-agent` is unavailable. ### Scheduling rules @@ -27,7 +27,7 @@ The `cattle-cluster-agent` uses a fixed fixed set of tolerations (listed below, | `cattle-cluster-agent` | `beta.kubernetes.io/os:NotIn:windows` | none | **Note:** These are the default tolerations, and will be replaced by tolerations matching taints applied to controlplane nodes.

`effect:NoSchedule`
`key:node-role.kubernetes.io/controlplane`
`value:true`

`effect:NoSchedule`
`key:node-role.kubernetes.io/control-plane`
`operator:Exists`

`effect:NoSchedule`
`key:node-role.kubernetes.io/master`
`operator:Exists` | | `cattle-node-agent` | `beta.kubernetes.io/os:NotIn:windows` | none | `operator:Exists` | -The `cattle-cluster-agent` Deployment has preferred scheduling rules using `preferredDuringSchedulingIgnoredDuringExecution`, favoring to be scheduled on nodes with the `controlplane` node. When there are no controlplane nodes visible in the cluster (this is usually the case when using [Clusters from Hosted Kubernetes Providers]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/)), you can add the label `cattle.io/cluster-agent=true` on a node to prefer scheduling the `cattle-cluster-agent` pod to that node. +The `cattle-cluster-agent` Deployment has preferred scheduling rules using `preferredDuringSchedulingIgnoredDuringExecution`, favoring to be scheduled on nodes with the `controlplane` node. When there are no controlplane nodes visible in the cluster (this is usually the case when using [Clusters from Hosted Kubernetes Providers](../../../../pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers.md)), you can add the label `cattle.io/cluster-agent=true` on a node to prefer scheduling the `cattle-cluster-agent` pod to that node. See [Kubernetes: Assigning Pods to Nodes](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) to find more information about scheduling rules. diff --git a/docs/en/cluster-provisioning/rke-clusters/behavior-differences-between-rke1-and-rke2/behavior-differences-between-rke1-and-rke2.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/rke1-vs-rke2-differences.md similarity index 100% rename from docs/en/cluster-provisioning/rke-clusters/behavior-differences-between-rke1-and-rke2/behavior-differences-between-rke1-and-rke2.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/rke1-vs-rke2-differences.md diff --git a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/amazon.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/amazon.md similarity index 90% rename from docs/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/amazon.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/amazon.md index 79ace942e3f..19ad0650b40 100644 --- a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/amazon.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/amazon.md @@ -22,9 +22,9 @@ All nodes added to the cluster must be able to interact with EC2 so that they ca * The first policy is for the nodes with the `controlplane` role. These nodes have to be able to create/remove EC2 resources. The following IAM policy is an example, please remove any unneeded permissions for your use case. * The second policy is for the nodes with the `etcd` or `worker` role. These nodes only have to be able to retrieve information from EC2. -While creating an [Amazon EC2 cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/), you must fill in the **IAM Instance Profile Name** (not ARN) of the created IAM role when creating the **Node Template**. +While creating an [Amazon EC2 cluster](../../use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster.md), you must fill in the **IAM Instance Profile Name** (not ARN) of the created IAM role when creating the **Node Template**. -While creating a [Custom cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes), you must manually attach the IAM role to the instance(s). +While creating a [Custom cluster](../../../../../../pages-for-subheaders/use-existing-nodes.md), you must manually attach the IAM role to the instance(s). IAM Policy for nodes with the `controlplane` role: @@ -137,7 +137,7 @@ Do not tag multiple security groups. Tagging multiple groups generates an error ::: -When you create an [Amazon EC2 Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/), the `ClusterID` is automatically configured for the created nodes. Other resources still need to be tagged manually. +When you create an [Amazon EC2 Cluster](../../use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster.md), the `ClusterID` is automatically configured for the created nodes. Other resources still need to be tagged manually. Use the following tag: diff --git a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/azure/azure.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/azure.md similarity index 100% rename from docs/en/cluster-provisioning/rke-clusters/cloud-providers/azure/azure.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/azure.md diff --git a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/gce/gce.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/google-compute-engine.md similarity index 100% rename from docs/en/cluster-provisioning/rke-clusters/cloud-providers/gce/gce.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/google-compute-engine.md diff --git a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/in-tree/in-tree.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-in-tree-vsphere.md similarity index 80% rename from docs/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/in-tree/in-tree.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-in-tree-vsphere.md index 17ddc2b2d57..c96345bde8f 100644 --- a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/in-tree/in-tree.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-in-tree-vsphere.md @@ -18,4 +18,4 @@ To set up the in-tree vSphere cloud provider, follow these steps while creating [Insert provider configuration] ``` -Rancher uses RKE (the Rancher Kubernetes Engine) to provision Kubernetes clusters. Refer to the [vSphere configuration reference in the RKE documentation]({{}}/rke/latest/en/config-options/cloud-providers/vsphere/config-reference/) for details about the properties of the `vsphereCloudProvider` directive. +Rancher uses RKE (the Rancher Kubernetes Engine) to provision Kubernetes clusters. Refer to the [vSphere configuration reference in the RKE documentation](https://rancher.com/docs/rke/latest/en/config-options/cloud-providers/vsphere/config-reference/) for details about the properties of the `vsphereCloudProvider` directive. diff --git a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/out-of-tree.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-out-of-tree-vsphere.md similarity index 100% rename from docs/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/out-of-tree.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-out-of-tree-vsphere.md diff --git a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/vsphere-volume-migration.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/migrate-from-in-tree-to-out-of-tree.md similarity index 100% rename from docs/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/vsphere-volume-migration.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/migrate-from-in-tree-to-out-of-tree.md diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/digital-ocean.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-a-digitalocean-cluster.md similarity index 72% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/digital-ocean.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-a-digitalocean-cluster.md index 28d7e799f36..b97384ff9e3 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/digital-ocean.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-a-digitalocean-cluster.md @@ -33,13 +33,13 @@ Then you will create a DigitalOcean cluster in Rancher, and when configuring the ### 2. Create a node template with your cloud credentials -Creating a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for DigitalOcean will allow Rancher to provision new nodes in DigitalOcean. Node templates can be reused for other clusters. +Creating a [node template](../../../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-templates) for DigitalOcean will allow Rancher to provision new nodes in DigitalOcean. Node templates can be reused for other clusters. 1. Click **☰ > Cluster Management**. 1. Click **RKE1 Configuration > Node Templates**. 1. Click **Add Template**. 1. Click **DigitalOcean**. -1. Fill out a node template for DigitalOcean. For help filling out the form, refer to [DigitalOcean Node Template Configuration.](./do-node-template-config) +1. Fill out a node template for DigitalOcean. For help filling out the form, refer to [DigitalOcean Node Template Configuration.](../../../../../reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/digitalocean.md) ### 3. Create a cluster with node pools using the node template @@ -47,8 +47,8 @@ Creating a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rk 1. On the **Clusters** page, click **Create**. 1. Click **DigitalOcean**. 1. Enter a **Cluster Name**. -1. Add one or more node pools to your cluster. Add one or more node pools to your cluster. Each node pool uses a node template to provision new nodes. For more information about node pools, including best practices for assigning Kubernetes roles to them, see [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools) -1. **In the Cluster Configuration** section, choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. To see more cluster options, click on **Show advanced options**. For help configuring the cluster, refer to the [RKE cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options) +1. Add one or more node pools to your cluster. Add one or more node pools to your cluster. Each node pool uses a node template to provision new nodes. For more information about node pools, including best practices for assigning Kubernetes roles to them, see [this section.](../../../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md) +1. **In the Cluster Configuration** section, choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. To see more cluster options, click on **Show advanced options**. For help configuring the cluster, refer to the [RKE cluster configuration reference.](cluster-provisioning/rke-clusters/options) 1. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user. 1. Click **Create**. @@ -76,9 +76,9 @@ Use Rancher to create a Kubernetes cluster in DigitalOcean. 1. Click **DigitalOcean**. 1. Select a **Cloud Credential**, if more than one exists. Otherwise, it's preselected. 1. Enter a **Cluster Name**. -1. Create a machine pool for each Kubernetes role. Refer to the [best practices]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools#node-roles-in-rke2) for recommendations on role assignments and counts. - 1. For each machine pool, define the machine configuration. Refer to the [DigitalOcean machine configuration reference]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-machine-config/) for information on configuration options. -1. Use the **Cluster Configuration** to choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. For help configuring the cluster, refer to the [RKE2 cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/rke2-config-reference/) +1. Create a machine pool for each Kubernetes role. Refer to the [best practices](../../../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-roles-in-rke2) for recommendations on role assignments and counts. + 1. For each machine pool, define the machine configuration. Refer to the [DigitalOcean machine configuration reference](../../../../../reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/digitalocean.md) for information on configuration options. +1. Use the **Cluster Configuration** to choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. For help configuring the cluster, refer to the [RKE2 cluster configuration reference.](../../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md) 1. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user. 1. Click **Create**. @@ -99,5 +99,5 @@ You can access your cluster after its state is updated to **Active**. After creating your cluster, you can access it through the Rancher UI. As a best practice, we recommend setting up these alternate ways of accessing your cluster: -- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. -- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. +- **Access your cluster with the kubectl CLI:** Follow [these steps](../../../../advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. +- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps](../../../../advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster.md similarity index 80% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster.md index 51360a624d6..cce6aaf8cef 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster.md @@ -19,7 +19,7 @@ Then you will create an EC2 cluster in Rancher, and when configuring the new clu - **AWS EC2 Access Key and Secret Key** that will be used to create the instances. See [Amazon Documentation: Creating Access Keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html#Using_CreateAccessKey) how to create an Access Key and Secret Key. - **IAM Policy created** to add to the user of the Access Key And Secret Key. See [Amazon Documentation: Creating IAM Policies (Console)](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html#access_policies_create-start) how to create an IAM policy. See our three example JSON policies below: - [Example IAM Policy](#example-iam-policy) - - [Example IAM Policy with PassRole](#example-iam-policy-with-passrole) (needed if you want to use [Kubernetes Cloud Provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers) or want to pass an IAM Profile to an instance) + - [Example IAM Policy with PassRole](#example-iam-policy-with-passrole) (needed if you want to use [Kubernetes Cloud Provider](../../../../../pages-for-subheaders/set-up-cloud-providers.md) or want to pass an IAM Profile to an instance) - [Example IAM Policy to allow encrypted EBS volumes](#example-iam-policy-to-allow-encrypted-ebs-volumes) - **IAM Policy added as Permission** to the user. See [Amazon Documentation: Adding Permissions to a User (Console)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_change-permissions.html#users_change_permissions-add-console) how to attach it to an user. @@ -49,34 +49,34 @@ The steps to create a cluster differ based on your Rancher version. ### 2. Create a node template with your cloud credentials and information from EC2 -Creating a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for EC2 will allow Rancher to provision new nodes in EC2. Node templates can be reused for other clusters. +Creating a [node template](../../../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-templates) for EC2 will allow Rancher to provision new nodes in EC2. Node templates can be reused for other clusters. 1. Click **☰ > Cluster Management**. 1. Click **RKE1 Configuration > Node Templates** 1. Click **Add Template**. -1. Fill out a node template for EC2. For help filling out the form, refer to [EC2 Node Template Configuration.](./ec2-node-template-config) +1. Fill out a node template for EC2. For help filling out the form, refer to [EC2 Node Template Configuration.](../../../../../reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/amazon-ec2.md) 1. Click **Create**. :::note - If you want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements]({{}}/rke//latest/en/config-options/dual-stack#requirements) that must be taken into consideration. + If you want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements](https://rancher.com/docs/rke//latest/en/config-options/dual-stack#requirements) that must be taken into consideration. ::: ### 3. Create a cluster with node pools using the node template -Add one or more node pools to your cluster. For more information about node pools, see [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools) +Add one or more node pools to your cluster. For more information about node pools, see [this section.](../../../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md) 1. Click **☰ > Cluster Management**. 1. On the **Clusters** page, click **Create**. 1. Click **Amazon EC2**. -1. Create a node pool for each Kubernetes role. For each node pool, choose a node template that you created. For more information about node pools, including best practices for assigning Kubernetes roles to them, see [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools) +1. Create a node pool for each Kubernetes role. For each node pool, choose a node template that you created. For more information about node pools, including best practices for assigning Kubernetes roles to them, see [this section.](../../../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md) 1. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user. -1. Use **Cluster Options** to choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. Refer to [Selecting Cloud Providers]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/) to configure the Kubernetes Cloud Provider. For help configuring the cluster, refer to the [RKE cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options) +1. Use **Cluster Options** to choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. Refer to [Selecting Cloud Providers](../../../../../pages-for-subheaders/set-up-cloud-providers.md) to configure the Kubernetes Cloud Provider. For help configuring the cluster, refer to the [RKE cluster configuration reference.](cluster-provisioning/rke-clusters/options) :::note - If you want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements]({{}}/rke//latest/en/config-options/dual-stack#requirements) that must be taken into consideration. + If you want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements](https://rancher.com/docs/rke//latest/en/config-options/dual-stack#requirements) that must be taken into consideration. ::: @@ -108,9 +108,9 @@ If you already have a set of cloud credentials to use, skip this section. 1. Click **Amazon EC2**. 1. Select a **Cloud Credential**, if more than one exists. Otherwise, it's preselected. 1. Enter a **Cluster Name**. -1. Create a machine pool for each Kubernetes role. Refer to the [best practices]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools#node-roles-in-rke2) for recommendations on role assignments and counts. - 1. For each machine pool, define the machine configuration. Refer to [the EC2 machine configuration reference]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-machine-config/) for information on configuration options. -1. Use the **Cluster Configuration** to choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. For help configuring the cluster, refer to the [RKE2 cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/rke2-config-reference/) +1. Create a machine pool for each Kubernetes role. Refer to the [best practices](../../../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-roles-in-rke2) for recommendations on role assignments and counts. + 1. For each machine pool, define the machine configuration. Refer to [the EC2 machine configuration reference](../../../../../reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/amazon-ec2.md) for information on configuration options. +1. Use the **Cluster Configuration** to choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. For help configuring the cluster, refer to the [RKE2 cluster configuration reference.](../../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md) 1. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user. 1. Click **Create**. @@ -132,8 +132,8 @@ You can access your cluster after its state is updated to **Active**. After creating your cluster, you can access it through the Rancher UI. As a best practice, we recommend setting up these alternate ways of accessing your cluster: -- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. -- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. +- **Access your cluster with the kubectl CLI:** Follow [these steps](../../../../advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. +- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps](../../../../advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. # IAM Policies diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/azure/azure.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-azure-cluster.md similarity index 74% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/azure/azure.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-azure-cluster.md index b20b48ed8e3..beefa0c8266 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/azure/azure.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-azure-cluster.md @@ -7,7 +7,7 @@ weight: 2220 import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -In this section, you'll learn how to install an [RKE]({{}}/rke/latest/en/) Kubernetes cluster in Azure through Rancher. +In this section, you'll learn how to install an [RKE](https://rancher.com/docs/rke/latest/en/) Kubernetes cluster in Azure through Rancher. First, you will set up your Azure cloud credentials in Rancher. Then you will use your cloud credentials to create a node template, which Rancher will use to provision new nodes in Azure. @@ -24,9 +24,9 @@ For more information, refer to the documentation on [Azure load balancer limitat ::: -For more information on configuring the Kubernetes cluster that Rancher will install on the Azure nodes, refer to the [RKE cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options) +For more information on configuring the Kubernetes cluster that Rancher will install on the Azure nodes, refer to the [RKE cluster configuration reference.](cluster-provisioning/rke-clusters/options) -For more information on configuring Azure node templates, refer to the [Azure node template configuration reference.](./azure-node-template-config) +For more information on configuring Azure node templates, refer to the [Azure node template configuration reference.](../../../../../reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/azure.md) - [Preparation in Azure](#preparation-in-azure) - [Creating an Azure Cluster](#creating-an-azure-cluster) @@ -70,13 +70,13 @@ The creation of this service principal returns three pieces of identification in ### 2. Create a node template with your cloud credentials -Creating a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for Azure will allow Rancher to provision new nodes in Azure. Node templates can be reused for other clusters. +Creating a [node template](../../../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-templates) for Azure will allow Rancher to provision new nodes in Azure. Node templates can be reused for other clusters. 1. Click **☰ > Cluster Management**. 1. Click **RKE1 Configuration > Node Templates**. 1. Click **Add Template**. 1. Click **Azure**. -1. Fill out a node template for Azure. For help filling out the form, refer to [Azure Node Template Configuration.](./azure-node-template-config) +1. Fill out a node template for Azure. For help filling out the form, refer to [Azure Node Template Configuration.](../../../../../reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/azure.md) ### 3. Create a cluster with node pools using the node template @@ -86,8 +86,8 @@ Use Rancher to create a Kubernetes cluster in Azure. 1. On the **Clusters** page, click **Create**. 1. Click **Azure**. 1. Enter a **Cluster Name**. -1. Add one or more node pools to your cluster. Each node pool uses a node template to provision new nodes. For more information about node pools, including best practices, see [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools) -1. In the **Cluster Configuration** to choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. To see more cluster options, click on **Show advanced options**. For help configuring the cluster, refer to the [RKE cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options) +1. Add one or more node pools to your cluster. Each node pool uses a node template to provision new nodes. For more information about node pools, including best practices, see [this section.](../../../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md) +1. In the **Cluster Configuration** to choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. To see more cluster options, click on **Show advanced options**. For help configuring the cluster, refer to the [RKE cluster configuration reference.](cluster-provisioning/rke-clusters/options) 1. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user. 1. Click **Create**. @@ -117,9 +117,9 @@ Use Rancher to create a Kubernetes cluster in Azure. 1. Click **Azure**. 1. Select a **Cloud Credential**, if more than one exists. Otherwise, it's preselected. 1. Enter a **Cluster Name**. -1. Create a machine pool for each Kubernetes role. Refer to the [best practices]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools#node-roles-in-rke2) for recommendations on role assignments and counts. - 1. For each machine pool, define the machine configuration. Refer to the [Azure machine configuration reference]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/azure/azure-machine-config/) for information on configuration options. -1. Use the **Cluster Configuration** to choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. For help configuring the cluster, refer to the [RKE2 cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/rke2-config-reference/) +1. Create a machine pool for each Kubernetes role. Refer to the [best practices](../../../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-roles-in-rke2) for recommendations on role assignments and counts. + 1. For each machine pool, define the machine configuration. Refer to the [Azure machine configuration reference](../../../../../reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/azure.md) for information on configuration options. +1. Use the **Cluster Configuration** to choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. For help configuring the cluster, refer to the [RKE2 cluster configuration reference.](../../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md) 1. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user. 1. Click **Create**. @@ -142,5 +142,5 @@ You can access your cluster after its state is updated to **Active**. After creating your cluster, you can access it through the Rancher UI. As a best practice, we recommend setting up these alternate ways of accessing your cluster: -- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. -- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. +- **Access your cluster with the kubectl CLI:** Follow [these steps](../../../../advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. +- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps](../../../../advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/nutanix/provisioning-nutanix-clusters/provisioning-nutanix-clusters.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/provision-kubernetes-clusters-in-aos.md similarity index 65% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/nutanix/provisioning-nutanix-clusters/provisioning-nutanix-clusters.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/provision-kubernetes-clusters-in-aos.md index f333463b38a..d817bb5809c 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/nutanix/provisioning-nutanix-clusters/provisioning-nutanix-clusters.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/provision-kubernetes-clusters-in-aos.md @@ -3,17 +3,17 @@ title: Provisioning Kubernetes Clusters in Nutanix AOS weight: 1 --- -To use Rancher to install an [RKE]({{}}/rke/latest/en/) Kubernetes cluster in Nutanix AOS (AHV): +To use Rancher to install an [RKE](https://rancher.com/docs/rke/latest/en/) Kubernetes cluster in Nutanix AOS (AHV): -1. Locate Rancher's built-in Nutanix [node driver and activate it]({{}}/rancher/v2.6/en/admin-settings/drivers/node-drivers/#activating-deactivating-node-drivers). +1. Locate Rancher's built-in Nutanix [node driver and activate it](../../../../../advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers.md#activating-deactivating-node-drivers). 1. Create a node template, which Rancher will use to provision nodes in Nutanix AOS. 1. Create a Nutanix AOS cluster in Rancher. When configuring the new cluster, you will define node pools for it. Each node pool will have a Kubernetes role of etcd, controlplane, or worker. Rancher will install RKE Kubernetes on the new nodes, and it will set up each node with the Kubernetes role defined by the node pool. -For details on configuring the Nutanix AOS node template, refer to the [Nutanix AOS node template configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/nutanix/nutanix-node-template-config/) +For details on configuring the Nutanix AOS node template, refer to the [Nutanix AOS node template configuration reference.](../../../../../../reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/nutanix.md) -For details on configuring RKE Kubernetes clusters in Rancher, refer to the [cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/rke-config-reference/) +For details on configuring RKE Kubernetes clusters in Rancher, refer to the [cluster configuration reference.](../../../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md) - [Preparation in Nutanix AOS](#preparation-in-nutanix-aos) - [Creating a Nutanix AOS Cluster](#creating-a-nutanix-aos-cluster) @@ -38,7 +38,7 @@ You must ensure that the hosts running the Rancher server are able to establish - To the Nutanix Prism Central API (usually port 9440/TCP). - To port 22/TCP and 2376/TCP on the created VMs -See [Node Networking Requirements]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements) for a detailed list of port requirements applicable for creating nodes on an infrastructure provider. +See [Node Networking Requirements](../../../node-requirements-for-rancher-managed-clusters.md#networking-requirements) for a detailed list of port requirements applicable for creating nodes on an infrastructure provider. ### VM-VM Anti-Affinity Policies @@ -51,14 +51,14 @@ Setting up [VM-VM Anti-Affinity Policies](https://portal.nutanix.com/page/docume ### 1. Create a node template -Creating a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for Nutanix AOS will allow Rancher to provision new nodes in Nutanix AOS. Node templates can be reused for other clusters. +Creating a [node template](../../../../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-templates) for Nutanix AOS will allow Rancher to provision new nodes in Nutanix AOS. Node templates can be reused for other clusters. 1. Click **☰ > Cluster Management**. 1. Click **RKE1 Configuration > Node Templates**. 1. Click **Create**. 1. Click **Add Template**. 1. Click **Nutanix**. -1. Fill out a node template for Nutanix AOS. For help filling out the form, refer to the Nutanix AOS node template [configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/nutanix/nutanix-node-template-config/). +1. Fill out a node template for Nutanix AOS. For help filling out the form, refer to the Nutanix AOS node template [configuration reference.](../../../../../../reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/nutanix.md). 1. Click **Create**. ### 2. Create a cluster with node pools using the node template @@ -70,8 +70,8 @@ Use Rancher to create a Kubernetes cluster in Nutanix AOS. 1. Click **Nutanix**. 1. Enter a **Cluster Name**, then click **Continue**. 1. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users who can access the cluster. Use the **Role** drop-down to set permissions for each user. -1. Use **Cluster Options** to choose the version of Kubernetes that will be installed, what network provider will be used, and whether you want to enable project network isolation. To see more cluster options, click on **Show advanced options**. For help configuring the cluster, refer to the [RKE cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/rke-config-reference/) -1. Add one or more node pools to your cluster. Each node pool uses a node template to provision new nodes. For more information about node pools, including best practices for assigning Kubernetes roles to the nodes, see [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-pools) +1. Use **Cluster Options** to choose the version of Kubernetes that will be installed, what network provider will be used, and whether you want to enable project network isolation. To see more cluster options, click on **Show advanced options**. For help configuring the cluster, refer to the [RKE cluster configuration reference.](../../../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md) +1. Add one or more node pools to your cluster. Each node pool uses a node template to provision new nodes. For more information about node pools, including best practices for assigning Kubernetes roles to the nodes, see [this section.](../../../../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-pools) 1. Review your options to confirm they're correct. Then click **Create**. **Result:** Your cluster is created and assigned a state of **Provisioning**. Rancher is standing up your cluster. @@ -88,6 +88,6 @@ You can access your cluster after its state is updated to **Active**. After creating your cluster, you can access it through the Rancher UI. As a best practice, we recommend setting up these alternate ways of accessing your cluster: -- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. +- **Access your cluster with the kubectl CLI:** Follow [these steps](../../../../../advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. -- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. \ No newline at end of file +- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps](../../../../../advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. \ No newline at end of file diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-a-vm-template/creating-a-vm-template.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md similarity index 100% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-a-vm-template/creating-a-vm-template.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-credentials/creating-credentials.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-credentials.md similarity index 88% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-credentials/creating-credentials.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-credentials.md index ed2495e46de..48faf823668 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-credentials/creating-credentials.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-credentials.md @@ -24,20 +24,20 @@ The following steps create a role with the required privileges and then assign i 3. Create a new role. Give it a name and select the privileges listed in the permissions table above. - {{< img "/img/rancher/rancherroles1.png" "image" >}} + ![](/img/rancherroles1.png) 4. Go to the **Users and Groups** tab. 5. Create a new user. Fill out the form and then click **OK**. Make sure to note the username and password, because you will need it when configuring node templates in Rancher. - {{< img "/img/rancher/rancheruser.png" "image" >}} + ![](/img/rancheruser.png) 6. Go to the **Global Permissions** tab. 7. Create a new Global Permission. Add the user you created earlier and assign it the role you created earlier. Click **OK**. - {{< img "/img/rancher/globalpermissionuser.png" "image" >}} + ![](/img/globalpermissionuser.png) - {{< img "/img/rancher/globalpermissionrole.png" "image" >}} + ![](/img/globalpermissionrole.png) **Result:** You now have credentials that Rancher can use to manipulate vSphere resources. diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/provisioning-vsphere-clusters.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/provision-kubernetes-clusters-in-vsphere.md similarity index 66% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/provisioning-vsphere-clusters.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/provision-kubernetes-clusters-in-vsphere.md index 18b9d24a741..2ad8526037d 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/provisioning-vsphere-clusters.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/provision-kubernetes-clusters-in-vsphere.md @@ -3,15 +3,15 @@ title: Provisioning Kubernetes Clusters in vSphere weight: 1 --- -In this section, you'll learn how to use Rancher to install an [RKE]({{}}/rke/latest/en/) Kubernetes cluster in vSphere. +In this section, you'll learn how to use Rancher to install an [RKE](https://rancher.com/docs/rke/latest/en/) Kubernetes cluster in vSphere. First, you will set up your vSphere cloud credentials in Rancher. Then you will use your cloud credentials to create a node template, which Rancher will use to provision nodes in vSphere. Then you will create a vSphere cluster in Rancher, and when configuring the new cluster, you will define node pools for it. Each node pool will have a Kubernetes role of etcd, controlplane, or worker. Rancher will install RKE Kubernetes on the new nodes, and it will set up each node with the Kubernetes role defined by the node pool. -For details on configuring the vSphere node template, refer to the [vSphere node template configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/) +For details on configuring the vSphere node template, refer to the [vSphere node template configuration reference.](../../../../../../reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere.md) -For details on configuring RKE Kubernetes clusters in Rancher, refer to the [cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options) +For details on configuring RKE Kubernetes clusters in Rancher, refer to the [cluster configuration reference.](cluster-provisioning/rke-clusters/options) - [Preparation in vSphere](#preparation-in-vsphere) - [Creating a vSphere Cluster](#creating-a-vsphere-cluster) @@ -26,7 +26,7 @@ The node templates are documented and tested with the vSphere Web Services API v Before proceeding to create a cluster, you must ensure that you have a vSphere user with sufficient permissions. When you set up a node template, the template will need to use these vSphere credentials. -Refer to this [how-to guide]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-credentials) for instructions on how to create a user in vSphere with the required permissions. These steps result in a username and password that you will need to provide to Rancher, which allows Rancher to provision resources in vSphere. +Refer to this [how-to guide](create-credentials.md) for instructions on how to create a user in vSphere with the required permissions. These steps result in a username and password that you will need to provide to Rancher, which allows Rancher to provision resources in vSphere. ### Network Permissions @@ -36,7 +36,7 @@ It must be ensured that the hosts running the Rancher server are able to establi - To the Host API (port 443/TCP) on all ESXi hosts used to instantiate virtual machines for the clusters (*only required when using the ISO creation method*). - To port 22/TCP and 2376/TCP on the created VMs -See [Node Networking Requirements]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements) for a detailed list of port requirements applicable for creating nodes on an infrastructure provider. +See [Node Networking Requirements](../../../node-requirements-for-rancher-managed-clusters.md#networking-requirements) for a detailed list of port requirements applicable for creating nodes on an infrastructure provider. ### Valid ESXi License for vSphere API Access @@ -60,21 +60,21 @@ The a vSphere cluster is created in Rancher depends on the Rancher version. 1. Click **Cloud Credentials**. 1. Click **Create**. 1. Click **VMware vSphere**. -1. Enter your vSphere credentials. For help, refer to **Account Access** in the [node template configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/) +1. Enter your vSphere credentials. For help, refer to **Account Access** in the [node template configuration reference.](../../../../../../reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere.md) 1. Click **Create**. **Result:** You have created the cloud credentials that will be used to provision nodes in your cluster. You can reuse these credentials for other node templates, or in other clusters. ### 2. Create a node template with your cloud credentials -Creating a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for vSphere will allow Rancher to provision new nodes in vSphere. Node templates can be reused for other clusters. +Creating a [node template](../../../../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-templates) for vSphere will allow Rancher to provision new nodes in vSphere. Node templates can be reused for other clusters. 1. Click **☰ > Cluster Management**. 1. Click **RKE1 Configuration > Node Templates**. 1. Click **Create**. 1. Click **Add Template**. 1. Click **vSphere**. -1. Fill out a node template for vSphere. For help filling out the form, refer to the vSphere node template [configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/). +1. Fill out a node template for vSphere. For help filling out the form, refer to the vSphere node template [configuration reference.](../../../../../../reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere.md). 1. Click **Create**. ### 3. Create a cluster with node pools using the node template @@ -86,9 +86,9 @@ Use Rancher to create a Kubernetes cluster in vSphere. 1. Click **VMware vSphere**. 1. Enter a **Cluster Name** and use your vSphere cloud credentials. Click **Continue**. 1. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user. -1. Use **Cluster Options** to choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. To see more cluster options, click on **Show advanced options**. For help configuring the cluster, refer to the [RKE cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options) -1. If you want to dynamically provision persistent storage or other infrastructure later, you will need to enable the vSphere cloud provider by modifying the cluster YAML file. For details, refer to [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere) -1. Add one or more node pools to your cluster. Each node pool uses a node template to provision new nodes. For more information about node pools, including best practices for assigning Kubernetes roles to the nodes, see [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-pools) +1. Use **Cluster Options** to choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. To see more cluster options, click on **Show advanced options**. For help configuring the cluster, refer to the [RKE cluster configuration reference.](cluster-provisioning/rke-clusters/options) +1. If you want to dynamically provision persistent storage or other infrastructure later, you will need to enable the vSphere cloud provider by modifying the cluster YAML file. For details, refer to [this section.](../../../../../../pages-for-subheaders/vsphere-cloud-provider.md) +1. Add one or more node pools to your cluster. Each node pool uses a node template to provision new nodes. For more information about node pools, including best practices for assigning Kubernetes roles to the nodes, see [this section.](../../../../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-pools) 1. Review your options to confirm they're correct. Then click **Create**. **Result:** @@ -107,6 +107,6 @@ You can access your cluster after its state is updated to **Active**. After creating your cluster, you can access it through the Rancher UI. As a best practice, we recommend setting up these alternate ways of accessing your cluster: -- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. -- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. -- **Provision Storage:** For an example of how to provision storage in vSphere using Rancher, refer to [this section.]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/vsphere) In order to dynamically provision storage in vSphere, the vSphere provider must be [enabled.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere) \ No newline at end of file +- **Access your cluster with the kubectl CLI:** Follow [these steps](../../../../../advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. +- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps](../../../../../advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. +- **Provision Storage:** For an example of how to provision storage in vSphere using Rancher, refer to [this section.](../../../../../advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/vsphere-storage.md) In order to dynamically provision storage in vSphere, the vSphere provider must be [enabled.](../../../../../../pages-for-subheaders/vsphere-cloud-provider.md) \ No newline at end of file diff --git a/docs/en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass/azure-storageclass.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/azure-storageclass-configuration.md similarity index 90% rename from docs/en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass/azure-storageclass.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/azure-storageclass-configuration.md index 23e41953557..770ee0d9e77 100644 --- a/docs/en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass/azure-storageclass.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/azure-storageclass-configuration.md @@ -7,7 +7,7 @@ If you are using Azure VMs for your nodes, you can use [Azure files](https://doc In order to have the Azure platform create the required storage resources, follow these steps: -1. [Configure the Azure cloud provider.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/azure) +1. [Configure the Azure cloud provider.](../set-up-cloud-providers/other-cloud-providers/azure.md) 1. Configure `kubectl` to connect to your cluster. 1. Copy the `ClusterRole` and `ClusterRoleBinding` manifest for the service account: diff --git a/docs/en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/host-gateway-requirements.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/network-requirements-for-host-gateway.md similarity index 100% rename from docs/en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/host-gateway-requirements.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/network-requirements-for-host-gateway.md diff --git a/docs/en/cluster-provisioning/rke-clusters/windows-clusters/windows-parity/windows-parity.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/windows-linux-cluster-feature-parity.md similarity index 100% rename from docs/en/cluster-provisioning/rke-clusters/windows-clusters/windows-parity/windows-parity.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/windows-linux-cluster-feature-parity.md diff --git a/docs/en/cluster-provisioning/node-requirements/node-requirements.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md similarity index 80% rename from docs/en/cluster-provisioning/node-requirements/node-requirements.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md index 59e074642c0..f49a5c4574c 100644 --- a/docs/en/cluster-provisioning/node-requirements/node-requirements.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md @@ -10,7 +10,7 @@ This page describes the requirements for the Rancher managed Kubernetes clusters :::note -If Rancher is installed on a high-availability Kubernetes cluster, the Rancher server three-node cluster and downstream clusters have different requirements. For Rancher installation requirements, refer to the node requirements in the [installation section.]({{}}/rancher/v2.6/en/installation/requirements/) +If Rancher is installed on a high-availability Kubernetes cluster, the Rancher server three-node cluster and downstream clusters have different requirements. For Rancher installation requirements, refer to the node requirements in the [installation section.](../../../pages-for-subheaders/installation-requirements.md) ::: @@ -29,7 +29,7 @@ For details on which OS and Docker versions were tested with each Rancher versio All supported operating systems are 64-bit x86. -If you plan to use ARM64, see [Running on ARM64 (Experimental).]({{}}/rancher/v2.6/en/installation/resources/advanced/arm64-platform/) +If you plan to use ARM64, see [Running on ARM64 (Experimental).](../../../getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/rancher-on-arm64.md) For information on how to install Docker, refer to the official [Docker documentation.](https://docs.docker.com/) @@ -50,11 +50,11 @@ In RHEL 8.4, two extra services are included on the NetworkManager: `nm-cloud-se ### SUSE Linux Nodes -SUSE Linux may have a firewall that blocks all ports by default. In that situation, follow [these steps]({{}}/rancher/v2.6/en/installation/requirements/ports/#opening-suse-linux-ports) to open the ports needed for adding a host to a custom cluster. +SUSE Linux may have a firewall that blocks all ports by default. In that situation, follow [these steps](../../../getting-started/installation-and-upgrade/installation-requirements/port-requirements.md#opening-suse-linux-ports) to open the ports needed for adding a host to a custom cluster. ### Flatcar Container Linux Nodes -When [Launching Kubernetes with Rancher]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) using Flatcar Container Linux nodes, it is required to use the following configuration in the [Cluster Config File]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#cluster-config-file) +When [Launching Kubernetes with Rancher](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) using Flatcar Container Linux nodes, it is required to use the following configuration in the [Cluster Config File](cluster-provisioning/rke-clusters/options/#cluster-config-file) @@ -99,13 +99,13 @@ It is also required to enable the Docker service, you can enable the Docker serv systemctl enable docker.service ``` -The Docker service is enabled automatically when using [Node Drivers]({{}}/rancher/v2.6/en/admin-settings/drivers/#node-drivers). +The Docker service is enabled automatically when using [Node Drivers](../../../pages-for-subheaders/about-provisioning-drivers.md#node-drivers). ### Windows Nodes Nodes with Windows Server must run Docker Enterprise Edition. -Windows nodes can be used for worker nodes only. See [Configuring Custom Clusters for Windows]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/) +Windows nodes can be used for worker nodes only. See [Configuring Custom Clusters for Windows](../../../pages-for-subheaders/use-windows-clusters.md) # Hardware Requirements @@ -121,14 +121,14 @@ For hardware recommendations for etcd clusters in production, refer to the offic For a production cluster, we recommend that you restrict traffic by opening only the ports defined in the port requirements below. -The ports required to be open are different depending on how the user cluster is launched. Each of the sections below list the ports that need to be opened for different [cluster creation options]({{}}/rancher/v2.6/en/cluster-provisioning/). +The ports required to be open are different depending on how the user cluster is launched. Each of the sections below list the ports that need to be opened for different [cluster creation options](../../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md). -For a breakdown of the port requirements for etcd nodes, controlplane nodes, and worker nodes in a Kubernetes cluster, refer to the [port requirements for the Rancher Kubernetes Engine.]({{}}/rke/latest/en/os/#ports) +For a breakdown of the port requirements for etcd nodes, controlplane nodes, and worker nodes in a Kubernetes cluster, refer to the [port requirements for the Rancher Kubernetes Engine.](https://rancher.com/docs/rke/latest/en/os/#ports) -Details on which ports are used in each situation are found under [Downstream Cluster Port Requirements]({{}}/rancher/v2.6/en/installation/requirements/ports#downstream-kubernetes-cluster-nodes). +Details on which ports are used in each situation are found under [Downstream Cluster Port Requirements](../../../getting-started/installation-and-upgrade/installation-requirements/port-requirements.md#downstream-kubernetes-cluster-nodes). # Optional: Security Considerations If you want to provision a Kubernetes cluster that is compliant with the CIS (Center for Internet Security) Kubernetes Benchmark, we recommend to following our hardening guide to configure your nodes before installing Kubernetes. -For more information on the hardening guide and details on which version of the guide corresponds to your Rancher and Kubernetes versions, refer to the [security section.]({{}}/rancher/v2.6/en/security/#rancher-hardening-guide) +For more information on the hardening guide and details on which version of the guide corresponds to your Rancher and Kubernetes versions, refer to the [security section.](../../../pages-for-subheaders/rancher-security.md#rancher-hardening-guide) diff --git a/docs/en/cluster-provisioning/registered-clusters/registered-clusters.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md similarity index 90% rename from docs/en/cluster-provisioning/registered-clusters/registered-clusters.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md index 748dfb689ac..9cd07255c64 100644 --- a/docs/en/cluster-provisioning/registered-clusters/registered-clusters.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md @@ -21,7 +21,7 @@ The control that Rancher has to manage a registered cluster depends on the type Registered RKE Kubernetes clusters must have all three node roles - etcd, controlplane and worker. A cluster with only controlplane components cannot be registered in Rancher. -For more information on RKE node roles, see the [best practices.]({{}}/rancher/v2.6/en/cluster-provisioning/production/#cluster-architecture) +For more information on RKE node roles, see the [best practices.](../../../pages-for-subheaders/checklist-for-production-ready-clusters.md#cluster-architecture) ### Permissions @@ -52,7 +52,7 @@ EKS clusters must have at least one managed node group to be imported into Ranch 1. Choose the type of cluster. 1. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user. 1. If you are importing a generic Kubernetes cluster in Rancher, perform the following steps for setup:
- a. Click **Agent Environment Variables** under **Cluster Options** to set environment variables for [rancher cluster agent]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/rancher-agents/). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables.
+ a. Click **Agent Environment Variables** under **Cluster Options** to set environment variables for [rancher cluster agent](launch-kubernetes-with-rancher/about-rancher-agents.md). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables.
b. Enable Project Network Isolation to ensure the cluster supports Kubernetes `NetworkPolicy` resources. Users can select the **Project Network Isolation** option under the **Advanced Options** dropdown to do so. 1. Click **Create**. 1. The prerequisite for `cluster-admin` privileges is shown (see **Prerequisites** above), including an example command to fulfil the prerequisite. @@ -133,20 +133,20 @@ The control that Rancher has to manage a registered cluster depends on the type After registering a cluster, the cluster owner can: -- [Manage cluster access]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/) through role-based access control -- Enable [monitoring, alerts and notifiers]({{}}/rancher/v2.6/en/monitoring-alerting/) -- Enable [logging]({{}}/rancher/v2.6/en/logging/) -- Enable [Istio]({{}}/rancher/v2.6/en/istio/) -- Use [pipelines]({{}}/rancher/v2.6/en/project-admin/pipelines/) +- [Manage cluster access](../../advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md) through role-based access control +- Enable [monitoring, alerts and notifiers](../../../pages-for-subheaders/monitoring-and-alerting.md) +- Enable [logging](../../../pages-for-subheaders/logging.md) +- Enable [Istio](../../../pages-for-subheaders/istio.md) +- Use [pipelines](../../advanced-user-guides/manage-projects/ci-cd-pipelines.md) - Manage projects and workloads ### Additional Features for Registered K3s Clusters -[K3s]({{}}/k3s/latest/en/) is a lightweight, fully compliant Kubernetes distribution. +[K3s](https://rancher.com/docs/k3s/latest/en/) is a lightweight, fully compliant Kubernetes distribution. When a K3s cluster is registered in Rancher, Rancher will recognize it as K3s. The Rancher UI will expose the features for [all registered clusters,](#features-for-all-registered-clusters) in addition to the following features for editing and upgrading the cluster: -- The ability to [upgrade the K3s version]({{}}/rancher/v2.6/en/cluster-admin/upgrading-kubernetes/) +- The ability to [upgrade the K3s version](../../../getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes.md) - The ability to configure the maximum number of nodes that will be upgraded concurrently - The ability to see a read-only version of the K3s cluster's configuration arguments and environment variables used to launch each node in the cluster @@ -158,7 +158,7 @@ Amazon EKS clusters and GKE clusters can now be registered in Rancher. For the m When you delete an EKS cluster or GKE cluster that was created in Rancher, the cluster is destroyed. When you delete a cluster that was registered in Rancher, it is disconnected from the Rancher server, but it still exists and you can still access it in the same way you did before it was registered in Rancher. -The capabilities for registered clusters are listed in the table on [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/) +The capabilities for registered clusters are listed in the table on [this page.](../../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md) # Configuring K3s Cluster Upgrades @@ -203,7 +203,7 @@ To prevent issues when upgrading, the [Kubernetes upgrade best practices](https: _Available as of v2.6.3_ -Authorized Cluster Endpoint (ACE) support has been added for registered RKE2 and K3s clusters. This support includes manual steps you will perform on the downstream cluster to enable the ACE. For additional information on the authorized cluster endpoint, click [here]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/ace/). +Authorized Cluster Endpoint (ACE) support has been added for registered RKE2 and K3s clusters. This support includes manual steps you will perform on the downstream cluster to enable the ACE. For additional information on the authorized cluster endpoint, click [here](../../advanced-user-guides/manage-clusters/access-clusters/authorized-cluster-endpoint.md). :::note Notes: @@ -211,7 +211,7 @@ Authorized Cluster Endpoint (ACE) support has been added for registered RKE2 and - The following steps will work on both RKE2 and K3s clusters registered in v2.6.x as well as those registered (or imported) from a previous version of Rancher with an upgrade to v2.6.x. -- These steps will alter the configuration of the downstream RKE2 and K3s clusters and deploy the `kube-api-authn-webhook`. If a future implementation of the ACE requires an update to the `kube-api-authn-webhook`, then this would also have to be done manually. For more information on this webhook, click [here]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/ace/#about-the-kube-api-auth-authentication-webhook). +- These steps will alter the configuration of the downstream RKE2 and K3s clusters and deploy the `kube-api-authn-webhook`. If a future implementation of the ACE requires an update to the `kube-api-authn-webhook`, then this would also have to be done manually. For more information on this webhook, click [here](../../advanced-user-guides/manage-clusters/access-clusters/authorized-cluster-endpoint.md#about-the-kube-api-auth-authentication-webhook). ::: diff --git a/docs/en/cluster-provisioning/hosted-kubernetes-clusters/aks/aks.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks.md similarity index 91% rename from docs/en/cluster-provisioning/hosted-kubernetes-clusters/aks/aks.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks.md index ac4c2a78cc5..158193312bd 100644 --- a/docs/en/cluster-provisioning/hosted-kubernetes-clusters/aks/aks.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks.md @@ -110,7 +110,7 @@ To give role-based access to your service principal, 1. Click **Cloud Credentials**. 1. Click **Create**. 1. Click **Azure**. -1. Fill out the form. For help with filling out the form, see the [configuration reference.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/aks-config-reference/#cloud-credentials) +1. Fill out the form. For help with filling out the form, see the [configuration reference.](../../../../reference-guides/cluster-configuration/rancher-server-configuration/aks-cluster-configuration.md#cloud-credentials) 1. Click **Create**. # 2. Create the AKS Cluster @@ -120,7 +120,7 @@ Use Rancher to set up and configure your Kubernetes cluster. 1. Click **☰ > Cluster Management**. 1. In the **Clusters** section, click **Create**. 1. Click **Azure AKS**. -1. Fill out the form. For help with filling out the form, see the [configuration reference.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/aks-config-reference) +1. Fill out the form. For help with filling out the form, see the [configuration reference.](../../../../reference-guides/cluster-configuration/rancher-server-configuration/aks-cluster-configuration.md) 1. Click **Create**. **Result:** Your cluster is created and assigned a state of **Provisioning**. Rancher is standing up your cluster. @@ -134,7 +134,7 @@ RBAC is required for AKS clusters that are registered or imported into Rancher. # AKS Cluster Configuration Reference -For more information about how to configure AKS clusters from the Rancher UI, see the [configuration reference.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/aks-config-reference) +For more information about how to configure AKS clusters from the Rancher UI, see the [configuration reference.](../../../../reference-guides/cluster-configuration/rancher-server-configuration/aks-cluster-configuration.md) # Private Clusters @@ -156,9 +156,9 @@ For more information about connecting to an AKS private cluster, see the [AKS do # Syncing -The AKS provisioner can synchronize the state of an AKS cluster between Rancher and the provider. For an in-depth technical explanation of how this works, see [Syncing.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/syncing) +The AKS provisioner can synchronize the state of an AKS cluster between Rancher and the provider. For an in-depth technical explanation of how this works, see [Syncing.](../../../../reference-guides/cluster-configuration/rancher-server-configuration/sync-clusters.md) -For information on configuring the refresh interval, see [this section.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference/#configuring-the-refresh-interval) +For information on configuring the refresh interval, see [this section.](../../../../pages-for-subheaders/gke-cluster-configuration.md#configuring-the-refresh-interval) # Programmatically Creating AKS Clusters diff --git a/docs/en/cluster-provisioning/hosted-kubernetes-clusters/ack/ack.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba.md similarity index 84% rename from docs/en/cluster-provisioning/hosted-kubernetes-clusters/ack/ack.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba.md index 8c01b435914..12073512976 100644 --- a/docs/en/cluster-provisioning/hosted-kubernetes-clusters/ack/ack.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba.md @@ -4,7 +4,7 @@ shortTitle: Alibaba Cloud Container Service for Kubernetes weight: 2120 --- -You can use Rancher to create a cluster hosted in Alibaba Cloud Kubernetes (ACK). Rancher has already implemented and packaged the [cluster driver]({{}}/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/) for ACK, but by default, this cluster driver is `inactive`. In order to launch ACK clusters, you will need to [enable the ACK cluster driver]({{}}/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/#activating-deactivating-cluster-drivers). After enabling the cluster driver, you can start provisioning ACK clusters. +You can use Rancher to create a cluster hosted in Alibaba Cloud Kubernetes (ACK). Rancher has already implemented and packaged the [cluster driver](../../../advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md) for ACK, but by default, this cluster driver is `inactive`. In order to launch ACK clusters, you will need to [enable the ACK cluster driver](../../../advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#activating-deactivating-cluster-drivers). After enabling the cluster driver, you can start provisioning ACK clusters. # Prerequisites Outside of Rancher diff --git a/docs/en/cluster-provisioning/hosted-kubernetes-clusters/gke/gke.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke.md similarity index 90% rename from docs/en/cluster-provisioning/hosted-kubernetes-clusters/gke/gke.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke.md index 88232871dce..85383530552 100644 --- a/docs/en/cluster-provisioning/hosted-kubernetes-clusters/gke/gke.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke.md @@ -68,7 +68,7 @@ Use Rancher to set up and configure your Kubernetes cluster. 1. Optional: Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user. 1. Optional: Add Kubernetes [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) or [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to the cluster. 1. Enter your Google project ID and your Google cloud credentials. -1. Fill out the rest of the form. For help, refer to the [GKE cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference) +1. Fill out the rest of the form. For help, refer to the [GKE cluster configuration reference.](../../../../pages-for-subheaders/gke-cluster-configuration.md) 1. Click **Create**. **Result:** You have successfully deployed a GKE cluster. @@ -84,11 +84,11 @@ You can access your cluster after its state is updated to **Active**. # Private Clusters -Private GKE clusters are supported. Note: This advanced setup can require more steps during the cluster provisioning process. For details, see [this section.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/) +Private GKE clusters are supported. Note: This advanced setup can require more steps during the cluster provisioning process. For details, see [this section.](../../../../reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-private-clusters.md) # Configuration Reference -For details on configuring GKE clusters in Rancher, see [this page.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference) +For details on configuring GKE clusters in Rancher, see [this page.](../../../../pages-for-subheaders/gke-cluster-configuration.md) # Updating Kubernetes Version The Kubernetes version of a cluster can be upgraded to any version available in the region or zone fo the GKE cluster. Upgrading the master Kubernetes version does not automatically upgrade worker nodes. Nodes can be upgraded independently. @@ -101,9 +101,9 @@ GKE has removed basic authentication in 1.19+. In order to upgrade a cluster to # Syncing -The GKE provisioner can synchronize the state of a GKE cluster between Rancher and the provider. For an in-depth technical explanation of how this works, see [Syncing.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/syncing) +The GKE provisioner can synchronize the state of a GKE cluster between Rancher and the provider. For an in-depth technical explanation of how this works, see [Syncing.](../../../../reference-guides/cluster-configuration/rancher-server-configuration/sync-clusters.md) -For information on configuring the refresh interval, see [this section.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference/#configuring-the-refresh-interval) +For information on configuring the refresh interval, see [this section.](../../../../pages-for-subheaders/gke-cluster-configuration.md#configuring-the-refresh-interval) # Programmatically Creating GKE Clusters diff --git a/docs/en/cluster-provisioning/hosted-kubernetes-clusters/cce/cce.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei.md similarity index 91% rename from docs/en/cluster-provisioning/hosted-kubernetes-clusters/cce/cce.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei.md index d5712c41af8..f95eb44ab6b 100644 --- a/docs/en/cluster-provisioning/hosted-kubernetes-clusters/cce/cce.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei.md @@ -4,7 +4,7 @@ shortTitle: Huawei Cloud Kubernetes Service weight: 2130 --- -You can use Rancher to create a cluster hosted in Huawei Cloud Container Engine (CCE). Rancher has already implemented and packaged the [cluster driver]({{}}/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/) for CCE, but by default, this cluster driver is `inactive`. In order to launch CCE clusters, you will need to [enable the CCE cluster driver]({{}}/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/#activating-deactivating-cluster-drivers). After enabling the cluster driver, you can start provisioning CCE clusters. +You can use Rancher to create a cluster hosted in Huawei Cloud Container Engine (CCE). Rancher has already implemented and packaged the [cluster driver](../../../advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md) for CCE, but by default, this cluster driver is `inactive`. In order to launch CCE clusters, you will need to [enable the CCE cluster driver](../../../advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#activating-deactivating-cluster-drivers). After enabling the cluster driver, you can start provisioning CCE clusters. # Prerequisites in Huawei @@ -72,7 +72,7 @@ You can access your cluster after its state is updated to **Active**. :::note -If you are editing the cluster in the `cluster.yml` instead of the Rancher UI, note that cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#config-file-structure-in-rancher-v2-3-0) +If you are editing the cluster in the `cluster.yml` instead of the Rancher UI, note that cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure.](cluster-provisioning/rke-clusters/options/#config-file-structure-in-rancher-v2-3-0) ::: diff --git a/docs/en/cluster-provisioning/hosted-kubernetes-clusters/tke/tke.md b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent.md similarity index 89% rename from docs/en/cluster-provisioning/hosted-kubernetes-clusters/tke/tke.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent.md index 66e68655759..596f6ca95f0 100644 --- a/docs/en/cluster-provisioning/hosted-kubernetes-clusters/tke/tke.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent.md @@ -4,7 +4,7 @@ shortTitle: Tencent Kubernetes Engine weight: 2125 --- -You can use Rancher to create a cluster hosted in Tencent Kubernetes Engine (TKE). Rancher has already implemented and packaged the [cluster driver]({{}}/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/) for TKE, but by default, this cluster driver is `inactive`. In order to launch TKE clusters, you will need to [enable the TKE cluster driver]({{}}/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/#activating-deactivating-cluster-drivers). After enabling the cluster driver, you can start provisioning TKE clusters. +You can use Rancher to create a cluster hosted in Tencent Kubernetes Engine (TKE). Rancher has already implemented and packaged the [cluster driver](../../../advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md) for TKE, but by default, this cluster driver is `inactive`. In order to launch TKE clusters, you will need to [enable the TKE cluster driver](../../../advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#activating-deactivating-cluster-drivers). After enabling the cluster driver, you can start provisioning TKE clusters. # Prerequisites in Tencent @@ -61,7 +61,7 @@ When the cluster driver is finished downloading, you will be able to create Tenc :::note - If you are editing the cluster in the `cluster.yml` instead of the Rancher UI, note that, cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure in Rancher v2.3.0+.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#config-file-structure-in-rancher-v2-3-0) + If you are editing the cluster in the `cluster.yml` instead of the Rancher UI, note that, cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure in Rancher v2.3.0+.](cluster-provisioning/rke-clusters/options/#config-file-structure-in-rancher-v2-3-0) ::: diff --git a/docs/en/k8s-in-rancher/configmaps/configmaps.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/configmaps.md similarity index 91% rename from docs/en/k8s-in-rancher/configmaps/configmaps.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/configmaps.md index 23811f400ee..a79e40f2f3b 100644 --- a/docs/en/k8s-in-rancher/configmaps/configmaps.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/configmaps.md @@ -21,7 +21,7 @@ ConfigMaps accept key value pairs in common string formats, like config files or 1. Select the **Namespace** you want to add Config Map to. -1. On the **Data** tab, add a key-value pair to your ConfigMap. Add as many values as you need. You can add multiple key value pairs to the ConfigMap by copying and pasting. Alternatively, use **Read from File** to add the data. Note: If you need to store sensitive data, [use a secret]({{}}/rancher/v2.6/en/k8s-in-rancher/secrets/), not a ConfigMap. +1. On the **Data** tab, add a key-value pair to your ConfigMap. Add as many values as you need. You can add multiple key value pairs to the ConfigMap by copying and pasting. Alternatively, use **Read from File** to add the data. Note: If you need to store sensitive data, [use a secret](secrets.md), not a ConfigMap. 1. Click **Create**. **Result:** Your ConfigMap is added to the namespace. You can view it in the Rancher UI from the **Resources > Config Maps** view. @@ -33,4 +33,4 @@ Now that you have a ConfigMap added to a namespace, you can add it to a workload - Application environment variables. - Specifying parameters for a Volume mounted to the workload. -For more information on adding ConfigMaps to a workload, see [Deploying Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/deploy-workloads/). +For more information on adding ConfigMaps to a workload, see [Deploying Workloads](workloads-and-pods/deploy-workloads.md). diff --git a/docs/en/k8s-in-rancher/service-discovery/service-discovery.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/create-services.md similarity index 100% rename from docs/en/k8s-in-rancher/service-discovery/service-discovery.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/create-services.md diff --git a/docs/en/k8s-in-rancher/certificates/certificates.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/encrypt-http-communication.md similarity index 95% rename from docs/en/k8s-in-rancher/certificates/certificates.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/encrypt-http-communication.md index 277517b1ca9..09a679d1845 100644 --- a/docs/en/k8s-in-rancher/certificates/certificates.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/encrypt-http-communication.md @@ -36,4 +36,4 @@ You must have a TLS private key and certificate available to upload. ## What's Next? -Now you can add the certificate when launching an ingress within the current project or namespace. For more information, see [Adding Ingress]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/ingress/). +Now you can add the certificate when launching an ingress within the current project or namespace. For more information, see [Adding Ingress](load-balancer-and-ingress-controller/add-ingresses.md). diff --git a/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/about-hpas.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/about-hpas.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/about-hpas.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-kubectl.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-kubectl.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-kubectl.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-ui.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-ui.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-ui.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/test-hpas-with-kubectl.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/test-hpas-with-kubectl.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/test-hpas-with-kubectl.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/k8s-in-rancher/registries/registries.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-and-docker-registries.md similarity index 100% rename from docs/en/k8s-in-rancher/registries/registries.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-and-docker-registries.md diff --git a/docs/en/k8s-in-rancher/load-balancers-and-ingress/ingress/ingress.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/add-ingresses.md similarity index 100% rename from docs/en/k8s-in-rancher/load-balancers-and-ingress/ingress/ingress.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/add-ingresses.md diff --git a/docs/en/k8s-in-rancher/load-balancers-and-ingress/ingress-config/ingress-config.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/ingress-configuration.md similarity index 97% rename from docs/en/k8s-in-rancher/load-balancers-and-ingress/ingress-config/ingress-config.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/ingress-configuration.md index d3655a4090b..68af8c466c0 100644 --- a/docs/en/k8s-in-rancher/load-balancers-and-ingress/ingress-config/ingress-config.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/ingress-configuration.md @@ -34,7 +34,7 @@ If you use this option, ingress routes requests for a hostname to the service or :::note -You must have an SSL certificate that the ingress can use to encrypt/decrypt communications. For more information see [Adding SSL Certificates]({{}}/rancher/v2.6/en/k8s-in-rancher/certificates/). +You must have an SSL certificate that the ingress can use to encrypt/decrypt communications. For more information see [Adding SSL Certificates](../encrypt-http-communication.md). ::: diff --git a/docs/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/load-balancers.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing.md similarity index 100% rename from docs/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/load-balancers.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing.md diff --git a/docs/en/k8s-in-rancher/secrets/secrets.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/secrets.md similarity index 92% rename from docs/en/k8s-in-rancher/secrets/secrets.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/secrets.md index 56bee0cda29..afcf18d9710 100644 --- a/docs/en/k8s-in-rancher/secrets/secrets.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/secrets.md @@ -7,7 +7,7 @@ weight: 3062 :::note -This page is about secrets in general. For details on setting up a private registry, refer to the section on [registries.]({{}}/rancher/v2.6/en/k8s-in-rancher/registries) +This page is about secrets in general. For details on setting up a private registry, refer to the section on [registries.](kubernetes-and-docker-registries.md) ::: @@ -39,7 +39,7 @@ Mounted secrets will be updated automatically unless they are mounted as subpath ::: - {{< img "/img/rancher/bulk-key-values.gif" "Bulk Key Value Pair Copy/Paste">}} + ![](/img/bulk-key-values.gif) 1. Click **Save**. @@ -74,4 +74,4 @@ Project-scoped secrets on the local cluster are only visible when a single proje Now that you have a secret added to a namespace, you can add it to a workload that you deploy. -For more information on adding secret to a workload, see [Deploying Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/deploy-workloads/). +For more information on adding secret to a workload, see [Deploying Workloads](workloads-and-pods/deploy-workloads.md). diff --git a/docs/en/k8s-in-rancher/workloads/add-a-sidecar/add-a-sidecar.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/add-a-sidecar.md similarity index 97% rename from docs/en/k8s-in-rancher/workloads/add-a-sidecar/add-a-sidecar.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/add-a-sidecar.md index adc69309b6b..5086662fd35 100644 --- a/docs/en/k8s-in-rancher/workloads/add-a-sidecar/add-a-sidecar.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/add-a-sidecar.md @@ -24,7 +24,7 @@ A _sidecar_ is a container that extends or enhances the main container in a pod. 1. From the **Container Image** field, enter the name of the container image that you want to deploy in support of the main container. During deployment, Rancher pulls this image from [Docker Hub](https://hub.docker.com/explore/). Enter the name exactly as it appears on Docker Hub. -1. Set the remaining options. You can read about them in [Deploying Workloads](../deploy-workloads). +1. Set the remaining options. You can read about them in [Deploying Workloads](deploy-workloads.md). 1. Click **Launch**. diff --git a/docs/en/k8s-in-rancher/workloads/deploy-workloads/deploy-workloads.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/deploy-workloads.md similarity index 85% rename from docs/en/k8s-in-rancher/workloads/deploy-workloads/deploy-workloads.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/deploy-workloads.md index 5e04fa91b78..ce6bb5d29fb 100644 --- a/docs/en/k8s-in-rancher/workloads/deploy-workloads/deploy-workloads.md +++ b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/deploy-workloads.md @@ -18,19 +18,19 @@ Deploy a workload to run an application in one or more containers. 1. Either select an existing namespace, or click **Add to a new namespace** and enter a new namespace. -1. Click **Add Port** to enter a port mapping, which enables access to the application inside and outside of the cluster . For more information, see [Services]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/#services). +1. Click **Add Port** to enter a port mapping, which enables access to the application inside and outside of the cluster . For more information, see [Services](../../../../pages-for-subheaders/workloads-and-pods.md#services). 1. Configure the remaining options: - **Environment Variables** - Use this section to either specify environment variables for your workload to consume on the fly, or to pull them from another source, such as a secret or [ConfigMap]({{}}/rancher/v2.6/en/k8s-in-rancher/configmaps/). + Use this section to either specify environment variables for your workload to consume on the fly, or to pull them from another source, such as a secret or [ConfigMap](../configmaps.md). - **Node Scheduling** - **Health Check** - **Volumes** - Use this section to add storage for your workload. You can manually specify the volume that you want to add, use a persistent volume claim to dynamically create a volume for the workload, or read data for a volume to use from a file such as a [ConfigMap]({{}}/rancher/v2.6/en/k8s-in-rancher/configmaps/). + Use this section to add storage for your workload. You can manually specify the volume that you want to add, use a persistent volume claim to dynamically create a volume for the workload, or read data for a volume to use from a file such as a [ConfigMap](../configmaps.md). When you are deploying a Stateful Set, you should use a Volume Claim Template when using Persistent Volumes. This will ensure that Persistent Volumes are created dynamically when you scale your Stateful Set. @@ -42,7 +42,7 @@ Deploy a workload to run an application in one or more containers. - In [Amazon AWS](https://aws.amazon.com/), the nodes must be in the same Availability Zone and possess IAM permissions to attach/unattach volumes. - - The cluster must be using the [AWS cloud provider](https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#aws) option. For more information on enabling this option see [Creating an Amazon EC2 Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/) or [Creating a Custom Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes). + - The cluster must be using the [AWS cloud provider](https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#aws) option. For more information on enabling this option see [Creating an Amazon EC2 Cluster](../../kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster.md) or [Creating a Custom Cluster](../../../../pages-for-subheaders/use-existing-nodes.md). ::: diff --git a/docs/en/k8s-in-rancher/workloads/rollback-workloads/rollback-workloads.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/roll-back-workloads.md similarity index 100% rename from docs/en/k8s-in-rancher/workloads/rollback-workloads/rollback-workloads.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/roll-back-workloads.md diff --git a/docs/en/k8s-in-rancher/workloads/upgrade-workloads/upgrade-workloads.md b/docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/upgrade-workloads.md similarity index 100% rename from docs/en/k8s-in-rancher/workloads/upgrade-workloads/upgrade-workloads.md rename to docs/en/how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/upgrade-workloads.md diff --git a/docs/en/installation/other-installation-methods/air-gap/air-gap.md b/docs/en/installation/other-installation-methods/air-gap/air-gap.md deleted file mode 100644 index 17315bb95a2..00000000000 --- a/docs/en/installation/other-installation-methods/air-gap/air-gap.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Air-Gapped Helm CLI Install -weight: 1 ---- - -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. - -The installation steps differ depending on whether Rancher is installed on an RKE Kubernetes cluster, a K3s Kubernetes cluster, or a single Docker container. - -For more information on each installation option, refer to [this page.]({{}}/rancher/v2.6/en/installation/) - -Throughout the installation instructions, there will be _tabs_ for each installation option. - -:::note Important: - -If you install Rancher following the Docker installation guide, there is no upgrade path to transition your Docker Installation to a Kubernetes Installation. - -::: - -# Installation Outline - -1. [Set up infrastructure and private registry]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/prepare-nodes/) -2. [Collect and publish images to your private registry]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/populate-private-registry/) -3. [Set up a Kubernetes cluster (Skip this step for Docker installations)]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/launch-kubernetes/) -4. [Install Rancher]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/install-rancher/) - -# Upgrades - -To upgrade Rancher with Helm CLI in an air gap environment, follow [this procedure.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/) - -### [Next: Prepare your Node(s)]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/prepare-nodes/) diff --git a/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infrastructure-tutorials.md b/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infrastructure-tutorials.md deleted file mode 100644 index 89f4a7ac795..00000000000 --- a/docs/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infrastructure-tutorials.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Don't have infrastructure for your Kubernetes cluster? Try one of these tutorials. -shortTitle: Infrastructure Tutorials -weight: 5 ---- - -To set up infrastructure for a high-availability K3s Kubernetes cluster with an external DB, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/) - - -To set up infrastructure for a high-availability RKE Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/) diff --git a/docs/en/installation/resources/resources.md b/docs/en/installation/resources/resources.md deleted file mode 100644 index d7c44116e0b..00000000000 --- a/docs/en/installation/resources/resources.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Resources -weight: 5 ---- - -### Docker Installations - -The [single-node Docker installation]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker) is for Rancher users that are wanting to test out Rancher. Instead of running on a Kubernetes cluster using Helm, you install the Rancher server component on a single node using a `docker run` command. - -Since there is only one node and a single Docker container, if the node goes down, there is no copy of the etcd data available on other nodes and you will lose all the data of your Rancher server. - -### Air-Gapped Installations - -Follow [these steps]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap) 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. - -### Advanced Options - -When installing Rancher, there are several advanced options that can be enabled during installation. Within each install guide, these options are presented. Learn more about these options: - -- [Custom CA Certificate]({{}}/rancher/v2.6/en/installation/resources/custom-ca-root-certificate/) -- [API Audit Log]({{}}/rancher/v2.6/en/installation/resources/advanced/api-audit-log/) -- [TLS Settings]({{}}/rancher/v2.6/en/installation/resources/tls-settings/) -- [etcd configuration]({{}}/rancher/v2.6/en/installation/resources/advanced/etcd/) -- [Local System Charts for Air Gap Installations]({{}}/rancher/v2.6/en/installation/resources/local-system-charts) | v2.3.0 | diff --git a/docs/en/istio/setup/setup.md b/docs/en/istio/setup/setup.md deleted file mode 100644 index 5d4ff8d8e36..00000000000 --- a/docs/en/istio/setup/setup.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Setup Guide -weight: 2 ---- - -This section describes how to enable Istio and start using it in your projects. - -If you use Istio for traffic management, you will need to allow external traffic to the cluster. In that case, you will need to follow all of the steps below. - -# Prerequisites - -This guide assumes you have already [installed Rancher,]({{}}/rancher/v2.6/en/installation) and you have already [provisioned a separate Kubernetes cluster]({{}}/rancher/v2.6/en/cluster-provisioning) on which you will install Istio. - -The nodes in your cluster must meet the [CPU and memory requirements.]({{}}/rancher/v2.6/en/istio/resources/) - -The workloads and services that you want to be controlled by Istio must meet [Istio's requirements.](https://istio.io/docs/setup/additional-setup/requirements/) - - -# Install - -:::tip Quick Setup Tip: If you don't need external traffic to reach Istio, and you just want to set up Istio for monitoring and tracing traffic within the cluster, skip the steps for [setting up the Istio gateway]({{}}/rancher/v2.6/en/istio/setup/gateway) and [setting up Istio's components for traffic management.]({{}}/rancher/v2.6/en/istio/setup/set-up-traffic-management) - -::: - -1. [Enable Istio in the cluster.]({{}}/rancher/v2.6/en/istio/setup/enable-istio-in-cluster) -1. [Enable Istio in all the namespaces where you want to use it.]({{}}/rancher/v2.6/en/istio/setup/enable-istio-in-namespace) -1. [Add deployments and services that have the Istio sidecar injected.]({{}}/rancher/v2.6/en/istio/setup/deploy-workloads) -1. [Set up the Istio gateway. ]({{}}/rancher/v2.6/en/istio/setup/gateway) -1. [Set up Istio's components for traffic management.]({{}}/rancher/v2.6/en/istio/setup/set-up-traffic-management) -1. [Generate traffic and see Istio in action.]({{}}/rancher/v2.6/en/istio/setup/view-traffic/ ) diff --git a/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md b/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md index 148d6b69432..b62c5fbf104 100644 --- a/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md +++ b/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/horizontal-pod-autoscaler.md @@ -17,12 +17,12 @@ The way that you manage HPAs is different based on your version of the Kubernete - **For Kubernetes API version autoscaling/V2beta1:** This version of the Kubernetes API lets you autoscale your pods based on the CPU and memory utilization of your application. - **For Kubernetes API Version autoscaling/V2beta2:** This version of the Kubernetes API lets you autoscale your pods based on CPU and memory utilization, in addition to custom metrics. -You can create, manage, and delete HPAs using the Rancher UI. From the Rancher UI you can configure the HPA to scale based on CPU and memory utilization. For more information, refer to [Managing HPAs with the Rancher UI]({{}}/rancher/v2.6/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui). To scale the HPA based on custom metrics, you still need to use `kubectl`. For more information, refer to [Configuring HPA to Scale Using Custom Metrics with Prometheus]({{}}/rancher/v2.6/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/#configuring-hpa-to-scale-using-custom-metrics-with-prometheus). +You can create, manage, and delete HPAs using the Rancher UI. From the Rancher UI you can configure the HPA to scale based on CPU and memory utilization. For more information, refer to [Managing HPAs with the Rancher UI](k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui). To scale the HPA based on custom metrics, you still need to use `kubectl`. For more information, refer to [Configuring HPA to Scale Using Custom Metrics with Prometheus](k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/#configuring-hpa-to-scale-using-custom-metrics-with-prometheus). Clusters created in Rancher v2.0.7 and higher automatically have all the requirements needed (metrics-server and Kubernetes cluster configuration) to use HPA. ## Testing HPAs with a Service Deployment -You can see your HPA's current number of replicas by going to your project and clicking **Resources > HPA**. For more information, refer to [Get HPA Metrics and Status]({{}}/rancher/v2.6/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui/). +You can see your HPA's current number of replicas by going to your project and clicking **Resources > HPA**. For more information, refer to [Get HPA Metrics and Status](k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui/). You can also use `kubectl` to get the status of HPAs that you test with your load testing tool. For more information, refer to [Testing HPAs with kubectl] -({{}}/rancher/v2.6/en/k8s-in-rancher/horizontal-pod-autoscaler/testing-hpa/). +(k8s-in-rancher/horizontal-pod-autoscaler/testing-hpa/). diff --git a/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/hpa-background/hpa-background.md b/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/hpa-background/hpa-background.md index c2a8dfc53fc..96f9cb54384 100644 --- a/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/hpa-background/hpa-background.md +++ b/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/hpa-background/hpa-background.md @@ -20,7 +20,7 @@ HPA improves your services by: ## How HPA Works -![HPA Schema]({{}}/img/rancher/horizontal-pod-autoscaler.jpg) +![HPA Schema](/img/horizontal-pod-autoscaler.jpg) HPA is implemented as a control loop, with a period controlled by the `kube-controller-manager` flags below: diff --git a/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/manage-hpa-with-kubectl.md b/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/manage-hpa-with-kubectl.md index 54cf441bdfb..ddb2901c0af 100644 --- a/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/manage-hpa-with-kubectl.md +++ b/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/manage-hpa-with-kubectl.md @@ -12,7 +12,7 @@ This section describes HPA management with `kubectl`. This document has instruct - Configure your HPAs to scale using custom metrics, if you use a third-party tool such as Prometheus for metrics -You can create, view, and delete HPAs from the Rancher UI. You can also configure them to scale based on CPU or memory usage from the Rancher UI. For more information, refer to [Managing HPAs with the Rancher UI]({{}}/rancher/v2.6/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui). For scaling HPAs based on other metrics than CPU or memory, you still need `kubectl`. +You can create, view, and delete HPAs from the Rancher UI. You can also configure them to scale based on CPU or memory usage from the Rancher UI. For more information, refer to [Managing HPAs with the Rancher UI](k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui). For scaling HPAs based on other metrics than CPU or memory, you still need `kubectl`. ##### Basic kubectl Command for Managing HPAs diff --git a/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui/manage-hpa-with-rancher-ui.md b/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui/manage-hpa-with-rancher-ui.md index a89fe1ae748..00563e231ef 100644 --- a/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui/manage-hpa-with-rancher-ui.md +++ b/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui/manage-hpa-with-rancher-ui.md @@ -5,7 +5,7 @@ weight: 3028 The Rancher UI supports creating, managing, and deleting HPAs. You can configure CPU or memory usage as the metric that the HPA uses to scale. -If you want to create HPAs that scale based on other metrics than CPU and memory, refer to [Configuring HPA to Scale Using Custom Metrics with Prometheus]({{}}/rancher/v2.6/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/#configuring-hpa-to-scale-using-custom-metrics-with-prometheus). +If you want to create HPAs that scale based on other metrics than CPU and memory, refer to [Configuring HPA to Scale Using Custom Metrics with Prometheus](k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/#configuring-hpa-to-scale-using-custom-metrics-with-prometheus). ## Creating an HPA @@ -17,7 +17,7 @@ If you want to create HPAs that scale based on other metrics than CPU and memory 1. Enter a **Name** for the HPA. 1. Select a **Target Reference** as scale target for the HPA. 1. Specify the **Minimum Replicas** and **Maximum Replicas** for the HPA. -1. Configure the metrics for the HPA. You can choose memory or CPU usage as the metric that will cause the HPA to scale the service up or down. In the **Quantity** field, enter the percentage of the workload's memory or CPU usage that will cause the HPA to scale the service. To configure other HPA metrics, including metrics available from Prometheus, you need to [manage HPAs using kubectl]({{}}/rancher/v2.6/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/#configuring-hpa-to-scale-using-custom-metrics-with-prometheus). +1. Configure the metrics for the HPA. You can choose memory or CPU usage as the metric that will cause the HPA to scale the service up or down. In the **Quantity** field, enter the percentage of the workload's memory or CPU usage that will cause the HPA to scale the service. To configure other HPA metrics, including metrics available from Prometheus, you need to [manage HPAs using kubectl](k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/#configuring-hpa-to-scale-using-custom-metrics-with-prometheus). 1. Click **Create** to create the HPA. diff --git a/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/testing-hpa/testing-hpa.md b/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/testing-hpa/testing-hpa.md index dad3c82420e..5de72772014 100644 --- a/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/testing-hpa/testing-hpa.md +++ b/docs/en/k8s-in-rancher/horizontal-pod-autoscaler/testing-hpa/testing-hpa.md @@ -3,7 +3,7 @@ title: Testing HPAs with kubectl weight: 3031 --- -This document describes how to check the status of your HPAs after scaling them up or down with your load testing tool. For information on how to check the status from the Rancher UI (at least version 2.3.x), refer to [Managing HPAs with the Rancher UI]({{}}/rancher/v2.6/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/). +This document describes how to check the status of your HPAs after scaling them up or down with your load testing tool. For information on how to check the status from the Rancher UI (at least version 2.3.x), refer to [Managing HPAs with the Rancher UI](k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl/). For HPA to work correctly, service deployments should have resources request definitions for containers. Follow this hello-world example to test if HPA is working correctly. diff --git a/docs/en/logging/custom-resource-config/custom-resource-config.md b/docs/en/logging/custom-resource-config/custom-resource-config.md deleted file mode 100644 index 71a5cfda34b..00000000000 --- a/docs/en/logging/custom-resource-config/custom-resource-config.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Custom Resource Configuration -weight: 5 ---- - -The following Custom Resource Definitions are used to configure logging: - -- [Flow and ClusterFlow](./flows) -- [Output and ClusterOutput](./outputs) \ No newline at end of file diff --git a/docs/en/monitoring-alerting/configuration/advanced/advanced.md b/docs/en/monitoring-alerting/configuration/advanced/advanced.md deleted file mode 100644 index f0b2f96fbc5..00000000000 --- a/docs/en/monitoring-alerting/configuration/advanced/advanced.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Advanced Configuration -weight: 500 ---- - -### Alertmanager - -For information on configuring the Alertmanager custom resource, see [this page.](./alertmanager) - -### Prometheus - -For information on configuring the Prometheus custom resource, see [this page.](./prometheus) - -### PrometheusRules - -For information on configuring the Prometheus custom resource, see [this page.](./prometheusrules) \ No newline at end of file diff --git a/docs/en/monitoring-alerting/guides/guides.md b/docs/en/monitoring-alerting/guides/guides.md deleted file mode 100644 index 1ef6fc5cce3..00000000000 --- a/docs/en/monitoring-alerting/guides/guides.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Monitoring Guides -shortTitle: Guides -weight: 4 ---- - -- [Enable monitoring](./enable-monitoring) -- [Uninstall monitoring](./uninstall) -- [Monitoring workloads](./monitoring-workloads) -- [Customizing Grafana dashboards](./customize-grafana) -- [Persistent Grafana dashboards](./persist-grafana) -- [Debugging high memory usage](./memory-usage) -- [Migrating from Monitoring V1 to V2](./migrating) \ No newline at end of file diff --git a/docs/en/admin-settings/authentication/authentication.md b/docs/en/pages-for-subheaders/about-authentication.md similarity index 65% rename from docs/en/admin-settings/authentication/authentication.md rename to docs/en/pages-for-subheaders/about-authentication.md index 4e11c9f3665..305c9075efe 100644 --- a/docs/en/admin-settings/authentication/authentication.md +++ b/docs/en/pages-for-subheaders/about-authentication.md @@ -13,27 +13,27 @@ The Rancher authentication proxy integrates with the following external authenti | Auth Service | | ------------------------------------------------------------------------------------------------ | -| [Microsoft Active Directory]({{}}/rancher/v2.6/en/admin-settings/authentication/ad/) | -| [GitHub]({{}}/rancher/v2.6/en/admin-settings/authentication/github/) | -| [Microsoft Azure AD]({{}}/rancher/v2.6/en/admin-settings/authentication/azure-ad/) | -| [FreeIPA]({{}}/rancher/v2.6/en/admin-settings/authentication/freeipa/) | -| [OpenLDAP]({{}}/rancher/v2.6/en/admin-settings/authentication/openldap/) | -| [Microsoft AD FS]({{}}/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/) | -| [PingIdentity]({{}}/rancher/v2.6/en/admin-settings/authentication/ping-federate/) | -| [Keycloak (OIDC)]({{}}/rancher/v2.6/en/admin-settings/authentication/keycloak-oidc/) | -| [Keycloak (SAML)]({{}}/rancher/v2.6/en/admin-settings/authentication/keycloak-saml/) | -| [Okta]({{}}/rancher/v2.6/en/admin-settings/authentication/okta/) | -| [Google OAuth]({{}}/rancher/v2.6/en/admin-settings/authentication/google/) | -| [Shibboleth]({{}}/rancher/v2.6/en/admin-settings/authentication/shibboleth) | +| [Microsoft Active Directory](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-active-directory.md) | +| [GitHub](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-github.md) | +| [Microsoft Azure AD](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-azure-ad.md) | +| [FreeIPA](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-freeipa.md) | +| [OpenLDAP](configure-openldap.md) | +| [Microsoft AD FS](configure-microsoft-ad-federation-service-saml.md) | +| [PingIdentity](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-pingidentity.md) | +| [Keycloak (OIDC)](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak-oidc.md) | +| [Keycloak (SAML)](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak-saml.md) | +| [Okta](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-okta-saml.md) | +| [Google OAuth](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-google-oauth.md) | +| [Shibboleth](configure-shibboleth-saml.md) |
-However, Rancher also provides [local authentication]({{}}/rancher/v2.6/en/admin-settings/authentication/local/). +However, Rancher also provides [local authentication](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/create-local-users.md). In most cases, you should use an external authentication service over local authentication, as external authentication allows user management from a central location. However, you may want a few local authentication users for managing Rancher under rare circumstances, such as if your external authentication provider is unavailable or undergoing maintenance. ## Users and Groups -Rancher relies on users and groups to determine who is allowed to log in to Rancher and which resources they can access. When authenticating with an external provider, groups are provided from the external provider based on the user. These users and groups are given specific roles to resources like clusters, projects, multi-cluster apps, and global DNS providers and entries. When you give access to a group, all users who are a member of that group in the authentication provider will be able to access the resource with the permissions that you've specified. For more information on roles and permissions, see [Role Based Access Control]({{}}/rancher/v2.6/en/admin-settings/rbac/). +Rancher relies on users and groups to determine who is allowed to log in to Rancher and which resources they can access. When authenticating with an external provider, groups are provided from the external provider based on the user. These users and groups are given specific roles to resources like clusters, projects, multi-cluster apps, and global DNS providers and entries. When you give access to a group, all users who are a member of that group in the authentication provider will be able to access the resource with the permissions that you've specified. For more information on roles and permissions, see [Role Based Access Control](manage-role-based-access-control-rbac.md). :::note @@ -41,7 +41,7 @@ Local authentication does not support creating or managing groups. ::: -For more information, see [Users and Groups]({{}}/rancher/v2.6/en/admin-settings/authentication/user-groups/) +For more information, see [Users and Groups](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/manage-users-and-groups.md) ## Scope of Rancher Authorization @@ -76,22 +76,22 @@ Configuration of external authentication affects how principal users are managed 1. Sign into Rancher as the local principal and complete configuration of external authentication. - ![Sign In]({{}}/img/rancher/sign-in.png) + ![Sign In](/img/sign-in.png) 2. Rancher associates the external principal with the local principal. These two users share the local principal's user ID. - ![Principal ID Sharing]({{}}/img/rancher/principal-ID.png) + ![Principal ID Sharing](/img/principal-ID.png) 3. After you complete configuration, Rancher automatically signs out the local principal. - ![Sign Out Local Principal]({{}}/img/rancher/sign-out-local.png) + ![Sign Out Local Principal](/img/sign-out-local.png) 4. Then, Rancher automatically signs you back in as the external principal. - ![Sign In External Principal]({{}}/img/rancher/sign-in-external.png) + ![Sign In External Principal](/img/sign-in-external.png) 5. Because the external principal and the local principal share an ID, no unique object for the external principal displays on the Users page. - ![Sign In External Principal]({{}}/img/rancher/users-page.png) + ![Sign In External Principal](/img/users-page.png) 6. The external principal and the local principal share the same access rights. diff --git a/docs/en/pages-for-subheaders/about-provisioning-drivers.md b/docs/en/pages-for-subheaders/about-provisioning-drivers.md new file mode 100644 index 00000000000..264c9d5ee8b --- /dev/null +++ b/docs/en/pages-for-subheaders/about-provisioning-drivers.md @@ -0,0 +1,48 @@ +--- +title: Provisioning Drivers +weight: 70 +--- + +Drivers in Rancher allow you to manage which providers can be used to deploy [hosted Kubernetes clusters](set-up-clusters-from-hosted-kubernetes-providers.md) or [nodes in an infrastructure provider](use-new-nodes-in-an-infra-provider.md) to allow Rancher to deploy and manage Kubernetes. + +### Rancher Drivers + +With Rancher drivers, you can enable/disable existing built-in drivers that are packaged in Rancher. Alternatively, you can add your own driver if Rancher has not yet implemented it. + +There are two types of drivers within Rancher: + +* [Cluster Drivers](#cluster-drivers) +* [Node Drivers](#node-drivers) + +### Cluster Drivers + +Cluster drivers are used to provision [hosted Kubernetes clusters](set-up-clusters-from-hosted-kubernetes-providers.md), such as GKE, EKS, AKS, etc.. The availability of which cluster driver to display when creating a cluster is defined based on the cluster driver's status. Only `active` cluster drivers will be displayed as an option for creating clusters for hosted Kubernetes clusters. By default, Rancher is packaged with several existing cluster drivers, but you can also create custom cluster drivers to add to Rancher. + +By default, Rancher has activated several hosted Kubernetes cloud providers including: + +* [Amazon EKS](amazon-eks-permissions.md) +* [Google GKE](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke.md) +* [Azure AKS](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks.md) + +There are several other hosted Kubernetes cloud providers that are disabled by default, but are packaged in Rancher: + +* [Alibaba ACK](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba.md) +* [Huawei CCE](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei.md) +* [Tencent](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent.md) + +### Node Drivers + +Node drivers are used to provision hosts, which Rancher uses to launch and manage Kubernetes clusters. A node driver is the same as a [Docker Machine driver](https://docs.docker.com/machine/drivers/). The availability of which node driver to display when creating node templates is defined based on the node driver's status. Only `active` node drivers will be displayed as an option for creating node templates. By default, Rancher is packaged with many existing Docker Machine drivers, but you can also create custom node drivers to add to Rancher. + +If there are specific node drivers that you don't want to show to your users, you would need to de-activate these node drivers. + +Rancher supports several major cloud providers, but by default, these node drivers are active and available for deployment: + +* [Amazon EC2](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster.md) +* [Azure](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-azure-cluster.md) +* [Digital Ocean](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-a-digitalocean-cluster.md) +* [vSphere](vsphere.md) + +There are several other node drivers that are disabled by default, but are packaged in Rancher: + +* [Harvester](../explanations/integrations-in-rancher/harvester.md#harvester-node-driver/), available in Rancher v2.6.1 diff --git a/docs/en/admin-settings/rke-templates/rke-templates.md b/docs/en/pages-for-subheaders/about-rke1-templates.md similarity index 53% rename from docs/en/admin-settings/rke-templates/rke-templates.md rename to docs/en/pages-for-subheaders/about-rke1-templates.md index 9d259bcc1bf..57b0c31bed0 100644 --- a/docs/en/admin-settings/rke-templates/rke-templates.md +++ b/docs/en/pages-for-subheaders/about-rke1-templates.md @@ -5,7 +5,7 @@ weight: 80 RKE templates are designed to allow DevOps and security teams to standardize and simplify the creation of Kubernetes clusters. -RKE is the [Rancher Kubernetes Engine,]({{}}/rke/latest/en/) which is the tool that Rancher uses to provision Kubernetes clusters. +RKE is the [Rancher Kubernetes Engine,](https://rancher.com/docs/rke/latest/en/) which is the tool that Rancher uses to provision Kubernetes clusters. With Kubernetes increasing in popularity, there is a trend toward managing a larger number of smaller clusters. When you want to create many clusters, it’s more important to manage them consistently. Multi-cluster management comes with challenges to enforcing security and add-on configurations that need to be standardized before turning clusters over to end users. @@ -15,7 +15,7 @@ Admins control which cluster options can be changed by end users. RKE templates If a cluster was created with an RKE template, you can't change it to a different RKE template. You can only update the cluster to a new revision of the same template. -You can [save the configuration of an existing cluster as an RKE template.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#converting-an-existing-cluster-to-use-an-rke-template) Then the cluster's settings can only be changed if the template is updated. The new template can also be used to launch new clusters. +You can [save the configuration of an existing cluster as an RKE template.](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/apply-templates.md#converting-an-existing-cluster-to-use-an-rke-template) Then the cluster's settings can only be changed if the template is updated. The new template can also be used to launch new clusters. The core features of RKE templates allow DevOps and security teams to: @@ -46,24 +46,24 @@ The [add-on section](#add-ons) of an RKE template is especially powerful because RKE templates are supported for Rancher-provisioned clusters. The templates can be used to provision custom clusters or clusters that are launched by an infrastructure provider. -RKE templates are for defining Kubernetes and Rancher settings. Node templates are responsible for configuring nodes. For tips on how to use RKE templates in conjunction with hardware, refer to [RKE Templates and Hardware]({{}}/rancher/v2.6/en/admin-settings/rke-templates/rke-templates-and-hardware). +RKE templates are for defining Kubernetes and Rancher settings. Node templates are responsible for configuring nodes. For tips on how to use RKE templates in conjunction with hardware, refer to [RKE Templates and Hardware](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/infrastructure.md). RKE templates can be created from scratch to pre-define cluster configuration. They can be applied to launch new clusters, or templates can also be exported from existing running clusters. -The settings of an existing cluster can be [saved as an RKE template.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#converting-an-existing-cluster-to-use-an-rke-template) This creates a new template and binds the cluster settings to the template, so that the cluster can only be upgraded if the [template is updated]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#updating-a-template), and the cluster is upgraded to [use a newer version of the template.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#upgrading-a-cluster-to-use-a-new-template-revision) The new template can also be used to create new clusters. +The settings of an existing cluster can be [saved as an RKE template.](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/apply-templates.md#converting-an-existing-cluster-to-use-an-rke-template) This creates a new template and binds the cluster settings to the template, so that the cluster can only be upgraded if the [template is updated](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/manage-rke1-templates.md#updating-a-template), and the cluster is upgraded to [use a newer version of the template.](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/manage-rke1-templates.md#upgrading-a-cluster-to-use-a-new-template-revision) The new template can also be used to create new clusters. # Example Scenarios When an organization has both basic and advanced Rancher users, administrators might want to give the advanced users more options for cluster creation, while restricting the options for basic users. -These [example scenarios]({{}}/rancher/v2.6/en/admin-settings/rke-templates/example-scenarios) describe how an organization could use templates to standardize cluster creation. +These [example scenarios](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/example-use-cases.md) describe how an organization could use templates to standardize cluster creation. Some of the example scenarios include the following: -- **Enforcing templates:** Administrators might want to [enforce one or more template settings for everyone]({{}}/rancher/v2.6/en/admin-settings/rke-templates/example-scenarios/#enforcing-a-template-setting-for-everyone) if they want all new Rancher-provisioned clusters to have those settings. -- **Sharing different templates with different users:** Administrators might give [different templates to basic and advanced users,]({{}}/rancher/v2.6/en/admin-settings/rke-templates/example-scenarios/#templates-for-basic-and-advanced-users) so that basic users can have more restricted options and advanced users can use more discretion when creating clusters. -- **Updating template settings:** If an organization's security and DevOps teams decide to embed best practices into the required settings for new clusters, those best practices could change over time. If the best practices change, [a template can be updated to a new revision]({{}}/rancher/v2.6/en/admin-settings/rke-templates/example-scenarios/#updating-templates-and-clusters-created-with-them) and clusters created from the template can [upgrade to the new version]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#upgrading-a-cluster-to-use-a-new-template-revision) of the template. -- **Sharing ownership of a template:** When a template owner no longer wants to maintain a template, or wants to share ownership of the template, this scenario describes how [template ownership can be shared.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/example-scenarios/#allowing-other-users-to-control-and-share-a-template) +- **Enforcing templates:** Administrators might want to [enforce one or more template settings for everyone](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/example-use-cases.md#enforcing-a-template-setting-for-everyone) if they want all new Rancher-provisioned clusters to have those settings. +- **Sharing different templates with different users:** Administrators might give [different templates to basic and advanced users,](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/example-use-cases.md#templates-for-basic-and-advanced-users) so that basic users can have more restricted options and advanced users can use more discretion when creating clusters. +- **Updating template settings:** If an organization's security and DevOps teams decide to embed best practices into the required settings for new clusters, those best practices could change over time. If the best practices change, [a template can be updated to a new revision](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/example-use-cases.md#updating-templates-and-clusters-created-with-them) and clusters created from the template can [upgrade to the new version](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/manage-rke1-templates.md#upgrading-a-cluster-to-use-a-new-template-revision) of the template. +- **Sharing ownership of a template:** When a template owner no longer wants to maintain a template, or wants to share ownership of the template, this scenario describes how [template ownership can be shared.](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/example-use-cases.md#allowing-other-users-to-control-and-share-a-template) # Template Management @@ -79,42 +79,42 @@ For the settings that cannot be overridden, the end user will not be able to dir The documents in this section explain the details of RKE template management: -- [Getting permission to create templates]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creator-permissions/) -- [Creating and revising templates]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/) -- [Enforcing template settings](./enforcement/#requiring-new-clusters-to-use-an-rke-template) -- [Overriding template settings]({{}}/rancher/v2.6/en/admin-settings/rke-templates/overrides/) -- [Sharing templates with cluster creators]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing/#sharing-templates-with-specific-users-or-groups) -- [Sharing ownership of a template]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing/#sharing-ownership-of-templates) +- [Getting permission to create templates](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/creator-permissions.md) +- [Creating and revising templates](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/manage-rke1-templates.md) +- [Enforcing template settings](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/enforce-templates.md#requiring-new-clusters-to-use-an-rke-template) +- [Overriding template settings](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/override-template-settings.md) +- [Sharing templates with cluster creators](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/access-or-share-templates.md#sharing-templates-with-specific-users-or-groups) +- [Sharing ownership of a template](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/access-or-share-templates.md#sharing-ownership-of-templates) -An [example YAML configuration file for a template]({{}}/rancher/v2.6/en/admin-settings/rke-templates/example-yaml) is provided for reference. +An [example YAML configuration file for a template](../reference-guides/rke1-template-example-yaml.md) is provided for reference. # Applying Templates -You can [create a cluster from a template]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#creating-a-cluster-from-an-rke-template) that you created, or from a template that has been [shared with you.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing) +You can [create a cluster from a template](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/apply-templates.md#creating-a-cluster-from-an-rke-template) that you created, or from a template that has been [shared with you.](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/access-or-share-templates.md) -If the RKE template owner creates a new revision of the template, you can [upgrade your cluster to that revision.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#updating-a-cluster-created-with-an-rke-template) +If the RKE template owner creates a new revision of the template, you can [upgrade your cluster to that revision.](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/apply-templates.md#updating-a-cluster-created-with-an-rke-template) RKE templates can be created from scratch to pre-define cluster configuration. They can be applied to launch new clusters, or templates can also be exported from existing running clusters. -You can [save the configuration of an existing cluster as an RKE template.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#converting-an-existing-cluster-to-use-an-rke-template) Then the cluster's settings can only be changed if the template is updated. +You can [save the configuration of an existing cluster as an RKE template.](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/apply-templates.md#converting-an-existing-cluster-to-use-an-rke-template) Then the cluster's settings can only be changed if the template is updated. # Standardizing Hardware -RKE templates are designed to standardize Kubernetes and Rancher settings. If you want to standardize your infrastructure as well, one option is to use RKE templates [in conjunction with other tools]({{}}/rancher/v2.6/en/admin-settings/rke-templates/rke-templates-and-hardware). +RKE templates are designed to standardize Kubernetes and Rancher settings. If you want to standardize your infrastructure as well, one option is to use RKE templates [in conjunction with other tools](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/infrastructure.md). -Another option is to use [cluster templates,]({{}}/rancher/v2.6/en/admin-settings/cluster-templates) which include node pool configuration options, but don't provide configuration enforcement. +Another option is to use [cluster templates,](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-cluster-templates.md) which include node pool configuration options, but don't provide configuration enforcement. # YAML Customization -If you define an RKE template as a YAML file, you can modify this [example RKE template YAML]({{}}/rancher/v2.6/en/admin-settings/rke-templates/example-yaml). The YAML in the RKE template uses the same customization that Rancher uses when creating an RKE cluster, but since the YAML is located within the context of a Rancher provisioned cluster, you will need to nest the RKE template customization under the `rancher_kubernetes_engine_config` directive in the YAML. +If you define an RKE template as a YAML file, you can modify this [example RKE template YAML](../reference-guides/rke1-template-example-yaml.md). The YAML in the RKE template uses the same customization that Rancher uses when creating an RKE cluster, but since the YAML is located within the context of a Rancher provisioned cluster, you will need to nest the RKE template customization under the `rancher_kubernetes_engine_config` directive in the YAML. -The RKE documentation also has [annotated]({{}}/rke/latest/en/example-yamls/) `cluster.yml` files that you can use for reference. +The RKE documentation also has [annotated](https://rancher.com/docs/rke/latest/en/example-yamls/) `cluster.yml` files that you can use for reference. -For guidance on available options, refer to the RKE documentation on [cluster configuration.]({{}}/rke/latest/en/config-options/) +For guidance on available options, refer to the RKE documentation on [cluster configuration.](https://rancher.com/docs/rke/latest/en/config-options/) ### Add-ons -The add-on section of the RKE template configuration file works the same way as the [add-on section of a cluster configuration file]({{}}/rke/latest/en/config-options/add-ons/). +The add-on section of the RKE template configuration file works the same way as the [add-on section of a cluster configuration file](https://rancher.com/docs/rke/latest/en/config-options/add-ons/). The user-defined add-ons directive allows you to either call out and pull down Kubernetes manifests or put them inline directly. If you include these manifests as part of your RKE template, Rancher will provision those in the cluster. @@ -124,4 +124,4 @@ Some things you could do with add-ons include: - Install plugins on nodes that are deployed with a Kubernetes daemonset - Automatically set up namespaces, service accounts, or role binding -The RKE template configuration must be nested within the `rancher_kubernetes_engine_config` directive. To set add-ons, when creating the template, you will click **Edit as YAML**. Then use the `addons` directive to add a manifest, or the `addons_include` directive to set which YAML files are used for the add-ons. For more information on custom add-ons, refer to the [user-defined add-ons documentation.]({{}}/rke/latest/en/config-options/add-ons/user-defined-add-ons/) +The RKE template configuration must be nested within the `rancher_kubernetes_engine_config` directive. To set add-ons, when creating the template, you will click **Edit as YAML**. Then use the `addons` directive to add a manifest, or the `addons_include` directive to set which YAML files are used for the add-ons. For more information on custom add-ons, refer to the [user-defined add-ons documentation.](https://rancher.com/docs/rke/latest/en/config-options/add-ons/user-defined-add-ons/) diff --git a/docs/en/api/api.md b/docs/en/pages-for-subheaders/about-the-api.md similarity index 91% rename from docs/en/api/api.md rename to docs/en/pages-for-subheaders/about-the-api.md index 746895d3d01..23cdc010023 100644 --- a/docs/en/api/api.md +++ b/docs/en/pages-for-subheaders/about-the-api.md @@ -27,9 +27,9 @@ Go to the URL endpoint at `https:///v3`, where `` is ## Authentication -API requests must include authentication information. Authentication is done with HTTP basic authentication using [API Keys]({{}}/rancher/v2.6/en/user-settings/api-keys/). API keys can create new clusters and have access to multiple clusters via `/v3/clusters/`. [Cluster and project roles]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/) apply to these keys and restrict what clusters and projects the account can see and what actions they can take. +API requests must include authentication information. Authentication is done with HTTP basic authentication using [API Keys](../reference-guides/user-settings/api-keys.md). API keys can create new clusters and have access to multiple clusters via `/v3/clusters/`. [Cluster and project roles](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md) apply to these keys and restrict what clusters and projects the account can see and what actions they can take. -By default, some cluster-level API tokens are generated with infinite time-to-live (`ttl=0`). In other words, API tokens with `ttl=0` never expire unless you invalidate them. For details on how to invalidate them, refer to the [API tokens page]({{}}/rancher/v2.6/en/api/api-tokens). +By default, some cluster-level API tokens are generated with infinite time-to-live (`ttl=0`). In other words, API tokens with `ttl=0` never expire unless you invalidate them. For details on how to invalidate them, refer to the [API tokens page](../reference-guides/about-the-api/api-tokens.md). ## Making requests diff --git a/docs/en/cluster-admin/cluster-access/cluster-access.md b/docs/en/pages-for-subheaders/access-clusters.md similarity index 55% rename from docs/en/cluster-admin/cluster-access/cluster-access.md rename to docs/en/pages-for-subheaders/access-clusters.md index 291423864fc..262e60d610b 100644 --- a/docs/en/cluster-admin/cluster-access/cluster-access.md +++ b/docs/en/pages-for-subheaders/access-clusters.md @@ -5,11 +5,11 @@ weight: 1 This section is about what tools can be used to access clusters managed by Rancher. -For information on how to give users permission to access a cluster, see the section on [adding users to clusters.]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/cluster-members/) +For information on how to give users permission to access a cluster, see the section on [adding users to clusters.](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/add-users-to-clusters.md) -For more information on roles-based access control, see [this section.]({{}}/rancher/v2.6/en/admin-settings/rbac/) +For more information on roles-based access control, see [this section.](manage-role-based-access-control-rbac.md) -For information on how to set up an authentication system, see [this section.]({{}}/rancher/v2.6/en/admin-settings/authentication/) +For information on how to set up an authentication system, see [this section.](about-authentication.md) ### Rancher UI @@ -18,15 +18,15 @@ Rancher provides an intuitive user interface for interacting with your clusters. ### kubectl -You can use the Kubernetes command-line tool, [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/), to manage your clusters. You have two options for using kubectl: +You can use the Kubernetes command-line tool, [kubectl](https://kubernetes.io/docs/referenccluster-admin/cluster-access/kubectloverview/), to manage your clusters. You have two options for using kubectl: -- **Rancher kubectl shell:** Interact with your clusters by launching a kubectl shell available in the Rancher UI. This option requires no configuration actions on your part. For more information, see [Accessing Clusters with kubectl Shell]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/). -- **Terminal remote connection:** You can also interact with your clusters by installing [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) on your local desktop and then copying the cluster's kubeconfig file to your local `~/.kube/config` directory. For more information, see [Accessing Clusters with kubectl and a kubeconfig File](./kubectl/). +- **Rancher kubectl shell:** Interact with your clusters by launching a kubectl shell available in the Rancher UI. This option requires no configuration actions on your part. For more information, see [Accessing Clusters with kubectl Shell](cluster-admin/cluster-accescluster-admin/cluster-access/kubectl). +- **Terminal remote connection:** You can also interact with your clusters by installing [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) on your local desktop and then copying the cluster's kubeconfig file to your local `~/.kube/config` directory. For more information, see [Accessing Clusters with kubectl and a kubeconfig File](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md). ### Rancher CLI -You can control your clusters by downloading Rancher's own command-line interface, [Rancher CLI]({{}}/rancher/v2.6/en/cli/). This CLI tool can interact directly with different clusters and projects or pass them `kubectl` commands. +You can control your clusters by downloading Rancher's own command-line interface, [Rancher CLI](cli-with-rancher.md). This CLI tool can interact directly with different clusters and projects or pass them `kubectl` commands. ### Rancher API -Finally, you can interact with your clusters over the Rancher API. Before you use the API, you must obtain an [API key]({{}}/rancher/v2.6/en/user-settings/api-keys/). To view the different resource fields and actions for an API object, open the API UI, which can be accessed by clicking on **View in API** for any Rancher UI object. \ No newline at end of file +Finally, you can interact with your clusters over the Rancher API. Before you use the API, you must obtain an [API key](../reference-guides/user-settings/api-keys.md). To view the different resource fields and actions for an API object, open the API UI, which can be accessed by clicking on **View in API** for any Rancher UI object. \ No newline at end of file diff --git a/docs/en/pages-for-subheaders/advanced-configuration.md b/docs/en/pages-for-subheaders/advanced-configuration.md new file mode 100644 index 00000000000..5280bc8102f --- /dev/null +++ b/docs/en/pages-for-subheaders/advanced-configuration.md @@ -0,0 +1,16 @@ +--- +title: Advanced Configuration +weight: 500 +--- + +### Alertmanager + +For information on configuring the Alertmanager custom resource, see [this page.](../how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager.md) + +### Prometheus + +For information on configuring the Prometheus custom resource, see [this page.](../how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheus.md) + +### PrometheusRules + +For information on configuring the Prometheus custom resource, see [this page.](monitoring-alerting/configuration/advancemonitoring-alerting/configuration/advanced/prometheusrules) \ No newline at end of file diff --git a/docs/en/installation/resources/advanced/advanced.md b/docs/en/pages-for-subheaders/advanced-options.md similarity index 100% rename from docs/en/installation/resources/advanced/advanced.md rename to docs/en/pages-for-subheaders/advanced-options.md diff --git a/docs/en/pages-for-subheaders/advanced-user-guides.md b/docs/en/pages-for-subheaders/advanced-user-guides.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/advanced-user-guides.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/pages-for-subheaders/air-gapped-helm-cli-install.md b/docs/en/pages-for-subheaders/air-gapped-helm-cli-install.md new file mode 100644 index 00000000000..717880520d0 --- /dev/null +++ b/docs/en/pages-for-subheaders/air-gapped-helm-cli-install.md @@ -0,0 +1,31 @@ +--- +title: Air-Gapped Helm CLI Install +weight: 1 +--- + +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. + +The installation steps differ depending on whether Rancher is installed on an RKE Kubernetes cluster, a K3s Kubernetes cluster, or a single Docker container. + +For more information on each installation option, refer to [this page.](installation-and-upgrade.md) + +Throughout the installation instructions, there will be _tabs_ for each installation option. + +:::note Important: + +If you install Rancher following the Docker installation guide, there is no upgrade path to transition your Docker Installation to a Kubernetes Installation. + +::: + +# Installation Outline + +1. [Set up infrastructure and private registry](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/infrastructure-private-registry.md) +2. [Collect and publish images to your private registry](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md) +3. [Set up a Kubernetes cluster (Skip this step for Docker installations)](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md) +4. [Install Rancher](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-rancher-ha.md) + +# Upgrades + +To upgrade Rancher with Helm CLI in an air gap environment, follow [this procedure.](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md) + +### [Next: Prepare your Node(s)](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/infrastructure-private-registry.md) diff --git a/docs/en/cluster-provisioning/hosted-kubernetes-clusters/eks/eks.md b/docs/en/pages-for-subheaders/amazon-eks-permissions.md similarity index 92% rename from docs/en/cluster-provisioning/hosted-kubernetes-clusters/eks/eks.md rename to docs/en/pages-for-subheaders/amazon-eks-permissions.md index 935b58ebdf6..d78200c71cc 100644 --- a/docs/en/cluster-provisioning/hosted-kubernetes-clusters/eks/eks.md +++ b/docs/en/pages-for-subheaders/amazon-eks-permissions.md @@ -76,7 +76,7 @@ You can access your cluster after its state is updated to **Active**. # EKS Cluster Configuration Reference -For the full list of EKS cluster configuration options, see [this page.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/eks-config-reference) +For the full list of EKS cluster configuration options, see [this page.](../reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md) # Architecture @@ -84,7 +84,7 @@ The figure below illustrates the high-level architecture of Rancher 2.x. The fig
Managing Kubernetes Clusters through Rancher's Authentication Proxy
-![Architecture]({{}}/img/rancher/rancher-architecture-rancher-api-server.svg) +![Architecture](/img/rancher-architecture-rancher-api-server.svg) # AWS Service Events @@ -102,13 +102,13 @@ This [tutorial](https://aws.amazon.com/blogs/opensource/managing-eks-clusters-ra # Minimum EKS Permissions -See [this page](./permissions) for the minimum set of permissions necessary to use all functionality of the EKS driver in Rancher. +See [this page](../reference-guides/amazon-eks-permissions/minimum-eks-permissions.md) for the minimum set of permissions necessary to use all functionality of the EKS driver in Rancher. # Syncing -The EKS provisioner can synchronize the state of an EKS cluster between Rancher and the provider. For an in-depth technical explanation of how this works, see [Syncing.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/syncing/) +The EKS provisioner can synchronize the state of an EKS cluster between Rancher and the provider. For an in-depth technical explanation of how this works, see [Syncing.](../reference-guides/cluster-configuration/rancher-server-configuration/sync-clusters.md) -For information on configuring the refresh interval, refer to [this section.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/eks-config-reference/#configuring-the-refresh-interval) +For information on configuring the refresh interval, refer to [this section.](../reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md#configuring-the-refresh-interval) # Troubleshooting diff --git a/docs/en/pages-for-subheaders/authentication-config.md b/docs/en/pages-for-subheaders/authentication-config.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/authentication-config.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/admin-settings/admin-settings.md b/docs/en/pages-for-subheaders/authentication-permissions-and-global-configuration.md similarity index 63% rename from docs/en/admin-settings/admin-settings.md rename to docs/en/pages-for-subheaders/authentication-permissions-and-global-configuration.md index 4d1f522a55c..ca88fdadaae 100644 --- a/docs/en/admin-settings/admin-settings.md +++ b/docs/en/pages-for-subheaders/authentication-permissions-and-global-configuration.md @@ -3,7 +3,7 @@ title: Authentication, Permissions and Global Configuration weight: 6 --- -After installation, the [system administrator]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) should configure Rancher to configure authentication, authorization, security, default settings, security policies, drivers and global DNS entries. +After installation, the [system administrator](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/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. ## First Log In @@ -19,36 +19,36 @@ After you set the Rancher Server URL, we do not support updating it. Set the URL One of the key features that Rancher adds to Kubernetes is centralized user authentication. This feature allows to set up local users and/or connect to an external authentication provider. By connecting to an external authentication provider, you can leverage that provider's user and groups. -For more information how authentication works and how to configure each provider, see [Authentication]({{}}/rancher/v2.6/en/admin-settings/authentication/). +For more information how authentication works and how to configure each provider, see [Authentication](about-authentication.md). ## Authorization Within Rancher, each person authenticates as a _user_, which is a login that grants you access to Rancher. Once the user logs in to Rancher, their _authorization_, or their access rights within the system, is determined by the user's role. Rancher provides built-in roles to allow you to easily configure a user's permissions to resources, but Rancher also provides the ability to customize the roles for each Kubernetes resource. -For more information how authorization works and how to customize roles, see [Roles Based Access Control (RBAC)]({{}}/rancher/v2.6/en/admin-settings/rbac/). +For more information how authorization works and how to customize roles, see [Roles Based Access Control (RBAC)](manage-role-based-access-control-rbac.md). ## Pod Security Policies _Pod Security Policies_ (or PSPs) are objects that control security-sensitive aspects of pod specification, e.g. root privileges. If a pod does not meet the conditions specified in the PSP, Kubernetes will not allow it to start, and Rancher will display an error message. -For more information how to create and use PSPs, see [Pod Security Policies]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/). +For more information how to create and use PSPs, see [Pod Security Policies](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies.md). ## Provisioning Drivers -Drivers in Rancher allow you to manage which providers can be used to provision [hosted Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/) or [nodes in an infrastructure provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/) to allow Rancher to deploy and manage Kubernetes. +Drivers in Rancher allow you to manage which providers can be used to provision [hosted Kubernetes clusters](set-up-clusters-from-hosted-kubernetes-providers.md) or [nodes in an infrastructure provider](use-new-nodes-in-an-infra-provider.md) to allow Rancher to deploy and manage Kubernetes. -For more information, see [Provisioning Drivers]({{}}/rancher/v2.6/en/admin-settings/drivers/). +For more information, see [Provisioning Drivers](about-provisioning-drivers.md). ## Adding Kubernetes Versions into Rancher With this feature, you can upgrade to the latest version of Kubernetes as soon as it is released, without upgrading Rancher. This feature allows you to easily upgrade Kubernetes patch versions (i.e. `v1.15.X`), but not intended to upgrade Kubernetes minor versions (i.e. `v1.X.0`) as Kubernetes tends to deprecate or add APIs between minor versions. -The information that Rancher uses to provision [RKE clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) is now located in the Rancher Kubernetes Metadata. For details on metadata configuration and how to change the Kubernetes version used for provisioning RKE clusters, see [Rancher Kubernetes Metadata.]({{}}/rancher/v2.6/en/admin-settings/k8s-metadata/) +The information that Rancher uses to provision [RKE clusters](launch-kubernetes-with-rancher.md) is now located in the Rancher Kubernetes Metadata. For details on metadata configuration and how to change the Kubernetes version used for provisioning RKE clusters, see [Rancher Kubernetes Metadata.](../getting-started/installation-and-upgrade/upgrade-kubernetes-without-upgrading-rancher.md) -Rancher Kubernetes Metadata contains Kubernetes version information which Rancher uses to provision [RKE clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/). +Rancher Kubernetes Metadata contains Kubernetes version information which Rancher uses to provision [RKE clusters](launch-kubernetes-with-rancher.md). -For more information on how metadata works and how to configure metadata config, see [Rancher Kubernetes Metadata]({{}}/rancher/v2.6/en/admin-settings/k8s-metadata/). +For more information on how metadata works and how to configure metadata config, see [Rancher Kubernetes Metadata](../getting-started/installation-and-upgrade/upgrade-kubernetes-without-upgrading-rancher.md). ## Enabling Experimental Features -Rancher includes some features that are experimental and disabled by default. Feature flags were introduced to allow you to try these features. For more information, refer to the section about [feature flags.]({{}}/rancher/v2.6/en/installation/resources/feature-flags/) +Rancher includes some features that are experimental and disabled by default. Feature flags were introduced to allow you to try these features. For more information, refer to the section about [feature flags.](enable-experimental-features.md) diff --git a/docs/en/backups/backups.md b/docs/en/pages-for-subheaders/backup-restore-and-disaster-recovery.md similarity index 78% rename from docs/en/backups/backups.md rename to docs/en/pages-for-subheaders/backup-restore-and-disaster-recovery.md index e381d440c9f..d7a19744d49 100644 --- a/docs/en/backups/backups.md +++ b/docs/en/pages-for-subheaders/backup-restore-and-disaster-recovery.md @@ -23,7 +23,7 @@ The backup-restore operator needs to be installed in the local cluster, and only # Backup and Restore for Rancher installed with Docker -For Rancher installed with Docker, refer to [this page](./docker-installs/docker-backups) to perform backups and [this page](./docker-installs/docker-restores) to perform restores. +For Rancher installed with Docker, refer to [this page](../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-docker-installed-rancher.md) to perform backups and [this page](../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-docker-installed-rancher.md) to perform restores. # How Backups and Restores Work @@ -45,7 +45,7 @@ The Backup and Restore custom resources can be created in the Rancher UI, or by :::note -Refer [here]({{}}/rancher/v2.6/en/backups/migrating-rancher/#2-restore-from-backup-using-a-restore-custom-resource) for help on restoring an existing backup file into a v1.22 cluster in Rancher v2.6.3. +Refer [here](../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md#2-restore-from-backup-using-a-restore-custom-resource) for help on restoring an existing backup file into a v1.22 cluster in Rancher v2.6.3. ::: @@ -66,7 +66,7 @@ There is a known issue in Fleet that occurs after performing a restoration using 1. In the left navigation bar, **Apps & Marketplace > Charts**. 1. Click **Rancher Backups**. 1. Click **Install**. -1. Optional: Configure the default storage location. For help, refer to the [configuration section.](./configuration/storage-config) +1. Optional: Configure the default storage location. For help, refer to the [configuration section.](../reference-guides/backup-restore-configuration/storage-configuration.md) 1. Click **Install**. **Result:** The `rancher-backup` operator is installed. @@ -86,22 +86,22 @@ Only the rancher admins and the local cluster’s cluster-owner can: # Backing up Rancher -A backup is performed by creating a Backup custom resource. For a tutorial, refer to [this page.](./back-up-rancher) +A backup is performed by creating a Backup custom resource. For a tutorial, refer to [this page.](../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md) # Restoring Rancher -A restore is performed by creating a Restore custom resource. For a tutorial, refer to [this page.](./restoring-rancher) +A restore is performed by creating a Restore custom resource. For a tutorial, refer to [this page.](../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher.md) # Migrating Rancher to a New Cluster -A migration is performed by following [these steps.]({{}}/rancher/v2.6/en/backups/migrating-rancher) +A migration is performed by following [these steps.](../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md) # 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. -For information on configuring these options, refer to [this page.](./configuration/storage-config) +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 -The example [values.yaml file](./configuration/storage-config/#example-values-yaml-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](backupbackups/configuration/storage-config/#example-values-yaml-for-the-rancher-backup-helm-chart) can be used to configure the `rancher-backup` operator when the Helm CLI is used to install it. diff --git a/docs/en/pages-for-subheaders/backup-restore-configuration.md b/docs/en/pages-for-subheaders/backup-restore-configuration.md new file mode 100644 index 00000000000..2d4c62fa201 --- /dev/null +++ b/docs/en/pages-for-subheaders/backup-restore-configuration.md @@ -0,0 +1,10 @@ +--- +title: Rancher Backup Configuration Reference +shortTitle: Configuration +weight: 4 +--- + +- [Backup configuration](../reference-guides/backup-restore-configuration/backup-configuration.md) +- [Restore configuration](../reference-guides/backup-restore-configuration/restore-configuration.md) +- [Storage location configuration](../reference-guides/backup-restore-configuration/storage-configuration.md) +- [Example Backup and Restore Custom Resources](../reference-guides/backup-restore-configuration/examples.md) \ No newline at end of file diff --git a/docs/en/best-practices/best-practices.md b/docs/en/pages-for-subheaders/best-practices.md similarity index 94% rename from docs/en/best-practices/best-practices.md rename to docs/en/pages-for-subheaders/best-practices.md index 37310b8fdd9..68e26b48b4d 100644 --- a/docs/en/best-practices/best-practices.md +++ b/docs/en/pages-for-subheaders/best-practices.md @@ -11,7 +11,7 @@ Use the navigation bar on the left to find the current best practices for managi For more guidance on best practices, you can consult these resources: -- [Security]({{}}/rancher/v2.6/en/security/) +- [Security](rancher-security.md) - [Rancher Blog](https://www.suse.com/c/rancherblog/) - [Rancher Forum](https://forums.rancher.com/) - [Rancher Users Slack](https://slack.rancher.io/) diff --git a/docs/en/cluster-provisioning/production/production.md b/docs/en/pages-for-subheaders/checklist-for-production-ready-clusters.md similarity index 74% rename from docs/en/cluster-provisioning/production/production.md rename to docs/en/pages-for-subheaders/checklist-for-production-ready-clusters.md index c0c61b54f01..66ef455ff53 100644 --- a/docs/en/cluster-provisioning/production/production.md +++ b/docs/en/pages-for-subheaders/checklist-for-production-ready-clusters.md @@ -5,15 +5,15 @@ weight: 2 In this section, we recommend best practices for creating the production-ready Kubernetes clusters that will run your apps and services. -For a list of requirements for your cluster, including the requirements for OS/Docker, hardware, and networking, refer to the section on [node requirements.]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements) +For a list of requirements for your cluster, including the requirements for OS/Docker, hardware, and networking, refer to the section on [node requirements.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md) This is a shortlist of best practices that we strongly recommend for all production clusters. -For a full list of all the best practices that we recommend, refer to the [best practices section.]({{}}/rancher/v2.6/en/best-practices) +For a full list of all the best practices that we recommend, refer to the [best practices section.](best-practices.md) ### Node Requirements -* Make sure your nodes fulfill all of the [node requirements,]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/) including the port requirements. +* Make sure your nodes fulfill all of the [node requirements,](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md) including the port requirements. ### Back up etcd @@ -30,10 +30,10 @@ For a full list of all the best practices that we recommend, refer to the [best * Assign two or more nodes the `controlplane` role for master component high availability. * Assign two or more nodes the `worker` role for workload rescheduling upon node failure. -For more information on what each role is used for, refer to the [section on roles for nodes in Kubernetes.]({{}}/rancher/v2.6/en/cluster-provisioning/production/nodes-and-roles) +For more information on what each role is used for, refer to the [section on roles for nodes in Kubernetes.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/roles-for-nodes-in-kubernetes.md) For more information about the -number of nodes for each Kubernetes role, refer to the section on [recommended architecture.]({{}}/rancher/v2.6/en/overview/architecture-recommendations/) +number of nodes for each Kubernetes role, refer to the section on [recommended architecture.](../reference-guides/rancher-manager-architecture/architecture-recommendations.md) ### Logging and Monitoring @@ -47,4 +47,4 @@ number of nodes for each Kubernetes role, refer to the section on [recommended a ### Networking * Minimize network latency. Rancher recommends minimizing latency between the etcd nodes. The default setting for `heartbeat-interval` is `500`, and the default setting for `election-timeout` is `5000`. These [settings for etcd tuning](https://coreos.com/etcd/docs/latest/tuning.html) allow etcd to run in most networks (except really high latency networks). -* Cluster nodes should be located within a single region. Most cloud providers provide multiple availability zones within a region, which can be used to create higher availability for your cluster. Using multiple availability zones is fine for nodes with any role. If you are using [Kubernetes Cloud Provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/) resources, consult the documentation for any restrictions (i.e. zone storage restrictions). +* Cluster nodes should be located within a single region. Most cloud providers provide multiple availability zones within a region, which can be used to create higher availability for your cluster. Using multiple availability zones is fine for nodes with any role. If you are using [Kubernetes Cloud Provider](set-up-cloud-providers.md) resources, consult the documentation for any restrictions (i.e. zone storage restrictions). diff --git a/docs/en/cis-scans/cis-scans.md b/docs/en/pages-for-subheaders/cis-scan-guides.md similarity index 90% rename from docs/en/cis-scans/cis-scans.md rename to docs/en/pages-for-subheaders/cis-scan-guides.md index 55f6f9710ba..f61760c0317 100644 --- a/docs/en/cis-scans/cis-scans.md +++ b/docs/en/pages-for-subheaders/cis-scan-guides.md @@ -11,8 +11,8 @@ The `rancher-cis-benchmark` app leverages self-assessment guide for the corresponding Kubernetes version. +Some tests are designated as "Not Applicable." These tests will not be run on any CIS scan because of the way that Rancher provisions RKE clusters. For information on how test results can be audited, and why some tests are designated to be not applicable, refer to Rancher's self-assessment guide for the corresponding Kubernetes version. The report contains the following information: @@ -63,7 +63,7 @@ The report contains the following information: | `actual_value` | The test's actual value, present if reported by `kube-bench`. | | `expected_result` | The test's expected result, present if reported by `kube-bench`. | -Refer to the table in the cluster hardening guide for information on which versions of Kubernetes, the Benchmark, Rancher, and our cluster hardening guide correspond to each other. Also refer to the hardening guide for configuration files of CIS-compliant clusters and information on remediating failed tests. +Refer to the table in the cluster hardening guide for information on which versions of Kubernetes, the Benchmark, Rancher, and our cluster hardening guide correspond to each other. Also refer to the hardening guide for configuration files of CIS-compliant clusters and information on remediating failed tests. # Test Profiles @@ -94,7 +94,7 @@ There are two types of RKE cluster scan profiles: The EKS and GKE cluster scan profiles are based on CIS Benchmark versions that are specific to those types of clusters. -In order to pass the "Hardened" profile, you will need to follow the steps on the hardening guide and use the `cluster.yml` defined in the hardening guide to provision a hardened cluster. +In order to pass the "Hardened" profile, you will need to follow the steps on the hardening guide and use the `cluster.yml` defined in the hardening guide to provision a hardened cluster. The default profile and the supported CIS benchmark version depends on the type of cluster that will be scanned: @@ -107,7 +107,7 @@ The `rancher-cis-benchmark` supports the CIS 1.6 Benchmark version. # About Skipped and Not Applicable Tests -For a list of skipped and not applicable tests, refer to this page. +For a list of skipped and not applicable tests, refer to this page. For now, only user-defined skipped tests are marked as skipped in the generated report. @@ -115,11 +115,11 @@ Any skipped tests that are defined as being skipped by one of the default profil # Roles-based Access Control -For information about permissions, refer to this page. +For information about permissions, refer to this page. # Configuration -For more information about configuring the custom resources for the scans, profiles, and benchmark versions, refer to this page. +For more information about configuring the custom resources for the scans, profiles, and benchmark versions, refer to this page. # How-to Guides @@ -235,9 +235,9 @@ Alerts can be configured to be sent out for a scan that runs on a schedule. :::note Prerequisite: -Before enabling alerts for `rancher-cis-benchmark`, make sure to install the `rancher-monitoring` application and configure the Receivers and Routes. For more information, see [this section.]({{}}/rancher/v2.6/en/monitoring-alerting/configuration) +Before enabling alerts for `rancher-cis-benchmark`, make sure to install the `rancher-monitoring` application and configure the Receivers and Routes. For more information, see [this section.](monitoring-alertincis-scans/configuration) -While configuring the routes for `rancher-cis-benchmark` alerts, you can specify the matching using the key-value pair `job: rancher-cis-scan`. An example route configuration is [here.]({{}}/rancher/v2.6/en/monitoring-alerting/configuration/receiver/#example-route-config-for-cis-scan-alerts) +While configuring the routes for `rancher-cis-benchmark` alerts, you can specify the matching using the key-value pair `job: rancher-cis-scan`. An example route configuration is [here.](monitoring-alertincis-scans/configuration/receiver/#example-route-config-for-cis-scan-alerts) ::: @@ -263,9 +263,9 @@ The CIS Benchmark application supports two types of alerts: :::note Prerequisite -Before enabling alerts for `rancher-cis-benchmark`, make sure to install the `rancher-monitoring` application and configure the Receivers and Routes. For more information, see [this section.]({{}}/rancher/v2.6/en/monitoring-alerting/configuration) +Before enabling alerts for `rancher-cis-benchmark`, make sure to install the `rancher-monitoring` application and configure the Receivers and Routes. For more information, see [this section.](monitoring-alertincis-scans/configuration) -While configuring the routes for `rancher-cis-benchmark` alerts, you can specify the matching using the key-value pair `job: rancher-cis-scan`. An example route configuration is [here.]({{}}/rancher/v2.6/en/monitoring-alerting/configuration/receiver/#example-route-config-for-cis-scan-alerts) +While configuring the routes for `rancher-cis-benchmark` alerts, you can specify the matching using the key-value pair `job: rancher-cis-scan`. An example route configuration is [here.](monitoring-alertincis-scans/configuration/receiver/#example-route-config-for-cis-scan-alerts) ::: @@ -293,4 +293,4 @@ There could be some Kubernetes cluster setups that require custom configurations It is now possible to create a custom Benchmark Version for running a cluster scan using the `rancher-cis-benchmark` application. -For details, see [this page.](./custom-benchmark) +For details, see [this page.](../explanations/integrations-in-rancher/cis-scans/custom-benchmark.md) diff --git a/docs/en/pages-for-subheaders/cis-scans.md b/docs/en/pages-for-subheaders/cis-scans.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/cis-scans.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/cli/cli.md b/docs/en/pages-for-subheaders/cli-with-rancher.md similarity index 75% rename from docs/en/cli/cli.md rename to docs/en/pages-for-subheaders/cli-with-rancher.md index d5208c898ce..e43371cdc8a 100644 --- a/docs/en/cli/cli.md +++ b/docs/en/pages-for-subheaders/cli-with-rancher.md @@ -22,18 +22,18 @@ The Rancher CLI (Command Line Interface) is a unified tool that you can use to i ### Download Rancher CLI -The binary can be downloaded directly from the UI. The link can be found in the right hand side of the footer in the UI. We have binaries for Windows, Mac, and Linux. You can also check the [releases page for our CLI](https://github.com/rancher/cli/releases) for direct downloads of the binary. +The binary can be downloaded directly from the UI. The link can be found in the right hand side of the footer in the UI. We have binaries for Windows, Mac, and Linux. You can also check the [releases page for our CLI](https://github.com/ranchcli/releases) for direct downloads of the binary. 1. In the upper left corner, click **☰**. 1. At the bottom, click **v2.6.x**, where **v2.6.x** is a hyperlinked text indicating the installed Rancher version. -1. Under the **CLI Downloads section**, there are links to download the binaries for Windows, Mac, and Linux. You can also check the [releases page for our CLI](https://github.com/rancher/cli/releases) for direct downloads of the binary. +1. Under the **CLI Downloads section**, there are links to download the binaries for Windows, Mac, and Linux. You can also check the [releases page for our CLI](https://github.com/ranchcli/releases) for direct downloads of the binary. ### Requirements After you download the Rancher CLI, you need to make a few configurations. Rancher CLI requires: - Your Rancher Server URL, which is used to connect to Rancher Server. -- An API Bearer Token, which is used to authenticate with Rancher. For more information about obtaining a Bearer Token, see [Creating an API Key]({{}}/rancher/v2.6/en/user-settings/api-keys/). +- An API Bearer Token, which is used to authenticate with Rancher. For more information about obtaining a Bearer Token, see [Creating an API Key](../reference-guides/user-settings/api-keys.md). ### CLI Authentication @@ -47,7 +47,7 @@ If Rancher Server uses a self-signed certificate, Rancher CLI prompts you to con ### Project Selection -Before you can perform any commands, you must select a Rancher project to perform those commands against. To select a [project]({{}}/rancher/v2.6/en/cluster-admin/projects-and-namespaces/) to work on, use the command `./rancher context switch`. When you enter this command, a list of available projects displays. Enter a number to choose your project. +Before you can perform any commands, you must select a Rancher project to perform those commands against. To select a [project](../how-to-guides/advanced-user-guides/manage-clusters/projects-and-namespaces.md) to work on, use the command `./rancher context switch`. When you enter this command, a list of available projects displays. Enter a number to choose your project. **Example: `./rancher context switch` Output** ``` @@ -64,7 +64,7 @@ After you enter a number, the console displays a message that you've changed pro ``` INFO[0005] Setting new context to project project-1 -INFO[0005] Saving config to /Users/markbishop/.rancher/cli2.json +INFO[0005] Saving config to /Users/markbishop/.ranchcli2.json ``` Ensure you can run `rancher kubectl get pods` successfully. @@ -76,16 +76,16 @@ The following commands are available for use in Rancher CLI. | Command | Result | |---|---| | `apps, [app]` | Performs operations on catalog applications (i.e., individual [Helm charts](https://docs.helm.sh/developing_charts/)) or Rancher charts. | -| `catalog` | Performs operations on [catalogs]({{}}/rancher/v2.6/en/helm-charts/). | -| `clusters, [cluster]` | Performs operations on your [clusters]({{}}/rancher/v2.6/en/cluster-provisioning/). | -| `context` | Switches between Rancher [projects]({{}}/rancher/v2.6/en/cluster-admin/projects-and-namespaces/). For an example, see [Project Selection](#project-selection). | -| `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects]({{}}/rancher/v2.6/en/cluster-admin/projects-and-namespaces/) and [workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/)). Specify resources by name or ID. | +| `catalog` | Performs operations on [catalogs]({{}}/rancher/v2.6/helm-charts). | +| `clusters, [cluster]` | Performs operations on your [clusters](kubernetes-clusters-in-rancher-setup.md). | +| `context` | Switches between Rancher [projects](../how-to-guides/advanced-user-guides/manage-clusters/projects-and-namespaces.md). For an example, see [Project Selection](#project-selection). | +| `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects](../how-to-guides/advanced-user-guides/manage-clusters/projects-and-namespaces.md) and [workloads](workloads-and-pods.md)). Specify resources by name or ID. | | `kubectl` |Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | | `login, [l]` | Logs into a Rancher Server. For an example, see [CLI Authentication](#cli-authentication). | | `namespaces, [namespace]` |Performs operations on namespaces. | | `nodes, [node]` |Performs operations on nodes. | -| `projects, [project]` | Performs operations on [projects]({{}}/rancher/v2.6/en/cluster-admin/projects-and-namespaces/). | -| `ps` | Displays [workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads) in a project. | +| `projects, [project]` | Performs operations on [projects](../how-to-guides/advanced-user-guides/manage-clusters/projects-and-namespaces.md). | +| `ps` | Displays [workloads](workloads-and-pods.md) in a project. | | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | | `help, [h]` | Shows a list of commands or help for one command. | @@ -99,7 +99,7 @@ All commands accept the `--help` flag, which documents each command's usage. ### Limitations -The Rancher CLI **cannot** be used to install [dashboard apps or Rancher feature charts](../helm-charts/). +The Rancher CLI **cannot** be used to install [dashboard apps or Rancher feature charts](helm-charts-in-rancher.md). # kubectl @@ -117,7 +117,7 @@ Run `kubectl cluster-info` or `kubectl get pods` successfully. _Requirements_ -If admins have [enforced TTL on kubeconfig tokens]({{}}/rancher/v2.6/en/api/api-tokens/#setting-ttl-on-kubeconfig-tokens), the kubeconfig file requires the [Rancher CLI](../cli) to be present in your PATH when you run `kubectl`. Otherwise, you’ll see an error like: +If admins have [enforced TTL on kubeconfig tokens](../reference-guides/about-the-api/api-tokens.md#setting-ttl-on-kubeconfig-tokens), the kubeconfig file requires the [Rancher CLI](cli-with-rancher.md) to be present in your PATH when you run `kubectl`. Otherwise, you’ll see an error like: `Unable to connect to the server: getting credentials: exec: exec: "rancher": executable file not found in $PATH`. This feature enables kubectl to authenticate with the Rancher server and get a new kubeconfig token when required. The following auth providers are currently supported: @@ -129,5 +129,5 @@ This feature enables kubectl to authenticate with the Rancher server and get a n 5. SAML providers: Ping, Okta, ADFS, Keycloak, Shibboleth When you first run kubectl, for example, `kubectl get pods`, it will ask you to pick an auth provider and log in with the Rancher server. -The kubeconfig token is cached in the path where you run kubectl under `./.cache/token`. This token is valid until [it expires](../api/api-tokens/#setting-ttl-on-kubeconfig-tokens-period), or [gets deleted from the Rancher server](../api/api-tokens/#deleting-tokens). +The kubeconfig token is cached in the path where you run kubectl under `./.cache/token`. This token is valid until [it expires](../reference-guides/about-the-api/api-tokens.md#setting-ttl-on-kubeconfig-tokens-period), or [gets deleted from the Rancher server](../reference-guides/about-the-api/api-tokens.md#deleting-tokens). Upon expiration, the next `kubectl get pods` will ask you to log in with the Rancher server again. diff --git a/docs/en/pages-for-subheaders/cluster-configuration.md b/docs/en/pages-for-subheaders/cluster-configuration.md new file mode 100644 index 00000000000..f08618880bd --- /dev/null +++ b/docs/en/pages-for-subheaders/cluster-configuration.md @@ -0,0 +1,30 @@ +--- +title: Cluster Configuration +weight: 2025 +--- + +After you provision a Kubernetes cluster using Rancher, you can still edit options and settings for the cluster. + +For information on editing cluster membership, go to [this page.](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/add-users-to-clusters.md) + +### Cluster Configuration References + +The cluster configuration options depend on the type of Kubernetes cluster: + +- [RKE Cluster Configuration](../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md) +- [RKE2 Cluster Configuration](../reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md) +- [K3s Cluster Configuration](../reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md) +- [EKS Cluster Configuration](../reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md) +- [GKE Cluster Configuration](gke-cluster-configuration.md) +- [AKS Cluster Configuration](../reference-guides/cluster-configuration/rancher-server-configuration/aks-cluster-configuration.md) + +### Cluster Management Capabilities by Cluster Type + +The options and settings available for an existing cluster change based on the method that you used to provision it. + +The following table summarizes the options and settings available for each cluster type: + +import ClusterCapabilitiesTable from '../shared-files/_cluster-capabilities-table.md'; + + + diff --git a/docs/en/istio/configuration-reference/configuration-reference.md b/docs/en/pages-for-subheaders/configuration-options.md similarity index 82% rename from docs/en/istio/configuration-reference/configuration-reference.md rename to docs/en/pages-for-subheaders/configuration-options.md index 1ed6fe50422..fb5004c75cd 100644 --- a/docs/en/istio/configuration-reference/configuration-reference.md +++ b/docs/en/pages-for-subheaders/configuration-options.md @@ -33,16 +33,16 @@ The Monitoring app sets `prometheus.prometheusSpec.ignoreNamespaceSelectors=fals If you would like to limit Prometheus to specific namespaces, set `prometheus.prometheusSpec.ignoreNamespaceSelectors=true`. Once you do this, you will need to add additional configuration to continue to monitor your resources. -For details, refer to [this section.](./selectors-and-scrape) +For details, refer to [this section.](../explanations/integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations.md) ### Enable Istio with Pod Security Policies -Refer to [this section.](./enable-istio-with-psp) +Refer to [this section.](../explanations/integrations-in-rancher/istio/configuration-options/pod-security-policies.md) ### Additional Steps for Installing Istio on an RKE2 Cluster -Refer to [this section.](./rke2) +Refer to [this section.](../explanations/integrations-in-rancher/istio/configuration-options/install-istio-on-rke2-cluster.md) ### Additional Steps for Project Network Isolation -Refer to [this section.](./canal-and-project-network) \ No newline at end of file +Refer to [this section.](../explanations/integrations-in-rancher/istio/configuration-options/project-network-isolation.md) \ No newline at end of file diff --git a/docs/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs.md b/docs/en/pages-for-subheaders/configure-microsoft-ad-federation-service-saml.md similarity index 64% rename from docs/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs.md rename to docs/en/pages-for-subheaders/configure-microsoft-ad-federation-service-saml.md index 32a60c9fec0..f06cc7b47d5 100644 --- a/docs/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs.md +++ b/docs/en/pages-for-subheaders/configure-microsoft-ad-federation-service-saml.md @@ -21,10 +21,10 @@ You must have a [Microsoft AD FS Server](https://docs.microsoft.com/en-us/window Setting up Microsoft AD FS with Rancher Server requires configuring AD FS on your Active Directory server, and configuring Rancher to utilize your AD FS server. The following pages serve as guides for setting up Microsoft AD FS authentication on your Rancher installation. -- [1. Configuring Microsoft AD FS for Rancher]({{}}/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup) -- [2. Configuring Rancher for Microsoft AD FS]({{}}/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup) +- [1. Configuring Microsoft AD FS for Rancher](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-ms-adfs-for-rancher.md) +- [2. Configuring Rancher for Microsoft AD FS](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-rancher-for-ms-adfs.md) {{< saml_caveats >}} -### [Next: Configuring Microsoft AD FS for Rancher]({{}}/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup) +### [Next: Configuring Microsoft AD FS for Rancher](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-ms-adfs-for-rancher.md) diff --git a/docs/en/admin-settings/authentication/openldap/openldap.md b/docs/en/pages-for-subheaders/configure-openldap.md similarity index 91% rename from docs/en/admin-settings/authentication/openldap/openldap.md rename to docs/en/pages-for-subheaders/configure-openldap.md index ddeb7c2fd52..59b2658a910 100644 --- a/docs/en/admin-settings/authentication/openldap/openldap.md +++ b/docs/en/pages-for-subheaders/configure-openldap.md @@ -15,9 +15,9 @@ Rancher must be configured with a LDAP bind account (aka service account) to sea ## Configure OpenLDAP in Rancher -Configure the settings for the OpenLDAP server, groups and users. For help filling out each field, refer to the [configuration reference.](./openldap-config) +Configure the settings for the OpenLDAP server, groups and users. For help filling out each field, refer to the [configuration reference.](../reference-guides/configure-openldap/openldap-config-reference.md) -> Before you proceed with the configuration, please familiarise yourself with the concepts of [External Authentication Configuration and Principal Users]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). +> Before you proceed with the configuration, please familiarise yourself with the concepts of [External Authentication Configuration and Principal Users](about-authentication.md#external-authentication-configuration-and-principal-users). 1. In the top left corner, click **☰ > Users & Authentication**. 1. In the left navigation menu, click **Auth Provider**. @@ -50,4 +50,4 @@ You will still be able to login using the locally configured `admin` account and ## Annex: Troubleshooting -If you are experiencing issues while testing the connection to the OpenLDAP server, first double-check the credentials entered for the service account as well as the search base configuration. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging]({{}}/rancher/v2.6/en/faq/technical/#how-can-i-enable-debug-logging) in this documentation. +If you are experiencing issues while testing the connection to the OpenLDAP server, first double-check the credentials entered for the service account as well as the search base configuration. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging](../faq/technical-items.md#how-can-i-enable-debug-logging) in this documentation. diff --git a/docs/en/admin-settings/authentication/shibboleth/shibboleth.md b/docs/en/pages-for-subheaders/configure-shibboleth-saml.md similarity index 92% rename from docs/en/admin-settings/authentication/shibboleth/shibboleth.md rename to docs/en/pages-for-subheaders/configure-shibboleth-saml.md index 914abb72577..3e2c420680c 100644 --- a/docs/en/admin-settings/authentication/shibboleth/shibboleth.md +++ b/docs/en/pages-for-subheaders/configure-shibboleth-saml.md @@ -9,7 +9,7 @@ In this configuration, when Rancher users log in, they will be redirected to the If you also configure OpenLDAP as the back end to Shibboleth, it will return a SAML assertion to Rancher with user attributes that include groups. Then the authenticated user will be able to access resources in Rancher that their groups have permissions for. -> The instructions in this section assume that you understand how Rancher, Shibboleth, and OpenLDAP work together. For a more detailed explanation of how it works, refer to [this page.](./about) +> The instructions in this section assume that you understand how Rancher, Shibboleth, and OpenLDAP work together. For a more detailed explanation of how it works, refer to [this page.](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-shibboleth-saml/about-group-permissions.md) This section covers the following topics: @@ -98,9 +98,9 @@ Rancher must be configured with a LDAP bind account (aka service account) to sea ### Configure OpenLDAP in Rancher -Configure the settings for the OpenLDAP server, groups and users. For help filling out each field, refer to the [configuration reference.]({{}}/rancher/v2.6/en/admin-settings/authentication/openldap/openldap-config) Note that nested group membership is not available for Shibboleth. +Configure the settings for the OpenLDAP server, groups and users. For help filling out each field, refer to the [configuration reference.](../reference-guides/configure-openldap/openldap-config-reference.md) Note that nested group membership is not available for Shibboleth. -> Before you proceed with the configuration, please familiarise yourself with the concepts of [External Authentication Configuration and Principal Users]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). +> Before you proceed with the configuration, please familiarise yourself with the concepts of [External Authentication Configuration and Principal Users](about-authentication.md#external-authentication-configuration-and-principal-users). 1. Log into the Rancher UI using the initial local `admin` account. 1. In the top left corner, click **☰ > Users & Authentication**. @@ -109,4 +109,4 @@ Configure the settings for the OpenLDAP server, groups and users. For help filli # Troubleshooting -If you are experiencing issues while testing the connection to the OpenLDAP server, first double-check the credentials entered for the service account as well as the search base configuration. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging]({{}}/rancher/v2.6/en/faq/technical/#how-can-i-enable-debug-logging) in this documentation. +If you are experiencing issues while testing the connection to the OpenLDAP server, first double-check the credentials entered for the service account as well as the search base configuration. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging](../faq/technical-items.md#how-can-i-enable-debug-logging) in this documentation. diff --git a/docs/en/cluster-admin/volumes-and-storage/volumes-and-storage.md b/docs/en/pages-for-subheaders/create-kubernetes-persistent-storage.md similarity index 59% rename from docs/en/cluster-admin/volumes-and-storage/volumes-and-storage.md rename to docs/en/pages-for-subheaders/create-kubernetes-persistent-storage.md index 745fbce0131..6d607713d1d 100644 --- a/docs/en/cluster-admin/volumes-and-storage/volumes-and-storage.md +++ b/docs/en/pages-for-subheaders/create-kubernetes-persistent-storage.md @@ -5,15 +5,15 @@ weight: 2031 --- 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. -The documents in this section assume that you understand the Kubernetes concepts of persistent volumes, persistent volume claims, and storage classes. For more information, refer to the section on [how storage works.](./how-storage-works) +The documents in this section assume that you understand the Kubernetes concepts of persistent volumes, persistent volume claims, and storage classes. For more information, refer to the section on [how storage works.](../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-persistent-storage.md) ### Prerequisites -To set up persistent storage, the `Manage Volumes` [role]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-role-reference) is required. +To set up persistent storage, the `Manage Volumes` [role](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#project-role-reference) is required. If you are provisioning storage for a cluster hosted in the cloud, the storage and cluster hosts must have the same cloud provider. -For provisioning new storage with Rancher, the cloud provider must be enabled. For details on enabling cloud providers, refer to [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/) +For provisioning new storage with Rancher, the cloud provider must be enabled. For details on enabling cloud providers, refer to [this page.](set-up-cloud-providers.md) For attaching existing persistent storage to a cluster, the cloud provider does not need to be enabled. @@ -26,7 +26,7 @@ The overall workflow for setting up existing storage is as follows: 3. Add a persistent volume claim (PVC) that refers to the PV. 4. Mount the PVC as a volume in your workload. -For details and prerequisites, refer to [this page.](./attaching-existing-storage) +For details and prerequisites, refer to [this page.](../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/set-up-existing-storage.md) ### Dynamically Provisioning New Storage in Rancher @@ -36,7 +36,7 @@ The overall workflow for provisioning new storage is as follows: 2. Add a persistent volume claim (PVC) that refers to the storage class. 3. Mount the PVC as a volume for your workload. -For details and prerequisites, refer to [this page.](./provisioning-new-storage) +For details and prerequisites, refer to [this page.](../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/dynamically-provision-new-storage.md) ### Longhorn Storage @@ -46,28 +46,28 @@ Longhorn is free, open source software. Originally developed by Rancher Labs, it If you have a pool of block storage, Longhorn can help you provide persistent storage to your Kubernetes cluster without relying on cloud providers. For more information about Longhorn features, refer to the [documentation.](https://longhorn.io/docs/latest/what-is-longhorn/) -Rancher v2.5 simplified the process of installing Longhorn on a Rancher-managed cluster. For more information, see [this page.]({{}}/rancher/v2.6/en/longhorn) +Rancher v2.5 simplified the process of installing Longhorn on a Rancher-managed cluster. For more information, see [this page.](../explanations/integrations-in-rancher/longhorn.md) ### Provisioning Storage Examples -We provide examples of how to provision storage with [NFS,](./examples/nfs) [vSphere,](./examples/vsphere) and [Amazon's EBS.](./examples/ebs) +We provide examples of how to provision storage with [NFS,](../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/nfs-storage.md) [vSphere,](../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/vsphere-storage.md) and [Amazon's EBS.](../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/persistent-storage-in-amazon-ebs.md) ### GlusterFS Volumes -In clusters that store data on GlusterFS volumes, you may experience an issue where pods fail to mount volumes after restarting the `kubelet`. For details on preventing this from happening, refer to [this page.](./glusterfs-volumes) +In clusters that store data on GlusterFS volumes, you may experience an issue where pods fail to mount volumes after restarting the `kubelet`. For details on preventing this from happening, refer to [this page.](../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-glusterfs-volumes.md) ### iSCSI Volumes -In [Rancher Launched Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) that store data on iSCSI volumes, you may experience an issue where kubelets fail to automatically connect with iSCSI volumes. For details on resolving this issue, refer to [this page.](./iscsi-volumes) +In [Rancher Launched Kubernetes clusters](launch-kubernetes-with-rancher.md) that store data on iSCSI volumes, you may experience an issue where kubelets fail to automatically connect with iSCSI volumes. For details on resolving this issue, refer to [this page.](../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/install-iscsi-volumes.md) ### hostPath Volumes -Before you create a hostPath volume, you need to set up an [extra_bind]({{}}/rke/latest/en/config-options/services/services-extras/#extra-binds/) in your cluster configuration. This will mount the path as a volume in your kubelets, which can then be used for hostPath volumes in your workloads. +Before you create a hostPath volume, you need to set up an [extra_bind](https://rancher.com/docs/rke/latest/en/config-options/services/services-extras/#extra-binds/) in your cluster configuration. This will mount the path as a volume in your kubelets, which can then be used for hostPath volumes in your workloads. ### Migrating vSphere Cloud Provider from In-tree to Out-of-tree Kubernetes is moving away from maintaining cloud providers in-tree. vSphere has an out-of-tree cloud provider that can be used by installing the vSphere cloud provider and cloud storage plugins. -For instructions on how to migrate from the in-tree vSphere cloud provider to out-of-tree, and manage the existing VMs post migration, refer to [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree) +For instructions on how to migrate from the in-tree vSphere cloud provider to out-of-tree, and manage the existing VMs post migration, refer to [this page.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-out-of-tree-vsphere.md) ### Related Links diff --git a/docs/en/pages-for-subheaders/custom-resource-configuration.md b/docs/en/pages-for-subheaders/custom-resource-configuration.md new file mode 100644 index 00000000000..bb051c785d6 --- /dev/null +++ b/docs/en/pages-for-subheaders/custom-resource-configuration.md @@ -0,0 +1,9 @@ +--- +title: Custom Resource Configuration +weight: 5 +--- + +The following Custom Resource Definitions are used to configure logging: + +- [Flow and ClusterFlow](../explanations/integrations-in-rancher/logging/custom-resource-configuration/flows-and-clusterflows.md) +- [Output and ClusterOutput](../explanations/integrations-in-rancher/logging/custom-resource-configuration/outputs-and-clusteroutputs.md) \ No newline at end of file diff --git a/docs/en/deploy-across-clusters/deploy-across-clusters.md b/docs/en/pages-for-subheaders/deploy-apps-across-clusters.md similarity index 68% rename from docs/en/deploy-across-clusters/deploy-across-clusters.md rename to docs/en/pages-for-subheaders/deploy-apps-across-clusters.md index bb41e0e6e00..bc0ebb83e33 100644 --- a/docs/en/deploy-across-clusters/deploy-across-clusters.md +++ b/docs/en/pages-for-subheaders/deploy-apps-across-clusters.md @@ -6,10 +6,10 @@ weight: 12 Rancher v2.5 introduced Fleet, a new way to deploy applications across clusters. -Fleet is GitOps at scale. For more information, refer to the [Fleet section.](./fleet) +Fleet is GitOps at scale. For more information, refer to the [Fleet section.](../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) ### Multi-cluster Apps In Rancher before v2.5, the multi-cluster apps feature was used to deploy applications across clusters. The multi-cluster apps feature is deprecated, but still available in Rancher v2.5. -Refer to the documentation [here.](./multi-cluster-apps) \ No newline at end of file +Refer to the documentation [here.](../how-to-guides/new-user-guides/deploy-apps-across-clusters/multi-cluster-apps.md) \ No newline at end of file diff --git a/docs/en/pages-for-subheaders/deploy-rancher-manager.md b/docs/en/pages-for-subheaders/deploy-rancher-manager.md new file mode 100644 index 00000000000..05be04756a8 --- /dev/null +++ b/docs/en/pages-for-subheaders/deploy-rancher-manager.md @@ -0,0 +1,21 @@ +--- +title: Deploying Rancher Server +weight: 100 +--- + +Use one of the following guides to deploy and provision Rancher and a Kubernetes cluster in the provider of your choice. + +- [AWS](../getting-started/quick-start-guides/deploy-rancher-manager/aws.md) (uses Terraform) +- [AWS Marketplace](../getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace.md) (uses Amazon EKS) +- [Azure](../getting-started/quick-start-guides/deploy-rancher-manager/azure.md) (uses Terraform) +- [DigitalOcean](../getting-started/quick-start-guides/deploy-rancher-manager/digitalocean.md) (uses Terraform) +- [GCP](../getting-started/quick-start-guides/deploy-rancher-manager/gcp.md) (uses Terraform) +- [Hetzner Cloud](../getting-started/quick-start-guides/deploy-rancher-manager/hetzner-cloud.md) (uses Terraform) +- [Vagrant](../getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md) +- [Equinix Metal](../getting-started/quick-start-guides/deploy-rancher-manager/equinix-metal.md) +- [Outscale](../getting-started/quick-start-guides/deploy-rancher-manager/outscale-qs.md) (uses Terraform) + + +If you prefer, the following guide will take you through the same process in individual steps. Use this if you want to run Rancher in a different provider, on prem, or if you would just like to see how easy it is. + +- [Manual Install](../getting-started/quick-start-guides/deploy-rancher-manager/helm-cli.md) diff --git a/docs/en/pages-for-subheaders/deploy-rancher-workloads.md b/docs/en/pages-for-subheaders/deploy-rancher-workloads.md new file mode 100644 index 00000000000..cf89f3341a1 --- /dev/null +++ b/docs/en/pages-for-subheaders/deploy-rancher-workloads.md @@ -0,0 +1,9 @@ +--- +title: Deploying Workloads +weight: 200 +--- + +These guides walk you through the deployment of an application, including how to expose the application for use outside of the cluster. + +- [Workload with Ingress](../getting-started/quick-start-guides/deploy-workloads/workload-ingress.md) +- [Workload with NodePort](../getting-started/quick-start-guides/deploy-workloads/nodeports.md) diff --git a/docs/en/pages-for-subheaders/downstream-cluster-configuration.md b/docs/en/pages-for-subheaders/downstream-cluster-configuration.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/downstream-cluster-configuration.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/installation/resources/feature-flags/feature-flags.md b/docs/en/pages-for-subheaders/enable-experimental-features.md similarity index 86% rename from docs/en/installation/resources/feature-flags/feature-flags.md rename to docs/en/pages-for-subheaders/enable-experimental-features.md index 5c113e3f390..39225b1a69a 100644 --- a/docs/en/installation/resources/feature-flags/feature-flags.md +++ b/docs/en/pages-for-subheaders/enable-experimental-features.md @@ -2,7 +2,7 @@ title: Enabling Experimental Features weight: 17 --- -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]({{}}/rancher/v2.6/en/installation/resources/feature-flags/enable-not-default-storage-drivers) 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. +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](../getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/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. The features can be enabled in three ways: @@ -29,14 +29,14 @@ There are some feature flags that may require a restart of the Rancher server co The following is a list of the feature flags available in Rancher: -- `harvester`: This feature flag is available starting in v2.6.1. It is used to manage access to the Virtualization Management page where users can navigate directly to Harvester clusters and access the Harvester UI. For more information, see [this page]({{}}/rancher/v2.6/en/virtualization-admin/#feature-flag/). +- `harvester`: This feature flag is available starting in v2.6.1. It is used to manage access to the Virtualization Management page where users can navigate directly to Harvester clusters and access the Harvester UI. For more information, see [this page](../explanations/integrations-in-rancher/harvester.md#feature-flag/). - `rke2`: Used to enable the ability to provision RKE2 clusters. By default, this feature flag is enabled, which allows users to attempt to provision these type of clusters. -- `fleet`: The previous `fleet` feature flag is now required to be enabled as the Fleet capabilities are leveraged within the new provisioning framework. If you had this feature flag disabled in earlier versions, upon upgrading to Rancher v2.6, the flag will automatically be enabled. See this [page]({{}}/rancher/v2.6/en/deploy-across-clusters/fleet) for more information. -- `continuous-delivery`: In Rancher v2.5.x, Fleet came with a GitOps feature that could not be disabled separately from Fleet. In Rancher v2.6, the `continuous-delivery` feature flag was introduced to allow the GitOps feature of Fleet to be disabled. For more information, see [this page.](./continuous-delivery). +- `fleet`: The previous `fleet` feature flag is now required to be enabled as the Fleet capabilities are leveraged within the new provisioning framework. If you had this feature flag disabled in earlier versions, upon upgrading to Rancher v2.6, the flag will automatically be enabled. See this [page](../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) for more information. +- `continuous-delivery`: In Rancher v2.5.x, Fleet came with a GitOps feature that could not be disabled separately from Fleet. In Rancher v2.6, the `continuous-delivery` feature flag was introduced to allow the GitOps feature of Fleet to be disabled. For more information, see [this page.](../getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/continuous-delivery.md). - `legacy`: There are a set of features from previous versions that are slowly being phased out of Rancher for newer iterations of the feature. This is a mix of deprecated features as well as features that will eventually be moved to newer variations in Rancher. By default, this feature flag is disabled for new installations. If you are upgrading from a previous version, this feature flag would be enabled. -- `token-hashing`: Used to enable new token-hashing feature. Once enabled, existing tokens will be hashed and all new tokens will be hashed automatically using the SHA256 algorithm. Once a token is hashed it cannot be undone. Once this feature flag is enabled, it cannot be disabled. See [hashing of tokens]({{}}/rancher/v2.6/en/api/api-tokens) for more information. -- `unsupported-storage-drivers`: This feature [allows unsupported storage drivers.]({{}}/rancher/v2.6/en/installation/resources/feature-flags/enable-not-default-storage-drivers). In other words, it enables types for storage providers and provisioners that are not enabled by default. -- `istio-virtual-service-ui`: This feature enables a [UI to create, read, update, and delete Istio virtual services and destination rules,]({{}}/rancher/v2.6/en/installation/resources/feature-flags/istio-virtual-service-ui) which are traffic management features of Istio. +- `token-hashing`: Used to enable new token-hashing feature. Once enabled, existing tokens will be hashed and all new tokens will be hashed automatically using the SHA256 algorithm. Once a token is hashed it cannot be undone. Once this feature flag is enabled, it cannot be disabled. See [hashing of tokens](../reference-guides/about-the-api/api-tokens.md) for more information. +- `unsupported-storage-drivers`: This feature [allows unsupported storage drivers.](../getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/unsupported-storage-drivers.md). In other words, it enables types for storage providers and provisioners that are not enabled by default. +- `istio-virtual-service-ui`: This feature enables a [UI to create, read, update, and delete Istio virtual services and destination rules,](../getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/istio-traffic-management-features.md) which are traffic management features of Istio. - `multi-cluster-management`: Used for multi-cluster provisioning and management of Kubernetes clusters. This feature flag can only be set at install time and not changed afterwards. The below table shows the availability and default value for feature flags in Rancher: @@ -87,7 +87,7 @@ If you are installing an alpha version, Helm requires adding the `--devel` optio ### Rendering the Helm Chart for Air Gap Installations -For an air gap installation of Rancher, you need to add a Helm chart repository and render a Helm template before installing Rancher with Helm. For details, refer to the [air gap installation documentation.]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/install-rancher) +For an air gap installation of Rancher, you need to add a Helm chart repository and render a Helm template before installing Rancher with Helm. For details, refer to the [air gap installation documentation.](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-rancher-ha.md) Here is an example of a command for passing in the feature flag names when rendering the Helm template. In the below example, two features are enabled by passing the feature flag names in a comma separated list. diff --git a/docs/en/pages-for-subheaders/fleet-gitops-at-scale.md b/docs/en/pages-for-subheaders/fleet-gitops-at-scale.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/fleet-gitops-at-scale.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/cluster-admin/editing-clusters/gke-config-reference/gke-config-reference.md b/docs/en/pages-for-subheaders/gke-cluster-configuration.md similarity index 97% rename from docs/en/cluster-admin/editing-clusters/gke-config-reference/gke-config-reference.md rename to docs/en/pages-for-subheaders/gke-cluster-configuration.md index 59c09aad32d..bdb8150ddfa 100644 --- a/docs/en/cluster-admin/editing-clusters/gke-config-reference/gke-config-reference.md +++ b/docs/en/pages-for-subheaders/gke-cluster-configuration.md @@ -105,7 +105,7 @@ _Mutable: no_ :::caution -Private clusters require additional planning and configuration outside of Rancher. Refer to the [private cluster guide]({{< baseurl >}}/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/). +Private clusters require additional planning and configuration outside of Rancher. Refer to the [private cluster guide](../reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-private-clusters.md). ::: @@ -115,7 +115,7 @@ Assign nodes only internal IP addresses. Private cluster nodes cannot access the :::caution -Private clusters require additional planning and configuration outside of Rancher. Refer to the [private cluster guide]({{< baseurl >}}/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/). +Private clusters require additional planning and configuration outside of Rancher. Refer to the [private cluster guide](../reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-private-clusters.md). ::: @@ -202,7 +202,7 @@ The node operating system image. For more information for the node image options :::note -The default option is "Container-Optimized OS with Docker". The read-only filesystem on GCP's Container-Optimized OS is not compatible with the [legacy logging]({{}}/rancher/v2.0-v2.4/en/cluster-admin/tools/logging) implementation in Rancher. If you need to use the legacy logging feature, select "Ubuntu with Docker" or "Ubuntu with Containerd". The [current logging feature]({{}}/rancher/v2.6/en/logging) is compatible with the Container-Optimized OS image. +The default option is "Container-Optimized OS with Docker". The read-only filesystem on GCP's Container-Optimized OS is not compatible with the [legacy logging]({{}}/rancher/v2.0-v2.4/en/cluster-admin/tools/logging) implementation in Rancher. If you need to use the legacy logging feature, select "Ubuntu with Docker" or "Ubuntu with Containerd". The [current logging feature](logging.md) is compatible with the Container-Optimized OS image. ::: diff --git a/docs/en/helm-charts/helm-charts.md b/docs/en/pages-for-subheaders/helm-charts-in-rancher.md similarity index 96% rename from docs/en/helm-charts/helm-charts.md rename to docs/en/pages-for-subheaders/helm-charts-in-rancher.md index 96397459906..c085be082b8 100644 --- a/docs/en/helm-charts/helm-charts.md +++ b/docs/en/pages-for-subheaders/helm-charts-in-rancher.md @@ -142,10 +142,10 @@ The upgrade button has been removed for legacy apps from the **Apps & Marketplac If you have a legacy app installed and want to upgrade it: -- The legacy [feature flag]({{}}/rancher/v2.6/en/installation/resources/feature-flags/) must be turned on (if it's not turned on automatically because of having a legacy app before upgrading) +- The legacy [feature flag](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 ### Limitations -[Dashboard apps or Rancher feature charts](../helm-charts/) **cannot** be installed using the Rancher CLI. +[Dashboard apps or Rancher feature charts](helm-charts-in-rancher.md) **cannot** be installed using the Rancher CLI. diff --git a/docs/en/pages-for-subheaders/horizontal-pod-autoscaler.md b/docs/en/pages-for-subheaders/horizontal-pod-autoscaler.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/horizontal-pod-autoscaler.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/pages-for-subheaders/infrastructure-setup.md b/docs/en/pages-for-subheaders/infrastructure-setup.md new file mode 100644 index 00000000000..081207021e8 --- /dev/null +++ b/docs/en/pages-for-subheaders/infrastructure-setup.md @@ -0,0 +1,10 @@ +--- +title: Don't have infrastructure for your Kubernetes cluster? Try one of these tutorials. +shortTitle: Infrastructure Tutorials +weight: 5 +--- + +To set up infrastructure for a high-availability K3s Kubernetes cluster with an external DB, refer to [this page.](../how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster.md) + + +To set up infrastructure for a high-availability RKE Kubernetes cluster, refer to [this page.](../how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster.md) diff --git a/docs/en/cluster-admin/cluster-autoscaler/cluster-autoscaler.md b/docs/en/pages-for-subheaders/install-cluster-autoscaler.md similarity index 91% rename from docs/en/cluster-admin/cluster-autoscaler/cluster-autoscaler.md rename to docs/en/pages-for-subheaders/install-cluster-autoscaler.md index 093de0f447d..40dafa4b01a 100644 --- a/docs/en/cluster-admin/cluster-autoscaler/cluster-autoscaler.md +++ b/docs/en/pages-for-subheaders/install-cluster-autoscaler.md @@ -22,4 +22,4 @@ Cluster Autoscaler provides support to distinct cloud providers. For more inform ### Setting up Cluster Autoscaler on Amazon Cloud Provider -For details on running the cluster autoscaler on Amazon cloud provider, refer to [this page.]({{}}/rancher/v2.6/en/cluster-admin/cluster-autoscaler/amazon) +For details on running the cluster autoscaler on Amazon cloud provider, refer to [this page.](../how-to-guides/advanced-user-guides/manage-clusters/install-cluster-autoscaler/use-aws-ec2-auto-scaling-groups.md) diff --git a/docs/en/installation/install-rancher-on-k8s/install-rancher-on-k8s.md b/docs/en/pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md similarity index 81% rename from docs/en/installation/install-rancher-on-k8s/install-rancher-on-k8s.md rename to docs/en/pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md index c3c309ab70a..323fd844d1b 100644 --- a/docs/en/installation/install-rancher-on-k8s/install-rancher-on-k8s.md +++ b/docs/en/pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md @@ -26,12 +26,12 @@ Rancher can be installed on any Kubernetes cluster. This cluster can use upstrea For help setting up a Kubernetes cluster, we provide these tutorials: -- **RKE:** For the tutorial to install an RKE Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-rke/) For help setting up the infrastructure for a high-availability RKE cluster, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha) -- **K3s:** For the tutorial to install a K3s Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-with-external-db) For help setting up the infrastructure for a high-availability K3s cluster, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db) -- **RKE2:** For the tutorial to install an RKE2 Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-rke2) For help setting up the infrastructure for a high-availability RKE2 cluster, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha) -- **Amazon EKS:** For details on how to install Rancher on Amazon EKS, including how to install an Ingress controller so that the Rancher server can be accessed, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/amazon-eks) -- **AKS:** For details on how to install Rancher with Azure Kubernetes Service, including how to install an Ingress controller so that the Rancher server can be accessed, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/aks) -- **GKE:** For details on how to install Rancher with Google Kubernetes Engine, including how to install an Ingress controller so that the Rancher server can be accessed, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/gke) +- **RKE:** For the tutorial to install an RKE Kubernetes cluster, refer to [this page.](installation/resources/k8s-tutorials/ha-rke/) For help setting up the infrastructure for a high-availability RKE cluster, refer to [this page.](../how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster.md) +- **K3s:** For the tutorial to install a K3s Kubernetes cluster, refer to [this page.](../how-to-guides/new-user-guides/kubernetes-cluster-setup/k3s-for-rancher.md) For help setting up the infrastructure for a high-availability K3s cluster, refer to [this page.](../how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster.md) +- **RKE2:** For the tutorial to install an RKE2 Kubernetes cluster, refer to [this page.](../how-to-guides/new-user-guides/kubernetes-cluster-setup/rke2-for-rancher.md) For help setting up the infrastructure for a high-availability RKE2 cluster, refer to [this page.](../how-to-guides/new-user-guides/infrastructure-setup/ha-rke2-kubernetes-cluster.md) +- **Amazon EKS:** For details on how to install Rancher on Amazon EKS, including how to install an Ingress controller so that the Rancher server can be accessed, refer to [this page.](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md) +- **AKS:** For details on how to install Rancher with Azure Kubernetes Service, including how to install an Ingress controller so that the Rancher server can be accessed, refer to [this page.](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md) +- **GKE:** For details on how to install Rancher with Google Kubernetes Engine, including how to install an Ingress controller so that the Rancher server can be accessed, refer to [this page.](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-gke.md) ### Ingress Controller @@ -48,17 +48,17 @@ Examples are included in the **Amazon EKS**, **AKS**, and **GKE** tutorials abov The following CLI tools are required for setting up the Kubernetes cluster. Please make sure these tools are installed and available in your `$PATH`. - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) - Kubernetes command-line tool. -- [helm](https://docs.helm.sh/using_helm/#installing-helm) - Package management for Kubernetes. Refer to the [Helm version requirements]({{}}/rancher/v2.6/en/installation/resources/helm-version) to choose a version of Helm to install Rancher. Refer to the [instructions provided by the Helm project](https://helm.sh/docs/intro/install/) for your specific platform. +- [helm](https://docs.helm.sh/using_helm/#installing-helm) - Package management for Kubernetes. Refer to the [Helm version requirements](../getting-started/installation-and-upgrade/resources/helm-version-requirements.md) to choose a version of Helm to install Rancher. Refer to the [instructions provided by the Helm project](https://helm.sh/docs/intro/install/) for your specific platform. # Install the Rancher Helm Chart Rancher is installed using the [Helm](https://helm.sh/) package manager for Kubernetes. Helm charts provide templating syntax for Kubernetes YAML manifest documents. With Helm, we can create configurable deployments instead of just using static files. -For systems without direct internet access, see [Air Gap: Kubernetes install]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/install-rancher/). +For systems without direct internet access, see [Air Gap: Kubernetes install](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-rancher-ha.md). -To choose a Rancher version to install, refer to [Choosing a Rancher Version.]({{}}/rancher/v2.6/en/installation/resources/choosing-version) +To choose a Rancher version to install, refer to [Choosing a Rancher Version.](../getting-started/installation-and-upgrade/resources/choose-a-rancher-version.md) -To choose a version of Helm to install Rancher with, refer to the [Helm version requirements]({{}}/rancher/v2.6/en/installation/resources/helm-version) +To choose a version of Helm to install Rancher with, refer to the [Helm version requirements](../getting-started/installation-and-upgrade/resources/helm-version-requirements.md) :::note @@ -78,7 +78,7 @@ To set up Rancher, ### 1. Add the Helm Chart Repository -Use `helm repo add` command to add the Helm chart repository that contains charts to install Rancher. For more information about the repository choices and which is best for your use case, see [Choosing a Version of Rancher]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories). +Use `helm repo add` command to add the Helm chart repository that contains charts to install Rancher. For more information about the repository choices and which is best for your use case, see [Choosing a Version of Rancher](../reference-guides/installation-references/helm-chart-options.md#helm-chart-repositories). {{< release-channel >}} @@ -100,7 +100,7 @@ The Rancher management server is designed to be secure by default and requires S :::note -If you want terminate SSL/TLS externally, see [TLS termination on an External Load Balancer]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination). +If you want terminate SSL/TLS externally, see [TLS termination on an External Load Balancer](../reference-guides/installation-references/helm-chart-options.md#external-tls-termination). ::: @@ -125,7 +125,7 @@ New in v2.6.4, cert-manager versions 1.6.2 and 1.7.1 are compatible. We recommen ::: -> You should skip this step if you are bringing your own certificate files (option `ingress.tls.source=secret`), or if you use [TLS termination on an external load balancer]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination). +> You should skip this step if you are bringing your own certificate files (option `ingress.tls.source=secret`), or if you use [TLS termination on an external load balancer](../reference-guides/installation-references/helm-chart-options.md#external-tls-termination). This step is only required to use certificates issued by Rancher's generated CA (`ingress.tls.source=rancher`) or to request Let's Encrypt issued certificates (`ingress.tls.source=letsEncrypt`). @@ -134,7 +134,7 @@ This step is only required to use certificates issued by Rancher's generated CA :::note Important: -Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.11.0, please see our [upgrade documentation]({{}}/rancher/v2.6/en/installation/resources/upgrading-cert-manager/). +Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.11.0, please see our [upgrade documentation](../getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md). ::: @@ -257,7 +257,7 @@ Although an entry in the `Subject Alternative Names` is technically required, ha :::note -If you want to check if your certificates are correct, see [How do I check Common Name and Subject Alternative Names in my server certificate?]({{}}/rancher/v2.6/en/faq/technical/#how-do-i-check-common-name-and-subject-alternative-names-in-my-server-certificate) +If you want to check if your certificates are correct, see [How do I check Common Name and Subject Alternative Names in my server certificate?](../faq/technical-items.md#how-do-i-check-common-name-and-subject-alternative-names-in-my-server-certificate) ::: @@ -285,18 +285,18 @@ helm install rancher rancher-/rancher \ --set privateCA=true ``` -Now that Rancher is deployed, see [Adding TLS Secrets]({{}}/rancher/v2.6/en/installation/resources/tls-secrets/) to publish the certificate files so Rancher and the Ingress controller can use them. +Now that Rancher is deployed, see [Adding TLS Secrets](../getting-started/installation-and-upgrade/resources/add-tls-secrets.md) to publish the certificate files so Rancher and the Ingress controller can use them. The Rancher chart configuration has many options for customizing the installation to suit your specific environment. Here are some common advanced scenarios. -- [HTTP Proxy]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#http-proxy) -- [Private container image Registry]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#private-registry-and-air-gap-installs) -- [TLS Termination on an External Load Balancer]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination) +- [HTTP Proxy](../reference-guides/installation-references/helm-chart-options.md#http-proxy) +- [Private container image Registry](../reference-guides/installation-references/helm-chart-options.md#private-registry-and-air-gap-installs) +- [TLS Termination on an External Load Balancer](../reference-guides/installation-references/helm-chart-options.md#external-tls-termination) -See the [Chart Options]({{}}/rancher/v2.6/en/installation/resources/chart-options/) for the full list of options. +See the [Chart Options](installation/resources/chart-options/) for the full list of options. ### 6. Verify that the Rancher Server is Successfully Deployed @@ -329,4 +329,4 @@ That's it. You should have a functional Rancher server. In a web browser, go to the DNS name that forwards traffic to your load balancer. Then you should be greeted by the colorful login page. -Doesn't work? Take a look at the [Troubleshooting]({{}}/rancher/v2.6/en/installation/resources/troubleshooting/) Page +Doesn't work? Take a look at the [Troubleshooting](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/troubleshooting.md) Page diff --git a/docs/en/installation/installation.md b/docs/en/pages-for-subheaders/installation-and-upgrade.md similarity index 56% rename from docs/en/installation/installation.md rename to docs/en/pages-for-subheaders/installation-and-upgrade.md index 9b7866d3bc9..e504eeeea26 100644 --- a/docs/en/installation/installation.md +++ b/docs/en/pages-for-subheaders/installation-and-upgrade.md @@ -15,7 +15,7 @@ In this section, - **K3s (Lightweight Kubernetes)** is also a fully compliant Kubernetes distribution. It is newer than RKE, easier to use, and more lightweight, with a binary size of less than 100 MB. - **RKE2** is a fully conformant Kubernetes distribution that focuses on security and compliance within the U.S. Federal Government sector. -Note the `restrictedAdmin` Helm chart option available for **the Rancher Server**. When this option is set to true, the initial Rancher user has restricted access to the local Kubernetes cluster to prevent privilege escalation. For more information, see the section about the [restricted-admin role.]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/#restricted-admin) +Note the `restrictedAdmin` Helm chart option available for **the Rancher Server**. When this option is set to true, the initial Rancher user has restricted access to the local Kubernetes cluster to prevent privilege escalation. For more information, see the section about the [restricted-admin role.](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md#restricted-admin) # Overview of Installation Options @@ -39,7 +39,7 @@ However, this option is useful if you want to save resources by using a single n For test and demonstration purposes, Rancher can be installed with Docker on a single node. A local Kubernetes cluster is installed in the single Docker container, and Rancher is installed on the local cluster. -The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.]({{}}/rancher/v2.6/en/backups/migrating-rancher) +The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.](../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md) ### Other Options @@ -47,9 +47,9 @@ There are also separate instructions for installing Rancher in an air gap enviro | Level of Internet Access | Kubernetes Installation - Strongly Recommended | Docker Installation | | ---------------------------------- | ------------------------------ | ---------- | -| With direct access to the Internet | [Docs]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) | [Docs]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker) | -| Behind an HTTP proxy | [Docs]({{}}/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/) | These [docs,]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker) plus this [configuration]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/proxy/) | -| In an air gap environment | [Docs]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap) | [Docs]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap) | +| With direct access to the Internet | [Docs](install-upgrade-on-a-kubernetes-cluster.md) | [Docs](rancher-on-a-single-node-with-docker.md) | +| Behind an HTTP proxy | [Docs](rancher-behind-an-http-proxy.md) | These [docs,](rancher-on-a-single-node-with-docker.md) plus this [configuration](../reference-guides/single-node-rancher-in-docker/http-proxy-configuration.md) | +| In an air gap environment | [Docs](air-gapped-helm-cli-install.md) | [Docs](air-gapped-helm-cli-install.md) | We recommend installing Rancher on a Kubernetes cluster, because in a multi-node cluster, the Rancher management server becomes highly available. This high-availability configuration helps maintain consistent access to the downstream Kubernetes clusters that Rancher will manage. @@ -57,38 +57,38 @@ For that reason, we recommend that for a production-grade architecture, you shou For testing or demonstration purposes, you can install Rancher in single Docker container. In this Docker install, you can use Rancher to set up Kubernetes clusters out-of-the-box. The Docker install allows you to explore the Rancher server functionality, but it is intended to be used for development and testing purposes only. -Our [instructions for installing Rancher on Kubernetes]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s) describe how to first use K3s or RKE to create and manage a Kubernetes cluster, then install Rancher onto that cluster. +Our [instructions for installing Rancher on Kubernetes](install-upgrade-on-a-kubernetes-cluster.md) describe how to first use K3s or RKE to create and manage a Kubernetes cluster, then install Rancher onto that cluster. -When the nodes in your Kubernetes cluster are running and fulfill the [node requirements,]({{}}/rancher/v2.6/en/installation/requirements) you will use Helm to deploy Rancher onto Kubernetes. Helm uses Rancher's Helm chart to install a replica of Rancher on each node in the Kubernetes cluster. We recommend using a load balancer to direct traffic to each replica of Rancher in the cluster. +When the nodes in your Kubernetes cluster are running and fulfill the [node requirements,](installation-requirements.md) you will use Helm to deploy Rancher onto Kubernetes. Helm uses Rancher's Helm chart to install a replica of Rancher on each node in the Kubernetes cluster. We recommend using a load balancer to direct traffic to each replica of Rancher in the cluster. -For a longer discussion of Rancher architecture, refer to the [architecture overview,]({{}}/rancher/v2.6/en/overview/architecture) [recommendations for production-grade architecture,]({{}}/rancher/v2.6/en/overview/architecture-recommendations) or our [best practices guide.]({{}}/rancher/v2.6/en/best-practices/rancher-server/deployment-types) +For a longer discussion of Rancher architecture, refer to the [architecture overview,](rancher-manager-architecture.md) [recommendations for production-grade architecture,](../reference-guides/rancher-manager-architecture/architecture-recommendations.md) or our [best practices guide.](../reference-guides/best-practices/rancher-server/tips-for-running-rancher.md) # Prerequisites -Before installing Rancher, make sure that your nodes fulfill all of the [installation requirements.]({{}}/rancher/v2.6/en/installation/requirements/) +Before installing Rancher, make sure that your nodes fulfill all of the [installation requirements.](installation-requirements.md) # Architecture Tip -For the best performance and greater security, we recommend a separate, dedicated Kubernetes cluster for the Rancher management server. Running user workloads on this cluster is not advised. After deploying Rancher, you can [create or import clusters]({{}}/rancher/v2.6/en/cluster-provisioning/) for running your workloads. +For the best performance and greater security, we recommend a separate, dedicated Kubernetes cluster for the Rancher management server. Running user workloads on this cluster is not advised. After deploying Rancher, you can [create or import clusters](kubernetes-clusters-in-rancher-setup.md) for running your workloads. -For more architecture recommendations, refer to [this page.]({{}}/rancher/v2.6/en/overview/architecture-recommendations) +For more architecture recommendations, refer to [this page.](../reference-guides/rancher-manager-architecture/architecture-recommendations.md) ### More Options for Installations on a Kubernetes Cluster -Refer to the [Helm chart options]({{}}/rancher/v2.6/en/installation/resources/chart-options/) for details on installing Rancher on a Kubernetes cluster with other configurations, including: +Refer to the [Helm chart options](installation/resources/chart-options/) for details on installing Rancher on a Kubernetes cluster with other configurations, including: -- With [API auditing to record all transactions]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#api-audit-log) -- With [TLS termination on a load balancer]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination) -- With a [custom Ingress]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#customizing-your-ingress) +- With [API auditing to record all transactions](../reference-guides/installation-references/helm-chart-options.md#api-audit-log) +- With [TLS termination on a load balancer](../reference-guides/installation-references/helm-chart-options.md#external-tls-termination) +- With a [custom Ingress](../reference-guides/installation-references/helm-chart-options.md#customizing-your-ingress) In the Rancher installation instructions, we recommend using K3s or RKE to set up a Kubernetes cluster before installing Rancher on the cluster. Both K3s and RKE have many configuration options for customizing the Kubernetes cluster to suit your specific environment. For the full list of their capabilities, refer to their documentation: -- [RKE configuration options]({{}}/rke/latest/en/config-options/) -- [K3s configuration options]({{}}/k3s/latest/en/installation/install-options/) +- [RKE configuration options](https://rancher.com/docs/rke/latest/en/config-options/) +- [K3s configuration options](https://rancher.com/docs/k3s/latest/en/installation/install-options/) ### More Options for Installations with Docker -Refer to the [docs about options for Docker installs]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker) for details about other configurations including: +Refer to the [docs about options for Docker installs](rancher-on-a-single-node-with-docker.md) for details about other configurations including: -- With [API auditing to record all transactions]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#api-audit-log) -- With an [external load balancer]({{}}/rancher/v2.6/en/installation/resources/advanced/single-node-install-external-lb/) -- With a [persistent data store]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#persistent-data) +- With [API auditing to record all transactions](../reference-guides/single-node-rancher-in-docker/advanced-options.md#api-audit-log) +- With an [external load balancer](../getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/configure-layer-7-nginx-load-balancer.md) +- With a [persistent data store](../reference-guides/single-node-rancher-in-docker/advanced-options.md#persistent-data) diff --git a/docs/en/pages-for-subheaders/installation-references.md b/docs/en/pages-for-subheaders/installation-references.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/installation-references.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/installation/requirements/requirements.md b/docs/en/pages-for-subheaders/installation-requirements.md similarity index 83% rename from docs/en/installation/requirements/requirements.md rename to docs/en/pages-for-subheaders/installation-requirements.md index 5728ac80acd..14e28c814e9 100644 --- a/docs/en/installation/requirements/requirements.md +++ b/docs/en/pages-for-subheaders/installation-requirements.md @@ -8,7 +8,7 @@ This page describes the software, hardware, and networking requirements for the :::note Important: -If you install Rancher on a Kubernetes cluster, requirements are different from the [node requirements for downstream user clusters,]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/) which will run your apps and services. +If you install Rancher on a Kubernetes cluster, requirements are different from the [node requirements for downstream user clusters,](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md) which will run your apps and services. ::: @@ -32,7 +32,7 @@ Make sure the node(s) for the Rancher server fulfill the following requirements: - [Port Requirements](#port-requirements) - [Dockershim Support](#dockershim-support) -For a list of best practices that we recommend for running the Rancher server in production, refer to the [best practices section.]({{}}/rancher/v2.6/en/best-practices/rancher-server/deployment-types/) +For a list of best practices that we recommend for running the Rancher server in production, refer to the [best practices section.](../reference-guides/best-practices/rancher-server/tips-for-running-rancher.md) The Rancher UI works best in Firefox or Chrome. @@ -54,7 +54,7 @@ Some distributions of Linux may have default firewall rules that block communica If you don't feel comfortable doing so you might check suggestions in the [respective issue](https://github.com/rancher/rancher/issues/28840). Some users were successful [creating a separate firewalld zone with a policy of ACCEPT for the Pod CIDR](https://github.com/rancher/rancher/issues/28840#issuecomment-787404822). -If you plan to run Rancher on ARM64, see [Running on ARM64 (Experimental).]({{}}/rancher/v2.6/en/installation/resources/advanced/arm64-platform/) +If you plan to run Rancher on ARM64, see [Running on ARM64 (Experimental).](../getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/rancher-on-arm64.md) ### RKE Specific Requirements @@ -72,9 +72,9 @@ For the container runtime, K3s should work with any modern version of Docker or Rancher needs to be installed on a supported Kubernetes version. To find out which versions of Kubernetes are supported for your Rancher version, refer to the [support maintenance terms.](https://rancher.com/support-maintenance-terms/) To specify the K3s version, use the INSTALL_K3S_VERSION environment variable when running the K3s installation script. -If you are installing Rancher on a K3s cluster with **Raspbian Buster**, follow [these steps]({{}}/k3s/latest/en/advanced/#enabling-legacy-iptables-on-raspbian-buster) to switch to legacy iptables. +If you are installing Rancher on a K3s cluster with **Raspbian Buster**, follow [these steps](https://rancher.com/docs/k3s/latest/en/advanced/#enabling-legacy-iptables-on-raspbian-buster) to switch to legacy iptables. -If you are installing Rancher on a K3s cluster with Alpine Linux, follow [these steps]({{}}/k3s/latest/en/advanced/#additional-preparation-for-alpine-linux-setup) for additional setup. +If you are installing Rancher on a K3s cluster with Alpine Linux, follow [these steps](https://rancher.com/docs/k3s/latest/en/advanced/#additional-preparation-for-alpine-linux-setup) for additional setup. @@ -86,7 +86,7 @@ Docker is not required for RKE2 installs. ### Installing Docker -Docker is required for Helm chart installs, and it can be installed by following the steps in the official [Docker documentation.](https://docs.docker.com/) Rancher also provides [scripts]({{}}/rancher/v2.6/en/installation/requirements/installing-docker) to install Docker with one command. +Docker is required for Helm chart installs, and it can be installed by following the steps in the official [Docker documentation.](https://docs.docker.com/) Rancher also provides [scripts](../getting-started/installation-and-upgrade/installation-requirements/install-docker.md) to install Docker with one command. # Hardware Requirements @@ -114,7 +114,7 @@ Every use case and environment is different. Please [contact Rancher](https://ra ### K3s Kubernetes -These CPU and memory requirements apply to each host in a [K3s Kubernetes cluster where the Rancher server is installed.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) +These CPU and memory requirements apply to each host in a [K3s Kubernetes cluster where the Rancher server is installed.](install-upgrade-on-a-kubernetes-cluster.md) | Deployment Size | Clusters | Nodes | vCPUs | RAM | Database Size | | --------------- | ---------- | ------------ | -------| ---------| ------------------------- | @@ -138,7 +138,7 @@ These CPU and memory requirements apply to each instance with RKE2 installed. Mi ### Docker -These CPU and memory requirements apply to a host with a [single-node]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker) installation of Rancher. +These CPU and memory requirements apply to a host with a [single-node](rancher-on-a-single-node-with-docker.md) installation of Rancher. | Deployment Size | Clusters | Nodes | vCPUs | RAM | | --------------- | -------- | --------- | ----- | ---- | @@ -155,9 +155,9 @@ For RKE and K3s installations, you don't have to install the Ingress manually be For hosted Kubernetes clusters (EKS, GKE, AKS) and RKE2 Kubernetes installations, you will need to set up the ingress. -- **Amazon EKS:** For details on how to install Rancher on Amazon EKS, including how to install an ingress so that the Rancher server can be accessed, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/amazon-eks) -- **AKS:** For details on how to install Rancher with Azure Kubernetes Service, including how to install an ingress so that the Rancher server can be accessed, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/aks) -- **GKE:** For details on how to install Rancher with Google Kubernetes Engine, including how to install an ingress so that the Rancher server can be accessed, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/gke) +- **Amazon EKS:** For details on how to install Rancher on Amazon EKS, including how to install an ingress so that the Rancher server can be accessed, refer to [this page.](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md) +- **AKS:** For details on how to install Rancher with Azure Kubernetes Service, including how to install an ingress so that the Rancher server can be accessed, refer to [this page.](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md) +- **GKE:** For details on how to install Rancher with Google Kubernetes Engine, including how to install an ingress so that the Rancher server can be accessed, refer to [this page.](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-gke.md) # Disks @@ -179,8 +179,8 @@ Each node used should have a static IP configured, regardless of whether you are ### Port Requirements -To operate properly, Rancher requires a number of ports to be open on Rancher nodes and on downstream Kubernetes cluster nodes. [Port Requirements]({{}}/rancher/v2.6/en/installation/requirements/ports) lists all the necessary ports for Rancher and Downstream Clusters for the different cluster types. +To operate properly, Rancher requires a number of ports to be open on Rancher nodes and on downstream Kubernetes cluster nodes. [Port Requirements](../getting-started/installation-and-upgrade/installation-requirements/port-requirements.md) lists all the necessary ports for Rancher and Downstream Clusters for the different cluster types. # Dockershim Support -For more information on Dockershim support, refer to [this page]({{}}/rancher/v2.6/en/installation/requirements/dockershim/). +For more information on Dockershim support, refer to [this page](../getting-started/installation-and-upgrade/installation-requirements/dockershim.md). diff --git a/docs/en/pages-for-subheaders/integrations-in-rancher.md b/docs/en/pages-for-subheaders/integrations-in-rancher.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/integrations-in-rancher.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/pages-for-subheaders/introduction.md b/docs/en/pages-for-subheaders/introduction.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/introduction.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/pages-for-subheaders/istio-setup-guide.md b/docs/en/pages-for-subheaders/istio-setup-guide.md new file mode 100644 index 00000000000..929ecdfc764 --- /dev/null +++ b/docs/en/pages-for-subheaders/istio-setup-guide.md @@ -0,0 +1,30 @@ +--- +title: Setup Guide +weight: 2 +--- + +This section describes how to enable Istio and start using it in your projects. + +If you use Istio for traffic management, you will need to allow external traffic to the cluster. In that case, you will need to follow all of the steps below. + +# Prerequisites + +This guide assumes you have already [installed Rancher,](installation-and-upgrade.md) and you have already [provisioned a separate Kubernetes cluster](kubernetes-clusters-in-rancher-setup.md) on which you will install Istio. + +The nodes in your cluster must meet the [CPU and memory requirements.](../explanations/integrations-in-rancher/istio/cpu-and-memory-allocations.md) + +The workloads and services that you want to be controlled by Istio must meet [Istio's requirements.](https://istio.io/docs/setup/additional-setup/requirements/) + + +# Install + +:::tip Quick Setup Tip: If you don't need external traffic to reach Istio, and you just want to set up Istio for monitoring and tracing traffic within the cluster, skip the steps for [setting up the Istio gateway](../how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md) and [setting up Istio's components for traffic management.](../how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md) + +::: + +1. [Enable Istio in the cluster.](../how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md) +1. [Enable Istio in all the namespaces where you want to use it.](../how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md) +1. [Add deployments and services that have the Istio sidecar injected.](../how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md) +1. [Set up the Istio gateway. ](../how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md) +1. [Set up Istio's components for traffic management.](../how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md) +1. [Generate traffic and see Istio in action.](istio/setup/view-traffic/ ) diff --git a/docs/en/istio/istio.md b/docs/en/pages-for-subheaders/istio.md similarity index 85% rename from docs/en/istio/istio.md rename to docs/en/pages-for-subheaders/istio.md index e594a127fc9..4e202f8a2ed 100644 --- a/docs/en/istio/istio.md +++ b/docs/en/pages-for-subheaders/istio.md @@ -15,7 +15,7 @@ This core service mesh provides features that include but are not limited to the - **Security** with resources to authenticate and authorize traffic and users, mTLS included. - **Observability** of logs, metrics, and distributed traffic flows. -After [setting up istio]({{}}/rancher/v2.6/en/istio/setup) you can leverage Istio's control plane functionality through the Rancher UI, `kubectl`, or `istioctl`. +After [setting up istio](istio-setup-guide.md) you can leverage Istio's control plane functionality through the Rancher UI, `kubectl`, or `istioctl`. Istio needs to be set up by a `cluster-admin` before it can be used in a project. @@ -35,7 +35,7 @@ The overall architecture of Istio has been simplified. A single component, Istio Addons that were previously installed by Istio (cert-manager, Grafana, Jaeger, Kiali, Prometheus, Zipkin) will now need to be installed separately. Istio will support installation of integrations that are from the Istio Project and will maintain compatibility with those that are not. -A Prometheus integration will still be available through an installation of [Rancher Monitoring]({{}}/rancher/v2.6/en/monitoring-alerting/), or by installing your own Prometheus operator. Rancher's Istio chart will also install Kiali by default to ensure you can get a full picture of your microservices out of the box. +A Prometheus integration will still be available through an installation of [Rancher Monitoring](monitoring-and-alerting.md), or by installing your own Prometheus operator. Rancher's Istio chart will also install Kiali by default to ensure you can get a full picture of your microservices out of the box. Istio has migrated away from Helm as a way to install Istio and now provides installation through the istioctl binary or Istio Operator. To ensure the easiest interaction with Istio, Rancher's Istio will maintain a Helm chart that utilizes the istioctl binary to manage your Istio installation. @@ -61,7 +61,7 @@ Note that this is not a production-qualified deployment of Jaeger. This deployme # Prerequisites -Before enabling Istio, we recommend that you confirm that your Rancher worker nodes have enough [CPU and memory]({{}}/rancher/v2.6/en/istio/resources) to run all of the components of Istio. +Before enabling Istio, we recommend that you confirm that your Rancher worker nodes have enough [CPU and memory](../explanations/integrations-in-rancher/istio/cpu-and-memory-allocations.md) to run all of the components of Istio. If you are installing Istio on RKE2 cluster, some additional steps are required. For details, see [this section.](#additional-steps-for-installing-istio-on-an-rke2-cluster) @@ -69,11 +69,11 @@ Note that Istio v2 (upstream Istio v1.7+) cannot be upgraded in an air gapped en # Setup Guide -Refer to the [setup guide]({{}}/rancher/v2.6/en/istio/setup) for instructions on how to set up Istio and use it in a project. +Refer to the [setup guide](istio-setup-guide.md) for instructions on how to set up Istio and use it in a project. # Remove Istio -To remove Istio components from a cluster, namespace, or workload, refer to the section on [uninstalling Istio.]({{}}/rancher/v2.6/en/istio/disabling-istio/) +To remove Istio components from a cluster, namespace, or workload, refer to the section on [uninstalling Istio.](../explanations/integrations-in-rancher/istio/disable-istio.md) # Migrate From Previous Istio Version @@ -85,7 +85,7 @@ Another option is to manually uninstall istio resources one at a time, but leave # Accessing Visualizations -> By default, only cluster-admins have access to Kiali. For instructions on how to allow admin, edit or views roles to access them, see [this section.]({{}}/rancher/v2.6/en/istio/rbac/) +> By default, only cluster-admins have access to Kiali. For instructions on how to allow admin, edit or views roles to access them, see [this section.](../explanations/integrations-in-rancher/istio/rbac-for-istio.md) After Istio is set up in a cluster, Grafana, Prometheus, and Kiali are available in the Rancher UI. @@ -103,7 +103,7 @@ To access the Kiali visualization, 1. In the left navigation bar, click **Istio**. 1. Click **Kiali**. From here you can access the **Traffic Graph** tab or the **Traffic Metrics** tab to see network visualizations and metrics. -By default, all namespace will picked up by prometheus and make data available for Kiali graphs. Refer to [selector/scrape config setup](./configuration-reference/selectors-and-scrape) if you would like to use a different configuration for prometheus data scraping. +By default, all namespace will picked up by prometheus and make data available for Kiali graphs. Refer to [selector/scrape config setup](../explanations/integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations.md) if you would like to use a different configuration for prometheus data scraping. Your access to the visualizations depend on your role. Grafana and Prometheus are only available for `cluster-admin` roles. The Kiali UI is available only to `cluster-admin` by default, but `cluster-admin` can allow other roles to access them by editing the Istio values.yaml. @@ -121,14 +121,14 @@ For more information on the Istio sidecar, refer to the [Istio sidecare-injectio By default, each Rancher-provisioned cluster has one NGINX ingress controller allowing traffic into the cluster. Istio also installs an ingress gateway by default into the `istio-system` namespace. The result is that your cluster will have two ingresses in your cluster. -![In an Istio-enabled cluster, you can have two ingresses: the default Nginx ingress, and the default Istio controller.]({{}}/img/rancher/istio-ingress.svg) +![In an Istio-enabled cluster, you can have two ingresses: the default Nginx ingress, and the default Istio controller.](/img/istio-ingress.svg) - Additional Istio Ingress gateways can be enabled via the [overlay file]({{}}/rancher/v2.6/en/istio/configuration-reference/#overlay-file). + Additional Istio Ingress gateways can be enabled via the [overlay file](configuration-options.md#overlay-file). ### Egress Support -By default the Egress gateway is disabled, but can be enabled on install or upgrade through the values.yaml or via the [overlay file]({{}}/rancher/v2.6/en/istio/configuration-reference/#overlay-file). +By default the Egress gateway is disabled, but can be enabled on install or upgrade through the values.yaml or via the [overlay file](configuration-options.md#overlay-file). # Additional Steps for Installing Istio on an RKE2 Cluster -To install Istio on an RKE2 cluster, follow the steps in [this section.]({{}}/rancher/v2.6/en/istio/configuration-reference/rke2/) +To install Istio on an RKE2 cluster, follow the steps in [this section.](../explanations/integrations-in-rancher/istio/configuration-options/install-istio-on-rke2-cluster.md) diff --git a/docs/en/installation/resources/k8s-tutorials/k8s-tutorials.md b/docs/en/pages-for-subheaders/kubernetes-cluster-setup.md similarity index 100% rename from docs/en/installation/resources/k8s-tutorials/k8s-tutorials.md rename to docs/en/pages-for-subheaders/kubernetes-cluster-setup.md diff --git a/docs/en/cluster-provisioning/cluster-provisioning.md b/docs/en/pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md similarity index 77% rename from docs/en/cluster-provisioning/cluster-provisioning.md rename to docs/en/pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md index b3e16047f42..309a6fbacd9 100644 --- a/docs/en/cluster-provisioning/cluster-provisioning.md +++ b/docs/en/pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md @@ -6,9 +6,9 @@ weight: 7 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. -This section assumes a basic familiarity with Docker and Kubernetes. For a brief explanation of how Kubernetes components work together, refer to the [concepts]({{}}/rancher/v2.6/en/overview/concepts) page. +This section assumes a basic familiarity with Docker and Kubernetes. For a brief explanation of how Kubernetes components work together, refer to the [concepts](../reference-guides/kubernetes-concepts.md) page. -For a conceptual overview of how the Rancher server provisions clusters and what tools it uses to provision them, refer to the [architecture]({{}}/rancher/v2.6/en/overview/architecture/) page. +For a conceptual overview of how the Rancher server provisions clusters and what tools it uses to provision them, refer to the [architecture](rancher-manager-architecture.md) page. This section covers the following topics: @@ -28,7 +28,7 @@ This section covers the following topics: The following table summarizes the options and settings available for each cluster type: -import ClusterCapabilitiesTable from '/rancher/v2.6/en/shared-files/_cluster-capabilities-table.md'; +import ClusterCapabilitiesTable from '../shared-files/_cluster-capabilities-table.md'; @@ -38,11 +38,11 @@ In this scenario, Rancher does not provision Kubernetes because it is installed If you use a Kubernetes provider such as Google GKE, Rancher integrates with its cloud APIs, allowing you to create and manage role-based access control for the hosted cluster from the Rancher UI. -For more information, refer to the section on [hosted Kubernetes clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters) +For more information, refer to the section on [hosted Kubernetes clusters.](set-up-clusters-from-hosted-kubernetes-providers.md) # Launching Kubernetes with Rancher -Rancher uses the [Rancher Kubernetes Engine (RKE)]({{}}/rke/latest/en/) as a library when provisioning Kubernetes on your own nodes. RKE is Rancher’s own lightweight Kubernetes installer. +Rancher uses the [Rancher Kubernetes Engine (RKE)](https://rancher.com/docs/rke/latest/en/) as a library when provisioning Kubernetes on your own nodes. RKE is Rancher’s own lightweight Kubernetes installer. In RKE clusters, Rancher manages the deployment of Kubernetes. These clusters can be deployed on any bare metal server, cloud provider, or virtualization platform. @@ -50,23 +50,23 @@ These nodes can be dynamically provisioned through Rancher's UI, which calls [Do If you already have a node that you want to add to an RKE cluster, you can add it to the cluster by running a Rancher agent container on it. -For more information, refer to the section on [RKE clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) +For more information, refer to the section on [RKE clusters.](launch-kubernetes-with-rancher.md) ### Launching Kubernetes and Provisioning Nodes in an Infrastructure Provider Rancher can dynamically provision nodes in infrastructure providers such as Amazon EC2, DigitalOcean, Azure, or vSphere, then install Kubernetes on them. -Using Rancher, you can create pools of nodes based on a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates). This template defines the parameters used to launch nodes in your cloud providers. +Using Rancher, you can create pools of nodes based on a [node template](use-new-nodes-in-an-infra-provider.md#node-templates). This template defines the parameters used to launch nodes in your cloud providers. One benefit of using nodes hosted by an infrastructure provider is that if a node loses connectivity with the cluster, Rancher can automatically replace it, thus maintaining the expected cluster configuration. -The cloud providers available for creating a node template are decided based on the [node drivers]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-drivers) active in the Rancher UI. +The cloud providers available for creating a node template are decided based on the [node drivers](use-new-nodes-in-an-infra-provider.md#node-drivers) active in the Rancher UI. -For more information, refer to the section on [nodes hosted by an infrastructure provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/) +For more information, refer to the section on [nodes hosted by an infrastructure provider](use-new-nodes-in-an-infra-provider.md) ### Launching Kubernetes on Existing Custom Nodes -When setting up this type of cluster, Rancher installs Kubernetes on existing [custom nodes,]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/) which creates a custom cluster. +When setting up this type of cluster, Rancher installs Kubernetes on existing [custom nodes,](use-existing-nodes.md) which creates a custom cluster. You can bring any nodes you want to Rancher and use them to create a cluster. @@ -80,10 +80,10 @@ Registering EKS clusters now provides additional benefits. For the most part, re When you delete an EKS cluster that was created in Rancher, the cluster is destroyed. When you delete an EKS cluster that was registered in Rancher, it is disconnected from the Rancher server, but it still exists and you can still access it in the same way you did before it was registered in Rancher. -For more information, see [this page.](./registered-clusters) +For more information, see [this page.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md) # Programmatically Creating Clusters The most common way to programmatically deploy Kubernetes clusters through Rancher is by using the Rancher2 Terraform provider. The documentation for creating clusters with Terraform is [here.](https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster) -EKS, GKE, AKS clusters and RKE clusters can be created or imported with Terraform. \ No newline at end of file +EKS, GKE, AKS clusters and RKE clusters can be created or imported with Terraform. diff --git a/docs/en/pages-for-subheaders/kubernetes-components.md b/docs/en/pages-for-subheaders/kubernetes-components.md new file mode 100644 index 00000000000..4fc8354908f --- /dev/null +++ b/docs/en/pages-for-subheaders/kubernetes-components.md @@ -0,0 +1,18 @@ +--- +title: Kubernetes Components +weight: 100 +--- + +The commands and steps listed in this section apply to the core Kubernetes components on [Rancher Launched Kubernetes](launch-kubernetes-with-rancher.md) clusters. + +This section includes troubleshooting tips in the following categories: + +- [Troubleshooting etcd Nodes](../troubleshooting/kubernetes-components/troubleshooting-etcd-nodes.md) +- [Troubleshooting Controlplane Nodes](../troubleshooting/kubernetes-components/troubleshooting-controlplane-nodes.md) +- [Troubleshooting nginx-proxy Nodes](../troubleshooting/kubernetes-components/troubleshooting-nginx-proxy.md) +- [Troubleshooting Worker Nodes and Generic Components](../troubleshooting/kubernetes-components/troubleshooting-worker-nodes-and-generic-components.md) + +# Kubernetes Component Diagram + +![Cluster diagram](/img/clusterdiagram.svg)
+Lines show the traffic flow between components. Colors are used purely for visual aid \ No newline at end of file diff --git a/docs/en/k8s-in-rancher/k8s-in-rancher.md b/docs/en/pages-for-subheaders/kubernetes-resources-setup.md similarity index 50% rename from docs/en/k8s-in-rancher/k8s-in-rancher.md rename to docs/en/pages-for-subheaders/kubernetes-resources-setup.md index 0864b408ef3..3778a8dbca0 100644 --- a/docs/en/k8s-in-rancher/k8s-in-rancher.md +++ b/docs/en/pages-for-subheaders/kubernetes-resources-setup.md @@ -7,15 +7,15 @@ You can view and manipulate all of the custom resources and CRDs in a Kubernetes ## Workloads -Deploy applications to your cluster nodes using [workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/), which are objects that contain pods that run your apps, along with metadata that set rules for the deployment's behavior. Workloads can be deployed within the scope of the entire clusters or within a namespace. +Deploy applications to your cluster nodes using [workloads](workloads-and-pods.md), which are objects that contain pods that run your apps, along with metadata that set rules for the deployment's behavior. Workloads can be deployed within the scope of the entire clusters or within a namespace. -When deploying a workload, you can deploy from any image. There are a variety of [workload types]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/#workload-types) to choose from which determine how your application should run. +When deploying a workload, you can deploy from any image. There are a variety of [workload types](workloads-and-pods.md#workload-types) to choose from which determine how your application should run. Following a workload deployment, you can continue working with it. You can: -- [Upgrade]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/upgrade-workloads) the workload to a newer version of the application it's running. -- [Roll back]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/rollback-workloads) a workload to a previous version, if an issue occurs during upgrade. -- [Add a sidecar]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/add-a-sidecar), which is a workload that supports a primary workload. +- [Upgrade](../how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/upgrade-workloads.md) the workload to a newer version of the application it's running. +- [Roll back](../how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/roll-back-workloads.md) a workload to a previous version, if an issue occurs during upgrade. +- [Add a sidecar](../how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/add-a-sidecar.md), which is a workload that supports a primary workload. ## Load Balancing and Ingress @@ -27,10 +27,10 @@ If you want your applications to be externally accessible, you must add a load b Rancher supports two types of load balancers: -- [Layer-4 Load Balancers]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#layer-4-load-balancer) -- [Layer-7 Load Balancers]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#layer-7-load-balancer) +- [Layer-4 Load Balancers](../how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing.md#layer-4-load-balancer) +- [Layer-7 Load Balancers](../how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing.md#layer-7-load-balancer) -For more information, see [load balancers]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers). +For more information, see [load balancers](../how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing.md). #### Ingress @@ -38,7 +38,7 @@ Load Balancers can only handle one IP address per service, which means if you ru Ingress is a set of rules that act as a load balancer. Ingress works in conjunction with one or more ingress controllers to dynamically route service requests. When the ingress receives a request, the ingress controller(s) in your cluster program the load balancer to direct the request to the correct service based on service subdomains or path rules that you've configured. -For more information, see [Ingress]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/ingress). +For more information, see [Ingress](../how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/add-ingresses.md). When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry. @@ -46,13 +46,13 @@ When using ingresses in a project, you can program the ingress hostname to an ex After you expose your cluster to external requests using a load balancer and/or ingress, it's only available by IP address. To create a resolveable hostname, you must create a service record, which is a record that maps an IP address, external hostname, DNS record alias, workload(s), or labelled pods to a specific hostname. -For more information, see [Service Discovery]({{}}/rancher/v2.6/en/k8s-in-rancher/service-discovery). +For more information, see [Service Discovery](../how-to-guides/new-user-guides/kubernetes-resources-setup/create-services.md). ## Pipelines -After your project has been [configured to a version control provider]({{}}/rancher/v2.6/en/project-admin/pipelines/#1-configure-version-control-providers), you can add the repositories and start configuring a pipeline for each repository. +After your project has been [configured to a version control provider](../how-to-guides/advanced-user-guides/manage-projects/ci-cd-pipelines.md#1-configure-version-control-providers), you can add the repositories and start configuring a pipeline for each repository. -For more information, see [Pipelines]({{}}/rancher/v2.6/en/pipelines/). +For more information, see [Pipelines](pipelines.md). ## Applications @@ -64,7 +64,7 @@ Within the context of a Rancher project or namespace, _resources_ are files and Resources include: -- [Certificates]({{}}/rancher/v2.6/en/k8s-in-rancher/certificates/): Files used to encrypt/decrypt data entering or leaving the cluster. -- [ConfigMaps]({{}}/rancher/v2.6/en/k8s-in-rancher/configmaps/): Files that store general configuration information, such as a group of config files. -- [Secrets]({{}}/rancher/v2.6/en/k8s-in-rancher/secrets/): Files that store sensitive data like passwords, tokens, or keys. -- [Registries]({{}}/rancher/v2.6/en/k8s-in-rancher/registries/): Files that carry credentials used to authenticate with private registries. +- [Certificates](../how-to-guides/new-user-guides/kubernetes-resources-setup/encrypt-http-communication.md): Files used to encrypt/decrypt data entering or leaving the cluster. +- [ConfigMaps](../how-to-guides/new-user-guides/kubernetes-resources-setup/configmaps.md): Files that store general configuration information, such as a group of config files. +- [Secrets](../how-to-guides/new-user-guides/kubernetes-resources-setup/secrets.md): Files that store sensitive data like passwords, tokens, or keys. +- [Registries](../how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-and-docker-registries.md): Files that carry credentials used to authenticate with private registries. diff --git a/docs/en/cluster-provisioning/rke-clusters/rke-clusters.md b/docs/en/pages-for-subheaders/launch-kubernetes-with-rancher.md similarity index 81% rename from docs/en/cluster-provisioning/rke-clusters/rke-clusters.md rename to docs/en/pages-for-subheaders/launch-kubernetes-with-rancher.md index 21f9d9de5d5..b071ea0c0b9 100644 --- a/docs/en/cluster-provisioning/rke-clusters/rke-clusters.md +++ b/docs/en/pages-for-subheaders/launch-kubernetes-with-rancher.md @@ -3,7 +3,7 @@ title: Launching Kubernetes with Rancher weight: 4 --- -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]({{}}/rke/latest/en/) (RKE) or [RKE2](https://docs.rke2.io) distributions. Rancher can launch Kubernetes on any computers, including: +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: - Bare-metal servers - On-premise virtual machines @@ -17,23 +17,23 @@ Rancher can also create pools of nodes. One benefit of installing Kubernetes on ### Requirements -If you use RKE to set up a cluster, your nodes must meet the [requirements]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements) for nodes in downstream user clusters. +If you use RKE to set up a cluster, your nodes must meet the [requirements](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md) for nodes in downstream user clusters. ### Launching Kubernetes on New Nodes in an Infrastructure Provider -Using Rancher, you can create pools of nodes based on a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates). This node template defines the parameters you want to use to launch nodes in your cloud providers. +Using Rancher, you can create pools of nodes based on a [node template](use-new-nodes-in-an-infra-provider.md#node-templates). This node template defines the parameters you want to use to launch nodes in your cloud providers. One benefit of installing Kubernetes on node pools hosted by an infrastructure provider is that if a node loses connectivity with the cluster, Rancher can automatically create another node to join the cluster to ensure that the count of the node pool is as expected. -For more information, refer to the section on [launching Kubernetes on new nodes.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/) +For more information, refer to the section on [launching Kubernetes on new nodes.](use-new-nodes-in-an-infra-provider.md) ### Launching Kubernetes on Existing Custom Nodes In this scenario, you want to install Kubernetes on bare-metal servers, on-prem virtual machines, or virtual machines that already exist in a cloud provider. With this option, you will run a Rancher agent Docker container on the machine. -If you want to reuse a node from a previous custom cluster, [clean the node]({{}}/rancher/v2.6/en/cluster-admin/cleaning-cluster-nodes/) before using it in a cluster again. If you reuse a node that hasn't been cleaned, cluster provisioning may fail. +If you want to reuse a node from a previous custom cluster, [clean the node](../how-to-guides/advanced-user-guides/manage-clusters/clean-cluster-nodes.md) before using it in a cluster again. If you reuse a node that hasn't been cleaned, cluster provisioning may fail. -For more information, refer to the section on [custom nodes.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/) +For more information, refer to the section on [custom nodes.](use-existing-nodes.md) # Programmatically Creating RKE Clusters diff --git a/docs/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers-and-ingress.md b/docs/en/pages-for-subheaders/load-balancer-and-ingress-controller.md similarity index 78% rename from docs/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers-and-ingress.md rename to docs/en/pages-for-subheaders/load-balancer-and-ingress-controller.md index 7cfbbca3982..793605dcf92 100644 --- a/docs/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers-and-ingress.md +++ b/docs/en/pages-for-subheaders/load-balancer-and-ingress-controller.md @@ -14,10 +14,10 @@ If you want your applications to be externally accessible, you must add a load b Rancher supports two types of load balancers: -- [Layer-4 Load Balancers]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#layer-4-load-balancer) -- [Layer-7 Load Balancers]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#layer-7-load-balancer) +- [Layer-4 Load Balancers](../how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing.md#layer-4-load-balancer) +- [Layer-7 Load Balancers](../how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing.md#layer-7-load-balancer) -For more information, see [load balancers]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers). +For more information, see [load balancers](../how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing.md). ### Load Balancer Limitations @@ -28,9 +28,9 @@ Load Balancers have a couple of limitations you should be aware of: - If you want to use a load balancer with a Hosted Kubernetes cluster (i.e., clusters hosted in GKE, EKS, or AKS), the load balancer must be running within that cloud provider's infrastructure. Please review the compatibility tables regarding support for load balancers based on how you've provisioned your clusters: - - [Support for Layer-4 Load Balancing]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#support-for-layer-4-load-balancing) + - [Support for Layer-4 Load Balancing](../how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing.md#support-for-layer-4-load-balancing) - - [Support for Layer-7 Load Balancing]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#support-for-layer-7-load-balancing) + - [Support for Layer-7 Load Balancing](../how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing.md#support-for-layer-7-load-balancing) ## Ingress @@ -58,6 +58,6 @@ Refrain from adding an Ingress to the `local` cluster. The Nginx Ingress Control ::: -- For more information on how to set up ingress in Rancher, see [Ingress]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/ingress). +- For more information on how to set up ingress in Rancher, see [Ingress](../how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/add-ingresses.md). - For complete information about ingress and ingress controllers, see the [Kubernetes Ingress Documentation](https://kubernetes.io/docs/concepts/services-networking/ingress/) - When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry. diff --git a/docs/en/logging/logging.md b/docs/en/pages-for-subheaders/logging.md similarity index 79% rename from docs/en/logging/logging.md rename to docs/en/pages-for-subheaders/logging.md index a22e38febac..00ba4dc2af9 100644 --- a/docs/en/logging/logging.md +++ b/docs/en/pages-for-subheaders/logging.md @@ -8,7 +8,7 @@ weight: 15 The [Banzai Cloud Logging operator](https://banzaicloud.com/docs/one-eye/logging-operator/) now powers Rancher's logging solution in place of the former, in-house solution. -For an overview of the changes in v2.5, see [this section.]({{}}/rancher/v2.6/en/logging/architecture/#changes-in-rancher-v2-5) For information about migrating from Logging V1, see [this page.](./migrating) +For an overview of the changes in v2.5, see [this section.](logginlogging/architecture/#changes-in-rancher-v2-5) For information about migrating from Logging V1, see [this page.](../explanations/integrations-in-rancher/logging/migrate-to-rancher-v2.5+-logging.md) - [Enabling Logging](#enabling-logging) - [Uninstall Logging](#uninstall-logging) @@ -47,13 +47,13 @@ You can enable the logging for a Rancher managed cluster by going to the Apps pa # Architecture -For more information about how the logging application works, see [this section.](./architecture) +For more information about how the logging application works, see [this section.](../explanations/integrations-in-rancher/logging/logging-architecture.md) # Role-based Access Control -Rancher logging has two roles, `logging-admin` and `logging-view`. For more information on how and when to use these roles, see [this page.](./rbac) +Rancher logging has two roles, `logging-admin` and `logging-view`. For more information on how and when to use these roles, see [this page.](../explanations/integrations-in-rancher/logging/rbac-for-logging.md) # Configuring Logging Custom Resources @@ -65,39 +65,39 @@ To manage `Flows,` `ClusterFlows`, `Outputs`, and `ClusterOutputs`, ### Flows and ClusterFlows -For help with configuring `Flows` and `ClusterFlows`, see [this page.](./custom-resource-config/flows) +For help with configuring `Flows` and `ClusterFlows`, see [this page.](../explanations/integrations-in-rancher/logging/custom-resource-configuration/flows-and-clusterflows.md) ### Outputs and ClusterOutputs -For help with configuring `Outputs` and `ClusterOutputs`, see [this page.](./custom-resource-config/outputs) +For help with configuring `Outputs` and `ClusterOutputs`, see [this page.](../explanations/integrations-in-rancher/logging/custom-resource-configuration/outputs-and-clusteroutputs.md) # Configuring the Logging Helm Chart -For a list of options that can be configured when the logging application is installed or upgraded, see [this page.](./helm-chart-options) +For a list of options that can be configured when the logging application is installed or upgraded, see [this page.](../explanations/integrations-in-rancher/logging/logging-helm-chart-options.md) ### Windows Support Logging support for Windows clusters is available and logs can be collected from Windows nodes. -For details on how to enable or disable Windows node logging, see [this section.](./helm-chart-options/#enable-disable-windows-node-logging) +For details on how to enable or disable Windows node logging, see [this section.](logginlogging/helm-chart-options/#enable-disable-windows-node-logging) ### Working with a Custom Docker Root Directory -For details on using a custom Docker root directory, see [this section.](./helm-chart-options/#working-with-a-custom-docker-root-directory) +For details on using a custom Docker root directory, see [this section.](logginlogging/helm-chart-options/#working-with-a-custom-docker-root-directory) ### Working with Taints and Tolerations -For information on how to use taints and tolerations with the logging application, see [this page.](./taints-tolerations) +For information on how to use taints and tolerations with the logging application, see [this page.](../explanations/integrations-in-rancher/logging/taints-and-tolerations.md) ### Logging V2 with SELinux -For information on enabling the logging application for SELinux-enabled nodes, see [this section.](./helm-chart-options/#enabling-the-logging-application-to-work-with-selinux) +For information on enabling the logging application for SELinux-enabled nodes, see [this section.](logginlogging/helm-chart-options/#enabling-the-logging-application-to-work-with-selinux) ### Additional Logging Sources -By default, Rancher collects logs for control plane components and node components for all cluster types. In some cases additional logs can be collected. For details, see [this section.](./helm-chart-options/#enabling-the-logging-application-to-work-with-selinux) +By default, Rancher collects logs for control plane components and node components for all cluster types. In some cases additional logs can be collected. For details, see [this section.](logginlogging/helm-chart-options/#enabling-the-logging-application-to-work-with-selinux) # Troubleshooting diff --git a/docs/en/pages-for-subheaders/machine-configuration.md b/docs/en/pages-for-subheaders/machine-configuration.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/machine-configuration.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/cluster-admin/cluster-admin.md b/docs/en/pages-for-subheaders/manage-clusters.md similarity index 62% rename from docs/en/cluster-admin/cluster-admin.md rename to docs/en/pages-for-subheaders/manage-clusters.md index 7c18b688572..24f9b6f365c 100644 --- a/docs/en/cluster-admin/cluster-admin.md +++ b/docs/en/pages-for-subheaders/manage-clusters.md @@ -13,15 +13,15 @@ This page covers the following topics: :::note -This section assumes a basic familiarity with Docker and Kubernetes. For a brief explanation of how Kubernetes components work together, refer to the [concepts]({{}}/rancher/v2.6/en/overview/concepts) page. +This section assumes a basic familiarity with Docker and Kubernetes. For a brief explanation of how Kubernetes components work together, refer to the [concepts](../reference-guides/kubernetes-concepts.md) page. ::: ## Managing Clusters in Rancher -After clusters have been [provisioned into Rancher]({{}}/rancher/v2.6/en/cluster-provisioning/), [cluster owners]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#cluster-roles) will need to manage these clusters. There are many different options of how to manage your cluster. +After clusters have been [provisioned into Rancher](kubernetes-clusters-in-rancher-setup.md), [cluster owners](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#cluster-roles) will need to manage these clusters. There are many different options of how to manage your cluster. -import ClusterCapabilitiesTable from '/rancher/v2.6/en/shared-files/_cluster-capabilities-table.md'; +import ClusterCapabilitiesTable from '../shared-files/_cluster-capabilities-table.md'; @@ -36,4 +36,4 @@ Rancher contains a variety of tools that aren't included in Kubernetes to assist - Istio Service Mesh - OPA Gatekeeper -Tools can be installed through **Apps & Marketplace.** \ No newline at end of file +Tools can be installed through **Apps & Marketplace.** diff --git a/docs/en/pages-for-subheaders/manage-persistent-storage.md b/docs/en/pages-for-subheaders/manage-persistent-storage.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/manage-persistent-storage.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/project-admin/resource-quotas/resource-quotas.md b/docs/en/pages-for-subheaders/manage-project-resource-quotas.md similarity index 86% rename from docs/en/project-admin/resource-quotas/resource-quotas.md rename to docs/en/pages-for-subheaders/manage-project-resource-quotas.md index 75e1aea6b90..5492d92781a 100644 --- a/docs/en/project-admin/resource-quotas/resource-quotas.md +++ b/docs/en/pages-for-subheaders/manage-project-resource-quotas.md @@ -7,9 +7,9 @@ In situations where several teams share a cluster, one team may overconsume the This page is a how-to guide for creating resource quotas in existing projects. -Resource quotas can also be set when a new project is created. For details, refer to the section on [creating new projects.]({{}}/rancher/v2.6/en/cluster-admin/projects-and-namespaces/#creating-projects) +Resource quotas can also be set when a new project is created. For details, refer to the section on [creating new projects.](../how-to-guides/advanced-user-guides/manage-clusters/projects-and-namespaces.md#creating-projects) -Resource quotas in Rancher include the same functionality as the [native version of Kubernetes](https://kubernetes.io/docs/concepts/policy/resource-quotas/). In Rancher, resource quotas have been extended so that you can apply them to projects. For details on how resource quotas work with projects in Rancher, refer to [this page.](./quotas-for-projects) +Resource quotas in Rancher include the same functionality as the [native version of Kubernetes](https://kubernetes.io/docs/concepts/policy/resource-quotas/). In Rancher, resource quotas have been extended so that you can apply them to projects. For details on how resource quotas work with projects in Rancher, refer to [this page.](../how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/about-project-resource-quotas.md) ### Applying Resource Quotas to Existing Projects @@ -25,7 +25,7 @@ Edit resource quotas when: 1. Expand **Resource Quotas** and click **Add Resource**. Alternatively, you can edit existing quotas. -1. Select a Resource Type. For more information on types, see the [quota type reference.](./quota-type-reference) +1. Select a Resource Type. For more information on types, see the [quota type reference.](../how-to-guides/advanced-user-guides/manage-projects/manage-project-resource-quotas/resource-quota-types.md) 1. Enter values for the **Project Limit** and the **Namespace Default Limit**. diff --git a/docs/en/project-admin/project-admin.md b/docs/en/pages-for-subheaders/manage-projects.md similarity index 51% rename from docs/en/project-admin/project-admin.md rename to docs/en/pages-for-subheaders/manage-projects.md index 42d36f0fb22..9ac4f58a7c0 100644 --- a/docs/en/project-admin/project-admin.md +++ b/docs/en/pages-for-subheaders/manage-projects.md @@ -16,19 +16,19 @@ Rancher projects resolve this issue by allowing you to apply resources and acces You can use projects to perform actions like: -- [Assign users access to a group of namespaces]({{}}/rancher/v2.6/en/project-admin/project-members) -- Assign users [specific roles in a project]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles). A role can be owner, member, read-only, or [custom]({{}}/rancher/v2.6/en/admin-settings/rbac/default-custom-roles/) -- [Set resource quotas]({{}}/rancher/v2.6/en/project-admin/resource-quotas/) -- [Manage namespaces]({{}}/rancher/v2.6/en/project-admin/namespaces/) -- [Configure tools]({{}}/rancher/v2.6/en/project-admin/tools/) -- [Set up pipelines for continuous integration and deployment]({{}}/rancher/v2.6/en/project-admin/pipelines) -- [Configure pod security policies]({{}}/rancher/v2.6/en/project-admin/pod-security-policies) +- [Assign users access to a group of namespaces](../how-to-guides/advanced-user-guides/manage-projects/add-users-to-projects.md) +- Assign users [specific roles in a project](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#project-roles). A role can be owner, member, read-only, or [custom](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/custom-roles.md) +- [Set resource quotas](manage-project-resource-quotas.md) +- [Manage namespaces](../how-to-guides/advanced-user-guides/manage-projects/manage-namespaces.md) +- [Configure tools](../reference-guides/rancher-project-tools.md) +- [Set up pipelines for continuous integration and deployment](../how-to-guides/advanced-user-guides/manage-projects/ci-cd-pipelines.md) +- [Configure pod security policies](../how-to-guides/advanced-user-guides/manage-projects/manage-pod-security-policies.md) ### Authorization -Non-administrative users are only authorized for project access after an [administrator]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/), [cluster owner or member]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#cluster-roles), or [project owner]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles) adds them to the project's **Members** tab. +Non-administrative users are only authorized for project access after an [administrator](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md), [cluster owner or member](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#cluster-roles), or [project owner](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#project-roles) adds them to the project's **Members** tab. -Whoever creates the project automatically becomes a [project owner]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles). +Whoever creates the project automatically becomes a [project owner](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#project-roles). ## Switching between Projects diff --git a/docs/en/admin-settings/rbac/rbac.md b/docs/en/pages-for-subheaders/manage-role-based-access-control-rbac.md similarity index 70% rename from docs/en/admin-settings/rbac/rbac.md rename to docs/en/pages-for-subheaders/manage-role-based-access-control-rbac.md index a0907463d94..42f1f049cc6 100644 --- a/docs/en/admin-settings/rbac/rbac.md +++ b/docs/en/pages-for-subheaders/manage-role-based-access-control-rbac.md @@ -3,7 +3,7 @@ title: Role-Based Access Control (RBAC) weight: 20 --- -Within Rancher, each person authenticates as a _user_, which is a login that grants you access to Rancher. As mentioned in [Authentication]({{}}/rancher/v2.6/en/admin-settings/authentication/), users can either be local or external. +Within Rancher, each person authenticates as a _user_, which is a login that grants you access to Rancher. As mentioned in [Authentication](about-authentication.md), users can either be local or external. After you configure external authentication, the users that display on the **Users** page changes. @@ -15,11 +15,11 @@ After you configure external authentication, the users that display on the **Use Once the user logs in to Rancher, their _authorization_, or their access rights within the system, is determined by _global permissions_, and _cluster and project roles_. -- [Global Permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/): +- [Global Permissions](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md): Define user authorization outside the scope of any particular cluster. -- [Cluster and Project Roles]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/): +- [Cluster and Project Roles](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md): Define user authorization inside the specific cluster or project where they are assigned the role. diff --git a/docs/en/pages-for-subheaders/monitoring-alerting-guides.md b/docs/en/pages-for-subheaders/monitoring-alerting-guides.md new file mode 100644 index 00000000000..3aa725064be --- /dev/null +++ b/docs/en/pages-for-subheaders/monitoring-alerting-guides.md @@ -0,0 +1,13 @@ +--- +title: Monitoring Guides +shortTitle: Guides +weight: 4 +--- + +- [Enable monitoring](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/enable-monitoring.md) +- [Uninstall monitoring](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/uninstall-monitoring.md) +- [Monitoring workloads](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/set-up-monitoring-for-workloads.md) +- [Customizing Grafana dashboards](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/customize-grafana-dashboard.md) +- [Persistent Grafana dashboards](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md) +- [Debugging high memory usage](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/debug-high-memory-usage.md) +- [Migrating from Monitoring V1 to V2](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/migrate-to-rancher-v2.5+-monitoring.md) \ No newline at end of file diff --git a/docs/en/monitoring-alerting/monitoring-alerting.md b/docs/en/pages-for-subheaders/monitoring-and-alerting.md similarity index 66% rename from docs/en/monitoring-alerting/monitoring-alerting.md rename to docs/en/pages-for-subheaders/monitoring-and-alerting.md index cd2b721917d..2192ab1badb 100644 --- a/docs/en/monitoring-alerting/monitoring-alerting.md +++ b/docs/en/pages-for-subheaders/monitoring-and-alerting.md @@ -34,7 +34,7 @@ The monitoring application allows you to: # How Monitoring Works -For an explanation of how the monitoring components work together, see [this page.](./how-monitoring-works) +For an explanation of how the monitoring components work together, see [this page.](../explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works.md) # Default Components and Deployments @@ -42,7 +42,7 @@ For an explanation of how the monitoring components work together, see [this pag By default, the monitoring application deploys Grafana dashboards (curated by the [kube-prometheus](https://github.com/prometheus-operator/kube-prometheus) project) onto a cluster. -It also deploys an Alertmanager UI and a Prometheus UI. For more information about these tools, see [Built-in Dashboards.](./dashboards) +It also deploys an Alertmanager UI and a Prometheus UI. For more information about these tools, see [Built-in Dashboards.](../explanations/integrations-in-rancher/monitoring-and-alerting/built-in-dashboards.md) ### Default Metrics Exporters By default, Rancher Monitoring deploys exporters (such as [node-exporter](https://github.com/prometheus/node_exporter) and [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics)). @@ -51,42 +51,42 @@ These default exporters automatically scrape metrics for CPU and memory from all ### Default Alerts -The monitoring application deploys some alerts by default. To see the default alerts, go to the [Alertmanager UI](./dashboards/#alertmanager-ui) and click **Expand all groups.** +The monitoring application deploys some alerts by default. To see the default alerts, go to the [Alertmanager UI](monitoring-alertinmonitoring-alerting/dashboards/#alertmanager-ui) and click **Expand all groups.** ### Components Exposed in the Rancher UI -For a list of monitoring components exposed in the Rancher UI, along with common use cases for editing them, see [this section.](./how-monitoring-works/#components-exposed-in-the-rancher-ui) +For a list of monitoring components exposed in the Rancher UI, along with common use cases for editing them, see [this section.](monitoring-alertinmonitoring-alerting/how-monitoring-works/#components-exposed-in-the-rancher-ui) # Role-based Access Control -For information on configuring access to monitoring, see [this page.](./rbac) +For information on configuring access to monitoring, see [this page.](../explanations/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md) # Guides -- [Enable monitoring](./guides/enable-monitoring) -- [Uninstall monitoring](./guides/uninstall) -- [Monitoring workloads](./guides/monitoring-workloads) -- [Customizing Grafana dashboards](./guides/customize-grafana) -- [Persistent Grafana dashboards](./guides/persist-grafana) -- [Debugging high memory usage](./guides/memory-usage) -- [Migrating from Monitoring V1 to V2](./guides/migrating) +- [Enable monitoring](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/enable-monitoring.md) +- [Uninstall monitoring](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/uninstall-monitoring.md) +- [Monitoring workloads](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/set-up-monitoring-for-workloads.md) +- [Customizing Grafana dashboards](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/customize-grafana-dashboard.md) +- [Persistent Grafana dashboards](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard.md) +- [Debugging high memory usage](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/debug-high-memory-usage.md) +- [Migrating from Monitoring V1 to V2](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/migrate-to-rancher-v2.5+-monitoring.md) # Configuration ### Configuring Monitoring Resources in Rancher -> The configuration reference assumes familiarity with how monitoring components work together. For more information, see [How Monitoring Works.](./how-monitoring-works) +> The configuration reference assumes familiarity with how monitoring components work together. For more information, see [How Monitoring Works.](../explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works.md) -- [ServiceMonitor and PodMonitor](./configuration/servicemonitor-podmonitor) -- [Receiver](./configuration/receiver) -- [Route](./configuration/route) -- [PrometheusRule](./configuration/advanced/prometheusrules) -- [Prometheus](./configuration/advanced/prometheus) -- [Alertmanager](./configuration/advanced/alertmanager) +- [ServiceMonitor and PodMonitor](../reference-guides/monitoring-v2-configuration/servicemonitors-and-podmonitors.md) +- [Receiver](../reference-guides/monitoring-v2-configuration/receivers.md) +- [Route](../reference-guides/monitoring-v2-configuration/routes.md) +- [PrometheusRule](monitoring-alertinmonitoring-alerting/configuration/advanced/prometheusrules) +- [Prometheus](../how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheus.md) +- [Alertmanager](../how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager.md) ### Configuring Helm Chart Options -For more information on `rancher-monitoring` chart options, including options to set resource limits and requests, see [this page.](./configuration/helm-chart-options) +For more information on `rancher-monitoring` chart options, including options to set resource limits and requests, see [this page.](../reference-guides/monitoring-v2-configuration/helm-chart-options.md) # Windows Cluster Support @@ -94,7 +94,7 @@ When deployed onto an RKE1 Windows cluster, Monitoring V2 will now automatically To be able to fully deploy Monitoring V2 for Windows, all of your Windows hosts must have a minimum [wins](https://github.com/rancher/wins) version of v0.1.0. -For more details on how to upgrade wins on existing Windows hosts, refer to the section on [Windows cluster support for Monitoring V2.](./windows-clusters) +For more details on how to upgrade wins on existing Windows hosts, refer to the section on [Windows cluster support for Monitoring V2.](../explanations/integrations-in-rancher/monitoring-and-alerting/windows-support.md) @@ -102,4 +102,4 @@ For more details on how to upgrade wins on existing Windows hosts, refer to the There is a [known issue](https://github.com/rancher/rancher/issues/28787#issuecomment-693611821) that K3s clusters require more default memory. If you are enabling monitoring on a K3s cluster, we recommend to setting `prometheus.prometheusSpec.resources.memory.limit` to 2500 Mi and `prometheus.prometheusSpec.resources.memory.request` to 1750 Mi. -For tips on debugging high memory usage, see [this page.](./guides/memory-usage) +For tips on debugging high memory usage, see [this page.](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/debug-high-memory-usage.md) diff --git a/docs/en/monitoring-alerting/configuration/configuration.md b/docs/en/pages-for-subheaders/monitoring-v2-configuration-guides.md similarity index 74% rename from docs/en/monitoring-alerting/configuration/configuration.md rename to docs/en/pages-for-subheaders/monitoring-v2-configuration-guides.md index c1884dc9489..5f2ee6872b1 100644 --- a/docs/en/monitoring-alerting/configuration/configuration.md +++ b/docs/en/pages-for-subheaders/monitoring-v2-configuration-guides.md @@ -9,7 +9,7 @@ For information on configuring custom scrape targets and rules for Prometheus, p # Setting Resource Limits and Requests -The resource requests and limits for the monitoring application can be configured when installing `rancher-monitoring`. For more information about the default limits, see [this page.](./helm-chart-options/#configuring-resource-limits-and-requests) +The resource requests and limits for the monitoring application can be configured when installing `rancher-monitoring`. For more information about the default limits, see [this page.](../reference-guides/monitoring-v2-configuration/helm-chart-options.md#configuring-resource-limits-and-requests) :::note @@ -26,11 +26,11 @@ Instead, to configure Prometheus to scrape custom metrics, you will only need to ### ServiceMonitor and PodMonitor Configuration -For details, see [this page.](./servicemonitor-podmonitor) +For details, see [this page.](../reference-guides/monitoring-v2-configuration/servicemonitors-and-podmonitors.md) ### Advanced Prometheus Configuration -For more information about directly editing the Prometheus custom resource, which may be helpful in advanced use cases, see [this page.](./advanced/prometheus) +For more information about directly editing the Prometheus custom resource, which may be helpful in advanced use cases, see [this page.](../how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheus.md) # Alertmanager Configuration @@ -38,15 +38,15 @@ The Alertmanager custom resource usually doesn't need to be edited directly. For Routes and receivers are part of the configuration of the alertmanager custom resource. In the Rancher UI, Routes and Receivers are not true custom resources, but pseudo-custom resources that the Prometheus Operator uses to synchronize your configuration with the Alertmanager custom resource. When routes and receivers are updated, the monitoring application will automatically update Alertmanager to reflect those changes. -For some advanced use cases, you may want to configure alertmanager directly. For more information, refer to [this page.](./advanced/alertmanager) +For some advanced use cases, you may want to configure alertmanager directly. For more information, refer to [this page.](../how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager.md) ### Receivers -Receivers are used to set up notifications. For details on how to configure receivers, see [this page.](./receiver) +Receivers are used to set up notifications. For details on how to configure receivers, see [this page.](../reference-guides/monitoring-v2-configuration/receivers.md) ### Routes -Routes filter notifications before they reach receivers. Each route needs to refer to a receiver that has already been configured. For details on how to configure routes, see [this page.](./route) +Routes filter notifications before they reach receivers. Each route needs to refer to a receiver that has already been configured. For details on how to configure routes, see [this page.](../reference-guides/monitoring-v2-configuration/routes.md) ### Advanced -For more information about directly editing the Alertmanager custom resource, which may be helpful in advanced use cases, see [this page.](./advanced/alertmanager) \ No newline at end of file +For more information about directly editing the Alertmanager custom resource, which may be helpful in advanced use cases, see [this page.](../how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager.md) \ No newline at end of file diff --git a/docs/en/pages-for-subheaders/monitoring-v2-configuration.md b/docs/en/pages-for-subheaders/monitoring-v2-configuration.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/monitoring-v2-configuration.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/pages-for-subheaders/new-user-guides.md b/docs/en/pages-for-subheaders/new-user-guides.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/new-user-guides.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/pages-for-subheaders/node-template-configuration.md b/docs/en/pages-for-subheaders/node-template-configuration.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/node-template-configuration.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/nutanix/nutanix.md b/docs/en/pages-for-subheaders/nutanix.md similarity index 66% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/nutanix/nutanix.md rename to docs/en/pages-for-subheaders/nutanix.md index f009dc078f8..25e0fc2e2d2 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/nutanix/nutanix.md +++ b/docs/en/pages-for-subheaders/nutanix.md @@ -12,9 +12,9 @@ Rancher can provision nodes in AOS (AHV) and install Kubernetes on them. When cr A Nutanix cluster may consist of multiple groups of VMs with distinct properties, such as the amount of memory or the number of vCPUs. This grouping allows for fine-grained control over the sizing of nodes for each Kubernetes role. -- [Creating a Nutanix Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/nutanix/provisioning-nutanix-clusters/#creating-a-nutanix-aos-cluster) -- [Provisioning Storage]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/nutanix/provisioning-nutanix-clusters) +- [Creating a Nutanix Cluster](cluster-provisioning/rke-clusters/node-pools/nutanicluster-provisioning/rke-clusters/node-pools/nutanix/provisioning-nutanix-clusters/#creating-a-nutanix-aos-cluster) +- [Provisioning Storage](cluster-provisioning/rke-clusters/node-pools/nutanicluster-provisioning/rke-clusters/node-pools/nutanix/provisioning-nutanix-clusters) # Creating a Nutanix Cluster -In [this section,](./provisioning-nutanix-clusters) you'll learn how to use Rancher to install an [RKE]({{}}/rke/latest/en/) Kubernetes cluster in Nutanix AOS. \ No newline at end of file +In [this section,](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/provision-kubernetes-clusters-in-aos.md) you'll learn how to use Rancher to install an [RKE](https://rancher.com/docs/rke/latest/en/) Kubernetes cluster in Nutanix AOS. \ No newline at end of file diff --git a/docs/en/pages-for-subheaders/other-cloud-providers.md b/docs/en/pages-for-subheaders/other-cloud-providers.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/other-cloud-providers.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/installation/other-installation-methods/other-installation-methods.md b/docs/en/pages-for-subheaders/other-installation-methods.md similarity index 53% rename from docs/en/installation/other-installation-methods/other-installation-methods.md rename to docs/en/pages-for-subheaders/other-installation-methods.md index 4a15c472dbe..939553398ae 100644 --- a/docs/en/installation/other-installation-methods/other-installation-methods.md +++ b/docs/en/pages-for-subheaders/other-installation-methods.md @@ -5,16 +5,16 @@ weight: 3 ### Air Gapped Installations -Follow [these steps]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap) to install the Rancher server in an air gapped environment. +Follow [these steps](air-gapped-helm-cli-install.md) 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. ### Docker Installations -The [single-node Docker installation]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker) is for Rancher users that are wanting to test out Rancher. Instead of running on a Kubernetes cluster using Helm, you install the Rancher server component on a single node using a `docker run` command. +The [single-node Docker installation](rancher-on-a-single-node-with-docker.md) is for Rancher users that are wanting to test out Rancher. Instead of running on a Kubernetes cluster using Helm, you install the Rancher server component on a single node using a `docker run` command. The Docker installation is for development and testing environments only. Since there is only one node and a single Docker container, if the node goes down, there is no copy of the etcd data available on other nodes and you will lose all the data of your Rancher server. -The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.]({{}}/rancher/v2.6/en/backups/migrating-rancher) +The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.](../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md) diff --git a/docs/en/pages-for-subheaders/other-troubleshooting-tips.md b/docs/en/pages-for-subheaders/other-troubleshooting-tips.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/other-troubleshooting-tips.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/pipelines/pipelines.md b/docs/en/pages-for-subheaders/pipelines.md similarity index 90% rename from docs/en/pipelines/pipelines.md rename to docs/en/pages-for-subheaders/pipelines.md index 155104f4fbd..d69ac8193e9 100644 --- a/docs/en/pipelines/pipelines.md +++ b/docs/en/pages-for-subheaders/pipelines.md @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem'; :::note Notes -- As of Rancher v2.5, Git-based deployment pipelines are now deprecated. We recommend handling pipelines with Rancher Continuous Delivery powered by [Fleet]({{}}/rancher/v2.6/en/deploy-across-clusters/fleet). To get to Fleet in Rancher, click ☰ > Continuous Delivery. +- As of Rancher v2.5, Git-based deployment pipelines are now deprecated. We recommend handling pipelines with Rancher Continuous Delivery powered by [Fleet](../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md). To get to Fleet in Rancher, click ☰ > Continuous Delivery. - Pipelines in Kubernetes 1.21+ are no longer supported. @@ -50,7 +50,7 @@ This section covers the following topics: # Concepts -For an explanation of concepts and terminology used in this section, refer to [this page.]({{}}/rancher/v2.6/en/pipelines/concepts) +For an explanation of concepts and terminology used in this section, refer to [this page.](../reference-guides/pipelines/concepts.md) # How Pipelines Work @@ -58,7 +58,7 @@ After enabling the ability to use pipelines in a project, you can configure mult A pipeline is configured off of a group of files that are checked into source code repositories. Users can configure their pipelines either through the Rancher UI or by adding a `.rancher-pipeline.yml` into the repository. -Before pipelines can be configured, you will need to configure authentication to your version control provider, e.g. GitHub, GitLab, Bitbucket. If you haven't configured a version control provider, you can always use [Rancher's example repositories]({{}}/rancher/v2.6/en/pipelines/example-repos/) to view some common pipeline deployments. +Before pipelines can be configured, you will need to configure authentication to your version control provider, e.g. GitHub, GitLab, Bitbucket. If you haven't configured a version control provider, you can always use [Rancher's example repositories](../reference-guides/pipelines/example-repositories.md) to view some common pipeline deployments. When you configure a pipeline in one of your projects, a namespace specifically for the pipeline is automatically created. The following components are deployed to it: @@ -82,7 +82,7 @@ When you configure a pipeline in one of your projects, a namespace specifically :::note - The managed Jenkins instance works statelessly, so don't worry about its data persistency. The Docker Registry and Minio instances use ephemeral volumes by default, which is fine for most use cases. If you want to make sure pipeline logs can survive node failures, you can configure persistent volumes for them, as described in [data persistency for pipeline components]({{}}/rancher/v2.6/en/pipelines/storage). + The managed Jenkins instance works statelessly, so don't worry about its data persistency. The Docker Registry and Minio instances use ephemeral volumes by default, which is fine for most use cases. If you want to make sure pipeline logs can survive node failures, you can configure persistent volumes for them, as described in [data persistency for pipeline components](../reference-guides/pipelines/configure-persistent-data.md). ::: @@ -90,7 +90,7 @@ When you configure a pipeline in one of your projects, a namespace specifically If you can access a project, you can enable repositories to start building pipelines. -Only [administrators]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/), [cluster owners or members]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#cluster-roles), or [project owners]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles) can configure version control providers and manage global pipeline execution settings. +Only [administrators](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md), [cluster owners or members](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#cluster-roles), or [project owners](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#project-roles) can configure version control providers and manage global pipeline execution settings. Project members can only configure repositories and pipelines. @@ -223,7 +223,7 @@ Now that repositories are added to your project, you can start configuring the p 1. In the dropdown menu in the top navigation bar, select the project where you want to configure pipelines. 1. In the left navigation bar, click **Legacy > Project > Pipelines**. 1. Find the repository that you want to set up a pipeline for. -1. Configure the pipeline through the UI or using a yaml file in the repository, i.e. `.rancher-pipeline.yml` or `.rancher-pipeline.yaml`. Pipeline configuration is split into stages and steps. Stages must fully complete before moving onto the next stage, but steps in a stage run concurrently. For each stage, you can add different step types. Note: As you build out each step, there are different advanced options based on the step type. Advanced options include trigger rules, environment variables, and secrets. For more information on configuring the pipeline through the UI or the YAML file, refer to the [pipeline configuration reference.]({{}}/rancher/v2.6/en/pipelines/config) +1. Configure the pipeline through the UI or using a yaml file in the repository, i.e. `.rancher-pipeline.yml` or `.rancher-pipeline.yaml`. Pipeline configuration is split into stages and steps. Stages must fully complete before moving onto the next stage, but steps in a stage run concurrently. For each stage, you can add different step types. Note: As you build out each step, there are different advanced options based on the step type. Advanced options include trigger rules, environment variables, and secrets. For more information on configuring the pipeline through the UI or the YAML file, refer to the [pipeline configuration reference.](../reference-guides/pipelines/pipeline-configuration.md) * If you are going to use the UI, select the vertical **⋮ > Edit Config** to configure the pipeline using the UI. After the pipeline is configured, you must view the YAML file and push it to the repository. * If you are going to use the YAML file, select the vertical **⋮ > View/Edit YAML** to configure the pipeline. If you choose to use a YAML file, you need to push it to the repository after any changes in order for it to be updated in the repository. When editing the pipeline configuration, it takes a few moments for Rancher to check for an existing pipeline configuration. @@ -243,7 +243,7 @@ Now that repositories are added to your project, you can start configuring the p # Pipeline Configuration Reference -Refer to [this page]({{}}/rancher/v2.6/en/pipelines/config) for details on how to configure a pipeline to: +Refer to [this page](../reference-guides/pipelines/pipeline-configuration.md) for details on how to configure a pipeline to: - Run a script - Build and publish images @@ -284,7 +284,7 @@ Available Events: :::note -This option doesn't exist for Rancher's [example repositories]({{}}/rancher/v2.6/en/pipelines/example-repos/). +This option doesn't exist for Rancher's [example repositories](../reference-guides/pipelines/example-repositories.md). ::: diff --git a/docs/en/pages-for-subheaders/prometheus-federator-guides.md b/docs/en/pages-for-subheaders/prometheus-federator-guides.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/prometheus-federator-guides.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/monitoring-alerting/prometheus-federator/prometheus-federator.md b/docs/en/pages-for-subheaders/prometheus-federator.md similarity index 96% rename from docs/en/monitoring-alerting/prometheus-federator/prometheus-federator.md rename to docs/en/pages-for-subheaders/prometheus-federator.md index 59592733ecc..e8f88c3f055 100644 --- a/docs/en/monitoring-alerting/prometheus-federator/prometheus-federator.md +++ b/docs/en/pages-for-subheaders/prometheus-federator.md @@ -21,7 +21,7 @@ Prometheus Federator is designed to be deployed alongside an existing Prometheus 1. On deploying this chart, users can create ProjectHelmCharts CRs with `spec.helmApiVersion` set to `monitoring.cattle.io/v1alpha1` (also known as "Project Monitors" in the Rancher UI) in a **Project Registration Namespace (`cattle-project-`)**. 2. On seeing each ProjectHelmChartCR, the operator will automatically deploy a Project Prometheus stack on the Project Owner's behalf in the **Project Release Namespace (`cattle-project--monitoring`)** based on a HelmChart CR and a HelmRelease CR automatically created by the ProjectHelmChart controller in the **Operator / System Namespace**. -3. RBAC will automatically be assigned in the Project Release Namespace to allow users to view the Prometheus, Alertmanager, and Grafana UIs of the Project Monitoring Stack deployed; this will be based on RBAC defined on the Project Registration Namespace against the [default Kubernetes user-facing roles](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles). For more information, see the section on [configuring RBAC](./rbac/). +3. RBAC will automatically be assigned in the Project Release Namespace to allow users to view the Prometheus, Alertmanager, and Grafana UIs of the Project Monitoring Stack deployed; this will be based on RBAC defined on the Project Registration Namespace against the [default Kubernetes user-facing roles](https://kubernetes.io/docs/reference/access-authn-authmonitoring-alerting/prometheus-federator/rbac#user-facing-roles). For more information, see the section on [configuring RBAC](./rbac/). ### What is a Project? @@ -40,7 +40,7 @@ As a Project Operator based on [rancher/helm-project-operator](https://github.co 1. **Operator / System Namespace**: The namespace that the operator is deployed into (e.g., `cattle-monitoring-system`). This namespace will contain all HelmCharts and HelmReleases for all ProjectHelmCharts watched by this operator. **Only Cluster Admins should have access to this namespace.** -2. **Project Registration Namespace (`cattle-project-`)**: The set of namespaces that the operator watches for ProjectHelmCharts within. The RoleBindings and ClusterRoleBindings that apply to this namespace will also be the source of truth for the auto-assigned RBAC created in the Project Release Namespace. For details, refer to the [RBAC page](./rbac/). **Project Owners (admin), Project Members (edit), and Read-Only Members (view) should have access to this namespace.** +2. **Project Registration Namespace (`cattle-project-`)**: The set of namespaces that the operator watches for ProjectHelmCharts within. The RoleBindings and ClusterRoleBindings that apply to this namespace will also be the source of truth for the auto-assigned RBAC created in the Project Release Namespace. For details, refer to the [RBAC page](../reference-guides/prometheus-federator/rbac.md). **Project Owners (admin), Project Members (edit), and Read-Only Members (view) should have access to this namespace.** :::note Notes: diff --git a/docs/en/cluster-admin/volumes-and-storage/examples/examples.md b/docs/en/pages-for-subheaders/provisioning-storage-examples.md similarity index 50% rename from docs/en/cluster-admin/volumes-and-storage/examples/examples.md rename to docs/en/pages-for-subheaders/provisioning-storage-examples.md index 2cdd479f767..9732249038b 100644 --- a/docs/en/cluster-admin/volumes-and-storage/examples/examples.md +++ b/docs/en/pages-for-subheaders/provisioning-storage-examples.md @@ -7,6 +7,6 @@ Rancher supports persistent storage with a variety of volume plugins. However, b For your convenience, Rancher offers documentation on how to configure some of the popular storage methods: -- [NFS](./nfs) -- [vSphere](./vsphere) -- [EBS](./ebs) +- [NFS](../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/nfs-storage.md) +- [vSphere](../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/vsphere-storage.md) +- [EBS](../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/persistent-storage-in-amazon-ebs.md) diff --git a/docs/en/quick-start-guide/quick-start-guide.md b/docs/en/pages-for-subheaders/quick-start-guides.md similarity index 66% rename from docs/en/quick-start-guide/quick-start-guide.md rename to docs/en/pages-for-subheaders/quick-start-guides.md index d04067484fa..e19a1729d3a 100644 --- a/docs/en/quick-start-guide/quick-start-guide.md +++ b/docs/en/pages-for-subheaders/quick-start-guides.md @@ -8,7 +8,7 @@ aliases: --- :::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]({{}}/rancher/v2.6/en/installation/). +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.md). ::: @@ -16,6 +16,6 @@ Use this section of the docs to jump start your deployment and testing of Ranche We have Quick Start Guides for: -- [Deploying Rancher Server]({{}}/rancher/v2.6/en/quick-start-guide/deployment/): Get started running Rancher using the method most convenient for you. +- [Deploying Rancher Server](deploy-rancher-manager.md): Get started running Rancher using the method most convenient for you. -- [Deploying Workloads]({{}}/rancher/v2.6/en/quick-start-guide/workload/): Deploy a simple [workload](https://kubernetes.io/docs/concepts/workloads/) and expose it, letting you access it from outside the cluster. +- [Deploying Workloads](deploy-rancher-workloads.md): Deploy a simple [workload](https://kubernetes.io/docs/concepts/workloads/) and expose it, letting you access it from outside the cluster. diff --git a/docs/en/installation/other-installation-methods/behind-proxy/behind-proxy.md b/docs/en/pages-for-subheaders/rancher-behind-an-http-proxy.md similarity index 50% rename from docs/en/installation/other-installation-methods/behind-proxy/behind-proxy.md rename to docs/en/pages-for-subheaders/rancher-behind-an-http-proxy.md index 2214b1c3b25..a2dc3b1edaf 100644 --- a/docs/en/installation/other-installation-methods/behind-proxy/behind-proxy.md +++ b/docs/en/pages-for-subheaders/rancher-behind-an-http-proxy.md @@ -5,10 +5,10 @@ weight: 4 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. -Alternatively, it is also possible to set up Rancher completely air-gapped without any Internet access. This process is described in detail in the [Rancher docs]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/). +Alternatively, it is also possible to set up Rancher completely air-gapped without any Internet access. This process is described in detail in the [Rancher docs](air-gapped-helm-cli-install.md). # Installation Outline -1. [Set up infrastructure]({{}}/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/prepare-nodes/) -2. [Set up a Kubernetes cluster]({{}}/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/) -3. [Install Rancher]({{}}/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/install-rancher/) +1. [Set up infrastructure](../getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/set-up-infrastructure.md) +2. [Set up a Kubernetes cluster](../getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-kubernetes.md) +3. [Install Rancher](../getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-rancher.md) diff --git a/docs/en/pages-for-subheaders/rancher-managed-clusters.md b/docs/en/pages-for-subheaders/rancher-managed-clusters.md new file mode 100644 index 00000000000..82d5004251f --- /dev/null +++ b/docs/en/pages-for-subheaders/rancher-managed-clusters.md @@ -0,0 +1,21 @@ +--- +title: Best Practices for Rancher Managed Clusters +shortTitle: Rancher Managed Clusters +weight: 2 +--- + +### Logging + +Refer to [this guide](../reference-guides/best-practices/rancher-managed-clusters/logging-best-practices.md) for our recommendations for cluster-level logging and application logging. + +### Monitoring + +Configuring sensible monitoring and alerting rules is vital for running any production workloads securely and reliably. Refer to this [guide](../reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices.md) for our recommendations. + +### Tips for Setting Up Containers + +Running well-built containers can greatly impact the overall performance and security of your environment. Refer to this [guide](../reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers.md) for tips. + +### Best Practices for Rancher Managed vSphere Clusters + +This [guide](../reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere.md) outlines a reference architecture for provisioning downstream Rancher clusters in a vSphere environment, in addition to standard vSphere best practices as documented by VMware. diff --git a/docs/en/overview/architecture/architecture.md b/docs/en/pages-for-subheaders/rancher-manager-architecture.md similarity index 82% rename from docs/en/overview/architecture/architecture.md rename to docs/en/pages-for-subheaders/rancher-manager-architecture.md index 4d1e5e1e05d..dcc38870cf7 100644 --- a/docs/en/overview/architecture/architecture.md +++ b/docs/en/pages-for-subheaders/rancher-manager-architecture.md @@ -5,15 +5,15 @@ weight: 1 This section focuses on the Rancher server, its components, and how Rancher communicates with downstream Kubernetes clusters. -For information on the different ways that Rancher can be installed, refer to the [overview of installation options.]({{}}/rancher/v2.6/en/installation/#overview-of-installation-options) +For information on the different ways that Rancher can be installed, refer to the [overview of installation options.](installation-and-upgrade.md#overview-of-installation-options) -For a list of main features of the Rancher API server, refer to the [overview section.]({{}}/rancher/v2.6/en/overview/#features-of-the-rancher-api-server) +For a list of main features of the Rancher API server, refer to the [overview section.](../getting-started/introduction/overview.md#features-of-the-rancher-api-server) -For guidance about setting up the underlying infrastructure for the Rancher server, refer to the [architecture recommendations.]({{}}/rancher/v2.6/en/overview/architecture-recommendations) +For guidance about setting up the underlying infrastructure for the Rancher server, refer to the [architecture recommendations.](../reference-guides/rancher-manager-architecture/architecture-recommendations.md) :::note -This section assumes a basic familiarity with Docker and Kubernetes. For a brief explanation of how Kubernetes components work together, refer to the [concepts]({{}}/rancher/v2.6/en/overview/concepts) page. +This section assumes a basic familiarity with Docker and Kubernetes. For a brief explanation of how Kubernetes components work together, refer to the [concepts](../reference-guides/kubernetes-concepts.md) page. ::: @@ -35,13 +35,13 @@ The majority of Rancher 2.x software runs on the Rancher Server. Rancher Server The figure below illustrates the high-level architecture of Rancher 2.x. The figure depicts a Rancher Server installation that manages two downstream Kubernetes clusters: one created by RKE and another created by Amazon EKS (Elastic Kubernetes Service). -For the best performance and security, we recommend a dedicated Kubernetes cluster for the Rancher management server. Running user workloads on this cluster is not advised. After deploying Rancher, you can [create or import clusters]({{}}/rancher/v2.6/en/cluster-provisioning/) for running your workloads. +For the best performance and security, we recommend a dedicated Kubernetes cluster for the Rancher management server. Running user workloads on this cluster is not advised. After deploying Rancher, you can [create or import clusters](kubernetes-clusters-in-rancher-setup.md) for running your workloads. -The diagram below shows how users can manipulate both [Rancher-launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) clusters and [hosted Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/) clusters through Rancher's authentication proxy: +The diagram below shows how users can manipulate both [Rancher-launched Kubernetes](launch-kubernetes-with-rancher.md) clusters and [hosted Kubernetes](set-up-clusters-from-hosted-kubernetes-providers.md) clusters through Rancher's authentication proxy:
Managing Kubernetes Clusters through Rancher's Authentication Proxy
-![Architecture]({{}}/img/rancher/rancher-architecture-rancher-api-server.svg) +![Architecture](/img/rancher-architecture-rancher-api-server.svg) You can install Rancher on a single node, or on a high-availability Kubernetes cluster. @@ -49,7 +49,7 @@ A high-availability Kubernetes installation is recommended for production. A Docker installation of Rancher is recommended only for development and testing purposes. The ability to migrate Rancher to a high-availability cluster depends on the Rancher version. -The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster]({{}}/rancher/v2.6/en/backups/migrating-rancher). +The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster](../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md). The Rancher server, regardless of the installation method, should always run on nodes that are separate from the downstream user clusters that it manages. If Rancher is installed on a high-availability Kubernetes cluster, it should run on a separate cluster from the cluster(s) it manages. @@ -61,7 +61,7 @@ The below diagram shows how the cluster controllers, cluster agents, and node ag
Communicating with Downstream Clusters
-![Rancher Components]({{}}/img/rancher/rancher-architecture-cluster-controller.svg) +![Rancher Components](/img/rancher-architecture-cluster-controller.svg) The following descriptions correspond to the numbers in the diagram above: @@ -79,7 +79,7 @@ The authentication proxy forwards all Kubernetes API calls to downstream cluster Rancher communicates with Kubernetes clusters using a [service account](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/), which provides an identity for processes that run in a pod. -By default, Rancher generates a [kubeconfig file]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/) that contains credentials for proxying through the Rancher server to connect to the Kubernetes API server on a downstream user cluster. The kubeconfig file (`kube_config_cluster.yml`) contains full access to the cluster. +By default, Rancher generates a [kubeconfig file](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md) that contains credentials for proxying through the Rancher server to connect to the Kubernetes API server on a downstream user cluster. The kubeconfig file (`kube_config_cluster.yml`) contains full access to the cluster. ### 2. Cluster Controllers and Cluster Agents @@ -113,9 +113,9 @@ An authorized cluster endpoint allows users to connect to the Kubernetes API ser :::note -- The authorized cluster endpoint only works on Rancher-launched Kubernetes clusters. In other words, it only works in clusters where Rancher [used RKE]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters) to provision the cluster. The ACE is not available for clusters in a hosted Kubernetes provider, such as Amazon's EKS. +- The authorized cluster endpoint only works on Rancher-launched Kubernetes clusters. In other words, it only works in clusters where Rancher [used RKE](launch-kubernetes-with-rancher.md) to provision the cluster. The ACE is not available for clusters in a hosted Kubernetes provider, such as Amazon's EKS. -- The [ACE is available for registered RKE2 and K3s clusters]({{}}/rancher/v2.6/en/cluster-provisioning/registered-clusters/#authorized-cluster-endpoint-support-for-rke2-and-k3s-clusters) as of Rancher v2.6.3. +- The [ACE is available for registered RKE2 and K3s clusters](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md#authorized-cluster-endpoint-support-for-rke2-and-k3s-clusters) as of Rancher v2.6.3. ::: @@ -136,7 +136,7 @@ Let's say that the Rancher server is located in the United States, and User Clus With this endpoint enabled for the downstream cluster, Rancher generates an extra Kubernetes context in the kubeconfig file in order to connect directly to the cluster. This file has the credentials for `kubectl` and `helm`. -You will need to use a context defined in this kubeconfig file to access the cluster if Rancher goes down. Therefore, we recommend exporting the kubeconfig file so that if Rancher goes down, you can still use the credentials in the file to access your cluster. For more information, refer to the section on accessing your cluster with [kubectl and the kubeconfig file.]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl) +You will need to use a context defined in this kubeconfig file to access the cluster if Rancher goes down. Therefore, we recommend exporting the kubeconfig file so that if Rancher goes down, you can still use the credentials in the file to access your cluster. For more information, refer to the section on accessing your cluster with [kubectl and the kubeconfig file.](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md) # Important Files @@ -152,7 +152,7 @@ The "rancher-cluster" parts of the two latter file names are dependent on how yo ::: -For more information on connecting to a cluster without the Rancher authentication proxy and other configuration options, refer to the [kubeconfig file]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/) documentation. +For more information on connecting to a cluster without the Rancher authentication proxy and other configuration options, refer to the [kubeconfig file](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md) documentation. # Tools for Provisioning Kubernetes Clusters @@ -184,7 +184,7 @@ In this type of cluster, Rancher connects to a Kubernetes cluster that has alrea This diagram shows each component that the Rancher server is composed of: -![Rancher Components]({{}}/img/rancher/rancher-architecture-rancher-components.svg) +![Rancher Components](/img/rancher-architecture-rancher-components.svg) The GitHub repositories for Rancher can be found at the following links: @@ -196,4 +196,4 @@ The GitHub repositories for Rancher can be found at the following links: - [Rancher CLI](https://github.com/rancher/cli) - [Catalog applications](https://github.com/rancher/helm) -This is a partial list of the most important Rancher repositories. For more details about Rancher source code, refer to the section on [contributing to Rancher.]({{}}/rancher/v2.6/en/contributing/#repositories) To see all libraries and projects used in Rancher, see the [`go.mod` file](https://github.com/rancher/rancher/blob/master/go.mod) in the `rancher/rancher` repository. +This is a partial list of the most important Rancher repositories. For more details about Rancher source code, refer to the section on [contributing to Rancher.](../contribute-to-rancher.md#repositories) To see all libraries and projects used in Rancher, see the [`go.mod` file](https://github.com/rancher/rancher/blob/master/go.mod) in the `rancher/rancher` repository. diff --git a/docs/en/installation/other-installation-methods/single-node-docker/single-node-docker.md b/docs/en/pages-for-subheaders/rancher-on-a-single-node-with-docker.md similarity index 82% rename from docs/en/installation/other-installation-methods/single-node-docker/single-node-docker.md rename to docs/en/pages-for-subheaders/rancher-on-a-single-node-with-docker.md index 51196529568..86c963177d7 100644 --- a/docs/en/installation/other-installation-methods/single-node-docker/single-node-docker.md +++ b/docs/en/pages-for-subheaders/rancher-on-a-single-node-with-docker.md @@ -10,13 +10,13 @@ In this installation scenario, you'll install Docker on a single Linux host, and :::note Want to use an external load balancer? -See [Docker Install with an External Load Balancer]({{}}/rancher/v2.6/en/installation/resources/advanced/single-node-install-external-lb) instead. +See [Docker Install with an External Load Balancer](installation/resourceinstallation/other-installation-methods/single-node-docker/advanced/single-node-install-external-lb) instead. ::: A Docker installation of Rancher is recommended only for development and testing purposes. The ability to migrate Rancher to a high-availability cluster depends on the Rancher version: -The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.]({{}}/rancher/v2.6/en/backups/migrating-rancher) +The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.](../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md) ### Privileged Access for Rancher @@ -24,11 +24,11 @@ When the Rancher server is deployed in the Docker container, a local Kubernetes # Requirements for OS, Docker, Hardware, and Networking -Make sure that your node fulfills the general [installation requirements.]({{}}/rancher/v2.6/en/installation/requirements/) +Make sure that your node fulfills the general [installation requirements.](installation-requirements.md) # 1. Provision Linux Host -Provision a single Linux host according to our [Requirements]({{}}/rancher/v2.6/en/installation/requirements) to launch your Rancher server. +Provision a single Linux host according to our [Requirements](installation-requirements.md) to launch your Rancher server. # 2. Choose an SSL Option and Install Rancher @@ -36,10 +36,10 @@ For security purposes, SSL (Secure Sockets Layer) is required when using Rancher :::tip Do you want to.. -- Use a proxy? See [HTTP Proxy Configuration]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/proxy/) -- Configure custom CA root certificate to access your services? See [Custom CA root certificate]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#custom-ca-certificate/) -- Complete an Air Gap Installation? See [Air Gap: Docker Install]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/) -- Record all transactions with the Rancher API? See [API Auditing](./advanced/#api-audit-log) +- Use a proxy? See [HTTP Proxy Configuration](../reference-guides/single-node-rancher-in-docker/http-proxy-configuration.md) +- Configure custom CA root certificate to access your services? See [Custom CA root certificate](installation/other-installation-methods/single-node-dockeinstallation/other-installation-methods/single-node-docker/advanced/#custom-ca-certificate/) +- Complete an Air Gap Installation? See [Air Gap: Docker Install](air-gapped-helm-cli-install.md) +- Record all transactions with the Rancher API? See [API Auditing](installation/other-installation-methods/single-node-dockeinstallation/other-installation-methods/single-node-docker/advanced/#api-audit-log) ::: @@ -72,7 +72,7 @@ In development or testing environments where your team will access your Rancher Create a self-signed certificate using [OpenSSL](https://www.openssl.org/) or another method of your choice. - The certificate files must be in PEM format. -- In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting) +- In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.](installation/other-installation-methods/single-node-dockeinstallation/other-installation-methods/single-node-docker/troubleshooting) ::: @@ -106,7 +106,7 @@ The Docker install is not recommended for production. These instructions are pro :::note Prerequisites: - The certificate files must be in PEM format. -- In your certificate file, include all intermediate certificates provided by the recognized CA. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting) +- In your certificate file, include all intermediate certificates provided by the recognized CA. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.](installation/other-installation-methods/single-node-dockeinstallation/other-installation-methods/single-node-docker/troubleshooting) ::: @@ -196,13 +196,13 @@ When installing Rancher on a single node with Docker, there are several advanced - Persistent Data - Running `rancher/rancher` and `rancher/rancher-agent` on the Same Node -Refer to [this page](./advanced) for details. +Refer to [this page](../reference-guides/single-node-rancher-in-docker/advanced-options.md) for details. ## Troubleshooting -Refer to [this page](./troubleshooting) for frequently asked questions and troubleshooting tips. +Refer to [this page](../getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/certificate-troubleshooting.md) for frequently asked questions and troubleshooting tips. ## What's Next? -- **Recommended:** Review [Single Node Backup and Restore]({{}}/rancher/v2.6/en/backups/docker-installs). Although you don't have any data you need to back up right now, we recommend creating backups after regular Rancher use. -- Create a Kubernetes cluster: [Provisioning Kubernetes Clusters]({{}}/rancher/v2.6/en/cluster-provisioning/). +- **Recommended:** Review [Single Node Backup and Restore](backups/docker-installs). Although you don't have any data you need to back up right now, we recommend creating backups after regular Rancher use. +- Create a Kubernetes cluster: [Provisioning Kubernetes Clusters](kubernetes-clusters-in-rancher-setup.md). diff --git a/docs/en/security/security.md b/docs/en/pages-for-subheaders/rancher-security.md similarity index 90% rename from docs/en/security/security.md rename to docs/en/pages-for-subheaders/rancher-security.md index c745f356c7c..bc77fd12ba4 100644 --- a/docs/en/security/security.md +++ b/docs/en/pages-for-subheaders/rancher-security.md @@ -22,7 +22,7 @@ aliases: -Security is at the heart of all Rancher features. From integrating with all the popular authentication tools and services, to an enterprise grade [RBAC capability]({{}}/rancher/v2.6/en/admin-settings/rbac), Rancher makes your Kubernetes clusters even more secure. +Security is at the heart of all Rancher features. From integrating with all the popular authentication tools and services, to an enterprise grade [RBAC capability](manage-role-based-access-control-rbac.md), Rancher makes your Kubernetes clusters even more secure. On this page, we provide security related documentation along with resources to help you secure your Rancher installation and your downstream Kubernetes clusters: @@ -39,7 +39,7 @@ On this page, we provide security related documentation along with resources to _New in v2.6.5_ -NeuVector is an open-source, container-focused security application that is now integrated into Rancher. NeuVector provides production security, DevOps vulnerability protection, and a container firewall, et al. Please see the [Rancher docs]({{}}/rancher/v2.6/en/neuvector-integration) and the [NeuVector docs](https://open-docs.neuvector.com/) for more information. +NeuVector is an open-source, container-focused security application that is now integrated into Rancher. NeuVector provides production security, DevOps vulnerability protection, and a container firewall, et al. Please see the [Rancher docs](../explanations/integrations-in-rancher/neuvector.md) and the [NeuVector docs](https://open-docs.neuvector.com/) for more information. ### Running a CIS Security Scan on a Kubernetes Cluster @@ -55,13 +55,13 @@ The Benchmark provides recommendations of two types: Automated and Manual. We ru When Rancher runs a CIS security scan on a cluster, it generates a report showing the results of each test, including a summary with the number of passed, skipped and failed tests. The report also includes remediation steps for any failed tests. -For details, refer to the section on [security scans]({{}}/rancher/v2.6/en/cis-scans). +For details, refer to the section on [security scans](cis-scan-guides.md). ### SELinux RPM [Security-Enhanced Linux (SELinux)](https://en.wikipedia.org/wiki/Security-Enhanced_Linux) is a security enhancement to Linux. After being historically used by government agencies, SELinux is now industry standard and is enabled by default on CentOS 7 and 8. -We provide two RPMs (Red Hat packages) that enable Rancher products to function properly on SELinux-enforcing hosts: `rancher-selinux` and `rke2-selinux`. For details, see [this page]({{}}/rancher/v2.6/en/security/selinux). +We provide two RPMs (Red Hat packages) that enable Rancher products to function properly on SELinux-enforcing hosts: `rancher-selinux` and `rke2-selinux`. For details, see [this page](selinux-rpm.md). ### Rancher Hardening Guide @@ -92,8 +92,8 @@ Results: ### Rancher Security Advisories and CVEs -Rancher is committed to informing the community of security issues in our products. For the list of CVEs (Common Vulnerabilities and Exposures) for issues we have resolved, refer to [this page.](./cve) +Rancher is committed to informing the community of security issues in our products. For the list of CVEs (Common Vulnerabilities and Exposures) for issues we have resolved, refer to [this page.](../reference-guides/rancher-security/security-advisories-and-cves.md) ### Kubernetes Security Best Practices -For recommendations on securing your Kubernetes cluster, refer to the [Kubernetes Security Best Practices](./best-practices) guide. +For recommendations on securing your Kubernetes cluster, refer to the [Kubernetes Security Best Practices](../reference-guides/rancher-security/kubernetes-security-best-practices.md) guide. diff --git a/docs/en/pages-for-subheaders/rancher-server-configuration.md b/docs/en/pages-for-subheaders/rancher-server-configuration.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/rancher-server-configuration.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/pages-for-subheaders/rancher-server.md b/docs/en/pages-for-subheaders/rancher-server.md new file mode 100644 index 00000000000..62678aabce1 --- /dev/null +++ b/docs/en/pages-for-subheaders/rancher-server.md @@ -0,0 +1,19 @@ +--- +title: Best Practices for the Rancher Server +shortTitle: Rancher Server +weight: 1 +--- + +This guide contains our recommendations for running the Rancher server, and is intended to be used in situations in which Rancher manages downstream Kubernetes clusters. + +### Recommended Architecture and Infrastructure + +Refer to this [guide](../reference-guides/best-practices/rancher-server/tips-for-running-rancher.md) for our general advice for setting up the Rancher server on a high-availability Kubernetes cluster. + +### Deployment Strategies + +This [guide](../reference-guides/best-practices/rancher-server/rancher-deployment-strategy.md) is designed to help you choose whether a regional deployment strategy or a hub-and-spoke deployment strategy is better for a Rancher server that manages downstream Kubernetes clusters. + +### Installing Rancher in a vSphere Environment + +This [guide](../reference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere.md) outlines a reference architecture for installing Rancher in a vSphere environment, in addition to standard vSphere best practices as documented by VMware. \ No newline at end of file diff --git a/docs/en/security/hardening-guides/hardening-guides.md b/docs/en/pages-for-subheaders/rancher-v2.6-hardening-guides.md similarity index 69% rename from docs/en/security/hardening-guides/hardening-guides.md rename to docs/en/pages-for-subheaders/rancher-v2.6-hardening-guides.md index 461b1eed92c..49e6bb89588 100644 --- a/docs/en/security/hardening-guides/hardening-guides.md +++ b/docs/en/pages-for-subheaders/rancher-v2.6-hardening-guides.md @@ -23,9 +23,9 @@ Rancher provides specific security hardening guides for each supported Rancher's Rancher uses the following Kubernetes distributions: -- [**RKE**]({{}}/rke/latest/en/), Rancher Kubernetes Engine, is a CNCF-certified Kubernetes distribution that runs entirely within Docker containers. +- [**RKE**](https://rancher.com/docs/rke/latest/en/), Rancher Kubernetes Engine, is a CNCF-certified Kubernetes distribution that runs entirely within Docker containers. - [**RKE2**](https://docs.rke2.io/) is a fully conformant Kubernetes distribution that focuses on security and compliance within the U.S. Federal Government sector. -- [**K3s**]({{}}/k3s/latest/en/) is a fully conformant, lightweight Kubernetes distribution. It is easy to install, with half the memory of upstream Kubernetes, all in a binary of less than 100 MB. +- [**K3s**](https://rancher.com/docs/k3s/latest/en/) is a fully conformant, lightweight Kubernetes distribution. It is easy to install, with half the memory of upstream Kubernetes, all in a binary of less than 100 MB. To harden a Kubernetes cluster outside of Rancher's distributions, refer to your Kubernetes provider docs. @@ -37,7 +37,7 @@ These guides have been tested along with the Rancher v2.6 release. Each self-ass | Kubernetes Version | CIS Benchmark Version | Self Assessment Guide | Hardening Guides | | ------------------ | --------------------- | --------------------- | ---------------- | -| Kubernetes v1.18 up to v1.23 | CIS v1.6 | [Link]({{}}/rancher/v2.6/en/security/hardening-guides/rke-1.6-benchmark-2.6) | [Link]({{}}/rancher/v2.6/en/security/hardening-guides/rke-1.6-hardening-2.6) | +| Kubernetes v1.18 up to v1.23 | CIS v1.6 | [Link](../reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke1-self-assessment-guide-with-cis-v1.6-benchmark.md) | [Link](../reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke1-hardening-guide-with-cis-v1.6-benchmark.md) | :::note @@ -49,17 +49,17 @@ These guides have been tested along with the Rancher v2.6 release. Each self-ass | Type | Kubernetes Version | CIS Benchmark Version | Self Assessment Guide | Hardening Guides | | ---- | ------------------ | --------------------- | --------------------- | ---------------- | -| Rancher provisioned RKE2 cluster | Kubernetes v1.21 up to v1.23 | CIS v1.6 | [Link]({{}}/rancher/v2.6/en/security/hardening-guides/rke2-1.6-benchmark-2.6) | [Link]({{}}/rancher/v2.6/en/security/hardening-guides/rke2-1.6-hardening-2.6) | +| Rancher provisioned RKE2 cluster | Kubernetes v1.21 up to v1.23 | CIS v1.6 | [Link](../reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke2-self-assessment-guide-with-cis-v1.6-benchmark.md) | [Link](../reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke2-hardening-guide-with-cis-v1.6-benchmark.md) | | Standalone RKE2 | Kubernetes v1.21 up to v1.23 | CIS v1.6 | [Link](https://docs.rke2.io/security/cis_self_assessment16/) | [Link](https://docs.rke2.io/security/hardening_guide/) | ### K3s Guides | Kubernetes Version | CIS Benchmark Version | Self Assessment Guide | Hardening Guides | | ------------------ | --------------------- | --------------------- | ---------------- | -| Kubernetes v1.21 and v1.22 | CIS v1.6 | [Link]({{}}/k3s/latest/en/security/self_assessment/) | [Link]({{}}/k3s/latest/en/security/hardening_guide/) | +| Kubernetes v1.21 and v1.22 | CIS v1.6 | [Link](https://rancher.com/docs/k3s/latest/en/security/self_assessment/) | [Link](https://rancher.com/docs/k3s/latest/en/security/hardening_guide/) | # Rancher with SELinux [Security-Enhanced Linux (SELinux)](https://en.wikipedia.org/wiki/Security-Enhanced_Linux) is a security enhancement to Linux. After being historically used by government agencies, SELinux is now industry standard and is enabled by default on RHEL and CentOS. -To use Rancher with SELinux, we recommend installing the `rancher-selinux` RPM according to the instructions on [this page.]({{}}/rancher/v2.6/en/security/selinux/#installing-the-rancher-selinux-rpm) +To use Rancher with SELinux, we recommend installing the `rancher-selinux` RPM according to the instructions on [this page.](selinux-rpm.md#installing-the-rancher-selinux-rpm) diff --git a/docs/en/pages-for-subheaders/resources.md b/docs/en/pages-for-subheaders/resources.md new file mode 100644 index 00000000000..a351d874001 --- /dev/null +++ b/docs/en/pages-for-subheaders/resources.md @@ -0,0 +1,26 @@ +--- +title: Resources +weight: 5 +--- + +### Docker Installations + +The [single-node Docker installation](rancher-on-a-single-node-with-docker.md) is for Rancher users that are wanting to test out Rancher. Instead of running on a Kubernetes cluster using Helm, you install the Rancher server component on a single node using a `docker run` command. + +Since there is only one node and a single Docker container, if the node goes down, there is no copy of the etcd data available on other nodes and you will lose all the data of your Rancher server. + +### Air-Gapped Installations + +Follow [these steps](air-gapped-helm-cli-install.md) 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. + +### Advanced Options + +When installing Rancher, there are several advanced options that can be enabled during installation. Within each install guide, these options are presented. Learn more about these options: + +- [Custom CA Certificate](../getting-started/installation-and-upgrade/resources/custom-ca-root-certificates.md) +- [API Audit Log](../getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/enable-api-audit-log.md) +- [TLS Settings](../reference-guides/installation-references/tls-settings.md) +- [etcd configuration](../getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/tune-etcd-for-large-installs.md) +- [Local System Charts for Air Gap Installations](../getting-started/installation-and-upgrade/resources/local-system-charts.md) | v2.3.0 | diff --git a/docs/en/security/selinux/selinux.md b/docs/en/pages-for-subheaders/selinux-rpm.md similarity index 100% rename from docs/en/security/selinux/selinux.md rename to docs/en/pages-for-subheaders/selinux-rpm.md diff --git a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/cloud-providers.md b/docs/en/pages-for-subheaders/set-up-cloud-providers.md similarity index 57% rename from docs/en/cluster-provisioning/rke-clusters/cloud-providers/cloud-providers.md rename to docs/en/pages-for-subheaders/set-up-cloud-providers.md index bcb6f1d2089..97d6ceb6a2f 100644 --- a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/cloud-providers.md +++ b/docs/en/pages-for-subheaders/set-up-cloud-providers.md @@ -19,25 +19,25 @@ The following cloud providers can be enabled: ### Setting up the Amazon Cloud Provider -For details on enabling the Amazon cloud provider, refer to [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/amazon) +For details on enabling the Amazon cloud provider, refer to [this page.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/amazon.md) ### Setting up the Azure Cloud Provider -For details on enabling the Azure cloud provider, refer to [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/azure) +For details on enabling the Azure cloud provider, refer to [this page.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/azure.md) ### Setting up the GCE Cloud Provider -For details on enabling the Google Compute Engine cloud provider, refer to [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/gce) +For details on enabling the Google Compute Engine cloud provider, refer to [this page.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/google-compute-engine.md) ### Setting up the vSphere Cloud Provider -For details on enabling the vSphere cloud provider, refer to [this page.](./vsphere) +For details on enabling the vSphere cloud provider, refer to [this page.](vsphere-cloud-provider.md) ### Setting up a Custom Cloud Provider The `Custom` cloud provider is available if you want to configure any Kubernetes cloud provider. -For the custom cloud provider option, you can refer to the [RKE docs]({{}}/rke/latest/en/config-options/cloud-providers/) on how to edit the yaml file for your specific cloud provider. There are specific cloud providers that have more detailed configuration: +For the custom cloud provider option, you can refer to the [RKE docs](https://rancher.com/docs/rke/latest/en/config-options/cloud-providers/) on how to edit the yaml file for your specific cloud provider. There are specific cloud providers that have more detailed configuration: -* [vSphere]({{}}/rke/latest/en/config-options/cloud-providers/vsphere/) -* [OpenStack]({{}}/rke/latest/en/config-options/cloud-providers/openstack/) +* [vSphere](https://rancher.com/docs/rke/latest/en/config-options/cloud-providercluster-provisioning/rke-clusters/cloud-providers/vsphere/) +* [OpenStack](https://rancher.com/docs/rke/latest/en/config-options/cloud-providers/openstack/) diff --git a/docs/en/cluster-provisioning/hosted-kubernetes-clusters/hosted-kubernetes-clusters.md b/docs/en/pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers.md similarity index 67% rename from docs/en/cluster-provisioning/hosted-kubernetes-clusters/hosted-kubernetes-clusters.md rename to docs/en/pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers.md index 32bb6ee82cd..9fbcc530135 100644 --- a/docs/en/cluster-provisioning/hosted-kubernetes-clusters/hosted-kubernetes-clusters.md +++ b/docs/en/pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers.md @@ -22,9 +22,9 @@ Rancher supports the following Kubernetes providers: When using Rancher to create a cluster hosted by a provider, you are prompted for authentication information. This information is required to access the provider's API. For more information on how to obtain this information, see the following procedures: -- [Creating a GKE Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/gke) -- [Creating an EKS Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/eks) -- [Creating an AKS Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/aks) -- [Creating an ACK Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/ack) -- [Creating a TKE Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/tke) -- [Creating a CCE Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/cce) +- [Creating a GKE Cluster](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke.md) +- [Creating an EKS Cluster](amazon-eks-permissions.md) +- [Creating an AKS Cluster](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks.md) +- [Creating an ACK Cluster](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba.md) +- [Creating a TKE Cluster](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent.md) +- [Creating a CCE Cluster](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei.md) diff --git a/docs/en/pages-for-subheaders/single-node-rancher-in-docker.md b/docs/en/pages-for-subheaders/single-node-rancher-in-docker.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/pages-for-subheaders/single-node-rancher-in-docker.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/cluster-provisioning/rke-clusters/custom-nodes/custom-nodes.md b/docs/en/pages-for-subheaders/use-existing-nodes.md similarity index 68% rename from docs/en/cluster-provisioning/rke-clusters/custom-nodes/custom-nodes.md rename to docs/en/pages-for-subheaders/use-existing-nodes.md index 63a50530c4e..cf3c02f89b6 100644 --- a/docs/en/cluster-provisioning/rke-clusters/custom-nodes/custom-nodes.md +++ b/docs/en/pages-for-subheaders/use-existing-nodes.md @@ -7,7 +7,7 @@ weight: 2225 When you create a custom cluster, Rancher uses RKE (the Rancher Kubernetes Engine) to create a Kubernetes cluster in on-prem bare-metal servers, on-prem virtual machines, or in any node hosted by an infrastructure provider. -To use this option you'll need access to servers you intend to use in your Kubernetes cluster. Provision each server according to the [requirements]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements), which includes some hardware specifications and Docker. After you install Docker on each server, you willl also run the command provided in the Rancher UI on each server to turn each one into a Kubernetes node. +To use this option you'll need access to servers you intend to use in your Kubernetes cluster. Provision each server according to the [requirements](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md), which includes some hardware specifications and Docker. After you install Docker on each server, you willl also run the command provided in the Rancher UI on each server to turn each one into a Kubernetes node. This section describes how to set up a custom cluster. @@ -15,7 +15,7 @@ This section describes how to set up a custom cluster. :::note Want to use Windows hosts as Kubernetes workers? -See [Configuring Custom Clusters for Windows]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/) before you start. +See [Configuring Custom Clusters for Windows](use-windows-clusters.md) before you start. ::: @@ -35,11 +35,11 @@ Begin creation of a custom cluster by provisioning a Linux host. Your host can b - An on-prem VM - A bare-metal server -If you want to reuse a node from a previous custom cluster, [clean the node]({{}}/rancher/v2.6/en/cluster-admin/cleaning-cluster-nodes/) before using it in a cluster again. If you reuse a node that hasn't been cleaned, cluster provisioning may fail. +If you want to reuse a node from a previous custom cluster, [clean the node](../how-to-guides/advanced-user-guides/manage-clusters/clean-cluster-nodes.md) before using it in a cluster again. If you reuse a node that hasn't been cleaned, cluster provisioning may fail. -Provision the host according to the [installation requirements]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements) and the [checklist for production-ready clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/production) +Provision the host according to the [installation requirements](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md) and the [checklist for production-ready clusters.](checklist-for-production-ready-clusters.md) -If you're using Amazon EC2 as your host and want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements]({{}}/rke//latest/en/config-options/dual-stack#requirements) when provisioning the host. +If you're using Amazon EC2 as your host and want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements](https://rancher.com/docs/rke//latest/en/config-options/dual-stack#requirements) when provisioning the host. ### 2. Create the Custom Cluster @@ -51,14 +51,14 @@ If you're using Amazon EC2 as your host and want to use the [dual-stack](https:/ :::note Using Windows nodes as Kubernetes workers? - - See [Enable the Windows Support Option]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/). + - See [Enable the Windows Support Option](use-windows-clusters.md). - The only Network Provider available for clusters with Windows support is Flannel. ::: :::note Dual-stack on Amazon EC2: - If you're using Amazon EC2 as your host and want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements]({{}}/rke//latest/en/config-options/dual-stack#requirements) when configuring RKE. + If you're using Amazon EC2 as your host and want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements](https://rancher.com/docs/rke//latest/en/config-options/dual-stack#requirements) when configuring RKE. ::: @@ -66,16 +66,16 @@ If you're using Amazon EC2 as your host and want to use the [dual-stack](https:/ 4. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user. -7. From **Node Role**, choose the roles that you want filled by a cluster node. You must provision at least one node for each role: `etcd`, `worker`, and `control plane`. All three roles are required for a custom cluster to finish provisioning. For more information on roles, see [this section.]({{}}/rancher/v2.6/en/overview/concepts/#roles-for-nodes-in-kubernetes-clusters) +7. From **Node Role**, choose the roles that you want filled by a cluster node. You must provision at least one node for each role: `etcd`, `worker`, and `control plane`. All three roles are required for a custom cluster to finish provisioning. For more information on roles, see [this section.](../reference-guides/kubernetes-concepts.md#roles-for-nodes-in-kubernetes-clusters) :::note Notes: -- Using Windows nodes as Kubernetes workers? See [this section]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/). +- Using Windows nodes as Kubernetes workers? See [this section](use-windows-clusters.md). - Bare-Metal Server Reminder: If you plan on dedicating bare-metal servers to each role, you must provision a bare-metal server for each role (i.e. provision multiple bare-metal servers). ::: -8. **Optional**: Click **[Show advanced options]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/rancher-agents/)** to specify IP address(es) to use when registering the node, override the hostname of the node, or to add [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) or [taints](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/) to the node. +8. **Optional**: Click **[Show advanced options](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/about-rancher-agents.md)** to specify IP address(es) to use when registering the node, override the hostname of the node, or to add [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) or [taints](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/) to the node. 9. Copy the command displayed on screen to your clipboard. @@ -143,5 +143,5 @@ Key=kubernetes.io/cluster/CLUSTERID, Value=shared After creating your cluster, you can access it through the Rancher UI. As a best practice, we recommend setting up these alternate ways of accessing your cluster: -- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. -- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. +- **Access your cluster with the kubectl CLI:** Follow [these steps](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. +- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/node-pools.md b/docs/en/pages-for-subheaders/use-new-nodes-in-an-infra-provider.md similarity index 89% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/node-pools.md rename to docs/en/pages-for-subheaders/use-new-nodes-in-an-infra-provider.md index a840dec637c..90a485ebc76 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/node-pools.md +++ b/docs/en/pages-for-subheaders/use-new-nodes-in-an-infra-provider.md @@ -27,11 +27,11 @@ When you create an RKE or RKE2 cluster using a node template in Rancher, each re ## RKE Clusters -Using Rancher, you can create pools of nodes based on a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates). This node template defines the parameters you want to use to launch nodes in your infrastructure providers or cloud providers. +Using Rancher, you can create pools of nodes based on a [node template](use-new-nodes-in-an-infra-provider.md#node-templates). This node template defines the parameters you want to use to launch nodes in your infrastructure providers or cloud providers. One benefit of installing Kubernetes on node pools hosted by an infrastructure provider is that if a node loses connectivity with the cluster, Rancher can automatically create another node to join the cluster to ensure that the count of the node pool is as expected. -The available cloud providers to create a node template are decided based on active [node drivers]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-drivers). +The available cloud providers to create a node template are decided based on active [node drivers](use-new-nodes-in-an-infra-provider.md#node-drivers). ### Node Templates @@ -85,7 +85,7 @@ The recommended setup is to have: By default, Rancher tries to run the Docker Install script when provisioning RKE1 downstream cluster nodes, such as in vSphere. However, the Rancher Docker installation script would fail in air-gapped environments. To work around this issue, you may choose to skip installing Docker when creating a Node Template where Docker is pre-installed onto a VM image. You can accomplish this by selecting **None** in the dropdown list for `Docker Install URL` under **Engine Options** in the Rancher UI.
**Engine Options Dropdown:**
-![Engine Options Dropdown]({{}}/img/rancher/node-template-engine-options-rke1.png) +![Engine Options Dropdown](/img/node-template-engine-options-rke1.png) #### Node Pool Taints @@ -138,11 +138,11 @@ Node templates can use cloud credentials to store credentials for launching node - Multiple node templates can share the same cloud credential to create node pools. If your key is compromised or expired, the cloud credential can be updated in a single place, which allows all node templates that are using it to be updated at once. -After cloud credentials are created, the user can start [managing the cloud credentials that they created]({{}}/rancher/v2.6/en/user-settings/cloud-credentials/). +After cloud credentials are created, the user can start [managing the cloud credentials that they created](../reference-guides/user-settings/manage-cloud-credentials.md). ### Node Drivers -If you don't find the node driver that you want to use, you can see if it is available in Rancher's built-in [node drivers and activate it]({{}}/rancher/v2.6/en/admin-settings/drivers/node-drivers/#activating-deactivating-node-drivers), or you can [add your own custom node driver]({{}}/rancher/v2.6/en/admin-settings/drivers/node-drivers/#adding-custom-node-drivers). +If you don't find the node driver that you want to use, you can see if it is available in Rancher's built-in [node drivers and activate it](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers.md#activating-deactivating-node-drivers), or you can [add your own custom node driver](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers.md#adding-custom-node-drivers). ## RKE2 Clusters @@ -150,7 +150,7 @@ Rancher v2.6 introduces provisioning for [RKE2](https://docs.rke2.io/) clusters :::note -For RKE2 cluster templates, please refer to [this page]({{}}/rancher/v2.6/en/admin-settings/cluster-templates/#rke2-cluster-template) for additional information. +For RKE2 cluster templates, please refer to [this page](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-cluster-templates.md#rke2-cluster-template) for additional information. ::: @@ -162,7 +162,7 @@ The same functionality of using `etcd`, `controlplane` and `worker` nodes is pos The implementation of the three node roles in Rancher means that Rancher managed RKE2 clusters are able to easily leverage all of the same architectural best practices that are recommended for RKE clusters. -In our [recommended cluster architecture]({{}}/rancher/v2.6/en/cluster-provisioning/production/recommended-architecture/), we outline how many nodes of each role clusters should have: +In our [recommended cluster architecture](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/checklist-for-production-ready-clusters/recommended-cluster-architecture.md), we outline how many nodes of each role clusters should have: - At least three nodes with the role etcd to survive losing one node - At least two nodes with the role controlplane for master component high availability diff --git a/docs/en/cluster-provisioning/rke-clusters/windows-clusters/windows-clusters.md b/docs/en/pages-for-subheaders/use-windows-clusters.md similarity index 84% rename from docs/en/cluster-provisioning/rke-clusters/windows-clusters/windows-clusters.md rename to docs/en/pages-for-subheaders/use-windows-clusters.md index d79d4d76adc..507cf8cb881 100644 --- a/docs/en/cluster-provisioning/rke-clusters/windows-clusters/windows-clusters.md +++ b/docs/en/pages-for-subheaders/use-windows-clusters.md @@ -3,7 +3,7 @@ title: Launching Kubernetes on Windows Clusters weight: 2240 --- -When provisioning a [custom cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes) using Rancher, Rancher uses RKE (the Rancher Kubernetes Engine) to install Kubernetes on your existing nodes. +When provisioning a [custom cluster](use-existing-nodes.md) using Rancher, Rancher uses RKE (the Rancher Kubernetes Engine) to install Kubernetes on your existing nodes. In a Windows cluster provisioned with Rancher, the cluster must contain both Linux and Windows nodes. The Kubernetes controlplane can only run on Linux nodes, and the Windows nodes can only have the worker role. Windows nodes can only be used for deploying workloads. @@ -51,7 +51,7 @@ Rancher will allow Windows workload pods to deploy on both Windows and Linux wor # Requirements for Windows Clusters -The general node requirements for networking, operating systems, and Docker are the same as the node requirements for a [Rancher installation]({{}}/rancher/v2.6/en/installation/requirements/). +The general node requirements for networking, operating systems, and Docker are the same as the node requirements for a [Rancher installation](installation-requirements.md). ### OS and Docker Requirements @@ -77,13 +77,13 @@ Rancher will not provision the node if the node does not meet these requirements ### Networking Requirements -Before provisioning a new cluster, be sure that you have already installed Rancher on a device that accepts inbound network traffic. This is required in order for the cluster nodes to communicate with Rancher. If you have not already installed Rancher, please refer to the [installation documentation]({{}}/rancher/v2.6/en/installation/) before proceeding with this guide. +Before provisioning a new cluster, be sure that you have already installed Rancher on a device that accepts inbound network traffic. This is required in order for the cluster nodes to communicate with Rancher. If you have not already installed Rancher, please refer to the [installation documentation](installation-and-upgrade.md) before proceeding with this guide. Rancher only supports Windows using Flannel as the network provider. There are two network options: [**Host Gateway (L2bridge)**](https://github.com/coreos/flannel/blob/master/Documentation/backends.md#host-gw) and [**VXLAN (Overlay)**](https://github.com/coreos/flannel/blob/master/Documentation/backends.md#vxlan). The default option is **VXLAN (Overlay)** mode. -For **Host Gateway (L2bridge)** networking, it's best to use the same Layer 2 network for all nodes. Otherwise, you need to configure the route rules for them. For details, refer to the [documentation on configuring cloud-hosted VM routes.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/#cloud-hosted-vm-routes-configuration) You will also need to [disable private IP address checks]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/#disabling-private-ip-address-checks) if you are using Amazon EC2, Google GCE, or Azure VM. +For **Host Gateway (L2bridge)** networking, it's best to use the same Layer 2 network for all nodes. Otherwise, you need to configure the route rules for them. For details, refer to the [documentation on configuring cloud-hosted VM routes.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/network-requirements-for-host-gateway.md#cloud-hosted-vm-routes-configuration) You will also need to [disable private IP address checks](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/network-requirements-for-host-gateway.md#disabling-private-ip-address-checks) if you are using Amazon EC2, Google GCE, or Azure VM. For **VXLAN (Overlay)** networking, the [KB4489899](https://support.microsoft.com/en-us/help/4489899) hotfix must be installed. Most cloud-hosted VMs already have this hotfix. @@ -143,18 +143,18 @@ Windows requires that containers must be built on the same Windows Server versio ### Cloud Provider Specific Requirements -If you set a Kubernetes cloud provider in your cluster, some additional steps are required. You might want to set a cloud provider if you want to want to leverage a cloud provider's capabilities, for example, to automatically provision storage, load balancers, or other infrastructure for your cluster. Refer to [this page]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/) for details on how to configure a cloud provider cluster of nodes that meet the prerequisites. +If you set a Kubernetes cloud provider in your cluster, some additional steps are required. You might want to set a cloud provider if you want to want to leverage a cloud provider's capabilities, for example, to automatically provision storage, load balancers, or other infrastructure for your cluster. Refer to [this page](set-up-cloud-providers.md) for details on how to configure a cloud provider cluster of nodes that meet the prerequisites. If you are using the GCE (Google Compute Engine) cloud provider, you must do the following: -- Enable the GCE cloud provider in the `cluster.yml` by following [these steps.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/gce) +- Enable the GCE cloud provider in the `cluster.yml` by following [these steps.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/google-compute-engine.md) - When provisioning the cluster in Rancher, choose **Custom cloud provider** as the cloud provider in the Rancher UI. # Tutorial: How to Create a Cluster with Windows Support This tutorial describes how to create a Rancher-provisioned cluster with the three nodes in the [recommended architecture.](#guide-architecture) -When you provision a cluster with Rancher on existing nodes, you will add nodes to the cluster by installing the [Rancher agent]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/) on each one. When you create or edit your cluster from the Rancher UI, you will see a **Customize Node Run Command** that you can run on each server to add it to your cluster. +When you provision a cluster with Rancher on existing nodes, you will add nodes to the cluster by installing the [Rancher agent](../reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/rancher-agent-options.md) on each one. When you create or edit your cluster from the Rancher UI, you will see a **Customize Node Run Command** that you can run on each server to add it to your cluster. To set up a cluster with support for Windows nodes and containers, you will need to complete the tasks below. @@ -188,11 +188,11 @@ You will provision three nodes: | Node 2 | Linux (Ubuntu Server 18.04 recommended) | | Node 3 | Windows (Windows Server core version 1809 or above required) | -If your nodes are hosted by a **Cloud Provider** and you want automation support such as loadbalancers or persistent storage devices, your nodes have additional configuration requirements. For details, see [Selecting Cloud Providers.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers) +If your nodes are hosted by a **Cloud Provider** and you want automation support such as loadbalancers or persistent storage devices, your nodes have additional configuration requirements. For details, see [Selecting Cloud Providers.](set-up-cloud-providers.md) # 2. Create the Cluster on Existing Nodes -The instructions for creating a Windows cluster on existing nodes are very similar to the general [instructions for creating a custom cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/) with some Windows-specific requirements. +The instructions for creating a Windows cluster on existing nodes are very similar to the general [instructions for creating a custom cluster](use-existing-nodes.md) with some Windows-specific requirements. 1. In the upper left corner, click **☰ > Cluster Management**. 1. On the **Clusters** page, click **Create**. @@ -206,7 +206,7 @@ The instructions for creating a Windows cluster on existing nodes are very simil :::note Important: -For Host Gateway (L2bridge) networking, it's best to use the same Layer 2 network for all nodes. Otherwise, you need to configure the route rules for them. For details, refer to the [documentation on configuring cloud-hosted VM routes.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/#cloud-hosted-vm-routes-configuration) You will also need to [disable private IP address checks]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/#disabling-private-ip-address-checks) if you are using Amazon EC2, Google GCE, or Azure VM. +For Host Gateway (L2bridge) networking, it's best to use the same Layer 2 network for all nodes. Otherwise, you need to configure the route rules for them. For details, refer to the [documentation on configuring cloud-hosted VM routes.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/network-requirements-for-host-gateway.md#cloud-hosted-vm-routes-configuration) You will also need to [disable private IP address checks](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/network-requirements-for-host-gateway.md#disabling-private-ip-address-checks) if you are using Amazon EC2, Google GCE, or Azure VM. ::: @@ -222,7 +222,7 @@ The first node in your cluster should be a Linux host has both the **Control Pla 1. In the **Node Operating System** section, click **Linux**. 1. In the **Node Role** section, choose at least **etcd** and **Control Plane**. We recommend selecting all three. -1. Optional: If you click **Show advanced options,** you can customize the settings for the [Rancher agent]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/) and [node labels.](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) +1. Optional: If you click **Show advanced options,** you can customize the settings for the [Rancher agent](../reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/rancher-agent-options.md) and [node labels.](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) 1. Copy the command displayed on the screen to your clipboard. 1. SSH into your Linux host and run the command that you copied to your clipboard. 1. When you are finished provisioning your Linux node(s), select **Done**. @@ -289,9 +289,9 @@ You can add Windows hosts to the cluster by editing the cluster and choosing the After creating your cluster, you can access it through the Rancher UI. As a best practice, we recommend setting up these alternate ways of accessing your cluster: -- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. -- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through the Rancher server. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. +- **Access your cluster with the kubectl CLI:** Follow [these steps](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. +- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through the Rancher server. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. # Configuration for Storage Classes in Azure -If you are using Azure VMs for your nodes, you can use [Azure files](https://docs.microsoft.com/en-us/azure/aks/azure-files-dynamic-pv) as a StorageClass for the cluster. For details, refer to [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass) +If you are using Azure VMs for your nodes, you can use [Azure files](https://docs.microsoft.com/en-us/azure/aks/azure-files-dynamic-pv) as a StorageClass for the cluster. For details, refer to [this section.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/azure-storageclass-configuration.md) diff --git a/docs/en/pages-for-subheaders/user-settings.md b/docs/en/pages-for-subheaders/user-settings.md new file mode 100644 index 00000000000..bab26d837ba --- /dev/null +++ b/docs/en/pages-for-subheaders/user-settings.md @@ -0,0 +1,16 @@ +--- +title: User Settings +weight: 23 +--- + +Within Rancher, each user has a number of settings associated with their login: personal preferences, API keys, etc. You can configure these settings by choosing from the **User Settings** menu. You can open this menu by clicking your avatar, located within the main menu. + +![User Settings Menu](/img/user-settings.png) + +The available user settings are: + +- [API & Keys](../reference-guides/user-settings/api-keys.md): If you want to interact with Rancher programmatically, you need an API key. Follow the directions in this section to obtain a key. +- [Cloud Credentials](../reference-guides/user-settings/manage-cloud-credentials.md): Manage cloud credentials [used by node templates](use-new-nodes-in-an-infra-provider.md#node-templates) to [provision nodes for clusters](launch-kubernetes-with-rancher.md). +- [Node Templates](../reference-guides/user-settings/manage-node-templates.md): Manage templates [used by Rancher to provision nodes for clusters](launch-kubernetes-with-rancher.md). +- [Preferences](../reference-guides/user-settings/user-preferences.md): Sets superficial preferences for the Rancher UI. +- Log Out: Ends your user session. diff --git a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/vsphere.md b/docs/en/pages-for-subheaders/vsphere-cloud-provider.md similarity index 58% rename from docs/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/vsphere.md rename to docs/en/pages-for-subheaders/vsphere-cloud-provider.md index 77a27a88eab..01f1d0ee24e 100644 --- a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/vsphere.md +++ b/docs/en/pages-for-subheaders/vsphere-cloud-provider.md @@ -7,8 +7,8 @@ In this section, you'll learn how to set up a vSphere cloud provider for a Ranch # In-tree Cloud Provider -To use the in-tree vSphere cloud provider, you will need to use an RKE configuration option. For details, refer to [this page.](./in-tree) +To use the in-tree vSphere cloud provider, you will need to use an RKE configuration option. For details, refer to [this page.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-in-tree-vsphere.md) # Out-of-tree Cloud Provider -To set up the out-of-tree vSphere cloud provider, you will need to install Helm charts from the Rancher marketplace. For details, refer to [this page.](./out-of-tree) +To set up the out-of-tree vSphere cloud provider, you will need to install Helm charts from the Rancher marketplace. For details, refer to [this page.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-out-of-tree-vsphere.md) diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere.md b/docs/en/pages-for-subheaders/vsphere.md similarity index 74% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere.md rename to docs/en/pages-for-subheaders/vsphere.md index 85d83075cb5..721c2fe854a 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere.md +++ b/docs/en/pages-for-subheaders/vsphere.md @@ -23,7 +23,7 @@ The vSphere node templates have been updated, allowing you to bring cloud operat ### Self-healing Node Pools -One of the biggest advantages of provisioning vSphere nodes with Rancher is that it allows you to take advantage of Rancher's self-healing node pools, also called the [node auto-replace feature,]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#about-node-auto-replace) in your on-premises clusters. Self-healing node pools are designed to help you replace worker nodes for stateless applications. When Rancher provisions nodes from a node template, Rancher can automatically replace unreachable nodes. +One of the biggest advantages of provisioning vSphere nodes with Rancher is that it allows you to take advantage of Rancher's self-healing node pools, also called the [node auto-replace feature,](use-new-nodes-in-an-infra-provider.md#about-node-auto-replace) in your on-premises clusters. Self-healing node pools are designed to help you replace worker nodes for stateless applications. When Rancher provisions nodes from a node template, Rancher can automatically replace unreachable nodes. :::caution @@ -35,7 +35,7 @@ It is not recommended to enable node auto-replace on a node pool of master nodes Node templates for vSphere have been updated so that when you create a node template with your vSphere credentials, the template is automatically populated with the same options for provisioning VMs that you have access to in the vSphere console. -For the fields to be populated, your setup needs to fulfill the [prerequisites.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/#prerequisites) +For the fields to be populated, your setup needs to fulfill the [prerequisites.](cluster-provisioning/rke-clusters/node-pools/vsphercluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/#prerequisites) ### More Supported Operating Systems @@ -49,14 +49,14 @@ In this YouTube video, we demonstrate how to set up a node template with the new # Creating a vSphere Cluster -In [this section,](./provisioning-vsphere-clusters) you'll learn how to use Rancher to install an [RKE]({{}}/rke/latest/en/) Kubernetes cluster in vSphere. +In [this section,](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/provision-kubernetes-clusters-in-vsphere.md) you'll learn how to use Rancher to install an [RKE](https://rancher.com/docs/rke/latest/en/) Kubernetes cluster in vSphere. # Provisioning Storage -For an example of how to provision storage in vSphere using Rancher, refer to [this section.]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/vsphere) In order to dynamically provision storage in vSphere, the vSphere provider must be [enabled.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere) +For an example of how to provision storage in vSphere using Rancher, refer to [this section.](../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/vsphere-storage.md) In order to dynamically provision storage in vSphere, the vSphere provider must be [enabled.](vsphere-cloud-provider.md) # Enabling the vSphere Cloud Provider When a cloud provider is set up in Rancher, the Rancher server can automatically provision new infrastructure for the cluster, including new nodes or persistent storage devices. -For details, refer to the section on [enabling the vSphere cloud provider.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere) +For details, refer to the section on [enabling the vSphere cloud provider.](vsphere-cloud-provider.md) diff --git a/docs/en/k8s-in-rancher/workloads/workloads.md b/docs/en/pages-for-subheaders/workloads-and-pods.md similarity index 92% rename from docs/en/k8s-in-rancher/workloads/workloads.md rename to docs/en/pages-for-subheaders/workloads-and-pods.md index c1fdac0a8a7..ea909365f75 100644 --- a/docs/en/k8s-in-rancher/workloads/workloads.md +++ b/docs/en/pages-for-subheaders/workloads-and-pods.md @@ -68,9 +68,9 @@ There are several types of services available in Rancher. The descriptions below This section of the documentation contains instructions for deploying workloads and using workload options. -- [Deploy Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/deploy-workloads/) -- [Upgrade Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/upgrade-workloads/) -- [Rollback Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/rollback-workloads/) +- [Deploy Workloads](../how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/deploy-workloads.md) +- [Upgrade Workloads](../how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/upgrade-workloads.md) +- [Rollback Workloads](../how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/roll-back-workloads.md) ## Related Links diff --git a/docs/en/quick-start-guide/deployment/deployment.md b/docs/en/quick-start-guide/deployment/deployment.md deleted file mode 100644 index 6c7369a3bd7..00000000000 --- a/docs/en/quick-start-guide/deployment/deployment.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Deploying Rancher Server -weight: 100 ---- - -Use one of the following guides to deploy and provision Rancher and a Kubernetes cluster in the provider of your choice. - -- [AWS](./amazon-aws-qs) (uses Terraform) -- [AWS Marketplace](./amazon-aws-marketplace-qs) (uses Amazon EKS) -- [Azure](./microsoft-azure-qs) (uses Terraform) -- [DigitalOcean](./digital-ocean-qs) (uses Terraform) -- [GCP](./google-gcp-qs) (uses Terraform) -- [Hetzner Cloud](./hetzner-cloud-qs) (uses Terraform) -- [Vagrant](./quickstart-vagrant) -- [Equinix Metal](./equinix-metal-qs) -- [Outscale](./outscale-qs) (uses Terraform) - - -If you prefer, the following guide will take you through the same process in individual steps. Use this if you want to run Rancher in a different provider, on prem, or if you would just like to see how easy it is. - -- [Manual Install](./quickstart-manual-setup) diff --git a/docs/en/quick-start-guide/workload/workload.md b/docs/en/quick-start-guide/workload/workload.md deleted file mode 100644 index a3be7493b6c..00000000000 --- a/docs/en/quick-start-guide/workload/workload.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Deploying Workloads -weight: 200 ---- - -These guides walk you through the deployment of an application, including how to expose the application for use outside of the cluster. - -- [Workload with Ingress](./quickstart-deploy-workload-ingress) -- [Workload with NodePort](./quickstart-deploy-workload-nodeport) diff --git a/docs/en/introduction.md b/docs/en/rancher-manager.md similarity index 100% rename from docs/en/introduction.md rename to docs/en/rancher-manager.md diff --git a/docs/en/reference-guides.md b/docs/en/reference-guides.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/reference-guides.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/api/api-tokens/api-tokens.md b/docs/en/reference-guides/about-the-api/api-tokens.md similarity index 88% rename from docs/en/api/api-tokens/api-tokens.md rename to docs/en/reference-guides/about-the-api/api-tokens.md index 374ad624186..756831cf4dd 100644 --- a/docs/en/api/api-tokens/api-tokens.md +++ b/docs/en/reference-guides/about-the-api/api-tokens.md @@ -40,7 +40,7 @@ Go to the global settings and: :::note -Once this setting is deactivated, a generated kubeconfig will reference the [Rancher CLI]({{}}/rancher/v2.6/en/cli) to retrieve a short lived token for the cluster. When you use this kubeconfig in a client, such as `kubectl`, the Rancher CLI needs to be installed as well. +Once this setting is deactivated, a generated kubeconfig will reference the [Rancher CLI](../../pages-for-subheaders/cli-with-rancher.md) to retrieve a short lived token for the cluster. When you use this kubeconfig in a client, such as `kubectl`, the Rancher CLI needs to be installed as well. ::: @@ -56,7 +56,7 @@ This value cannot exceed max-ttl of API tokens.(`https://}}/rancher/v2.6/en/installation/resources/feature-flags). +To enable token hashing, refer to [this section](../../pages-for-subheaders/enable-experimental-features.md). This feature will affect all tokens which include, but are not limited to, the following: diff --git a/docs/en/cluster-provisioning/hosted-kubernetes-clusters/eks/permissions/permissions.md b/docs/en/reference-guides/amazon-eks-permissions/minimum-eks-permissions.md similarity index 100% rename from docs/en/cluster-provisioning/hosted-kubernetes-clusters/eks/permissions/permissions.md rename to docs/en/reference-guides/amazon-eks-permissions/minimum-eks-permissions.md diff --git a/docs/en/backups/configuration/backup-config/backup-config.md b/docs/en/reference-guides/backup-restore-configuration/backup-configuration.md similarity index 98% rename from docs/en/backups/configuration/backup-config/backup-config.md rename to docs/en/reference-guides/backup-restore-configuration/backup-configuration.md index d4e410a21b6..97702378797 100644 --- a/docs/en/backups/configuration/backup-config/backup-config.md +++ b/docs/en/reference-guides/backup-restore-configuration/backup-configuration.md @@ -61,7 +61,7 @@ This will ensure that the secret contains a key named `encryption-provider-confi The `Encryption Config Secret` dropdown will filter out and list only those Secrets that have this exact key -{{< img "/img/rancher/backup_restore/backup/encryption.png" "">}} +![](/img/backup_restore/backup/encryption.png) In the example command above, the name `encryptionconfig` can be changed to anything. @@ -177,4 +177,4 @@ After the role is created, and you have attached the corresponding instance prof # Examples -For example Backup custom resources, refer to [this page.](../../examples/#backup) +For example Backup custom resources, refer to [this page.](examples.md#backup) diff --git a/docs/en/backups/examples/examples.md b/docs/en/reference-guides/backup-restore-configuration/examples.md similarity index 97% rename from docs/en/backups/examples/examples.md rename to docs/en/reference-guides/backup-restore-configuration/examples.md index b1282f9c3ca..dfab5caa5f4 100644 --- a/docs/en/backups/examples/examples.md +++ b/docs/en/reference-guides/backup-restore-configuration/examples.md @@ -133,7 +133,7 @@ spec: ### Backup from EC2 Nodes with IAM Permission to Access S3 -This example shows that the AWS credential secret does not have to be provided to create a backup if the nodes running `rancher-backup` have [these permissions for access to S3.](../configuration/backup-config/#iam-permissions-for-ec2-nodes-to-access-s3) +This example shows that the AWS credential secret does not have to be provided to create a backup if the nodes running `rancher-backup` have [these permissions for access to S3.](backup-configuration.md#iam-permissions-for-ec2-nodes-to-access-s3) ```yaml apiVersion: resources.cattle.io/v1 @@ -239,7 +239,7 @@ spec: ### Restore from EC2 Nodes with IAM Permissions to Access S3 -This example shows that the AWS credential secret does not have to be provided to restore from backup if the nodes running `rancher-backup` have [these permissions for access to S3.](../configuration/backup-config/#iam-permissions-for-ec2-nodes-to-access-s3) +This example shows that the AWS credential secret does not have to be provided to restore from backup if the nodes running `rancher-backup` have [these permissions for access to S3.](backup-configuration.md#iam-permissions-for-ec2-nodes-to-access-s3) ```yaml apiVersion: resources.cattle.io/v1 diff --git a/docs/en/backups/configuration/restore-config/restore-config.md b/docs/en/reference-guides/backup-restore-configuration/restore-configuration.md similarity index 92% rename from docs/en/backups/configuration/restore-config/restore-config.md rename to docs/en/reference-guides/backup-restore-configuration/restore-configuration.md index 5c980d904b9..36b2679f011 100644 --- a/docs/en/backups/configuration/restore-config/restore-config.md +++ b/docs/en/reference-guides/backup-restore-configuration/restore-configuration.md @@ -6,7 +6,7 @@ weight: 2 The Restore Create page lets you provide details of the backup to restore from -{{< img "/img/rancher/backup_restore/restore/restore.png" "">}} +![](/img/backup_restore/restore/restore.png) - [Backup Source](#backup-source) - [An Existing Backup Config](#an-existing-backup-config) @@ -26,7 +26,7 @@ Provide details of the backup file and its storage location, which the operator Selecting this option will populate the **Target Backup** dropdown with the Backups available in this cluster. Select the Backup from the dropdown, and that will fill out the **Backup Filename** field for you, and will also pass the backup source information from the selected Backup to the operator. -{{< img "/img/rancher/backup_restore/restore/existing.png" "">}} +![](/img/backup_restore/restore/existing.png) If the Backup custom resource does not exist in the cluster, you need to get the exact filename and provide the backup source details with the default storage target or an S3-compatible object store. @@ -35,19 +35,19 @@ If the Backup custom resource does not exist in the cluster, you need to get the Select this option if you are restoring from a backup file that exists in the default storage location configured at the operator-level. The operator-level configuration is the storage location that was configured when the `rancher-backup` operator was installed or upgraded. Provide the exact filename in the **Backup Filename** field. -{{< img "/img/rancher/backup_restore/restore/default.png" "">}} +![](/img/backup_restore/restore/default.png) ### An S3-compatible object store -Select this option if no default storage location is configured at the operator-level, OR if the backup file exists in a different S3 bucket than the one configured as the default storage location. Provide the exact filename in the **Backup Filename** field. Refer to [this section](#getting-the-backup-filename-from-s3) for exact steps on getting the backup filename from s3. Fill in all the details for the S3 compatible object store. Its fields are exactly same as ones for the `backup.StorageLocation` configuration in the [Backup custom resource.](../../configuration/backup-config/#storage-location) +Select this option if no default storage location is configured at the operator-level, OR if the backup file exists in a different S3 bucket than the one configured as the default storage location. Provide the exact filename in the **Backup Filename** field. Refer to [this section](#getting-the-backup-filename-from-s3) for exact steps on getting the backup filename from s3. Fill in all the details for the S3 compatible object store. Its fields are exactly same as ones for the `backup.StorageLocation` configuration in the [Backup custom resource.](backup-configuration.md#storage-location) -{{< img "/img/rancher/backup_restore/restore/s3store.png" "">}} +![](/img/backup_restore/restore/s3store.png) # Encryption If the backup was created with encryption enabled, its file will have `.enc` suffix. Choosing such a Backup, or providing a backup filename with `.enc` suffix will display another dropdown named **Encryption Config Secret**. -{{< img "/img/rancher/backup_restore/restore/encryption.png" "">}} +![](/img/backup_restore/restore/encryption.png) The Secret selected from this dropdown must have the same contents as the one used for the Backup custom resource while performing the backup. If the encryption configuration doesn't match, the restore will fail diff --git a/docs/en/backups/configuration/storage-config/storage-config.md b/docs/en/reference-guides/backup-restore-configuration/storage-configuration.md similarity index 88% rename from docs/en/backups/configuration/storage-config/storage-config.md rename to docs/en/reference-guides/backup-restore-configuration/storage-configuration.md index 1b2e8d889fc..5df67541fdf 100644 --- a/docs/en/backups/configuration/storage-config/storage-config.md +++ b/docs/en/reference-guides/backup-restore-configuration/storage-configuration.md @@ -26,7 +26,7 @@ You can choose to not have any operator-level storage location configured. If yo | Parameter | Description | | -------------- | -------------- | -| Credential Secret | Choose the credentials for S3 from your secrets in Rancher. [Example]({{}}/rancher/v2.6/en/backups/examples/#example-credential-secret-for-storing-backups-in-s3). | +| Credential Secret | Choose the credentials for S3 from your secrets in Rancher. [Example](examples.md#example-credential-secret-for-storing-backups-in-s3). | | Bucket Name | Enter the name of the [S3 bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html) where the backups will be stored. Default: `rancherbackups`. | | Region | The [AWS region](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) where the S3 bucket is located. | | Folder | The [folder in the S3 bucket](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-folders.html) where the backups will be stored. | @@ -38,7 +38,7 @@ You can choose to not have any operator-level storage location configured. If yo Installing the `rancher-backup` chart by selecting the StorageClass option will create a Persistent Volume Claim (PVC), and Kubernetes will in turn dynamically provision a Persistent Volume (PV) where all the backups will be saved by default. -For information about creating storage classes refer to [this section.]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/provisioning-new-storage/) +For information about creating storage classes refer to [this section.](../../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/dynamically-provision-new-storage.md) ::: note Important: @@ -49,7 +49,7 @@ If no such StorageClass is available, after the PV is provisioned, make sure to ### Existing Persistent Volume -Select an existing Persistent Volume (PV) that will be used to store your backups. For information about creating PersistentVolumes in Rancher, refer to [this section.]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/attaching-existing-storage/#2-add-a-persistent-volume-that-refers-to-the-persistent-storage) +Select an existing Persistent Volume (PV) that will be used to store your backups. For information about creating PersistentVolumes in Rancher, refer to [this section.](../../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/set-up-existing-storage.md#2-add-a-persistent-volume-that-refers-to-the-persistent-storage) :::note Important: diff --git a/docs/en/best-practices/rancher-managed/logging/logging.md b/docs/en/reference-guides/best-practices/rancher-managed-clusters/logging-best-practices.md similarity index 100% rename from docs/en/best-practices/rancher-managed/logging/logging.md rename to docs/en/reference-guides/best-practices/rancher-managed-clusters/logging-best-practices.md diff --git a/docs/en/best-practices/rancher-managed/monitoring/monitoring.md b/docs/en/reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices.md similarity index 93% rename from docs/en/best-practices/rancher-managed/monitoring/monitoring.md rename to docs/en/reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices.md index 0abd7a2d515..166eb9442d2 100644 --- a/docs/en/best-practices/rancher-managed/monitoring/monitoring.md +++ b/docs/en/reference-guides/best-practices/rancher-managed-clusters/monitoring-best-practices.md @@ -5,7 +5,7 @@ weight: 2 Configuring sensible monitoring and alerting rules is vital for running any production workloads securely and reliably. This is not different when using Kubernetes and Rancher. Fortunately the integrated monitoring and alerting functionality makes this whole process a lot easier. -The [Rancher monitoring documentation]({{}}/rancher/v2.6/en/monitoring-alerting/) describes how you can set up a complete Prometheus and Grafana stack. Out of the box this will scrape monitoring data from all system and Kubernetes components in your cluster and provide sensible dashboards and alerts for them to get started. But for a reliable setup, you also need to monitor your own workloads and adapt Prometheus and Grafana to your own specific use cases and cluster sizes. This document aims to give you best practices for this. +The [Rancher monitoring documentation](../../../pages-for-subheaders/monitoring-and-alerting.md) describes how you can set up a complete Prometheus and Grafana stack. Out of the box this will scrape monitoring data from all system and Kubernetes components in your cluster and provide sensible dashboards and alerts for them to get started. But for a reliable setup, you also need to monitor your own workloads and adapt Prometheus and Grafana to your own specific use cases and cluster sizes. This document aims to give you best practices for this. - [What to Monitor](#what-to-monitor) - [Configuring Prometheus Resource Usage](#configuring-prometheus-resource-usage) @@ -103,7 +103,7 @@ Monitoring the availability and performance of all your internal workloads is vi # Security Monitoring -In addition to monitoring workloads to detect performance, availability or scalability problems, the cluster and the workloads running into it should also be monitored for potential security problems. A good starting point is to frequently run and alert on [CIS Scans]({{}}/rancher/v2.6/en/cis-scans/) which check if the cluster is configured according to security best practices. +In addition to monitoring workloads to detect performance, availability or scalability problems, the cluster and the workloads running into it should also be monitored for potential security problems. A good starting point is to frequently run and alert on [CIS Scans](../../../pages-for-subheaders/cis-scan-guides.md) which check if the cluster is configured according to security best practices. For the workloads, you can have a look at Kubernetes and Container security solutions like [Falco](https://falco.org/), [Aqua Kubernetes Security](https://www.aquasec.com/solutions/kubernetes-container-security/), [SysDig](https://sysdig.com/). @@ -117,4 +117,4 @@ When setting up alerts, configure them for all the workloads that are critical t If an alert starts firing, but there is nothing you can do about it at the moment, it's also fine to silence the alert for a certain amount of time, so that you can look at it later. -You can find more information on how to set up alerts and notification channels in the [Rancher Documentation]({{}}/rancher/v2.6/en/monitoring-alerting). +You can find more information on how to set up alerts and notification channels in the [Rancher Documentation](../../../pages-for-subheaders/monitoring-and-alerting.md). diff --git a/docs/en/best-practices/rancher-managed/managed-vsphere/managed-vsphere.md b/docs/en/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere.md similarity index 97% rename from docs/en/best-practices/rancher-managed/managed-vsphere/managed-vsphere.md rename to docs/en/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere.md index d355cdca047..1f7f08da9c3 100644 --- a/docs/en/best-practices/rancher-managed/managed-vsphere/managed-vsphere.md +++ b/docs/en/reference-guides/best-practices/rancher-managed-clusters/rancher-managed-clusters-in-vsphere.md @@ -12,7 +12,7 @@ This guide outlines a reference architecture for provisioning downstream Rancher
Solution Overview
-![Solution Overview]({{}}/img/rancher/solution_overview.drawio.svg) +![Solution Overview](/img/solution_overview.drawio.svg) # 1. VM Considerations diff --git a/docs/en/best-practices/rancher-managed/containers/containers.md b/docs/en/reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers.md similarity index 100% rename from docs/en/best-practices/rancher-managed/containers/containers.md rename to docs/en/reference-guides/best-practices/rancher-managed-clusters/tips-to-set-up-containers.md diff --git a/docs/en/best-practices/rancher-server/rancher-in-vsphere/rancher-in-vsphere.md b/docs/en/reference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere.md similarity index 98% rename from docs/en/best-practices/rancher-server/rancher-in-vsphere/rancher-in-vsphere.md rename to docs/en/reference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere.md index 207ab8accb2..3a0f0ca3448 100644 --- a/docs/en/best-practices/rancher-server/rancher-in-vsphere/rancher-in-vsphere.md +++ b/docs/en/reference-guides/best-practices/rancher-server/on-premises-rancher-in-vsphere.md @@ -14,7 +14,7 @@ This guide outlines a reference architecture for installing Rancher on an RKE Ku
Solution Overview
-![Solution Overview](/docs/img/rancher/rancher-on-prem-vsphere.svg) +![Solution Overview](/img/rancher-on-prem-vsphere.svg) # 1. Load Balancer Considerations diff --git a/docs/en/best-practices/rancher-server/deployment-strategies/deployment-strategies.md b/docs/en/reference-guides/best-practices/rancher-server/rancher-deployment-strategy.md similarity index 92% rename from docs/en/best-practices/rancher-server/deployment-strategies/deployment-strategies.md rename to docs/en/reference-guides/best-practices/rancher-server/rancher-deployment-strategy.md index b2544d473b5..c31fdec2fdc 100644 --- a/docs/en/best-practices/rancher-server/deployment-strategies/deployment-strategies.md +++ b/docs/en/reference-guides/best-practices/rancher-server/rancher-deployment-strategy.md @@ -13,7 +13,7 @@ There are two recommended deployment strategies for a Rancher server that manage In this deployment scenario, there is a single Rancher control plane managing Kubernetes clusters across the globe. The control plane would be run on a high-availability Kubernetes cluster, and there would be impact due to latencies. -{{< img "/img/rancher/bpg/hub-and-spoke.png" "Hub and Spoke Deployment">}} +![](/img/bpg/hub-and-spoke.png) ### Pros @@ -30,7 +30,7 @@ In this deployment scenario, there is a single Rancher control plane managing Ku --- In the regional deployment model a control plane is deployed in close proximity to the compute nodes. -{{< img "/img/rancher/bpg/regional.png" "Regional Deployment">}} +![](/img/bpg/regional.png) ### Pros diff --git a/docs/en/best-practices/rancher-server/deployment-types/deployment-types.md b/docs/en/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md similarity index 84% rename from docs/en/best-practices/rancher-server/deployment-types/deployment-types.md rename to docs/en/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index 35e0fcaf41a..a4c0d828037 100644 --- a/docs/en/best-practices/rancher-server/deployment-types/deployment-types.md +++ b/docs/en/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -7,7 +7,7 @@ This guide is geared toward use cases where Rancher is used to manage downstream A high-availability Kubernetes installation, defined as an installation of Rancher on a Kubernetes cluster with at least three nodes, should be used in any production installation of Rancher, as well as any installation deemed "important." Multiple Rancher instances running on multiple nodes ensure high availability that cannot be accomplished with a single node environment. -If you are installing Rancher in a vSphere environment, refer to the best practices documented [here.](../rancher-in-vsphere) +If you are installing Rancher in a vSphere environment, refer to the best practices documented [here.](on-premises-rancher-in-vsphere.md) When you set up your high-availability Rancher installation, consider the following: @@ -27,11 +27,11 @@ For best performance, run all three of your nodes in the same geographic datacen It's strongly recommended to have a "staging" or "pre-production" environment of the Kubernetes cluster that Rancher runs on. This environment should mirror your production environment as closely as possible in terms of software and hardware configuration. ### Monitor Your Clusters to Plan Capacity -The Rancher server's Kubernetes cluster should run within the [system and hardware requirements]({{}}/rancher/v2.6/en/installation/requirements/) as closely as possible. The more you deviate from the system and hardware requirements, the more risk you take. +The Rancher server's Kubernetes cluster should run within the [system and hardware requirements](../../../pages-for-subheaders/installation-requirements.md) as closely as possible. The more you deviate from the system and hardware requirements, the more risk you take. However, metrics-driven capacity planning analysis should be the ultimate guidance for scaling Rancher, because the published requirements take into account a variety of workload types. Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with Prometheus, a leading open-source monitoring solution, and Grafana, which lets you visualize the metrics from Prometheus. -After you [enable monitoring]({{}}/rancher/v2.6/en/monitoring-alerting) in the cluster, you can set up alerts to let you know if your cluster is approaching its capacity. You can also use the Prometheus and Grafana monitoring framework to establish a baseline for key metrics as you scale. +After you [enable monitoring](../../../pages-for-subheaders/monitoring-and-alerting.md) in the cluster, you can set up alerts to let you know if your cluster is approaching its capacity. You can also use the Prometheus and Grafana monitoring framework to establish a baseline for key metrics as you scale. diff --git a/docs/en/reference-guides/cli-with-rancher/kubectl-utility.md b/docs/en/reference-guides/cli-with-rancher/kubectl-utility.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/reference-guides/cli-with-rancher/kubectl-utility.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/reference-guides/cli-with-rancher/rancher-cli.md b/docs/en/reference-guides/cli-with-rancher/rancher-cli.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/reference-guides/cli-with-rancher/rancher-cli.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-machine-config/ec2-machine-config.md b/docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/amazon-ec2.md similarity index 93% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-machine-config/ec2-machine-config.md rename to docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/amazon-ec2.md index d29a7567669..4b00f3e1bf1 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-machine-config/ec2-machine-config.md +++ b/docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/amazon-ec2.md @@ -43,7 +43,7 @@ The username for connecting to your launched instances. Refer to [here](https:// Choose the default security group or configure a security group. -Please refer to [Amazon EC2 security group when using Node Driver]({{}}/rancher/v2.6/en/installation/requirements/ports/#rancher-aws-ec2-security-group) to see what rules are created in the `rancher-nodes` Security Group. +Please refer to [Amazon EC2 security group when using Node Driver](../../../../getting-started/installation-and-upgrade/installation-requirements/port-requirements.md#rancher-aws-ec2-security-group) to see what rules are created in the `rancher-nodes` Security Group. ### EBS Root Volume Type diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/azure/azure-machine-config/azure-machine-config.md b/docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/azure.md similarity index 100% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/azure/azure-machine-config/azure-machine-config.md rename to docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/azure.md diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-machine-config/do-machine-config.md b/docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/digitalocean.md similarity index 100% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-machine-config/do-machine-config.md rename to docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/machine-configuration/digitalocean.md diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-node-template-config/ec2-node-template-config.md b/docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/amazon-ec2.md similarity index 54% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-node-template-config/ec2-node-template-config.md rename to docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/amazon-ec2.md index 4da61dccaf7..8a72e8be2b6 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-node-template-config/ec2-node-template-config.md +++ b/docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/amazon-ec2.md @@ -10,7 +10,7 @@ In the **Region** field, select the same region that you used when creating your ### Cloud Credentials -Your AWS account access information, stored in a [cloud credential.]({{}}/rancher/v2.6/en/user-settings/cloud-credentials/) +Your AWS account access information, stored in a [cloud credential.](../../../user-settings/manage-cloud-credentials.md) See [Amazon Documentation: Creating Access Keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html#Using_CreateAccessKey) how to create an Access Key and Secret Key. @@ -20,9 +20,9 @@ See [Amazon Documentation: Adding Permissions to a User (Console)](https://docs. See our three example JSON policies: -- [Example IAM Policy]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/#example-iam-policy) -- [Example IAM Policy with PassRole]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/#example-iam-policy-with-passrole) (needed if you want to use [Kubernetes Cloud Provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers) or want to pass an IAM Profile to an instance) -- [Example IAM Policy to allow encrypted EBS volumes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/#example-iam-policy-to-allow-encrypted-ebs-volumes) policy to an user. +- [Example IAM Policy](../../../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster.md#example-iam-policy) +- [Example IAM Policy with PassRole](../../../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster.md#example-iam-policy-with-passrole) (needed if you want to use [Kubernetes Cloud Provider](../../../../pages-for-subheaders/set-up-cloud-providers.md) or want to pass an IAM Profile to an instance) +- [Example IAM Policy to allow encrypted EBS volumes](../../../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/create-an-amazon-ec2-cluster.md#example-iam-policy-to-allow-encrypted-ebs-volumes) policy to an user. ### Authenticate & Configure Nodes @@ -32,18 +32,18 @@ Choose an availability zone and network settings for your cluster. Choose the default security group or configure a security group. -Please refer to [Amazon EC2 security group when using Node Driver]({{}}/rancher/v2.6/en/installation/requirements/ports/#rancher-aws-ec2-security-group) to see what rules are created in the `rancher-nodes` Security Group. +Please refer to [Amazon EC2 security group when using Node Driver](../../../../getting-started/installation-and-upgrade/installation-requirements/port-requirements.md#rancher-aws-ec2-security-group) to see what rules are created in the `rancher-nodes` Security Group. --- **_New in v2.6.4_** -If you provide your own security group for an EC2 instance, please note that Rancher will not modify it. As such, you will be responsible for ensuring that your security group is set to allow the [necessary ports for Rancher to provision the instance]({{}}/rancher/v2.6/en/installation/requirements/ports/#ports-for-rancher-server-nodes-on-rke). For more information on controlling inbound and outbound traffic to EC2 instances with security groups, refer [here](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#WorkingWithSecurityGroups). +If you provide your own security group for an EC2 instance, please note that Rancher will not modify it. As such, you will be responsible for ensuring that your security group is set to allow the [necessary ports for Rancher to provision the instance](../../../../getting-started/installation-and-upgrade/installation-requirements/port-requirements.md#ports-for-rancher-server-nodes-on-rke). For more information on controlling inbound and outbound traffic to EC2 instances with security groups, refer [here](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#WorkingWithSecurityGroups). ### Instance Options Configure the instances that will be created. Make sure you configure the correct **SSH User** for the configured AMI. It is possible that a selected region does not support the default instance type. In this scenario you must select an instance type that does exist, otherwise an error will occur stating the requested configuration is not supported. -If you need to pass an **IAM Instance Profile Name** (not ARN), for example, when you want to use a [Kubernetes Cloud Provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers), you will need an additional permission in your policy. See [Example IAM policy with PassRole](#example-iam-policy-with-passrole) for an example policy. +If you need to pass an **IAM Instance Profile Name** (not ARN), for example, when you want to use a [Kubernetes Cloud Provider](../../../../pages-for-subheaders/set-up-cloud-providers.md), you will need an additional permission in your policy. See [Example IAM policy with PassRole](#example-iam-policy-with-passrole) for an example policy. ### Engine Options diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/azure/azure-node-template-config/azure-node-template-config.md b/docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/azure.md similarity index 100% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/azure/azure-node-template-config/azure-node-template-config.md rename to docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/azure.md diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-node-template-config/do-node-template-config.md b/docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/digitalocean.md similarity index 100% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-node-template-config/do-node-template-config.md rename to docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/digitalocean.md diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/nutanix/nutanix-node-template-config/nutanix-node-template-config.md b/docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/nutanix.md similarity index 100% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/nutanix/nutanix-node-template-config/nutanix-node-template-config.md rename to docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/nutanix.md diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/vsphere-node-template-config.md b/docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere.md similarity index 96% rename from docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/vsphere-node-template-config.md rename to docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere.md index bd446a50462..81c66fd8416 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/vsphere-node-template-config.md +++ b/docs/en/reference-guides/cluster-configuration/downstream-cluster-configuration/node-template-configuration/vsphere.md @@ -14,7 +14,7 @@ weight: 2 | Parameter | Required | Description | |:----------------------|:--------:|:-----| -| Cloud Credentials | * | Your vSphere account access information, stored in a [cloud credential.]({{}}/rancher/v2.6/en/user-settings/cloud-credentials/) | +| Cloud Credentials | * | Your vSphere account access information, stored in a [cloud credential.](../../../user-settings/manage-cloud-credentials.md) | Your cloud credential has these fields: @@ -50,7 +50,7 @@ In the **Instance Options** section, configure the number of vCPUs, memory, and | Creation method | * | The method for setting up an operating system on the node. The operating system can be installed from an ISO or from a VM template. Depending on the creation method, you will also have to specify a VM template, content library, existing VM, or ISO. For more information on creation methods, refer to [About VM Creation Methods.](#about-vm-creation-methods) | | Cloud Init | | URL of a `cloud-config.yml` file or URL to provision VMs with. This file allows further customization of the operating system, such as network configuration, DNS servers, or system daemons. The operating system must support `cloud-init`. | | Networks | | Name(s) of the network to attach the VM to. | -| Configuration Parameters used for guestinfo | | Additional configuration parameters for the VMs. These correspond to the [Advanced Settings](https://kb.vmware.com/s/article/1016098) in the vSphere console. Example use cases include providing RancherOS [guestinfo]({{< baseurl >}}/os/v1.x/en/installation/cloud/vmware-esxi/#vmware-guestinfo) parameters or enabling disk UUIDs for the VMs (`disk.EnableUUID=TRUE`). | +| Configuration Parameters used for guestinfo | | Additional configuration parameters for the VMs. These correspond to the [Advanced Settings](https://kb.vmware.com/s/article/1016098) in the vSphere console. Example use cases include providing RancherOS [guestinfo]({{}}/os/v1.x/en/installation/cloud/vmware-esxi/#vmware-guestinfo) parameters or enabling disk UUIDs for the VMs (`disk.EnableUUID=TRUE`). | ### About VM Creation Methods diff --git a/docs/en/cluster-admin/editing-clusters/aks-config-reference/aks-config-reference.md b/docs/en/reference-guides/cluster-configuration/rancher-server-configuration/aks-cluster-configuration.md similarity index 98% rename from docs/en/cluster-admin/editing-clusters/aks-config-reference/aks-config-reference.md rename to docs/en/reference-guides/cluster-configuration/rancher-server-configuration/aks-cluster-configuration.md index d6d6fa90bbb..d27ddf7f621 100644 --- a/docs/en/cluster-admin/editing-clusters/aks-config-reference/aks-config-reference.md +++ b/docs/en/reference-guides/cluster-configuration/rancher-server-configuration/aks-cluster-configuration.md @@ -15,13 +15,13 @@ weight: 4 When provisioning an AKS cluster in the Rancher UI, RBAC cannot be disabled. If role-based access control is disabled for the cluster in AKS, the cluster cannot be registered or imported into Rancher. -Rancher can configure member roles for AKS clusters in the same way as any other cluster. For more information, see the section on [role-based access control.]({{}}/rancher/v2.6/en/admin-settings/rbac) +Rancher can configure member roles for AKS clusters in the same way as any other cluster. For more information, see the section on [role-based access control.](../../../pages-for-subheaders/manage-role-based-access-control-rbac.md) # Cloud Credentials :::note -The configuration information in this section assumes you have already set up a service principal for Rancher. For step-by-step instructions for how to set up the service principal, see [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/aks/#prerequisites-in-microsoft-azure) +The configuration information in this section assumes you have already set up a service principal for Rancher. For step-by-step instructions for how to set up the service principal, see [this section.](../../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks.md#prerequisites-in-microsoft-azure) ::: diff --git a/docs/en/cluster-admin/editing-clusters/eks-config-reference/eks-config-reference.md b/docs/en/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md similarity index 99% rename from docs/en/cluster-admin/editing-clusters/eks-config-reference/eks-config-reference.md rename to docs/en/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md index b49e9ae8694..ad5e489d8d5 100644 --- a/docs/en/cluster-admin/editing-clusters/eks-config-reference/eks-config-reference.md +++ b/docs/en/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md @@ -11,7 +11,7 @@ Complete each drop-down and field using the information obtained for your IAM po | Setting | Description | | ---------- | -------------------------------------------------------------------------------------------------------------------- | | Region | From the drop-down choose the geographical region in which to build your cluster. | -| Cloud Credentials | Select the cloud credentials that you created for your IAM policy. For more information on creating cloud credentials in Rancher, refer to [this page.]({{}}/rancher/v2.6/en/user-settings/cloud-credentials/) | +| Cloud Credentials | Select the cloud credentials that you created for your IAM policy. For more information on creating cloud credentials in Rancher, refer to [this page.](../../user-settings/manage-cloud-credentials.md) | ### Service Role diff --git a/docs/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/private-clusters.md b/docs/en/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-private-clusters.md similarity index 100% rename from docs/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/private-clusters.md rename to docs/en/reference-guides/cluster-configuration/rancher-server-configuration/gke-cluster-configuration/gke-private-clusters.md diff --git a/docs/en/cluster-admin/editing-clusters/k3s-config-reference/k3s-config-reference.md b/docs/en/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md similarity index 94% rename from docs/en/cluster-admin/editing-clusters/k3s-config-reference/k3s-config-reference.md rename to docs/en/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md index a95b89c4935..a827719123c 100644 --- a/docs/en/cluster-admin/editing-clusters/k3s-config-reference/k3s-config-reference.md +++ b/docs/en/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md @@ -26,7 +26,7 @@ Some advanced configuration options are not exposed in the Rancher UI forms, but The version of Kubernetes installed on your cluster nodes. Rancher packages its own version of Kubernetes based on [hyperkube](https://github.com/rancher/hyperkube). -For more detail, see [Upgrading Kubernetes]({{}}/rancher/v2.6/en/cluster-admin/upgrading-kubernetes). +For more detail, see [Upgrading Kubernetes](../../../getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes.md). #### Encrypt Secrets @@ -108,9 +108,9 @@ Add additional hostnames or IPv4/IPv6 addresses as Subject Alternative Names on Authorized Cluster Endpoint can be used to directly access the Kubernetes API server, without requiring communication through Rancher. -For more detail on how an authorized cluster endpoint works and why it is used, refer to the [architecture section.]({{}}/rancher/v2.6/en/overview/architecture/#4-authorized-cluster-endpoint) +For more detail on how an authorized cluster endpoint works and why it is used, refer to the [architecture section.](../../../pages-for-subheaders/rancher-manager-architecture.md#4-authorized-cluster-endpoint) -We recommend using a load balancer with the authorized cluster endpoint. For details, refer to the [recommended architecture section.]({{}}/rancher/v2.6/en/overview/architecture-recommendations/#architecture-for-an-authorized-cluster-endpoint) +We recommend using a load balancer with the authorized cluster endpoint. For details, refer to the [recommended architecture section.](../../rancher-manager-architecture/architecture-recommendations.md#architecture-for-an-authorized-cluster-endpoint) ### Registries diff --git a/docs/en/cluster-admin/editing-clusters/rke-config-reference/rke-config-references.md b/docs/en/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md similarity index 69% rename from docs/en/cluster-admin/editing-clusters/rke-config-reference/rke-config-references.md rename to docs/en/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md index 2897a604911..fa0e21809b7 100644 --- a/docs/en/cluster-admin/editing-clusters/rke-config-reference/rke-config-references.md +++ b/docs/en/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md @@ -4,7 +4,7 @@ shortTitle: RKE Cluster Configuration weight: 1 --- -When Rancher installs Kubernetes, it uses [RKE]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) or [RKE2](https://docs.rke2.io/) as the Kubernetes distribution. +When Rancher installs Kubernetes, it uses [RKE](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) or [RKE2](https://docs.rke2.io/) as the Kubernetes distribution. This section covers the configuration options that are available in Rancher for a new or existing RKE Kubernetes cluster. @@ -48,11 +48,11 @@ You can configure the Kubernetes options one of two ways: The RKE cluster config options are nested under the `rancher_kubernetes_engine_config` directive. For more information, see the section about the [cluster config file.](#cluster-config-file) -In [clusters launched by RKE]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/), you can edit any of the remaining options that follow. +In [clusters launched by RKE](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md), you can edit any of the remaining options that follow. -For an example of RKE config file syntax, see the [RKE documentation]({{}}/rke/latest/en/example-yamls/). +For an example of RKE config file syntax, see the [RKE documentation](https://rancher.com/docs/rke/latest/en/example-yamls/). -The forms in the Rancher UI don't include all advanced options for configuring RKE. For the complete reference of configurable options for RKE Kubernetes clusters in YAML, see the [RKE documentation.]({{}}/rke/latest/en/config-options/) +The forms in the Rancher UI don't include all advanced options for configuring RKE. For the complete reference of configurable options for RKE Kubernetes clusters in YAML, see the [RKE documentation.](https://rancher.com/docs/rke/latest/en/config-options/) # Editing Clusters with a Form in the Rancher UI @@ -79,7 +79,7 @@ To edit an RKE config file directly from the Rancher UI, :::tip -Some advanced configuration options are not exposed in the Rancher UI forms, but they can be enabled by editing the RKE cluster configuration file in YAML. For the complete reference of configurable options for RKE Kubernetes clusters in YAML, see the [RKE documentation.]({{}}/rke/latest/en/config-options/) +Some advanced configuration options are not exposed in the Rancher UI forms, but they can be enabled by editing the RKE cluster configuration file in YAML. For the complete reference of configurable options for RKE Kubernetes clusters in YAML, see the [RKE documentation.](https://rancher.com/docs/rke/latest/en/config-options/) ::: @@ -87,11 +87,11 @@ Some advanced configuration options are not exposed in the Rancher UI forms, but The version of Kubernetes installed on your cluster nodes. Rancher packages its own version of Kubernetes based on [hyperkube](https://github.com/rancher/hyperkube). -For more detail, see [Upgrading Kubernetes]({{}}/rancher/v2.6/en/cluster-admin/upgrading-kubernetes). +For more detail, see [Upgrading Kubernetes](../../../getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes.md). ### Network Provider -The [Network Provider](https://kubernetes.io/docs/concepts/cluster-administration/networking/) that the cluster uses. For more details on the different networking providers, please view our [Networking FAQ]({{}}/rancher/v2.6/en/faq/networking/cni-providers/). +The [Network Provider](https://kubernetes.io/docs/concepts/cluster-administration/networking/) that the cluster uses. For more details on the different networking providers, please view our [Networking FAQ](../../../faq/container-network-interface-providers.md). :::caution @@ -108,7 +108,7 @@ Out of the box, Rancher is compatible with the following network providers: :::note Notes on Weave: -When Weave is selected as network provider, Rancher will automatically enable encryption by generating a random password. If you want to specify the password manually, please see how to configure your cluster using a [Config File]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#cluster-config-file) and the [Weave Network Plug-in Options]({{}}/rke/latest/en/config-options/add-ons/network-plugins/#weave-network-plug-in-options). +When Weave is selected as network provider, Rancher will automatically enable encryption by generating a random password. If you want to specify the password manually, please see how to configure your cluster using a [Config File](cluster-provisioning/rke-clusters/options/#cluster-config-file) and the [Weave Network Plug-in Options](https://rancher.com/docs/rke/latest/en/config-options/add-ons/network-plugins/#weave-network-plug-in-options). ::: @@ -120,11 +120,11 @@ Project network isolation is available if you are using any RKE network plugin t ### Kubernetes Cloud Providers -You can configure a [Kubernetes cloud provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers). If you want to use dynamically provisioned [volumes and storage]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/) in Kubernetes, typically you must select the specific cloud provider in order to use it. For example, if you want to use Amazon EBS, you would need to select the `aws` cloud provider. +You can configure a [Kubernetes cloud provider](../../../pages-for-subheaders/set-up-cloud-providers.md). If you want to use dynamically provisioned [volumes and storage](../../../pages-for-subheaders/create-kubernetes-persistent-storage.md) in Kubernetes, typically you must select the specific cloud provider in order to use it. For example, if you want to use Amazon EBS, you would need to select the `aws` cloud provider. :::note -If the cloud provider you want to use is not listed as an option, you will need to use the [config file option](#cluster-config-file) to configure the cloud provider. Please reference the [RKE cloud provider documentation]({{}}/rke/latest/en/config-options/cloud-providers/) on how to configure the cloud provider. +If the cloud provider you want to use is not listed as an option, you will need to use the [config file option](#cluster-config-file) to configure the cloud provider. Please reference the [RKE cloud provider documentation](https://rancher.com/docs/rke/latest/en/config-options/cloud-providers/) on how to configure the cloud provider. ::: @@ -132,18 +132,18 @@ If the cloud provider you want to use is not listed as an option, you will need The cluster-level private registry configuration is only used for provisioning clusters. -There are two main ways to set up private registries in Rancher: by setting up the [global default registry]({{}}/rancher/v2.6/en/admin-settings/config-private-registry) through the **Settings** tab in the global view, and by setting up a private registry in the advanced options in the cluster-level settings. The global default registry is intended to be used for air-gapped setups, for registries that do not require credentials. The cluster-level private registry is intended to be used in all setups in which the private registry requires credentials. +There are two main ways to set up private registries in Rancher: by setting up the [global default registry](../../../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry.md) through the **Settings** tab in the global view, and by setting up a private registry in the advanced options in the cluster-level settings. The global default registry is intended to be used for air-gapped setups, for registries that do not require credentials. The cluster-level private registry is intended to be used in all setups in which the private registry requires credentials. If your private registry requires credentials, you need to pass the credentials to Rancher by editing the cluster options for each cluster that needs to pull images from the registry. -The private registry configuration option tells Rancher where to pull the [system images]({{}}/rke/latest/en/config-options/system-images/) or [addon images]({{}}/rke/latest/en/config-options/add-ons/) that will be used in your cluster. +The private registry configuration option tells Rancher where to pull the [system images](https://rancher.com/docs/rke/latest/en/config-options/system-images/) or [addon images](https://rancher.com/docs/rke/latest/en/config-options/add-ons/) that will be used in your cluster. - **System images** are components needed to maintain the Kubernetes cluster. - **Add-ons** are used to deploy several cluster components, including network plug-ins, the ingress controller, the DNS provider, or the metrics server. -For more information on setting up a private registry for components applied during the provisioning of the cluster, see the [RKE documentation on private registries]({{}}/rke/latest/en/config-options/private-registries/). +For more information on setting up a private registry for components applied during the provisioning of the cluster, see the [RKE documentation on private registries](https://rancher.com/docs/rke/latest/en/config-options/private-registries/). -Rancher v2.6 introduced the ability to configure [ECR registries for RKE clusters]({{}}/rke/latest/en/config-options/private-registries/#amazon-elastic-container-registry-ecr-private-registry-setup). +Rancher v2.6 introduced the ability to configure [ECR registries for RKE clusters](https://rancher.com/docs/rke/latest/en/config-options/private-registries/#amazon-elastic-container-registry-ecr-private-registry-setup). ### Authorized Cluster Endpoint @@ -151,19 +151,19 @@ Authorized Cluster Endpoint can be used to directly access the Kubernetes API se :::note -The authorized cluster endpoint only works on Rancher-launched Kubernetes clusters. In other words, it only works in clusters where Rancher [used RKE]({{}}/rancher/v2.6/en/overview/architecture/#tools-for-provisioning-kubernetes-clusters) to provision the cluster. It is not available for clusters in a hosted Kubernetes provider, such as Amazon's EKS. +The authorized cluster endpoint only works on Rancher-launched Kubernetes clusters. In other words, it only works in clusters where Rancher [used RKE](../../../pages-for-subheaders/rancher-manager-architecture.md#tools-for-provisioning-kubernetes-clusters) to provision the cluster. It is not available for clusters in a hosted Kubernetes provider, such as Amazon's EKS. ::: This is enabled by default in Rancher-launched Kubernetes clusters, using the IP of the node with the `controlplane` role and the default Kubernetes self signed certificates. -For more detail on how an authorized cluster endpoint works and why it is used, refer to the [architecture section.]({{}}/rancher/v2.6/en/overview/architecture/#4-authorized-cluster-endpoint) +For more detail on how an authorized cluster endpoint works and why it is used, refer to the [architecture section.](../../../pages-for-subheaders/rancher-manager-architecture.md#4-authorized-cluster-endpoint) -We recommend using a load balancer with the authorized cluster endpoint. For details, refer to the [recommended architecture section.]({{}}/rancher/v2.6/en/overview/architecture-recommendations/#architecture-for-an-authorized-cluster-endpoint) +We recommend using a load balancer with the authorized cluster endpoint. For details, refer to the [recommended architecture section.](../../rancher-manager-architecture/architecture-recommendations.md#architecture-for-an-authorized-cluster-endpoint) ### Node Pools -For information on using the Rancher UI to set up node pools in an RKE cluster, refer to [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools) +For information on using the Rancher UI to set up node pools in an RKE cluster, refer to [this page.](../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md) ### NGINX Ingress @@ -171,13 +171,13 @@ If you want to publish your applications in a high-availability configuration, a ### Metrics Server Monitoring -Option to enable or disable [Metrics Server]({{}}/rke/latest/en/config-options/add-ons/metrics-server/). +Option to enable or disable [Metrics Server](https://rancher.com/docs/rke/latest/en/config-options/add-ons/metrics-server/). Each cloud provider capable of launching a cluster using RKE can collect metrics and monitor for your cluster nodes. Enable this option to view your node metrics from your cloud provider's portal. ### Pod Security Policy Support -Enables [pod security policies]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/) for the cluster. After enabling this option, choose a policy using the **Default Pod Security Policy** drop-down. +Enables [pod security policies](../../../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies.md) for the cluster. After enabling this option, choose a policy using the **Default Pod Security Policy** drop-down. You must have an existing Pod Security Policy configured before you can use this option. @@ -203,11 +203,11 @@ Option to change the range of ports that can be used for [NodePort services](htt ### Recurring etcd Snapshots -Option to enable or disable [recurring etcd snapshots]({{}}/rke/latest/en/etcd-snapshots/#etcd-recurring-snapshots). +Option to enable or disable [recurring etcd snapshots](https://rancher.com/docs/rke/latest/en/etcd-snapshots/#etcd-recurring-snapshots). ### Agent Environment Variables -Option to set environment variables for [rancher agents]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/rancher-agents/). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables. +Option to set environment variables for [rancher agents](../../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/about-rancher-agents.md). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables. ### Updating ingress-nginx @@ -219,13 +219,13 @@ If the `updateStrategy` of `ingress-nginx` is `OnDelete`, you will need to delet # RKE Cluster Config File Reference -Instead of using the Rancher UI to choose Kubernetes options for the cluster, advanced users can create an RKE config file. Using a config file allows you to set any of the [options available]({{}}/rke/latest/en/config-options/) in an RKE installation, except for `system_images` configuration. The `system_images` option is not supported when creating a cluster with the Rancher UI or API. +Instead of using the Rancher UI to choose Kubernetes options for the cluster, advanced users can create an RKE config file. Using a config file allows you to set any of the [options available](https://rancher.com/docs/rke/latest/en/config-options/) in an RKE installation, except for `system_images` configuration. The `system_images` option is not supported when creating a cluster with the Rancher UI or API. -For the complete reference for configurable options for RKE Kubernetes clusters in YAML, see the [RKE documentation.]({{}}/rke/latest/en/config-options/) +For the complete reference for configurable options for RKE Kubernetes clusters in YAML, see the [RKE documentation.](https://rancher.com/docs/rke/latest/en/config-options/) ### Config File Structure in Rancher -RKE (Rancher Kubernetes Engine) is the tool that Rancher uses to provision Kubernetes clusters. Rancher's cluster config files used to have the same structure as [RKE config files,]({{}}/rke/latest/en/example-yamls/) but the structure changed so that in Rancher, RKE cluster config items are separated from non-RKE config items. Therefore, configuration for your cluster needs to be nested under the `rancher_kubernetes_engine_config` directive in the cluster config file. Cluster config files created with earlier versions of Rancher will need to be updated for this format. An example cluster config file is included below. +RKE (Rancher Kubernetes Engine) is the tool that Rancher uses to provision Kubernetes clusters. Rancher's cluster config files used to have the same structure as [RKE config files,](https://rancher.com/docs/rke/latest/en/example-yamls/) but the structure changed so that in Rancher, RKE cluster config items are separated from non-RKE config items. Therefore, configuration for your cluster needs to be nested under the `rancher_kubernetes_engine_config` directive in the cluster config file. Cluster config files created with earlier versions of Rancher will need to be updated for this format. An example cluster config file is included below.
Example Cluster Config File @@ -324,7 +324,7 @@ windows_prefered_cluster: false ### Default DNS provider -The table below indicates what DNS provider is deployed by default. See [RKE documentation on DNS provider]({{}}/rke/latest/en/config-options/add-ons/dns/) for more information how to configure a different DNS provider. CoreDNS can only be used on Kubernetes v1.12.0 and higher. +The table below indicates what DNS provider is deployed by default. See [RKE documentation on DNS provider](https://rancher.com/docs/rke/latest/en/config-options/add-ons/dns/) for more information how to configure a different DNS provider. CoreDNS can only be used on Kubernetes v1.12.0 and higher. | Rancher version | Kubernetes version | Default DNS provider | |-------------|--------------------|----------------------| @@ -342,7 +342,7 @@ See [Docker Root Directory](#docker-root-directory). ### enable_cluster_monitoring -Option to enable or disable [Cluster Monitoring]({{}}/rancher/v2.6/en/monitoring-alerting/). +Option to enable or disable [Cluster Monitoring](../../../pages-for-subheaders/monitoring-and-alerting.md). ### enable_network_policy @@ -368,11 +368,11 @@ local_cluster_auth_endpoint: ### Custom Network Plug-in -You can add a custom network plug-in by using the [user-defined add-on functionality]({{}}/rke/latest/en/config-options/add-ons/user-defined-add-ons/) of RKE. You define any add-on that you want deployed after the Kubernetes cluster is deployed. +You can add a custom network plug-in by using the [user-defined add-on functionality](https://rancher.com/docs/rke/latest/en/config-options/add-ons/user-defined-add-ons/) of RKE. You define any add-on that you want deployed after the Kubernetes cluster is deployed. There are two ways that you can specify an add-on: -- [In-line Add-ons]({{}}/rke/latest/en/config-options/add-ons/user-defined-add-ons/#in-line-add-ons) -- [Referencing YAML Files for Add-ons]({{}}/rke/latest/en/config-options/add-ons/user-defined-add-ons/#referencing-yaml-files-for-add-ons) +- [In-line Add-ons](https://rancher.com/docs/rke/latest/en/config-options/add-ons/user-defined-add-ons/#in-line-add-ons) +- [Referencing YAML Files for Add-ons](https://rancher.com/docs/rke/latest/en/config-options/add-ons/user-defined-add-ons/#referencing-yaml-files-for-add-ons) -For an example of how to configure a custom network plug-in by editing the `cluster.yml`, refer to the [RKE documentation.]({{}}/rke/latest/en/config-options/add-ons/network-plugins/custom-network-plugin-example) +For an example of how to configure a custom network plug-in by editing the `cluster.yml`, refer to the [RKE documentation.](https://rancher.com/docs/rke/latest/en/config-options/add-ons/network-plugins/custom-network-plugin-example) diff --git a/docs/en/cluster-admin/editing-clusters/rke2-config-reference/rke2-config-reference.md b/docs/en/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md similarity index 83% rename from docs/en/cluster-admin/editing-clusters/rke2-config-reference/rke2-config-reference.md rename to docs/en/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md index dcbdcadca9f..fa11f572140 100644 --- a/docs/en/cluster-admin/editing-clusters/rke2-config-reference/rke2-config-reference.md +++ b/docs/en/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md @@ -26,7 +26,7 @@ Some advanced configuration options are not exposed in the Rancher UI forms, but The version of Kubernetes installed on your cluster nodes. Rancher packages its own version of Kubernetes based on [hyperkube](https://github.com/rancher/hyperkube). -For more detail, see [Upgrading Kubernetes]({{}}/rancher/v2.6/en/cluster-admin/upgrading-kubernetes). +For more detail, see [Upgrading Kubernetes](../../../getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes.md). #### Container Network Provider @@ -45,7 +45,7 @@ Out of the box, Rancher is compatible with the following network providers: - [Calico](https://docs.projectcalico.org/v3.11/introduction/) - [Multus](https://github.com/k8snetworkplumbingwg/multus-cni) -\* When using [project network isolation](#project-network-isolation) in the [Cilium CNI]({{}}/rancher/v2.6/en/faq/networking/cni-providers/#cilium), it is possible to enable cross-node ingress routing. Click the [CNI provider docs]({{}}/rancher/v2.6/en/faq/networking/cni-providers/#ingress-routing-across-nodes-in-cilium) to learn more. +\* When using [project network isolation](#project-network-isolation) in the [Cilium CNI](../../../faq/container-network-interface-providers.md#cilium), it is possible to enable cross-node ingress routing. Click the [CNI provider docs](../../../faq/container-network-interface-providers.md#ingress-routing-across-nodes-in-cilium) to learn more. For more details on the different networking providers and how to configure them, please view our [RKE2 documentation](https://docs.rke2.io/install/network_options/). @@ -59,21 +59,21 @@ When using `cilium` or `multus,cilium` as your container network interface provi #### Cloud Provider -You can configure a [Kubernetes cloud provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers). If you want to use dynamically provisioned [volumes and storage]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/) in Kubernetes, typically you must select the specific cloud provider in order to use it. For example, if you want to use Amazon EBS, you would need to select the `aws` cloud provider. +You can configure a [Kubernetes cloud provider](../../../pages-for-subheaders/set-up-cloud-providers.md). If you want to use dynamically provisioned [volumes and storage](../../../pages-for-subheaders/create-kubernetes-persistent-storage.md) in Kubernetes, typically you must select the specific cloud provider in order to use it. For example, if you want to use Amazon EBS, you would need to select the `aws` cloud provider. :::note -If the cloud provider you want to use is not listed as an option, you will need to use the [config file option](#cluster-config-file) to configure the cloud provider. Please reference [this documentation]({{}}/rke/latest/en/config-options/cloud-providers/) on how to configure the cloud provider. +If the cloud provider you want to use is not listed as an option, you will need to use the [config file option](#cluster-config-file) to configure the cloud provider. Please reference [this documentation](https://rancher.com/docs/rke/latest/en/config-options/cloud-providers/) on how to configure the cloud provider. ::: #### Default Pod Security Policy -Choose the default [pod security policy]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/) for the cluster. Please refer to the [RKE2 documentation](https://docs.rke2.io/security/policies/) on the specifications of each available policy. +Choose the default [pod security policy](../../../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies.md) for the cluster. Please refer to the [RKE2 documentation](https://docs.rke2.io/security/policies/) on the specifications of each available policy. #### Worker CIS Profile -Select a [CIS benchmark]({{}}/rancher/v2.6/en/cis-scans/) to validate the system configuration against. +Select a [CIS benchmark](../../../pages-for-subheaders/cis-scan-guides.md) to validate the system configuration against. #### Project Network Isolation @@ -97,7 +97,7 @@ Refer to the [RKE2 documentation](https://docs.rke2.io/networking/#nginx-ingress #### Metrics Server -Option to enable or disable [Metrics Server]({{}}/rke/latest/en/config-options/add-ons/metrics-server/). +Option to enable or disable [Metrics Server](https://rancher.com/docs/rke/latest/en/config-options/add-ons/metrics-server/). Each cloud provider capable of launching a cluster using RKE2 can collect metrics and monitor for your cluster nodes. Enable this option to view your node metrics from your cloud provider's portal. @@ -163,9 +163,9 @@ Authorized Cluster Endpoint can be used to directly access the Kubernetes API se This is enabled by default in Rancher-launched Kubernetes clusters, using the IP of the node with the `controlplane` role and the default Kubernetes self signed certificates. -For more detail on how an authorized cluster endpoint works and why it is used, refer to the [architecture section.]({{}}/rancher/v2.6/en/overview/architecture/#4-authorized-cluster-endpoint) +For more detail on how an authorized cluster endpoint works and why it is used, refer to the [architecture section.](../../../pages-for-subheaders/rancher-manager-architecture.md#4-authorized-cluster-endpoint) -We recommend using a load balancer with the authorized cluster endpoint. For details, refer to the [recommended architecture section.]({{}}/rancher/v2.6/en/overview/architecture-recommendations/#architecture-for-an-authorized-cluster-endpoint) +We recommend using a load balancer with the authorized cluster endpoint. For details, refer to the [recommended architecture section.](../../rancher-manager-architecture/architecture-recommendations.md#architecture-for-an-authorized-cluster-endpoint) ### Registries diff --git a/docs/en/cluster-admin/editing-clusters/syncing/syncing.md b/docs/en/reference-guides/cluster-configuration/rancher-server-configuration/sync-clusters.md similarity index 100% rename from docs/en/cluster-admin/editing-clusters/syncing/syncing.md rename to docs/en/reference-guides/cluster-configuration/rancher-server-configuration/sync-clusters.md diff --git a/docs/en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/agent-options.md b/docs/en/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/rancher-agent-options.md similarity index 93% rename from docs/en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/agent-options.md rename to docs/en/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/rancher-agent-options.md index 12670480979..39413de95ba 100644 --- a/docs/en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/agent-options.md +++ b/docs/en/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/rancher-agent-options.md @@ -3,9 +3,9 @@ title: Rancher Agent Options weight: 2500 --- -Rancher deploys an agent on each node to communicate with the node. This pages describes the options that can be passed to the agent. To use these options, you will need to [create a cluster with custom nodes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes) and add the options to the generated `docker run` command when adding a node. +Rancher deploys an agent on each node to communicate with the node. This pages describes the options that can be passed to the agent. To use these options, you will need to [create a cluster with custom nodes](../../../../pages-for-subheaders/use-existing-nodes.md) and add the options to the generated `docker run` command when adding a node. -For an overview of how Rancher communicates with downstream clusters using node agents, refer to the [architecture section.]({{}}/rancher/v2.6/en/overview/architecture/#3-node-agents) +For an overview of how Rancher communicates with downstream clusters using node agents, refer to the [architecture section.](../../../../pages-for-subheaders/rancher-manager-architecture.md#3-node-agents) ## General options diff --git a/docs/en/admin-settings/authentication/openldap/openldap-config/openldap-config.md b/docs/en/reference-guides/configure-openldap/openldap-config-reference.md similarity index 90% rename from docs/en/admin-settings/authentication/openldap/openldap-config/openldap-config.md rename to docs/en/reference-guides/configure-openldap/openldap-config-reference.md index cf53e751945..1a02ee9b236 100644 --- a/docs/en/admin-settings/authentication/openldap/openldap-config/openldap-config.md +++ b/docs/en/reference-guides/configure-openldap/openldap-config-reference.md @@ -7,7 +7,7 @@ This section is intended to be used as a reference when setting up an OpenLDAP a For further details on configuring OpenLDAP, refer to the [official documentation.](https://www.openldap.org/doc/) -> Before you proceed with the configuration, please familiarize yourself with the concepts of [External Authentication Configuration and Principal Users]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). +> Before you proceed with the configuration, please familiarize yourself with the concepts of [External Authentication Configuration and Principal Users](../../pages-for-subheaders/about-authentication.md#external-authentication-configuration-and-principal-users). - [Background: OpenLDAP Authentication Flow](#background-openldap-authentication-flow) - [OpenLDAP server configuration](#openldap-server-configuration) @@ -30,7 +30,7 @@ You will need to enter the address, port, and protocol to connect to your OpenLD > > If the certificate used by the OpenLDAP server is self-signed or not from a recognized certificate authority, make sure have at hand the CA certificate (concatenated with any intermediate certificates) in PEM format. You will have to paste in this certificate during the configuration so that Rancher is able to validate the certificate chain. -If you are in doubt about the correct values to enter in the user/group Search Base configuration fields, consult your LDAP administrator or refer to the section [Identify Search Base and Schema using ldapsearch]({{}}/rancher/v2.6/en/admin-settings/authentication/ad/#annex-identify-search-base-and-schema-using-ldapsearch) in the Active Directory authentication documentation. +If you are in doubt about the correct values to enter in the user/group Search Base configuration fields, consult your LDAP administrator or refer to the section [Identify Search Base and Schema using ldapsearch](../../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-active-directory.md#annex-identify-search-base-and-schema-using-ldapsearch) in the Active Directory authentication documentation.
OpenLDAP Server Parameters
@@ -51,7 +51,7 @@ If your OpenLDAP directory deviates from the standard OpenLDAP schema, you must Note that the attribute mappings configured in this section are used by Rancher to construct search filters and resolve group membership. It is therefore always recommended to verify that the configuration here matches the schema used in your OpenLDAP. -If you are unfamiliar with the user/group schema used in the OpenLDAP server, consult your LDAP administrator or refer to the section [Identify Search Base and Schema using ldapsearch]({{}}/rancher/v2.6/en/admin-settings/authentication/ad/#annex-identify-search-base-and-schema-using-ldapsearch) in the Active Directory authentication documentation. +If you are unfamiliar with the user/group schema used in the OpenLDAP server, consult your LDAP administrator or refer to the section [Identify Search Base and Schema using ldapsearch](../../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-active-directory.md#annex-identify-search-base-and-schema-using-ldapsearch) in the Active Directory authentication documentation. ### User Schema Configuration diff --git a/docs/en/reference-guides/installation-references/feature-flags.md b/docs/en/reference-guides/installation-references/feature-flags.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/reference-guides/installation-references/feature-flags.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/installation/install-rancher-on-k8s/chart-options/chart-options.md b/docs/en/reference-guides/installation-references/helm-chart-options.md similarity index 93% rename from docs/en/installation/install-rancher-on-k8s/chart-options/chart-options.md rename to docs/en/reference-guides/installation-references/helm-chart-options.md index 65d0288c77a..fadc2f7a746 100644 --- a/docs/en/installation/install-rancher-on-k8s/chart-options/chart-options.md +++ b/docs/en/reference-guides/installation-references/helm-chart-options.md @@ -7,9 +7,9 @@ aliases: This page is a configuration reference for the Rancher Helm chart. -For help choosing a Helm chart version, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/choosing-version/) +For help choosing a Helm chart version, refer to [this page.](../../getting-started/installation-and-upgrade/resources/choose-a-rancher-version.md) -For information on enabling experimental features, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/feature-flags/) +For information on enabling experimental features, refer to [this page.](../../pages-for-subheaders/enable-experimental-features.md) - [Common Options](#common-options) - [Advanced Options](#advanced-options) @@ -44,7 +44,7 @@ For information on enabling experimental features, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/advanced/api-audit-log) level. 0 is off. [0-3] | +| `auditLog.level` | 0 | `int` - set the [API Audit Log](../../getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/enable-api-audit-log.md) level. 0 is off. [0-3] | | `auditLog.maxAge` | 1 | `int` - maximum number of days to retain old audit log files (only applies when `auditLog.destination` is set to `hostPath`) | | `auditLog.maxBackup` | 1 | `int` - maximum number of audit log files to retain (only applies when `auditLog.destination` is set to `hostPath`) | | `auditLog.maxSize` | 100 | `int` - maximum size in megabytes of the audit log file before it gets rotated (only applies when `auditLog.destination` is set to `hostPath`) | @@ -64,7 +64,7 @@ For information on enabling experimental features, refer to [this page.]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/#restricted-admin) | +| `restrictedAdmin` | `false` | `bool` - When this option is set to true, the initial Rancher user has restricted access to the local Kubernetes cluster to prevent privilege escalation. For more information, see the section about the [restricted-admin role.](../../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md#restricted-admin) | | `systemDefaultRegistry` | "" | `string` - private registry to be used for all system container images, e.g., http://registry.example.com/ | | `tls` | "ingress" | `string` - See [External TLS Termination](#external-tls-termination) for details. - "ingress, external" | | `useBundledSystemChart` | `false` | `bool` - select to use the system-charts packaged with Rancher server. This option is used for air gapped installations. | @@ -89,15 +89,15 @@ kubectl get secret --namespace cattle-system bootstrap-secret -o go-template='{{ ### API Audit Log -Enabling the [API Audit Log]({{}}/rancher/v2.6/en/installation/resources/advanced/api-audit-log) +Enabling the [API Audit Log](../../getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/enable-api-audit-log.md) -You can collect this log as you would any container log. Enable [logging]({{}}/rancher/v2.6/en/logging) for the `System` Project on the Rancher server cluster. +You can collect this log as you would any container log. Enable [logging](../../pages-for-subheaders/logging.md) for the `System` Project on the Rancher server cluster. ```plain --set auditLog.level=1 ``` -By default enabling Audit Logging will create a sidecar container in the Rancher pod. This container (`rancher-audit-log`) will stream the log to `stdout`. You can collect this log as you would any container log. When using the sidecar as the audit log destination, the `hostPath`, `maxAge`, `maxBackups`, and `maxSize` options do not apply. It's advised to use your OS or Docker daemon's log rotation features to control disk space use. Enable [logging]({{}}/rancher/v2.6/en/logging) for the Rancher server cluster or System Project. +By default enabling Audit Logging will create a sidecar container in the Rancher pod. This container (`rancher-audit-log`) will stream the log to `stdout`. You can collect this log as you would any container log. When using the sidecar as the audit log destination, the `hostPath`, `maxAge`, `maxBackups`, and `maxSize` options do not apply. It's advised to use your OS or Docker daemon's log rotation features to control disk space use. Enable [logging](../../pages-for-subheaders/logging.md) for the Rancher server cluster or System Project. Set the `auditLog.destination` to `hostPath` to forward logs to volume shared with the host system instead of streaming to a sidecar container. When setting the destination to `hostPath` you may want to adjust the other auditLog parameters for log rotation. @@ -114,7 +114,7 @@ You can set extra environment variables for Rancher server using `extraEnv`. Thi When you install Rancher inside of a Kubernetes cluster, TLS is offloaded at the cluster's ingress controller. The possible TLS settings depend on the used ingress controller. -See [TLS settings]({{}}/rancher/v2.6/en/installation/resources/tls-settings) for more information and options. +See [TLS settings](tls-settings.md) for more information and options. ### Import `local` Cluster @@ -177,7 +177,7 @@ kubectl -n cattle-system create secret generic tls-ca-additional --from-file=ca- ### Private Registry and Air Gap Installs -For details on installing Rancher with a private registry, see the [air gap installation docs.]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap) +For details on installing Rancher with a private registry, see the [air gap installation docs.](../../pages-for-subheaders/air-gapped-helm-cli-install.md) # External TLS Termination @@ -187,7 +187,7 @@ You may terminate the SSL/TLS on a L7 load balancer external to the Rancher clus :::note -If you are using a Private CA signed certificate, add `--set privateCA=true` and see [Adding TLS Secrets - Using a Private CA Signed Certificate]({{}}/rancher/v2.6/en/installation/resources/tls-secrets/) to add the CA cert for Rancher. +If you are using a Private CA signed certificate, add `--set privateCA=true` and see [Adding TLS Secrets - Using a Private CA Signed Certificate](../../getting-started/installation-and-upgrade/resources/add-tls-secrets.md) to add the CA cert for Rancher. ::: diff --git a/docs/en/installation/resources/tls-settings/tls-settings.md b/docs/en/reference-guides/installation-references/tls-settings.md similarity index 100% rename from docs/en/installation/resources/tls-settings/tls-settings.md rename to docs/en/reference-guides/installation-references/tls-settings.md diff --git a/docs/en/overview/concepts/concepts.md b/docs/en/reference-guides/kubernetes-concepts.md similarity index 98% rename from docs/en/overview/concepts/concepts.md rename to docs/en/reference-guides/kubernetes-concepts.md index eab89a4bc67..8b8c007ab08 100644 --- a/docs/en/overview/concepts/concepts.md +++ b/docs/en/reference-guides/kubernetes-concepts.md @@ -65,7 +65,7 @@ Each [worker node](https://kubernetes.io/docs/concepts/architecture/nodes/) runs - **Kubelets:** An agent that monitors the state of the node, ensuring your containers are healthy. - **Workloads:** The containers and pods that hold your apps, as well as other types of deployments. -Worker nodes also run storage and networking drivers, and ingress controllers when required. You create as many worker nodes as necessary to run your [workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/). +Worker nodes also run storage and networking drivers, and ingress controllers when required. You create as many worker nodes as necessary to run your [workloads](../pages-for-subheaders/workloads-and-pods.md). # About Helm diff --git a/docs/en/monitoring-alerting/configuration/examples/examples.md b/docs/en/reference-guides/monitoring-v2-configuration/examples.md similarity index 87% rename from docs/en/monitoring-alerting/configuration/examples/examples.md rename to docs/en/reference-guides/monitoring-v2-configuration/examples.md index 8cb06b633d3..a9149e462d2 100644 --- a/docs/en/monitoring-alerting/configuration/examples/examples.md +++ b/docs/en/reference-guides/monitoring-v2-configuration/examples.md @@ -22,4 +22,4 @@ An example PrometheusRule is on [this page.](https://github.com/prometheus-opera ### Alertmanager Config -For an example configuration, refer to [this section.](../advanced/alertmanager/#example-alertmanager-config) \ No newline at end of file +For an example configuration, refer to [this section.](../../how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager.md#example-alertmanager-config) \ No newline at end of file diff --git a/docs/en/monitoring-alerting/configuration/helm-chart-options/helm-chart-options.md b/docs/en/reference-guides/monitoring-v2-configuration/helm-chart-options.md similarity index 92% rename from docs/en/monitoring-alerting/configuration/helm-chart-options/helm-chart-options.md rename to docs/en/reference-guides/monitoring-v2-configuration/helm-chart-options.md index 78b4e977b87..17cd311beec 100644 --- a/docs/en/monitoring-alerting/configuration/helm-chart-options/helm-chart-options.md +++ b/docs/en/reference-guides/monitoring-v2-configuration/helm-chart-options.md @@ -49,7 +49,7 @@ If the scrape configuration you want cannot be specified via a ServiceMonitor or A [scrape_config section](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config) specifies a set of targets and parameters describing how to scrape them. In the general case, one scrape configuration specifies a single job. -An example of where this might be used is with Istio. For more information, see [this section.]({{}}/rancher/v2.6/en/istio/configuration-reference/selectors-and-scrape) +An example of where this might be used is with Istio. For more information, see [this section.](../../explanations/integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations.md) # Configuring Applications Packaged within Monitoring v2 @@ -64,7 +64,7 @@ But in the top level chart you can add values that override values that exist in ### Increase the Replicas of Alertmanager -As part of the chart deployment options, you can opt to increase the number of replicas of the Alertmanager deployed onto your cluster. The replicas can all be managed using the same underlying Alertmanager Config Secret. For more information on the Alertmanager Config Secret, refer to [this section.](../advanced/alertmanager/#multiple-alertmanager-replicas) +As part of the chart deployment options, you can opt to increase the number of replicas of the Alertmanager deployed onto your cluster. The replicas can all be managed using the same underlying Alertmanager Config Secret. For more information on the Alertmanager Config Secret, refer to [this section.](../../how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager.md#multiple-alertmanager-replicas) ### Configuring the Namespace for a Persistent Grafana Dashboard diff --git a/docs/en/monitoring-alerting/configuration/receiver/receiver.md b/docs/en/reference-guides/monitoring-v2-configuration/receivers.md similarity index 97% rename from docs/en/monitoring-alerting/configuration/receiver/receiver.md rename to docs/en/reference-guides/monitoring-v2-configuration/receivers.md index 3a3dc178b14..24e0b337d45 100644 --- a/docs/en/monitoring-alerting/configuration/receiver/receiver.md +++ b/docs/en/reference-guides/monitoring-v2-configuration/receivers.md @@ -11,7 +11,7 @@ The [Alertmanager Config](https://prometheus.io/docs/alerting/latest/configurati :::note -This section assumes familiarity with how monitoring components work together. For more information about Alertmanager, see [this section.](../../how-monitoring-works/#3-how-alertmanager-works) +This section assumes familiarity with how monitoring components work together. For more information about Alertmanager, see [this section.](../../explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works.md#3-how-alertmanager-works) ::: @@ -26,7 +26,7 @@ This section assumes familiarity with how monitoring components work together. F - [Teams](#teams) - [SMS](#sms) - [Configuring Multiple Receivers](#configuring-multiple-receivers) -- [Example Alertmanager Config](../examples/#example-alertmanager-config) +- [Example Alertmanager Config](examples.md#example-alertmanager-config) - [Example Route Config for CIS Scan Alerts](#example-route-config-for-cis-scan-alerts) - [Trusted CA for Notifiers](#trusted-ca-for-notifiers) @@ -311,9 +311,9 @@ spec: # key: string ``` -For more information on enabling alerting for `rancher-cis-benchmark`, see [this section.]({{}}/rancher/v2.6/en/cis-scans/#enabling-alerting-for-rancher-cis-benchmark) +For more information on enabling alerting for `rancher-cis-benchmark`, see [this section.](../../pages-for-subheaders/cis-scan-guides.md#enabling-alerting-for-rancher-cis-benchmark) # Trusted CA for Notifiers -If you need to add a trusted CA to your notifier, follow the steps in [this section.](../helm-chart-options/#trusted-ca-for-notifiers) \ No newline at end of file +If you need to add a trusted CA to your notifier, follow the steps in [this section.](helm-chart-options.md#trusted-ca-for-notifiers) \ No newline at end of file diff --git a/docs/en/monitoring-alerting/configuration/route/route.md b/docs/en/reference-guides/monitoring-v2-configuration/routes.md similarity index 96% rename from docs/en/monitoring-alerting/configuration/route/route.md rename to docs/en/reference-guides/monitoring-v2-configuration/routes.md index a5a6f4d8723..5b07c72f9f4 100644 --- a/docs/en/monitoring-alerting/configuration/route/route.md +++ b/docs/en/reference-guides/monitoring-v2-configuration/routes.md @@ -15,7 +15,7 @@ For more information about configuring routes, refer to the [official Alertmanag :::note -This section assumes familiarity with how monitoring components work together. For more information, see [this section.]({{}}/rancher/v2.6/en/monitoring-alerting/how-monitoring-works) +This section assumes familiarity with how monitoring components work together. For more information, see [this section.](../../explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works.md) ::: diff --git a/docs/en/monitoring-alerting/configuration/servicemonitor-podmonitor/servicemonitor-podmonitor.md b/docs/en/reference-guides/monitoring-v2-configuration/servicemonitors-and-podmonitors.md similarity index 95% rename from docs/en/monitoring-alerting/configuration/servicemonitor-podmonitor/servicemonitor-podmonitor.md rename to docs/en/reference-guides/monitoring-v2-configuration/servicemonitors-and-podmonitors.md index 696574ba6ad..a1097240b96 100644 --- a/docs/en/monitoring-alerting/configuration/servicemonitor-podmonitor/servicemonitor-podmonitor.md +++ b/docs/en/reference-guides/monitoring-v2-configuration/servicemonitors-and-podmonitors.md @@ -12,7 +12,7 @@ ServiceMonitors are more commonly used than PodMonitors, and we recommend them f :::note -This section assumes familiarity with how monitoring components work together. For more information about Alertmanager, see [this section.](../../how-monitoring-works/) +This section assumes familiarity with how monitoring components work together. For more information about Alertmanager, see [this section.](../../explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works.md) ::: diff --git a/docs/en/pipelines/concepts/concepts.md b/docs/en/reference-guides/pipelines/concepts.md similarity index 100% rename from docs/en/pipelines/concepts/concepts.md rename to docs/en/reference-guides/pipelines/concepts.md diff --git a/docs/en/pipelines/storage/storage.md b/docs/en/reference-guides/pipelines/configure-persistent-data.md similarity index 93% rename from docs/en/pipelines/storage/storage.md rename to docs/en/reference-guides/pipelines/configure-persistent-data.md index 56afb958eed..6c074272a72 100644 --- a/docs/en/pipelines/storage/storage.md +++ b/docs/en/reference-guides/pipelines/configure-persistent-data.md @@ -8,11 +8,11 @@ import TabItem from '@theme/TabItem'; The pipelines' internal Docker registry and the Minio workloads use ephemeral volumes by default. This default storage works out-of-the-box and makes testing easy, but you lose the build images and build logs if the node running the Docker Registry or Minio fails. In most cases this is fine. If you want build images and logs to survive node failures, you can configure the Docker Registry and Minio to use persistent volumes. -This section assumes that you understand how persistent storage works in Kubernetes. For more information, refer to the section on [how storage works.]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/how-storage-works/) +This section assumes that you understand how persistent storage works in Kubernetes. For more information, refer to the section on [how storage works.](../../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/about-persistent-storage.md) :::note Prerequisites for both parts A and B: -[Persistent volumes]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/) must be available for the cluster. +[Persistent volumes](../../pages-for-subheaders/create-kubernetes-persistent-storage.md) must be available for the cluster. ::: diff --git a/docs/en/pipelines/example-repos/example-repos.md b/docs/en/reference-guides/pipelines/example-repositories.md similarity index 92% rename from docs/en/pipelines/example-repos/example-repos.md rename to docs/en/reference-guides/pipelines/example-repositories.md index 4be1264961c..02a8d5d8ba9 100644 --- a/docs/en/pipelines/example-repos/example-repos.md +++ b/docs/en/reference-guides/pipelines/example-repositories.md @@ -11,7 +11,7 @@ Rancher ships with several example repositories that you can use to familiarize :::note Prerequisites: -- The example repositories are only available if you have not [configured a version control provider]({{}}/rancher/v2.6/en/project-admin/pipelines). +- The example repositories are only available if you have not [configured a version control provider](../../how-to-guides/advanced-user-guides/manage-projects/ci-cd-pipelines.md). - Because the pipelines app was deprecated in favor of Fleet, you will need to turn on the feature flag for legacy features before using pipelines. - Note that pipelines in Kubernetes 1.21+ are no longer supported. @@ -87,4 +87,4 @@ After enabling an example repository, run the pipeline to see how it works. ### What's Next? -For detailed information about setting up your own pipeline for your repository, [configure a version control provider]({{}}/rancher/v2.6/en/project-admin/pipelines), enable a repository and finally configure your pipeline. +For detailed information about setting up your own pipeline for your repository, [configure a version control provider](../../how-to-guides/advanced-user-guides/manage-projects/ci-cd-pipelines.md), enable a repository and finally configure your pipeline. diff --git a/docs/en/pipelines/example/example.md b/docs/en/reference-guides/pipelines/example-yaml.md similarity index 90% rename from docs/en/pipelines/example/example.md rename to docs/en/reference-guides/pipelines/example-yaml.md index 3c0be119356..5a04f2def8b 100644 --- a/docs/en/pipelines/example/example.md +++ b/docs/en/reference-guides/pipelines/example-yaml.md @@ -5,7 +5,7 @@ weight: 501 Pipelines can be configured either through the UI or using a yaml file in the repository, i.e. `.rancher-pipeline.yml` or `.rancher-pipeline.yaml`. -In the [pipeline configuration reference]({{}}/rancher/v2.6/en/pipelines/config), we provide examples of how to configure each feature using the Rancher UI or using YAML configuration. +In the [pipeline configuration reference](pipeline-configuration.md), we provide examples of how to configure each feature using the Rancher UI or using YAML configuration. Below is a full example `rancher-pipeline.yml` for those who want to jump right in. diff --git a/docs/en/pipelines/config/config.md b/docs/en/reference-guides/pipelines/pipeline-configuration.md similarity index 99% rename from docs/en/pipelines/config/config.md rename to docs/en/reference-guides/pipelines/pipeline-configuration.md index 04f809a3892..da5bf92a6e3 100644 --- a/docs/en/pipelines/config/config.md +++ b/docs/en/reference-guides/pipelines/pipeline-configuration.md @@ -502,7 +502,7 @@ stages: # Secrets -If you need to use security-sensitive information in your pipeline scripts (like a password), you can pass them in using Kubernetes [secrets]({{}}/rancher/v2.6/en/k8s-in-rancher/secrets/). +If you need to use security-sensitive information in your pipeline scripts (like a password), you can pass them in using Kubernetes [secrets](../../how-to-guides/new-user-guides/kubernetes-resources-setup/secrets.md). ### Prerequisite Create a secret in the same project as your pipeline, or explicitly in the namespace where pipeline build pods run. @@ -653,8 +653,8 @@ If you want to use a version control provider with a certificate from a custom/i The internal Docker registry and the Minio workloads use ephemeral volumes by default. This default storage works out-of-the-box and makes testing easy, but you lose the build images and build logs if the node running the Docker Registry or Minio fails. In most cases this is fine. If you want build images and logs to survive node failures, you can configure the Docker Registry and Minio to use persistent volumes. -For details on setting up persistent storage for pipelines, refer to [this page.]({{}}/rancher/v2.6/en/pipelines/storage) +For details on setting up persistent storage for pipelines, refer to [this page.](configure-persistent-data.md) # Example rancher-pipeline.yml -An example pipeline configuration file is on [this page.]({{}}/rancher/v2.6/en/pipelines/example) +An example pipeline configuration file is on [this page.](example-yaml.md) diff --git a/docs/en/monitoring-alerting/prometheus-federator/rbac/rbac.md b/docs/en/reference-guides/prometheus-federator/rbac.md similarity index 75% rename from docs/en/monitoring-alerting/prometheus-federator/rbac/rbac.md rename to docs/en/reference-guides/prometheus-federator/rbac.md index d33c125565d..d27dddea504 100644 --- a/docs/en/monitoring-alerting/prometheus-federator/rbac/rbac.md +++ b/docs/en/reference-guides/prometheus-federator/rbac.md @@ -6,7 +6,7 @@ weight: 2 This section describes the expectations for Role-Based Access Control (RBAC) for Prometheus Federator. -As described in the section on [namespaces](../prometheus-federator#namespaces), Prometheus Federator expects that Project Owners, Project Members, and other users in the cluster with Project-level permissions (e.g. permissions in a certain set of namespaces identified by a single label selector) have minimal permissions in any namespaces except the Project Registration Namespace (which is imported into the project by default) and those that already comprise their projects. Therefore, in order to allow Project Owners to assign specific chart permissions to other users in their Project namespaces, the Helm Project Operator will automatically watch the following bindings: +As described in the section on [namespaces](monitoring-alerting/prometheus-federator/prometheus-federator#namespaces), Prometheus Federator expects that Project Owners, Project Members, and other users in the cluster with Project-level permissions (e.g. permissions in a certain set of namespaces identified by a single label selector) have minimal permissions in any namespaces except the Project Registration Namespace (which is imported into the project by default) and those that already comprise their projects. Therefore, in order to allow Project Owners to assign specific chart permissions to other users in their Project namespaces, the Helm Project Operator will automatically watch the following bindings: - ClusterRoleBindings - RoleBindings in the Project Release Namespace diff --git a/docs/en/cluster-admin/tools/tools.md b/docs/en/reference-guides/rancher-cluster-tools.md similarity index 88% rename from docs/en/cluster-admin/tools/tools.md rename to docs/en/reference-guides/rancher-cluster-tools.md index d502eefc441..68a105ecfe1 100644 --- a/docs/en/cluster-admin/tools/tools.md +++ b/docs/en/reference-guides/rancher-cluster-tools.md @@ -28,7 +28,7 @@ Logging is helpful because it allows you to: Rancher can integrate with Elasticsearch, splunk, kafka, syslog, and fluentd. -For more information, refer to the logging documentation [here.]({{}}/rancher/v2.6/en/logging/) +For more information, refer to the logging documentation [here.](../pages-for-subheaders/logging.md) # Monitoring and Alerts Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with [Prometheus](https://prometheus.io/), a leading open-source monitoring solution. @@ -39,7 +39,7 @@ Notifiers are services that inform you of alert events. You can configure notifi Alerts are rules that trigger those notifications. Before you can receive alerts, you must configure one or more notifier in Rancher. The scope for alerts can be set at either the cluster or project level. -For more information, refer to the monitoring documentation [here.]({{}}/rancher/v2.6/en/monitoring-alerting/) +For more information, refer to the monitoring documentation [here.](../pages-for-subheaders/monitoring-and-alerting.md) # Istio @@ -47,13 +47,13 @@ For more information, refer to the monitoring documentation [here.]({{} Rancher's integration with Istio was improved in Rancher v2.5. -For more information, refer to the Istio documentation [here.]({{}}/rancher/v2.6/en/istio) +For more information, refer to the Istio documentation [here.](../pages-for-subheaders/istio.md) # OPA Gatekeeper -[OPA Gatekeeper](https://github.com/open-policy-agent/gatekeeper) is an open-source project that provides integration between OPA and Kubernetes to provide policy control via admission controller webhooks. For details on how to enable Gatekeeper in Rancher, refer to the [OPA Gatekeeper section.]({{}}/rancher/v2.6/en/opa-gatekeper) +[OPA Gatekeeper](https://github.com/open-policy-agent/gatekeeper) is an open-source project that provides integration between OPA and Kubernetes to provide policy control via admission controller webhooks. For details on how to enable Gatekeeper in Rancher, refer to the [OPA Gatekeeper section.](../explanations/integrations-in-rancher/opa-gatekeeper.md) # CIS Scans Rancher can run a security scan to check whether Kubernetes is deployed according to security best practices as defined in the CIS Kubernetes Benchmark. -For more information, refer to the CIS scan documentation [here.]({{}}/rancher/v2.6/en/cis-scans) \ No newline at end of file +For more information, refer to the CIS scan documentation [here.](../pages-for-subheaders/cis-scan-guides.md) \ No newline at end of file diff --git a/docs/en/overview/architecture-recommendations/architecture-recommendations.md b/docs/en/reference-guides/rancher-manager-architecture/architecture-recommendations.md similarity index 84% rename from docs/en/overview/architecture-recommendations/architecture-recommendations.md rename to docs/en/reference-guides/rancher-manager-architecture/architecture-recommendations.md index 112388c36c9..99022aa6912 100644 --- a/docs/en/overview/architecture-recommendations/architecture-recommendations.md +++ b/docs/en/reference-guides/rancher-manager-architecture/architecture-recommendations.md @@ -22,7 +22,7 @@ If you have a Docker installation of Rancher, the node running the Rancher serve If Rancher is intended to manage downstream Kubernetes clusters, the Kubernetes cluster that the Rancher server runs on should also be separate from the downstream user clusters. -![Separation of Rancher Server from User Clusters]({{}}/img/rancher/rancher-architecture-separation-of-rancher-server.svg) +![Separation of Rancher Server from User Clusters](/img/rancher-architecture-separation-of-rancher-server.svg) # Why HA is Better for Rancher in Production @@ -35,14 +35,14 @@ We don't recommend installing Rancher in a single Docker container, because if t One option for the underlying Kubernetes cluster is to use K3s Kubernetes. K3s is Rancher's CNCF certified Kubernetes distribution. It is easy to install and uses half the memory of Kubernetes, all in a binary of less than 100 MB. Another advantage of K3s is that it allows an external datastore to hold the cluster data, allowing the K3s server nodes to be treated as ephemeral.
Architecture of a K3s Kubernetes Cluster Running the Rancher Management Server
-![Architecture of a K3s Kubernetes Cluster Running the Rancher Management Server]({{}}/img/rancher/k3s-server-storage.svg) +![Architecture of a K3s Kubernetes Cluster Running the Rancher Management Server](/img/k3s-server-storage.svg) ### RKE Kubernetes Cluster Installations In an RKE installation, the cluster data is replicated on each of three etcd nodes in the cluster, providing redundancy and data duplication in case one of the nodes fails.
Architecture of an RKE Kubernetes Cluster Running the Rancher Management Server
-![Architecture of an RKE Kubernetes cluster running the Rancher management server]({{}}/img/rancher/rke-server-storage.svg) +![Architecture of an RKE Kubernetes cluster running the Rancher management server](/img/rke-server-storage.svg) # Recommended Load Balancer Configuration for Kubernetes Installations @@ -54,13 +54,13 @@ We recommend the following configurations for the load balancer and Ingress cont * The Ingress controller will forward traffic to port TCP/80 on the pod in the Rancher deployment.
Rancher installed on a Kubernetes cluster with layer 4 load balancer, depicting SSL termination at Ingress controllers
-![Rancher HA]({{}}/img/rancher/ha/rancher2ha.svg) +![Rancher HA](/img/ha/rancher2ha.svg) # Environment for Kubernetes Installations It is strongly recommended to install Rancher on a Kubernetes cluster on hosted infrastructure such as Amazon's EC2 or Google Compute Engine. -For the best performance and greater security, we recommend a dedicated Kubernetes cluster for the Rancher management server. Running user workloads on this cluster is not advised. After deploying Rancher, you can [create or import clusters]({{}}/rancher/v2.6/en/cluster-provisioning/) for running your workloads. +For the best performance and greater security, we recommend a dedicated Kubernetes cluster for the Rancher management server. Running user workloads on this cluster is not advised. After deploying Rancher, you can [create or import clusters](../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md) for running your workloads. # Recommended Node Roles for Kubernetes Installations @@ -84,7 +84,7 @@ Rancher uses RKE as a library when provisioning downstream Kubernetes clusters. For downstream Kubernetes clusters, we recommend that each node in a user cluster should have a single role for stability and scalability. -![Kubernetes Roles for Nodes in Rancher Server Cluster vs. User Clusters]({{}}/img/rancher/rancher-architecture-node-roles.svg) +![Kubernetes Roles for Nodes in Rancher Server Cluster vs. User Clusters](/img/rancher-architecture-node-roles.svg) RKE only requires at least one node with each role and does not require nodes to be restricted to one role. However, for the clusters that run your apps, we recommend separate roles for each node so that workloads on worker nodes don't interfere with the Kubernetes master or cluster data as your services scale. @@ -102,12 +102,12 @@ With that said, it is safe to use all three roles on three nodes when setting up Because no additional workloads will be deployed on the Rancher server cluster, in most cases it is not necessary to use the same architecture that we recommend for the scalability and reliability of downstream clusters. -For more best practices for downstream clusters, refer to the [production checklist]({{}}/rancher/v2.6/en/cluster-provisioning/production) or our [best practices guide.]({{}}/rancher/v2.6/en/best-practices/) +For more best practices for downstream clusters, refer to the [production checklist](../../pages-for-subheaders/checklist-for-production-ready-clusters.md) or our [best practices guide.](../../pages-for-subheaders/best-practices.md) # Architecture for an Authorized Cluster Endpoint (ACE) -If you are using an [authorized cluster endpoint (ACE),]({{}}/rancher/v2.6/en/overview/architecture/#4-authorized-cluster-endpoint) we recommend creating an FQDN pointing to a load balancer which balances traffic across your nodes with the `controlplane` role. +If you are using an [authorized cluster endpoint (ACE),](../../pages-for-subheaders/rancher-manager-architecture.md#4-authorized-cluster-endpoint) we recommend creating an FQDN pointing to a load balancer which balances traffic across your nodes with the `controlplane` role. -If you are using private CA signed certificates on the load balancer, you have to supply the CA certificate, which will be included in the generated kubeconfig file to validate the certificate chain. See the documentation on [kubeconfig files]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/) and [API keys]({{}}/rancher/v2.6/en/user-settings/api-keys/#creating-an-api-key) for more information. +If you are using private CA signed certificates on the load balancer, you have to supply the CA certificate, which will be included in the generated kubeconfig file to validate the certificate chain. See the documentation on [kubeconfig files](../../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md) and [API keys](../user-settings/api-keys.md#creating-an-api-key) for more information. -As of Rancher v2.6.3, ACE support is available for registered RKE2 and K3s clusters. To view the manual steps to perform on the downstream cluster to enable the ACE, click [here]({{}}/rancher/v2.6/en/cluster-provisioning/registered-clusters/#authorized-cluster-endpoint-support-for-rke2-and-k3s-clusters). +As of Rancher v2.6.3, ACE support is available for registered RKE2 and K3s clusters. To view the manual steps to perform on the downstream cluster to enable the ACE, click [here](../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md#authorized-cluster-endpoint-support-for-rke2-and-k3s-clusters). diff --git a/docs/en/reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters.md b/docs/en/reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/reference-guides/rancher-manager-architecture/rancher-server-and-components.md b/docs/en/reference-guides/rancher-manager-architecture/rancher-server-and-components.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/reference-guides/rancher-manager-architecture/rancher-server-and-components.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/project-admin/tools/tools.md b/docs/en/reference-guides/rancher-project-tools.md similarity index 91% rename from docs/en/project-admin/tools/tools.md rename to docs/en/reference-guides/rancher-project-tools.md index a35a719eb11..1bfba4bf217 100644 --- a/docs/en/project-admin/tools/tools.md +++ b/docs/en/reference-guides/rancher-project-tools.md @@ -32,8 +32,8 @@ Logging is helpful because it allows you to: Rancher can integrate with Elasticsearch, splunk, kafka, syslog, and fluentd. -For details, refer to the [logging section.]({{}}/rancher/v2.6/en/logging) +For details, refer to the [logging section.](../pages-for-subheaders/logging.md) ## Monitoring -Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with [Prometheus](https://prometheus.io/), a leading open-source monitoring solution. For details, refer to the [monitoring section.]({{}}/rancher/v2.6/en/monitoring-alerting) +Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with [Prometheus](https://prometheus.io/), a leading open-source monitoring solution. For details, refer to the [monitoring section.](../pages-for-subheaders/monitoring-and-alerting.md) diff --git a/docs/en/security/best-practices/best-practices.md b/docs/en/reference-guides/rancher-security/kubernetes-security-best-practices.md similarity index 100% rename from docs/en/security/best-practices/best-practices.md rename to docs/en/reference-guides/rancher-security/kubernetes-security-best-practices.md diff --git a/docs/en/security/hardening-guides/rke-1.6-hardening-2.6/rke-1.6-hardening-2.6.md b/docs/en/reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke1-hardening-guide-with-cis-v1.6-benchmark.md similarity index 94% rename from docs/en/security/hardening-guides/rke-1.6-hardening-2.6/rke-1.6-hardening-2.6.md rename to docs/en/reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke1-hardening-guide-with-cis-v1.6-benchmark.md index d783ac7bde0..449c042ae61 100644 --- a/docs/en/security/hardening-guides/rke-1.6-hardening-2.6/rke-1.6-hardening-2.6.md +++ b/docs/en/reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke1-hardening-guide-with-cis-v1.6-benchmark.md @@ -34,12 +34,12 @@ This hardening guide is intended to be used for RKE clusters and associated with This document provides prescriptive guidance for hardening a RKE cluster to be used for installing Rancher v2.6 with Kubernetes v1.18 up to v1.23 or provisioning a RKE cluster with Kubernetes v1.18 up to v1.23 to be used within Rancher v2.6. It outlines the configurations required to address Kubernetes benchmark controls from the Center for Information Security (CIS). -For more details about evaluating a hardened cluster against the official CIS benchmark, refer to the [CIS 1.6 Benchmark - Self-Assessment Guide - Rancher v2.6]({{}}/rancher/v2.6/en/security/hardening-guides/1.6-benchmark-2.6/). +For more details about evaluating a hardened cluster against the official CIS benchmark, refer to the [CIS 1.6 Benchmark - Self-Assessment Guide - Rancher v2.6](security/hardening-guides/1.6-benchmark-2.6/). #### Known Issues - Rancher **exec shell** and **view logs** for pods are **not** functional in a CIS v1.6 hardened setup when only public IP is provided when registering custom nodes. This functionality requires a private IP to be provided when registering the custom nodes. -- When setting the `default_pod_security_policy_template_id:` to `restricted` or `restricted-noroot`, based on the pod security policies (PSP) [provided]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/) by Rancher, Rancher creates **RoleBindings** and **ClusterRoleBindings** on the default service accounts. The CIS v1.6 check 5.1.5 requires that the default service accounts have no roles or cluster roles bound to it apart from the defaults. In addition the default service accounts should be configured such that it does not provide a service account token and does not have any explicit rights assignments. +- When setting the `default_pod_security_policy_template_id:` to `restricted` or `restricted-noroot`, based on the pod security policies (PSP) [provided](../../../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies.md) by Rancher, Rancher creates **RoleBindings** and **ClusterRoleBindings** on the default service accounts. The CIS v1.6 check 5.1.5 requires that the default service accounts have no roles or cluster roles bound to it apart from the defaults. In addition the default service accounts should be configured such that it does not provide a service account token and does not have any explicit rights assignments. ### Configure Kernel Runtime Parameters @@ -156,7 +156,7 @@ Execute this script to apply the `default-allow-all.yaml` configuration with the ### Reference Hardened RKE `cluster.yml` Configuration -The reference `cluster.yml` is used by the RKE CLI that provides the configuration needed to achieve a hardened install of Rancher Kubernetes Engine (RKE). RKE install [documentation]({{}}/rke/latest/en/installation/) is provided with additional details about the configuration items. This reference `cluster.yml` does not include the required **nodes** directive which will vary depending on your environment. Documentation for node configuration in RKE can be found [here]({{}}/rke/latest/en/config-options/nodes/). +The reference `cluster.yml` is used by the RKE CLI that provides the configuration needed to achieve a hardened install of Rancher Kubernetes Engine (RKE). RKE install [documentation](https://rancher.com/docs/rke/latest/en/installation/) is provided with additional details about the configuration items. This reference `cluster.yml` does not include the required **nodes** directive which will vary depending on your environment. Documentation for node configuration in RKE can be found [here](https://rancher.com/docs/rke/latest/en/config-options/nodes/). :::note Important: @@ -457,7 +457,7 @@ upgrade_strategy: ### Reference Hardened RKE Template Configuration -The reference RKE template provides the configuration needed to achieve a hardened install of Kubernetes. RKE templates are used to provision Kubernetes and define Rancher settings. Follow the Rancher [documentation]({{}}/rancher/v2.6/en/installation) for additional installation and RKE template details. +The reference RKE template provides the configuration needed to achieve a hardened install of Kubernetes. RKE templates are used to provision Kubernetes and define Rancher settings. Follow the Rancher [documentation](../../../pages-for-subheaders/installation-and-upgrade.md) for additional installation and RKE template details. ```yaml # diff --git a/docs/en/security/hardening-guides/rke-1.6-benchmark-2.6/rke-1.6-benchmark-2.6.md b/docs/en/reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke1-self-assessment-guide-with-cis-v1.6-benchmark.md similarity index 99% rename from docs/en/security/hardening-guides/rke-1.6-benchmark-2.6/rke-1.6-benchmark-2.6.md rename to docs/en/reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke1-self-assessment-guide-with-cis-v1.6-benchmark.md index 8a979e1b2eb..3e4e703e30b 100644 --- a/docs/en/security/hardening-guides/rke-1.6-benchmark-2.6/rke-1.6-benchmark-2.6.md +++ b/docs/en/reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke1-self-assessment-guide-with-cis-v1.6-benchmark.md @@ -11,7 +11,7 @@ aliases: #### Overview -This document is a companion to the [Rancher v2.6 RKE security hardening guide]({{}}/rancher/v2.6/en/security/hardening-guides/rke-1.6-hardening-2.6/). The hardening guide provides prescriptive guidance for hardening a production installation of Rancher, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark. +This document is a companion to the [Rancher v2.6 RKE security hardening guide](rke1-hardening-guide-with-cis-v1.6-benchmark.md). The hardening guide provides prescriptive guidance for hardening a production installation of Rancher, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark. This guide corresponds to specific versions of the hardening guide, Rancher, CIS Benchmark and Kubernetes: diff --git a/docs/en/security/hardening-guides/rke2-1.6-hardening-2.6/rke2-1.6-hardening-2.6.md b/docs/en/reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke2-hardening-guide-with-cis-v1.6-benchmark.md similarity index 98% rename from docs/en/security/hardening-guides/rke2-1.6-hardening-2.6/rke2-1.6-hardening-2.6.md rename to docs/en/reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke2-hardening-guide-with-cis-v1.6-benchmark.md index fbc925a9fe5..4d4ff7ad2e1 100644 --- a/docs/en/security/hardening-guides/rke2-1.6-hardening-2.6/rke2-1.6-hardening-2.6.md +++ b/docs/en/reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke2-hardening-guide-with-cis-v1.6-benchmark.md @@ -32,7 +32,7 @@ This hardening guide is intended to be used for RKE2 clusters and associated wit This document provides prescriptive guidance for hardening a RKE2 cluster to be provisioned through Rancher v2.6.5+ with Kubernetes v1.21 up to v1.23. It outlines the configurations required to address Kubernetes benchmark controls from the Center for Information Security (CIS). -For more details about evaluating a hardened RKE2 cluster against the official CIS benchmark, refer to the [RKE2 - CIS 1.6 Benchmark - Self-Assessment Guide - Rancher v2.6]({{}}/rancher/v2.6/en/security/hardening-guides/rke2-1.6-benchmark-2.6/). +For more details about evaluating a hardened RKE2 cluster against the official CIS benchmark, refer to the [RKE2 - CIS 1.6 Benchmark - Self-Assessment Guide - Rancher v2.6](rke2-self-assessment-guide-with-cis-v1.6-benchmark.md). RKE2 is designed to be "hardened by default" and pass the majority of the Kubernetes CIS controls without modification. There are a few notable exceptions to this that require manual intervention to fully pass the CIS Benchmark: @@ -415,4 +415,4 @@ __clone: true ### Conclusion -If you have followed this guide, your RKE2 custom cluster provisioned by Rancher will be configured to pass the CIS Kubernetes Benchmark. You can review our RKE2 CIS Benchmark Self-Assessment Guide [v1.6]({{}}/rancher/v2.6/en/security/hardening-guides/rke2-1.6-benchmark-2.6/) to understand how we verified each of the benchmarks and how you can do the same on your cluster. +If you have followed this guide, your RKE2 custom cluster provisioned by Rancher will be configured to pass the CIS Kubernetes Benchmark. You can review our RKE2 CIS Benchmark Self-Assessment Guide [v1.6](rke2-self-assessment-guide-with-cis-v1.6-benchmark.md) to understand how we verified each of the benchmarks and how you can do the same on your cluster. diff --git a/docs/en/security/hardening-guides/rke2-1.6-benchmark-2.6/rke2-1.6-benchmark-2.6.md b/docs/en/reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke2-self-assessment-guide-with-cis-v1.6-benchmark.md similarity index 99% rename from docs/en/security/hardening-guides/rke2-1.6-benchmark-2.6/rke2-1.6-benchmark-2.6.md rename to docs/en/reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke2-self-assessment-guide-with-cis-v1.6-benchmark.md index 1353fd50b30..2d7a959932c 100644 --- a/docs/en/security/hardening-guides/rke2-1.6-benchmark-2.6/rke2-1.6-benchmark-2.6.md +++ b/docs/en/reference-guides/rancher-security/rancher-v2.6-hardening-guides/rke2-self-assessment-guide-with-cis-v1.6-benchmark.md @@ -9,7 +9,7 @@ weight: 101 #### Overview -This document is a companion to the [Rancher v2.6 RKE2 security hardening guide]({{}}/rancher/v2.6/en/security/hardening-guides/rke2-1.6-hardening-2.6/). The hardening guide provides prescriptive guidance for hardening a production installation of Rancher with RKE2 provisioned clusters, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark. +This document is a companion to the [Rancher v2.6 RKE2 security hardening guide](rke2-hardening-guide-with-cis-v1.6-benchmark.md). The hardening guide provides prescriptive guidance for hardening a production installation of Rancher with RKE2 provisioned clusters, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark. This guide corresponds to specific versions of the hardening guide, Rancher, CIS Benchmark and Kubernetes: diff --git a/docs/en/security/cve/cve.md b/docs/en/reference-guides/rancher-security/security-advisories-and-cves.md similarity index 99% rename from docs/en/security/cve/cve.md rename to docs/en/reference-guides/rancher-security/security-advisories-and-cves.md index 3288b0da979..28c652786e1 100644 --- a/docs/en/security/cve/cve.md +++ b/docs/en/reference-guides/rancher-security/security-advisories-and-cves.md @@ -28,4 +28,4 @@ Rancher is committed to informing the community of security issues in our produc | [CVE-2019-12274](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-12274) | Nodes using the built-in node drivers using a file path option allows the machine to read arbitrary files including sensitive ones from inside the Rancher server container. | 5 Jun 2019 | [Rancher v2.2.4](https://github.com/rancher/rancher/releases/tag/v2.2.4), [Rancher v2.1.10](https://github.com/rancher/rancher/releases/tag/v2.1.10) and [Rancher v2.0.15](https://github.com/rancher/rancher/releases/tag/v2.0.15) | | [CVE-2019-11202](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-11202) | The default admin, that is shipped with Rancher, will be re-created upon restart of Rancher despite being explicitly deleted. | 16 Apr 2019 | [Rancher v2.2.2](https://github.com/rancher/rancher/releases/tag/v2.2.2), [Rancher v2.1.9](https://github.com/rancher/rancher/releases/tag/v2.1.9) and [Rancher v2.0.14](https://github.com/rancher/rancher/releases/tag/v2.0.14) | | [CVE-2019-6287](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-6287) | Project members continue to get access to namespaces from projects that they were removed from if they were added to more than one project. | 29 Jan 2019 | [Rancher v2.1.6](https://github.com/rancher/rancher/releases/tag/v2.1.6) and [Rancher v2.0.11](https://github.com/rancher/rancher/releases/tag/v2.0.11) | -| [CVE-2018-20321](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-20321) | Any project member with access to the `default` namespace can mount the `netes-default` service account in a pod and then use that pod to execute administrative privileged commands against the Kubernetes cluster. | 29 Jan 2019 | [Rancher v2.1.6](https://github.com/rancher/rancher/releases/tag/v2.1.6) and [Rancher v2.0.11](https://github.com/rancher/rancher/releases/tag/v2.0.11) - Rolling back from these versions or greater have specific [instructions]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/rollbacks). | +| [CVE-2018-20321](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-20321) | Any project member with access to the `default` namespace can mount the `netes-default` service account in a pod and then use that pod to execute administrative privileged commands against the Kubernetes cluster. | 29 Jan 2019 | [Rancher v2.1.6](https://github.com/rancher/rancher/releases/tag/v2.1.6) and [Rancher v2.0.11](https://github.com/rancher/rancher/releases/tag/v2.0.11) - Rolling back from these versions or greater have specific [instructions](../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md). | diff --git a/docs/en/reference-guides/rancher-security/selinux-rpm/about-rancher-selinux.md b/docs/en/reference-guides/rancher-security/selinux-rpm/about-rancher-selinux.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/reference-guides/rancher-security/selinux-rpm/about-rancher-selinux.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/reference-guides/rancher-security/selinux-rpm/about-rke2-selinux.md b/docs/en/reference-guides/rancher-security/selinux-rpm/about-rke2-selinux.md new file mode 100644 index 00000000000..fa42a3bae89 --- /dev/null +++ b/docs/en/reference-guides/rancher-security/selinux-rpm/about-rke2-selinux.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/admin-settings/rke-templates/example-yaml/example-yaml.md b/docs/en/reference-guides/rke1-template-example-yaml.md similarity index 100% rename from docs/en/admin-settings/rke-templates/example-yaml/example-yaml.md rename to docs/en/reference-guides/rke1-template-example-yaml.md diff --git a/docs/en/installation/other-installation-methods/single-node-docker/advanced/advanced.md b/docs/en/reference-guides/single-node-rancher-in-docker/advanced-options.md similarity index 80% rename from docs/en/installation/other-installation-methods/single-node-docker/advanced/advanced.md rename to docs/en/reference-guides/single-node-rancher-in-docker/advanced-options.md index 6686fef83cd..c5cca0e8296 100644 --- a/docs/en/installation/other-installation-methods/single-node-docker/advanced/advanced.md +++ b/docs/en/reference-guides/single-node-rancher-in-docker/advanced-options.md @@ -25,7 +25,7 @@ Use the command example to start a Rancher container with your private CA certif The example below is based on having the CA root certificates in the `/host/certs` directory on the host and mounting this directory on `/container/certs` inside the Rancher container. -Privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher) +Privileged access is [required.](../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher) ``` docker run -d --restart=unless-stopped \ @@ -42,9 +42,9 @@ The API Audit Log records all the user and system transactions made through Ranc The API Audit Log writes to `/var/log/auditlog` inside the rancher container by default. Share that directory as a volume and set your `AUDIT_LEVEL` to enable the log. -See [API Audit Log]({{}}/rancher/v2.6/en/installation/resources/advanced/api-audit-log) for more information and options. +See [API Audit Log](../../getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/enable-api-audit-log.md) for more information and options. -Privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher) +Privileged access is [required.](../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher) ``` docker run -d --restart=unless-stopped \ @@ -67,9 +67,9 @@ docker run -d --restart=unless-stopped \ rancher/rancher:latest ``` -Privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher) +Privileged access is [required.](../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher) -See [TLS settings]({{}}/rancher/v2.6/en/installation/resources/tls-settings) for more information and options. +See [TLS settings](../installation-references/tls-settings.md) for more information and options. ### Air Gap @@ -93,7 +93,7 @@ docker run -d --restart=unless-stopped \ rancher/rancher:latest ``` -Privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher) +Privileged access is [required.](../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher) ### Running `rancher/rancher` and `rancher/rancher-agent` on the Same Node @@ -112,4 +112,4 @@ docker run -d --restart=unless-stopped \ rancher/rancher:latest ``` -Privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher) +Privileged access is [required.](../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher) diff --git a/docs/en/installation/other-installation-methods/single-node-docker/proxy/proxy.md b/docs/en/reference-guides/single-node-rancher-in-docker/http-proxy-configuration.md similarity index 90% rename from docs/en/installation/other-installation-methods/single-node-docker/proxy/proxy.md rename to docs/en/reference-guides/single-node-rancher-in-docker/http-proxy-configuration.md index 58fb799bcf4..1e49073b2aa 100644 --- a/docs/en/installation/other-installation-methods/single-node-docker/proxy/proxy.md +++ b/docs/en/reference-guides/single-node-rancher-in-docker/http-proxy-configuration.md @@ -21,7 +21,7 @@ NO_PROXY must be in uppercase to use network range (CIDR) notation. ## Docker Installation -Passing environment variables to the Rancher container can be done using `-e KEY=VALUE` or `--env KEY=VALUE`. Required values for `NO_PROXY` in a [Docker Installation]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/) are: +Passing environment variables to the Rancher container can be done using `-e KEY=VALUE` or `--env KEY=VALUE`. Required values for `NO_PROXY` in a [Docker Installation](../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md) are: - `localhost` - `127.0.0.1` @@ -43,7 +43,7 @@ docker run -d --restart=unless-stopped \ rancher/rancher:latest ``` -Privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher) +Privileged access is [required.](../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher) ### Air-gapped proxy configuration diff --git a/docs/en/system-tools/system-tools.md b/docs/en/reference-guides/system-tools.md similarity index 100% rename from docs/en/system-tools/system-tools.md rename to docs/en/reference-guides/system-tools.md diff --git a/docs/en/user-settings/api-keys/api-keys.md b/docs/en/reference-guides/user-settings/api-keys.md similarity index 89% rename from docs/en/user-settings/api-keys/api-keys.md rename to docs/en/reference-guides/user-settings/api-keys.md index 77e9d2a5fa6..cb3151520c9 100644 --- a/docs/en/user-settings/api-keys/api-keys.md +++ b/docs/en/reference-guides/user-settings/api-keys.md @@ -18,7 +18,7 @@ API Keys are composed of four components: :::note -Users may opt to enable [token hashing]({{}}/rancher/v2.6/en/api/api-tokens). +Users may opt to enable [token hashing](../about-the-api/api-tokens.md). ::: @@ -34,7 +34,7 @@ Users may opt to enable [token hashing]({{}}/rancher/v2.6/en/api/api-to Expiration period will be bound by `v3/settings/auth-token-max-ttl-minutes`. If it exceeds the max-ttl, API key will be created with max-ttl as the expiration period. - A scope will limit the API key so that it will only work against the Kubernetes API of the specified cluster. If the cluster is configured with an Authorized Cluster Endpoint, you will be able to use a scoped token directly against the cluster's API without proxying through the Rancher server. See [Authorized Cluster Endpoints]({{}}/rancher/v2.6/en/overview/architecture/#4-authorized-cluster-endpoint) for more information. + A scope will limit the API key so that it will only work against the Kubernetes API of the specified cluster. If the cluster is configured with an Authorized Cluster Endpoint, you will be able to use a scoped token directly against the cluster's API without proxying through the Rancher server. See [Authorized Cluster Endpoints](../../pages-for-subheaders/rancher-manager-architecture.md#4-authorized-cluster-endpoint) for more information. 4. Click **Create**. @@ -48,7 +48,7 @@ Users may opt to enable [token hashing]({{}}/rancher/v2.6/en/api/api-to - Enter your API key information into the application that will send requests to the Rancher API. - Learn more about the Rancher endpoints and parameters by selecting **View in API** for an object in the Rancher UI. -- API keys are used for API calls and [Rancher CLI]({{}}/rancher/v2.6/en/cli). +- API keys are used for API calls and [Rancher CLI](../../pages-for-subheaders/cli-with-rancher.md). ## Deleting API Keys diff --git a/docs/en/user-settings/cloud-credentials/cloud-credentials.md b/docs/en/reference-guides/user-settings/manage-cloud-credentials.md similarity index 71% rename from docs/en/user-settings/cloud-credentials/cloud-credentials.md rename to docs/en/reference-guides/user-settings/manage-cloud-credentials.md index f3022599613..39105211752 100644 --- a/docs/en/user-settings/cloud-credentials/cloud-credentials.md +++ b/docs/en/reference-guides/user-settings/manage-cloud-credentials.md @@ -3,7 +3,7 @@ title: Managing Cloud Credentials weight: 7011 --- -When you create a cluster [hosted by an infrastructure provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools), [node templates]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) are used to provision the cluster nodes. These templates use Docker Machine configuration options to define an operating system image and settings/parameters for the node. +When you create a cluster [hosted by an infrastructure provider](../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md), [node templates](../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-templates) are used to provision the cluster nodes. These templates use Docker Machine configuration options to define an operating system image and settings/parameters for the node. Node templates can use cloud credentials to access the credential information required to provision nodes in the infrastructure providers. The same cloud credential can be used by multiple node templates. By using a cloud credential, you do not have to re-enter access keys for the same cloud provider. Cloud credentials are stored as Kubernetes secrets. @@ -11,7 +11,7 @@ Cloud credentials are only used by node templates if there are fields marked as You can create cloud credentials in two contexts: -- [During creation of a node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for a cluster. +- [During creation of a node template](../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-templates) for a cluster. - In the **User Settings** All cloud credentials are bound to the user profile of who created it. They **cannot** be shared across users. @@ -21,12 +21,12 @@ All cloud credentials are bound to the user profile of who created it. They **ca 1. Click **☰ > Cluster Management**. 1. Click **Cloud Credentials**. 1. Click **Create**. -1. Click a cloud credential type. The values of this dropdown is based on the `active` [node drivers]({{}}/rancher/v2.6/en/admin-settings/drivers/node-drivers/) in Rancher. +1. Click a cloud credential type. The values of this dropdown is based on the `active` [node drivers](../../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers.md) in Rancher. 1. Enter a name for the cloud credential. 1. Based on the selected cloud credential type, enter the required values to authenticate with the infrastructure provider. 1. Click **Create**. -**Result:** The cloud credential is created and can immediately be used to [create node templates]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates). +**Result:** The cloud credential is created and can immediately be used to [create node templates](../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-templates). ## Updating a Cloud Credential @@ -37,11 +37,11 @@ When access credentials are changed or compromised, updating a cloud credential 1. Choose the cloud credential you want to edit and click the **⋮ > Edit Config**. 1. Update the credential information and click **Save**. -**Result:** The cloud credential is updated with the new access credentials. All existing node templates using this cloud credential will automatically use the updated information whenever [new nodes are added]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/). +**Result:** The cloud credential is updated with the new access credentials. All existing node templates using this cloud credential will automatically use the updated information whenever [new nodes are added](../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md). ## Deleting a Cloud Credential -In order to delete cloud credentials, there must not be any node template associated with it. If you are unable to delete the cloud credential, [delete any node templates]({{}}/rancher/v2.6/en/user-settings/node-templates/#deleting-a-node-template) that are still associated to that cloud credential. +In order to delete cloud credentials, there must not be any node template associated with it. If you are unable to delete the cloud credential, [delete any node templates](manage-node-templates.md#deleting-a-node-template) that are still associated to that cloud credential. 1. Click **☰ > Cluster Management**. 1. Click **Cloud Credentials**. diff --git a/docs/en/user-settings/node-templates/node-templates.md b/docs/en/reference-guides/user-settings/manage-node-templates.md similarity index 64% rename from docs/en/user-settings/node-templates/node-templates.md rename to docs/en/reference-guides/user-settings/manage-node-templates.md index 62a18b571ad..2d57fec003d 100644 --- a/docs/en/user-settings/node-templates/node-templates.md +++ b/docs/en/reference-guides/user-settings/manage-node-templates.md @@ -3,9 +3,9 @@ title: Managing Node Templates weight: 7010 --- -When you provision a cluster [hosted by an infrastructure provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools), [node templates]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) are used to provision the cluster nodes. These templates use Docker Machine configuration options to define an operating system image and settings/parameters for the node. You can create node templates in two contexts: +When you provision a cluster [hosted by an infrastructure provider](../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md), [node templates](../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-templates) are used to provision the cluster nodes. These templates use Docker Machine configuration options to define an operating system image and settings/parameters for the node. You can create node templates in two contexts: -- While [provisioning a node pool cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools). +- While [provisioning a node pool cluster](../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md). - At any time, from your [user settings](#creating-a-node-template-from-user-settings). When you create a node template, it is bound to your user profile. Node templates cannot be shared among users. You can delete stale node templates that you no longer user from your user settings. @@ -17,7 +17,7 @@ When you create a node template, it is bound to your user profile. Node template 1. Click **Add Template**. 1. Select one of the cloud providers available. Then follow the instructions on screen to configure the template. -**Result:** The template is configured. You can use the template later when you [provision a node pool cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools). +**Result:** The template is configured. You can use the template later when you [provision a node pool cluster](../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md). ## Updating a Node Template @@ -27,7 +27,7 @@ When you create a node template, it is bound to your user profile. Node template :::note - The default `active` [node drivers]({{}}/rancher/v2.6/en/admin-settings/drivers/node-drivers/) and any node driver, that has fields marked as `password`, are required to use [cloud credentials]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#cloud-credentials). + The default `active` [node drivers](../../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers.md) and any node driver, that has fields marked as `password`, are required to use [cloud credentials](../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#cloud-credentials). ::: @@ -44,7 +44,7 @@ When creating new node templates from your user settings, you can clone an exist 1. Find the template you want to clone. Then select **⋮ > Clone**. 1. Complete the rest of the form. -**Result:** The template is cloned and configured. You can use the template later when you [provision a node pool cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools). +**Result:** The template is cloned and configured. You can use the template later when you [provision a node pool cluster](../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md). ## Deleting a Node Template diff --git a/docs/en/user-settings/preferences/preferences.md b/docs/en/reference-guides/user-settings/user-preferences.md similarity index 100% rename from docs/en/user-settings/preferences/preferences.md rename to docs/en/reference-guides/user-settings/user-preferences.md diff --git a/docs/en/security/security-scan/security-scan.md b/docs/en/security/security-scan/security-scan.md index c5a3cdb21d4..28e59b6b0d2 100644 --- a/docs/en/security/security-scan/security-scan.md +++ b/docs/en/security/security-scan/security-scan.md @@ -3,4 +3,4 @@ title: Security Scans weight: 299 --- -The documentation about CIS security scans has moved [here.]({{}}/rancher/v2.6/en/cis-scans) +The documentation about CIS security scans has moved [here.](../../pages-for-subheaders/cis-scan-guides.md) diff --git a/docs/en/shared-files/_cluster-capabilities-table.md b/docs/en/shared-files/_cluster-capabilities-table.md index 2ea295d4617..aa387b684b0 100644 --- a/docs/en/shared-files/_cluster-capabilities-table.md +++ b/docs/en/shared-files/_cluster-capabilities-table.md @@ -5,24 +5,24 @@ headless: true | Action | Rancher Launched Kubernetes Clusters | EKS, GKE and AKS Clusters1 | Other Hosted Kubernetes Clusters | Non-EKS or GKE Registered Clusters | | --- | --- | ---| ---|----| -| [Using kubectl and a kubeconfig file to Access a Cluster]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/) | ✓ | ✓ | ✓ | ✓ | -| [Managing Cluster Members]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/cluster-members/) | ✓ | ✓ | ✓ | ✓ | -| [Editing and Upgrading Clusters]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/) | ✓ | ✓ | ✓ | ✓2 | -| [Managing Nodes]({{}}/rancher/v2.6/en/cluster-admin/nodes) | ✓ | ✓ | ✓ | ✓3 | -| [Managing Persistent Volumes and Storage Classes]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/) | ✓ | ✓ | ✓ | ✓ | -| [Managing Projects, Namespaces and Workloads]({{}}/rancher/v2.6/en/cluster-admin/projects-and-namespaces/) | ✓ | ✓ | ✓ | ✓ | -| [Using App Catalogs]({{}}/rancher/v2.6/en/helm-charts/) | ✓ | ✓ | ✓ | ✓ | -| Configuring Tools ([Alerts, Notifiers, Monitoring]({{}}/rancher/v2.6/en/monitoring-alerting/), [Logging]({{}}/rancher/v2.6/en/logging/), [Istio]({{}}/rancher/v2.6/en/istio/)) | ✓ | ✓ | ✓ | ✓ | -| [Running Security Scans]({{}}/rancher/v2.6/en/security/security-scan/) | ✓ | ✓ | ✓ | ✓ | -| [Use existing configuration to create additional clusters]({{}}/rancher/v2.6/en/cluster-admin/cloning-clusters/)| ✓ | ✓ | ✓ | | -| [Ability to rotate certificates]({{}}/rancher/v2.6/en/cluster-admin/certificate-rotation/) | ✓ | ✓ | | | -| Ability to [backup]({{}}/rancher/v2.6/en/cluster-admin/backing-up-etcd/) and [restore]({{}}/rancher/v2.6/en/cluster-admin/restoring-etcd/) Rancher-launched clusters | ✓ | ✓ | | ✓4 | -| [Cleaning Kubernetes components when clusters are no longer reachable from Rancher]({{}}/rancher/v2.6/en/cluster-admin/cleaning-cluster-nodes/) | ✓ | | | | -| [Configuring Pod Security Policies]({{}}/rancher/v2.6/en/cluster-admin/pod-security-policy/) | ✓ | ✓ | || +| [Using kubectl and a kubeconfig file to Access a Cluster](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md) | ✓ | ✓ | ✓ | ✓ | +| [Managing Cluster Members](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/add-users-to-clusters.md) | ✓ | ✓ | ✓ | ✓ | +| [Editing and Upgrading Clusters](../pages-for-subheaders/cluster-configuration.md) | ✓ | ✓ | ✓ | ✓2 | +| [Managing Nodes](../how-to-guides/advanced-user-guides/manage-clusters/nodes-and-node-pools.md) | ✓ | ✓ | ✓ | ✓3 | +| [Managing Persistent Volumes and Storage Classes](../pages-for-subheaders/create-kubernetes-persistent-storage.md) | ✓ | ✓ | ✓ | ✓ | +| [Managing Projects, Namespaces and Workloads](../how-to-guides/advanced-user-guides/manage-clusters/projects-and-namespaces.md) | ✓ | ✓ | ✓ | ✓ | +| [Using App Catalogs](../pages-for-subheaders/helm-charts-in-rancher.md) | ✓ | ✓ | ✓ | ✓ | +| Configuring Tools ([Alerts, Notifiers, Monitoring](../pages-for-subheaders/monitoring-and-alerting.md), [Logging](../pages-for-subheaders/logging.md), [Istio](../pages-for-subheaders/istio.md)) | ✓ | ✓ | ✓ | ✓ | +| [Running Security Scans](security/security-scan/) | ✓ | ✓ | ✓ | ✓ | +| [Use existing configuration to create additional clusters](../how-to-guides/advanced-user-guides/manage-clusters/clone-cluster-configuration.md)| ✓ | ✓ | ✓ | | +| [Ability to rotate certificates](../how-to-guides/advanced-user-guides/manage-clusters/rotate-certificates.md) | ✓ | ✓ | | | +| Ability to [backup](../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher-launched-kubernetes-clusters.md) and [restore](../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup.md) Rancher-launched clusters | ✓ | ✓ | | ✓4 | +| [Cleaning Kubernetes components when clusters are no longer reachable from Rancher](../how-to-guides/advanced-user-guides/manage-clusters/clean-cluster-nodes.md) | ✓ | | | | +| [Configuring Pod Security Policies](../how-to-guides/advanced-user-guides/manage-clusters/add-a-pod-security-policy.md) | ✓ | ✓ | || 1. Registered GKE and EKS clusters have the same options available as GKE and EKS clusters created from the Rancher UI. The difference is that when a registered cluster is deleted from the Rancher UI, it is not destroyed. -2. Cluster configuration options can't be edited for registered clusters, except for [K3s and RKE2 clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/registered-clusters/) +2. Cluster configuration options can't be edited for registered clusters, except for [K3s and RKE2 clusters.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md) 3. For registered cluster nodes, the Rancher UI exposes the ability to cordon, drain, and edit the node. diff --git a/docs/en/troubleshooting/troubleshooting.md b/docs/en/troubleshooting.md similarity index 56% rename from docs/en/troubleshooting/troubleshooting.md rename to docs/en/troubleshooting.md index 47448e25c17..c514b31b38d 100644 --- a/docs/en/troubleshooting/troubleshooting.md +++ b/docs/en/troubleshooting.md @@ -5,7 +5,7 @@ weight: 26 This section contains information to help you troubleshoot issues when using Rancher. -- [Kubernetes components]({{}}/rancher/v2.6/en/troubleshooting/kubernetes-components/) +- [Kubernetes components](pages-for-subheaders/kubernetes-components.md) If you need help troubleshooting core Kubernetes cluster components like: * `etcd` @@ -16,30 +16,30 @@ This section contains information to help you troubleshoot issues when using Ran * `kube-proxy` * `nginx-proxy` -- [Kubernetes resources]({{}}/rancher/v2.6/en/troubleshooting/kubernetes-resources/) +- [Kubernetes resources](troubleshooting/other-troubleshooting-tips/kubernetes-resources.md) Options for troubleshooting Kubernetes resources like Nodes, Ingress Controller and Rancher Agents are described in this section. -- [Networking]({{}}/rancher/v2.6/en/troubleshooting/networking/) +- [Networking](troubleshooting/other-troubleshooting-tips/networking.md) Steps to troubleshoot networking issues can be found here. -- [DNS]({{}}/rancher/v2.6/en/troubleshooting/dns/) +- [DNS](troubleshooting/other-troubleshooting-tips/dns.md) When you experience name resolution issues in your cluster. -- [Troubleshooting Rancher installed on Kubernetes]({{}}/rancher/v2.6/en/troubleshooting/rancherha/) +- [Troubleshooting Rancher installed on Kubernetes](troubleshooting/other-troubleshooting-tips/rancher-ha.md) - If you experience issues with your [Rancher server installed on Kubernetes]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) + If you experience issues with your [Rancher server installed on Kubernetes](pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md) -- [Logging]({{}}/rancher/v2.6/en/troubleshooting/logging/) +- [Logging](troubleshooting/other-troubleshooting-tips/logging.md) Read more about what log levels can be configured and how to configure a log level. -- [User ID Tracking in Audit Logs]({{}}/rancher/v2.6/en/troubleshooting/userid-tracking-in-audit-logs/) +- [User ID Tracking in Audit Logs](troubleshooting/other-troubleshooting-tips/user-id-tracking-in-audit-logs.md) Read more about how a Rancher Admin can trace an event from the Rancher audit logs and into the Kubernetes audit logs using the external Identity Provider username. -- [Expired Webhook Certificates]({{}}/rancher/v2.6/en/troubleshooting/expired-webhook-certificates/) +- [Expired Webhook Certificates](troubleshooting/other-troubleshooting-tips/expired-webhook-certificate-rotation.md) Read more about how to rotate a Rancher webhook certificate secret after it expires on an annual basis. diff --git a/docs/en/troubleshooting/kubernetes-components/kubernetes-components.md b/docs/en/troubleshooting/kubernetes-components/kubernetes-components.md deleted file mode 100644 index 0b6fd969dbc..00000000000 --- a/docs/en/troubleshooting/kubernetes-components/kubernetes-components.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Kubernetes Components -weight: 100 ---- - -The commands and steps listed in this section apply to the core Kubernetes components on [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) clusters. - -This section includes troubleshooting tips in the following categories: - -- [Troubleshooting etcd Nodes]({{}}/rancher/v2.6/en/troubleshooting/kubernetes-components/etcd) -- [Troubleshooting Controlplane Nodes]({{}}/rancher/v2.6/en/troubleshooting/kubernetes-components/controlplane) -- [Troubleshooting nginx-proxy Nodes]({{}}/rancher/v2.6/en/troubleshooting/kubernetes-components/nginx-proxy) -- [Troubleshooting Worker Nodes and Generic Components]({{}}/rancher/v2.6/en/troubleshooting/kubernetes-components/worker-and-generic) - -# Kubernetes Component Diagram - -![Cluster diagram]({{}}/img/rancher/clusterdiagram.svg)
-Lines show the traffic flow between components. Colors are used purely for visual aid \ No newline at end of file diff --git a/docs/en/troubleshooting/kubernetes-components/controlplane/etcd.md b/docs/en/troubleshooting/kubernetes-components/troubleshooting-controlplane-nodes.md similarity index 90% rename from docs/en/troubleshooting/kubernetes-components/controlplane/etcd.md rename to docs/en/troubleshooting/kubernetes-components/troubleshooting-controlplane-nodes.md index 6a04373c0a2..2d0c44a2126 100644 --- a/docs/en/troubleshooting/kubernetes-components/controlplane/etcd.md +++ b/docs/en/troubleshooting/kubernetes-components/troubleshooting-controlplane-nodes.md @@ -31,7 +31,7 @@ bdf3898b8063 rancher/hyperkube:v1.11.5-rancher1 "/opt/rke-tools/en..." :::note -If you added multiple nodes with the `controlplane` role, both `kube-controller-manager` and `kube-scheduler` use a leader election process to determine the leader. Only the current leader will log the performed actions. See [Kubernetes leader election]({{}}/rancher/v2.6/en/troubleshooting/kubernetes-resources/#kubernetes-leader-election) how to retrieve the current leader. +If you added multiple nodes with the `controlplane` role, both `kube-controller-manager` and `kube-scheduler` use a leader election process to determine the leader. Only the current leader will log the performed actions. See [Kubernetes leader election](../other-troubleshooting-tips/kubernetes-resources.md#kubernetes-leader-election) how to retrieve the current leader. ::: diff --git a/docs/en/troubleshooting/kubernetes-components/etcd/etcd.md b/docs/en/troubleshooting/kubernetes-components/troubleshooting-etcd-nodes.md similarity index 100% rename from docs/en/troubleshooting/kubernetes-components/etcd/etcd.md rename to docs/en/troubleshooting/kubernetes-components/troubleshooting-etcd-nodes.md diff --git a/docs/en/troubleshooting/kubernetes-components/nginx-proxy/nginx-proxy.md b/docs/en/troubleshooting/kubernetes-components/troubleshooting-nginx-proxy.md similarity index 100% rename from docs/en/troubleshooting/kubernetes-components/nginx-proxy/nginx-proxy.md rename to docs/en/troubleshooting/kubernetes-components/troubleshooting-nginx-proxy.md diff --git a/docs/en/troubleshooting/kubernetes-components/worker-and-generic/worker-and-generic.md b/docs/en/troubleshooting/kubernetes-components/troubleshooting-worker-nodes-and-generic-components.md similarity index 100% rename from docs/en/troubleshooting/kubernetes-components/worker-and-generic/worker-and-generic.md rename to docs/en/troubleshooting/kubernetes-components/troubleshooting-worker-nodes-and-generic-components.md diff --git a/docs/en/troubleshooting/dns/dns.md b/docs/en/troubleshooting/other-troubleshooting-tips/dns.md similarity index 92% rename from docs/en/troubleshooting/dns/dns.md rename to docs/en/troubleshooting/other-troubleshooting-tips/dns.md index 1b392ccdf16..2aae15a34f5 100644 --- a/docs/en/troubleshooting/dns/dns.md +++ b/docs/en/troubleshooting/other-troubleshooting-tips/dns.md @@ -7,7 +7,7 @@ The commands/steps listed on this page can be used to check name resolution issu Make sure you configured the correct kubeconfig (for example, `export KUBECONFIG=$PWD/kube_config_cluster.yml` for Rancher HA) or are using the embedded kubectl via the UI. -Before running the DNS checks, check the [default DNS provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#default-dns-provider) for your cluster and make sure that [the overlay network is functioning correctly]({{}}/rancher/v2.6/en/troubleshooting/networking/#check-if-overlay-network-is-functioning-correctly) as this can also be the reason why DNS resolution (partly) fails. +Before running the DNS checks, check the [default DNS provider](cluster-provisioning/rke-clusters/options/#default-dns-provider) for your cluster and make sure that [the overlay network is functioning correctly](networking.md#check-if-overlay-network-is-functioning-correctly) as this can also be the reason why DNS resolution (partly) fails. ### Check if DNS pods are running @@ -200,7 +200,7 @@ As the `kubelet` is running inside a container, the path for files located in `/ ::: -See [Editing Cluster as YAML]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/#editing-clusters-with-yaml) how to apply this change. When the provisioning of the cluster has finished, you have to remove the kube-dns pod to activate the new setting in the pod: +See [Editing Cluster as YAML](../../pages-for-subheaders/cluster-configuration.md#editing-clusters-with-yaml) how to apply this change. When the provisioning of the cluster has finished, you have to remove the kube-dns pod to activate the new setting in the pod: ``` kubectl delete pods -n kube-system -l k8s-app=kube-dns diff --git a/docs/en/troubleshooting/expired-webhook-certificates/expired-webhook-certificates.md b/docs/en/troubleshooting/other-troubleshooting-tips/expired-webhook-certificate-rotation.md similarity index 100% rename from docs/en/troubleshooting/expired-webhook-certificates/expired-webhook-certificates.md rename to docs/en/troubleshooting/other-troubleshooting-tips/expired-webhook-certificate-rotation.md diff --git a/docs/en/troubleshooting/kubernetes-resources/kubernetes-resources.md b/docs/en/troubleshooting/other-troubleshooting-tips/kubernetes-resources.md similarity index 98% rename from docs/en/troubleshooting/kubernetes-resources/kubernetes-resources.md rename to docs/en/troubleshooting/other-troubleshooting-tips/kubernetes-resources.md index 450f02f85df..b135139882e 100644 --- a/docs/en/troubleshooting/kubernetes-resources/kubernetes-resources.md +++ b/docs/en/troubleshooting/other-troubleshooting-tips/kubernetes-resources.md @@ -3,7 +3,7 @@ title: Kubernetes resources weight: 101 --- -The commands/steps listed on this page can be used to check the most important Kubernetes resources and apply to [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) clusters. +The commands/steps listed on this page can be used to check the most important Kubernetes resources and apply to [Rancher Launched Kubernetes](../../pages-for-subheaders/launch-kubernetes-with-rancher.md) clusters. Make sure you configured the correct kubeconfig (for example, `export KUBECONFIG=$PWD/kube_config_cluster.yml` for Rancher HA) or are using the embedded kubectl via the UI. @@ -266,6 +266,6 @@ kubectl get pods --all-namespaces -o go-template='{{range .items}}{{if eq .statu ### Job does not complete -If you have enabled Istio, and you are having issues with a Job you deployed not completing, you will need to add an annotation to your pod using [these steps.]({{}}/rancher/v2.6/en/istio/setup/enable-istio-in-namespace) +If you have enabled Istio, and you are having issues with a Job you deployed not completing, you will need to add an annotation to your pod using [these steps.](../../how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md) Since Istio Sidecars run indefinitely, a Job cannot be considered complete even after its task has completed. This is a temporary workaround and will disable Istio for any traffic to/from the annotated Pod. Keep in mind this may not allow you to continue to use a Job for integration testing, as the Job will not have access to the service mesh. \ No newline at end of file diff --git a/docs/en/troubleshooting/logging/logging.md b/docs/en/troubleshooting/other-troubleshooting-tips/logging.md similarity index 100% rename from docs/en/troubleshooting/logging/logging.md rename to docs/en/troubleshooting/other-troubleshooting-tips/logging.md diff --git a/docs/en/troubleshooting/networking/networking.md b/docs/en/troubleshooting/other-troubleshooting-tips/networking.md similarity index 91% rename from docs/en/troubleshooting/networking/networking.md rename to docs/en/troubleshooting/other-troubleshooting-tips/networking.md index c6b55500b8c..00863c315dd 100644 --- a/docs/en/troubleshooting/networking/networking.md +++ b/docs/en/troubleshooting/other-troubleshooting-tips/networking.md @@ -9,7 +9,7 @@ Make sure you configured the correct kubeconfig (for example, `export KUBECONFIG ### Double check if all the required ports are opened in your (host) firewall -Double check if all the [required ports]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements) are opened in your (host) firewall. The overlay network uses UDP in comparison to all other required ports which are TCP. +Double check if all the [required ports](../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md#networking-requirements) are opened in your (host) firewall. The overlay network uses UDP in comparison to all other required ports which are TCP. ### Check if overlay network is functioning correctly The pod can be scheduled to any of the hosts you used for your cluster, but that means that the NGINX ingress controller needs to be able to route the request from `NODE_1` to `NODE_2`. This happens over the overlay network. If the overlay network is not functioning, you will experience intermittent TCP/HTTP connection failures due to the NGINX ingress controller not being able to route to the pod. @@ -90,7 +90,7 @@ This container [does not support ARM nodes](https://github.com/leodotcloud/swiss wk1 can reach wk1 => End network overlay test ``` - If you see error in the output, there is some issue with the route between the pods on the two hosts. In the above output the node `wk2` has no connectivity over the overlay network. This could be because the [required ports]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements) for overlay networking are not opened for `wk2`. + If you see error in the output, there is some issue with the route between the pods on the two hosts. In the above output the node `wk2` has no connectivity over the overlay network. This could be because the [required ports](../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md#networking-requirements) for overlay networking are not opened for `wk2`. 6. You can now clean up the DaemonSet by running `kubectl delete ds/overlaytest`. diff --git a/docs/en/troubleshooting/rancherha/rancherha.md b/docs/en/troubleshooting/other-troubleshooting-tips/rancher-ha.md similarity index 100% rename from docs/en/troubleshooting/rancherha/rancherha.md rename to docs/en/troubleshooting/other-troubleshooting-tips/rancher-ha.md diff --git a/docs/en/troubleshooting/imported-clusters/imported-clusters.md b/docs/en/troubleshooting/other-troubleshooting-tips/registered-clusters.md similarity index 100% rename from docs/en/troubleshooting/imported-clusters/imported-clusters.md rename to docs/en/troubleshooting/other-troubleshooting-tips/registered-clusters.md diff --git a/docs/en/troubleshooting/userid-tracking-in-audit-logs/userid-tracking-in-audit-logs.md b/docs/en/troubleshooting/other-troubleshooting-tips/user-id-tracking-in-audit-logs.md similarity index 88% rename from docs/en/troubleshooting/userid-tracking-in-audit-logs/userid-tracking-in-audit-logs.md rename to docs/en/troubleshooting/other-troubleshooting-tips/user-id-tracking-in-audit-logs.md index e6150b18bf8..d7def700d06 100644 --- a/docs/en/troubleshooting/userid-tracking-in-audit-logs/userid-tracking-in-audit-logs.md +++ b/docs/en/troubleshooting/other-troubleshooting-tips/user-id-tracking-in-audit-logs.md @@ -5,8 +5,8 @@ weight: 110 The following audit logs are used in Rancher to track events occuring on the local and downstream clusters: -* [Kubernetes Audit Logs]({{}}/rke/latest/en/config-options/audit-log/) -* [Rancher API Audit Logs]({{}}/rancher/v2.6/en/installation/resources/advanced/api-audit-log/) +* [Kubernetes Audit Logs](https://rancher.com/docs/rke/latest/en/config-options/audit-log/) +* [Rancher API Audit Logs](../../getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/enable-api-audit-log.md) Audit logs in Rancher v2.6 have been enhanced to include the external Identity Provider name (common name of the user in the external Auth provider) in both the Rancher and downstream Kubernetes audit logs. diff --git a/docs/en/user-settings/user-settings.md b/docs/en/user-settings/user-settings.md deleted file mode 100644 index 3781c633859..00000000000 --- a/docs/en/user-settings/user-settings.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: User Settings -weight: 23 ---- - -Within Rancher, each user has a number of settings associated with their login: personal preferences, API keys, etc. You can configure these settings by choosing from the **User Settings** menu. You can open this menu by clicking your avatar, located within the main menu. - -![User Settings Menu]({{}}/img/rancher/user-settings.png) - -The available user settings are: - -- [API & Keys]({{}}/rancher/v2.6/en/user-settings/api-keys/): If you want to interact with Rancher programmatically, you need an API key. Follow the directions in this section to obtain a key. -- [Cloud Credentials]({{}}/rancher/v2.6/en/user-settings/cloud-credentials/): Manage cloud credentials [used by node templates]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) to [provision nodes for clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters). -- [Node Templates]({{}}/rancher/v2.6/en/user-settings/node-templates): Manage templates [used by Rancher to provision nodes for clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters). -- [Preferences]({{}}/rancher/v2.6/en/user-settings/preferences): Sets superficial preferences for the Rancher UI. -- Log Out: Ends your user session.