Fix formatting for air gap docs

This commit is contained in:
Catherine Luse
2021-05-04 15:02:37 -07:00
parent 5a3cca8653
commit e3ce36d0b7
3 changed files with 22 additions and 24 deletions
@@ -64,29 +64,29 @@ helm template ./rancher-<VERSION>.tgz --output-dir . \
```plain ```plain
helm template ./rancher-<VERSION>.tgz --output-dir . \ helm template ./rancher-<VERSION>.tgz --output-dir . \
--name rancher \ --name rancher \
--no-hooks \ # prevent files for Helm hooks from being generated --no-hooks \ # prevent files for Helm hooks from being generated
--namespace cattle-system \ --namespace cattle-system \
--set hostname=<RANCHER.YOURDOMAIN.COM> \ --set hostname=<RANCHER.YOURDOMAIN.COM> \
--set rancherImage=<REGISTRY.YOURDOMAIN.COM:PORT>/rancher/rancher \ --set rancherImage=<REGISTRY.YOURDOMAIN.COM:PORT>/rancher/rancher \
--set ingress.tls.source=secret \ --set ingress.tls.source=secret \
--set systemDefaultRegistry=<REGISTRY.YOURDOMAIN.COM:PORT> \ # Set a default private registry to be used in Rancher --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 useBundledSystemChart=true # Use the packaged Rancher system charts
``` ```
If you are using a Private CA signed cert, add `--set privateCA=true` following `--set ingress.tls.source=secret`: If you are using a Private CA signed cert, add `--set privateCA=true` following `--set ingress.tls.source=secret`:
```plain ```plain
helm template ./rancher-<VERSION>.tgz --output-dir . \ helm template ./rancher-<VERSION>.tgz --output-dir . \
--name rancher \ --name rancher \
--no-hooks \ # prevent files for Helm hooks from being generated --no-hooks \ # prevent files for Helm hooks from being generated
--namespace cattle-system \ --namespace cattle-system \
--set hostname=<RANCHER.YOURDOMAIN.COM> \ --set hostname=<RANCHER.YOURDOMAIN.COM> \
--set rancherImage=<REGISTRY.YOURDOMAIN.COM:PORT>/rancher/rancher \ --set rancherImage=<REGISTRY.YOURDOMAIN.COM:PORT>/rancher/rancher \
--set ingress.tls.source=secret \ --set ingress.tls.source=secret \
--set privateCA=true \ --set privateCA=true \
--set systemDefaultRegistry=<REGISTRY.YOURDOMAIN.COM:PORT> \ # Set a default private registry to be used in Rancher --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 useBundledSystemChart=true # Use the packaged Rancher system charts
``` ```
{{% /tab %}} {{% /tab %}}
@@ -191,7 +191,7 @@ Render the Rancher template, declaring your chosen options. Use the reference ta
```plain ```plain
helm template rancher ./rancher-<VERSION>.tgz --output-dir . \ helm template rancher ./rancher-<VERSION>.tgz --output-dir . \
--no-hooks \ # prevent files for Helm hooks from being generated --no-hooks \ # prevent files for Helm hooks from being generated
--namespace cattle-system \ --namespace cattle-system \
--set hostname=<RANCHER.YOURDOMAIN.COM> \ --set hostname=<RANCHER.YOURDOMAIN.COM> \
--set rancherImage=<REGISTRY.YOURDOMAIN.COM:PORT>/rancher/rancher \ --set rancherImage=<REGISTRY.YOURDOMAIN.COM:PORT>/rancher/rancher \
@@ -51,10 +51,10 @@ The below table shows the availability and default value for feature flags in Ra
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. 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. > **Note:** Values set from the Rancher API will override the value passed in through the command line.
{{% tabs %}}
{{% tab "Kubernetes Install" %}}
When installing Rancher with a Helm chart, use the `--features` option. In the below example, two features are enabled by passing the feature flag names names in a comma separated list: When installing Rancher with a Helm chart, use the `--features` option. In the below example, two features are enabled by passing the feature flag names names in a comma separated list:
``` ```
@@ -123,8 +123,8 @@ helm template ./rancher-<VERSION>.tgz --output-dir . \
--set 'extraEnv[0].value=<FEATURE-FLAG-NAME-1>=true,<FEATURE-FLAG-NAME-2>=true' --set 'extraEnv[0].value=<FEATURE-FLAG-NAME-1>=true,<FEATURE-FLAG-NAME-2>=true'
``` ```
{{% /tab %}} ### Enabling Features for Docker Installs
{{% tab "Docker Install" %}}
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: 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:
``` ```
@@ -134,8 +134,6 @@ docker run -d -p 80:80 -p 443:443 \
--features=<FEATURE-FLAG-NAME-1>=true,<FEATURE-NAME-2>=true --features=<FEATURE-FLAG-NAME-1>=true,<FEATURE-NAME-2>=true
``` ```
{{% /tab %}}
{{% /tabs %}}
# Enabling Features with the Rancher UI # Enabling Features with the Rancher UI