[2.5] Move files out of pages-for-subheaders

2026-09-29 14:38:50 +00:00 · 2024-01-11 16:36:20 -08:00
parent 3a4b7e73c0
commit ca77220901
234 changed files with 1148 additions and 1148 deletions
@@ -0,0 +1,9 @@
+---
+title: Advanced
+---
+
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/advanced-user-guides"/>
+</head>
+
+The documents in this section contain resources for less common use cases.
@@ -9,16 +9,16 @@ A layer-7 load balancer can be beneficial if you want to centralize your TLS ter
 This install procedure walks you through deployment of Rancher using a single container, and then provides a sample configuration for a layer-7 NGINX load balancer.

 > **Want to skip the external load balancer?**
-> See [Docker Installation](../../../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md) instead.
+> See [Docker Installation](../../other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md) instead.

 ## Requirements for OS, Docker, Hardware, and Networking

-Make sure that your node fulfills the general [installation requirements.](../../../../pages-for-subheaders/installation-requirements.md)
+Make sure that your node fulfills the general [installation requirements.](../../installation-requirements/installation-requirements.md)


 ## 1. Provision Linux Host

-Provision a single Linux host according to our [Requirements](../../../../pages-for-subheaders/installation-requirements.md) to launch your Rancher Server.
+Provision a single Linux host according to our [Requirements](../../installation-requirements/installation-requirements.md) to launch your Rancher Server.

 ## 2. Choose an SSL Option and Install Rancher

@@ -156,7 +156,7 @@ http {
 ## What's Next?

 - **Recommended:** Review Single Node [Backup](../../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-docker-installed-rancher.md) and [Restore](../../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-docker-installed-rancher.md). 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).
+- Create a Kubernetes cluster: [Provisioning Kubernetes Clusters](../../../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md).

 <br/>

@@ -178,7 +178,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](../../../../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 `<REGISTRY.DOMAIN.COM:PORT>` with your private registry URL in front of `rancher/rancher:latest`.
+If you are visiting this page to complete an [Air Gap Installation](../../other-installation-methods/air-gapped-helm-cli-install/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 `<REGISTRY.DOMAIN.COM:PORT>` with your private registry URL in front of `rancher/rancher:latest`.

 **Example:**

@@ -198,7 +198,7 @@ docker run -d --restart=unless-stopped \
  rancher/rancher:latest
 ```

-As of Rancher v2.5, privileged access is [required.](../../../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher-v25)
+As of Rancher v2.5, privileged access is [required.](../../other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md#privileged-access-for-rancher-v25)

 This layer 7 NGINX configuration is tested on NGINX version 1.13 (mainline) and 1.14 (stable).

@@ -66,7 +66,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 [Logging](../../../../pages-for-subheaders/logging.md) 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 [Logging](../../../../explanations/integrations-in-rancher/logging/logging.md) for details.

 ## Audit Log Samples

@@ -0,0 +1,126 @@
+---
+title: Enabling Experimental Features
+---
+
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/enable-experimental-features"/>
+</head>
+
+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](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:
+
+- [Enable features when starting Rancher.](#enabling-features-when-starting-rancher) When installing Rancher with a CLI, you can use a feature flag to enable a feature by default.
+- [Enable features from the Rancher UI](#enabling-features-with-the-rancher-ui) by going to the **Settings** page.
+- [Enable features with the Rancher API](#enabling-features-with-the-rancher-api) after installing Rancher.
+
+Each feature has two values:
+
+- A default value, which can be configured with a flag or environment variable from the command line
+- A set value, which can be configured with the Rancher API or UI
+
+If no value has been set, Rancher uses the default value.
+
+Because the API sets the actual value and the command line sets the default value, that means that if you enable or disable a feature with the API or UI, it will override any value set with the command line.
+
+For example, if you install Rancher, then set a feature flag to true with the Rancher API, then upgrade Rancher with a command that sets the feature flag to false, the default value will still be false, but the feature will still be enabled because it was set with the Rancher API. If you then deleted the set value (true) with the Rancher API, setting it to NULL, the default value (false) would take effect. See the [feature flags page](../../../../reference-guides/installation-references/feature-flags.md) for more information.
+
+## Enabling Features when Starting Rancher
+
+When you install Rancher, enable the feature you want with a feature flag. The command is different depending on whether you are installing Rancher on a single node or if you are doing a Kubernetes Installation of Rancher.
+
+### Enabling Features for Kubernetes Installs
+
+:::note
+
+Values set from the Rancher API will override the value passed in through the command line.
+
+:::
+
+When installing Rancher with a Helm chart, use the `--set` option. In the below example, two features are enabled by passing the feature flag names in a comma separated list:
+
+```
+helm install rancher rancher-latest/rancher \
+  --namespace cattle-system \
+  --set hostname=rancher.my.org \
+  --set 'extraEnv[0].name=CATTLE_FEATURES'
+  --set 'extraEnv[0].value=<FEATURE-FLAG-NAME-1>=true,<FEATURE-FLAG-NAME-2>=true'
+```
+
+:::note
+
+If you are installing an alpha version, Helm requires adding the `--devel` option to the command.
+
+:::
+
+### 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.](../../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.
+
+The Helm command is as follows:
+
+```
+helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
+  --no-hooks \ # prevent files for Helm hooks from being generated
+  --namespace cattle-system \
+  --set hostname=<RANCHER.YOURDOMAIN.COM> \
+  --set rancherImage=<REGISTRY.YOURDOMAIN.COM:PORT>/rancher/rancher \
+  --set ingress.tls.source=secret \
+  --set systemDefaultRegistry=<REGISTRY.YOURDOMAIN.COM:PORT> \ # Set a default private registry to be used in Rancher
+  --set useBundledSystemChart=true # Use the packaged Rancher system charts
+  --set 'extraEnv[0].name=CATTLE_FEATURES'
+  --set 'extraEnv[0].value=<FEATURE-FLAG-NAME-1>=true,<FEATURE-FLAG-NAME-2>=true'
+```
+
+### Enabling Features for Docker Installs
+
+When installing Rancher with Docker, use the `--features` option. In the below example, two features are enabled by passing the feature flag names in a comma separated list:
+
+```
+docker run -d -p 80:80 -p 443:443 \
+  --restart=unless-stopped \
+  rancher/rancher:rancher-latest \
+  --features=<FEATURE-FLAG-NAME-1>=true,<FEATURE-FLAG-NAME-2>=true
+```
+
+## Enabling Features with the Rancher UI
+
+1. In the upper left corner, click **☰ > Global Settings**.
+1. Click **Feature Flags**.
+1. To enable a feature, go to the disabled feature you want to enable and click **⋮ > Activate**.
+
+**Result:** The feature is enabled.
+
+### Disabling Features with the Rancher UI
+
+1. In the upper left corner, click **☰ > Global Settings**.
+1. Click **Feature Flags**. You will see a list of experimental features.
+1. To disable a feature, go to the enabled feature you want to disable and click **⋮ > Deactivate**.
+
+**Result:** The feature is disabled.
+
+## Enabling Features with the Rancher API
+
+1. Go to `<RANCHER-SERVER-URL>/v3/features`.
+1. In the `data` section, you will see an array containing all of the features that can be turned on with feature flags. The name of the feature is in the `id` field. Click the name of the feature you want to enable.
+1. In the upper left corner of the screen, under **Operations,** click **Edit**.
+1. In the **Value** drop-down menu, click **True**.
+1. Click **Show Request**.
+1. Click **Send Request**.
+1. Click **Close**.
+
+**Result:** The feature is enabled.
+
+### Disabling Features with the Rancher API
+
+1. Go to `<RANCHER-SERVER-URL>/v3/features`.
+1. In the `data` section, you will see an array containing all of the features that can be turned on with feature flags. The name of the feature is in the `id` field. Click the name of the feature you want to enable.
+1. In the upper left corner of the screen, under **Operations,** click **Edit**.
+1. In the **Value** drop-down menu, click **False**.
+1. Click **Show Request**.
+1. Click **Send Request**.
+1. Click **Close**.
+
+**Result:** The feature is disabled.
@@ -4,9 +4,9 @@ title: UI for Istio Virtual Services and Destination Rules

 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](../../../../pages-for-subheaders/istio-setup-guide.md) 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](../../../../how-to-guides/advanced-user-guides/istio-setup-guide/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.](../../../../pages-for-subheaders/enable-experimental-features.md)
+To enable or disable this feature, refer to the instructions on [the main page about enabling experimental features.](enable-experimental-features.md)

 Environment Variable Key | Default Value | Status | Available as of
 ---|---|---|---
@@ -9,7 +9,7 @@ title: "Running on ARM64 (Experimental)"
 The following options are available when using an ARM64 platform:

 - Running Rancher on ARM64 based node(s)
-  - Only for Docker Install. Please note that the following installation command replaces the examples found in the [Docker Install](../../../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md) link:
+  - Only for Docker Install. Please note that the following installation command replaces the examples found in the [Docker Install](../../other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md) link:

  ```
  # In the last line `rancher/rancher:vX.Y.Z`, be certain to replace "X.Y.Z" with a released version in which ARM64 builds exist. For  example, if your matching version is v2.5.8, you would fill in this line with `rancher/rancher:v2.5.8`.