Fix order of headings (#1465)

* Fix 'title out of sequence' errors fixed Dockershim.md * fixed deprecated-features.md * fixed install-and-configure-kubectl.md * fixed rancher-is-no-longer-needed.md * fixed security.md * fixed technical-items.md + spacing, duplicate section, admonitions * fixed telemetry.md * fixed upgrades.md * fixed upgrade-kubernetes-without-upgrading-rancher.md * fixed air-gapped-upgrades.md * fixed dockershim.md * fixed docker-install-commands.md * fixed install-kubernetes.md * fixed infrastructure-private-registry.md * fixed install-rancher-ha * fixed manage-namespaces and tune-etcd-for-large-installs.md * fixed cis-scans/configuration-reference.md * fixed custom-benchmark.md * fixed supportconfig.md * fixed harvester/overview.md * fixed logging-architecture.md * fixed logging-helm-chart-options.md + rm'd unnecessary annotation title * fixed taints-and-tolerances.md * fixed longhorn/overview.md * fixed neuvector/overview.md * fixed monitoring-and-alerting * fixed rancher-cli.md * fixed cluster-configuration.md * fixed monitoring-v2-configuration/examples.md * fixed servicemonitors-and-podmonitors.md * fixed other-troubleshooting-tips/dns.md
2026-09-26 13:08:11 +00:00 · 2024-09-18 14:02:55 -04:00
parent 9f8e1a7a53
commit c869ea69ac
191 changed files with 1059 additions and 1135 deletions
@@ -14,7 +14,7 @@ To configure the custom resources, go to the **Cluster Dashboard** To configure
 1. On the **Clusters** page, go to the cluster where you want to configure CIS scans and click **Explore**.
 1. In the left navigation bar, click **CIS Benchmark**.

-### Scans
+## Scans

 A scan is created to trigger a CIS scan on the cluster based on the defined profile. A report is created after the scan is completed.

@@ -31,7 +31,7 @@ spec:
  scanProfileName: rke-profile-hardened
 ```

-### Profiles
+## Profiles

 A profile contains the configuration for the CIS scan, which includes the benchmark version to use and any specific tests to skip in that benchmark.

@@ -66,7 +66,7 @@ spec:
    - "1.1.21"
 ```

-### Benchmark Versions
+## Benchmark Versions

 A benchmark version is the name of benchmark to run using `kube-bench`, as well as the valid configuration parameters for that benchmark.

@@ -17,7 +17,7 @@ When a cluster scan is run, you need to select a Profile which points to a speci

 Follow all the steps below to add a custom Benchmark Version and run a scan using it.

-### 1. Prepare the Custom Benchmark Version ConfigMap
+## 1. Prepare the Custom Benchmark Version ConfigMap

 To create a custom benchmark version, first you need to create a ConfigMap containing the benchmark version's config files and upload it to your Kubernetes cluster where you want to run the scan.

@@ -42,7 +42,7 @@ To prepare a custom benchmark version ConfigMap, suppose we want to add a custom
    kubectl create configmap -n <namespace> foo --from-file=<path to directory foo>
    ```

-### 2. Add a Custom Benchmark Version to a Cluster
+## 2. Add a Custom Benchmark Version to a Cluster

 1. In the upper left corner, click **☰ > Cluster Management**.
 1. On the **Clusters** page, go to the cluster where you want to add a custom benchmark and click **Explore**.
@@ -54,7 +54,7 @@ To prepare a custom benchmark version ConfigMap, suppose we want to add a custom
 1. Add the minimum and maximum Kubernetes version limits applicable, if any.
 1. Click **Create**.

-### 3. Create a New Profile for the Custom Benchmark Version
+## 3. Create a New Profile for the Custom Benchmark Version

 To run a scan using your custom benchmark version, you need to add a new Profile pointing to this benchmark version.

@@ -66,7 +66,7 @@ To run a scan using your custom benchmark version, you need to add a new Profile
 1. Choose the Benchmark Version from the dropdown.
 1. Click **Create**.

-### 4. Run a Scan Using the Custom Benchmark Version
+## 4. Run a Scan Using the Custom Benchmark Version

 Once the Profile pointing to your custom benchmark version `foo` has been created, you can create a new Scan to run the custom test configs in the Benchmark Version.

@@ -1,5 +1,5 @@
 ---
-title: Supportconfig bundle
+title: Supportconfig Bundle
 ---

 <head>
@@ -12,7 +12,7 @@ These bundles can be created through Rancher or through direct access to the clu

 > **Note:** Only admin users can generate/download supportconfig bundles, regardless of method.

-### Accessing through Rancher
+## Accessing Through Rancher

 First, click on the hamburger menu. Then click the `Get Support` button.

@@ -24,7 +24,7 @@ In the next page, click on the `Generate Support Config` button.

 ![Get Support](/img/generate-support-config.png)

-### Accessing without rancher
+## Accessing Without Rancher

 First, generate a kubeconfig for the cluster that Rancher is installed on.

@@ -8,7 +8,7 @@ title: Overview

 Introduced in Rancher v2.6.1, [Harvester](https://docs.harvesterhci.io/) is an open-source hyper-converged infrastructure (HCI) software built on Kubernetes. Harvester installs on bare metal servers and provides integrated virtualization and distributed storage capabilities. Although Harvester operates using Kubernetes, it does not require users to know Kubernetes concepts, making it a more user-friendly application.

-### Feature Flag
+## 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](../../how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md) for more information on feature flags in Rancher.

@@ -22,7 +22,7 @@ To navigate to the Harvester cluster, click **☰ > Virtualization Management**.

 * Users may import a Harvester cluster only on the Virtualization Management page. Importing a cluster on the Cluster Management page is not supported, and a warning will advise you to return to the VM page to do so.

-### Harvester Node Driver
+## Harvester Node Driver

 The [Harvester node driver](https://docs.harvesterhci.io/v1.1/rancher/node/node-driver/) is generally available for RKE and RKE2 options in Rancher. The node driver is available whether or not the Harvester feature flag is enabled. Note that the node driver is off by default. Users may create RKE or RKE2 clusters on Harvester only from the Cluster Management page.

@@ -30,7 +30,7 @@ Harvester allows `.ISO` images to be uploaded and displayed through the Harveste

 See [Provisioning Drivers](../../how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md#node-drivers) for more information on node drivers in Rancher.

-### Port Requirements
+## Port Requirements

 The port requirements for the Harvester cluster can be found [here](https://docs.harvesterhci.io/v1.1/install/requirements#networking).

@@ -10,7 +10,7 @@ This section summarizes the architecture of the Rancher logging application.

 For more details about how the Logging operator works, see the [official documentation.](https://kube-logging.github.io/docs/#architecture)

-### How the Logging Operator Works
+## How the Logging Operator Works

 The Logging operator automates the deployment and configuration of a Kubernetes logging pipeline. It deploys and configures a Fluent Bit DaemonSet on every node to collect container and application logs from the node file system.

@@ -6,7 +6,7 @@ title: rancher-logging Helm Chart Options
  <link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/logging/logging-helm-chart-options"/>
 </head>

-### Enable/Disable Windows Node Logging
+## Enable/Disable Windows Node Logging

 You can enable or disable Windows node logging by setting `global.cattle.windows.enabled` to either `true` or `false` in the `values.yaml`.

@@ -21,7 +21,7 @@ Currently an [issue](https://github.com/rancher/rancher/issues/32325) exists whe

 :::

-### Working with a Custom Docker Root Directory
+## Working with a Custom Docker Root Directory

 If using a custom Docker root directory, you can set `global.dockerRootDirectory` in `values.yaml`.

@@ -31,11 +31,11 @@ Note that this only affects Linux nodes.

 If there are any Windows nodes in the cluster, the change will not be applicable to those nodes.

-### Adding NodeSelector Settings and Tolerations for Custom Taints
+## 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-and-tolerations.md)

-### Enabling the Logging Application to Work with SELinux
+## Enabling the Logging Application to Work with SELinux

 :::note Requirements:

@@ -49,7 +49,7 @@ To use Logging v2 with SELinux, we recommend installing the `rancher-selinux` RP

 Then, when installing the logging application, configure the chart to be SELinux aware by changing `global.seLinux.enabled` to `true` in the `values.yaml`.

-### Additional Logging Sources
+## Additional Logging Sources

 By default, Rancher collects logs for [control plane components](https://kubernetes.io/docs/concepts/overview/components/#control-plane-components) and [node components](https://kubernetes.io/docs/concepts/overview/components/#node-components) for all cluster types.

@@ -72,7 +72,7 @@ When enabled, Rancher collects all additional node and control plane logs the pr

 If you're already using a cloud provider's own logging solution such as AWS CloudWatch or Google Cloud operations suite (formerly Stackdriver), it is not necessary to enable this option as the native solution will have unrestricted access to all logs.

-### Systemd Configuration
+## Systemd Configuration

 In Rancher logging, `SystemdLogPath` must be configured for K3s and RKE2 Kubernetes distributions.

@@ -87,7 +87,7 @@ K3s and RKE2 Kubernetes distributions log to journald, which is the subsystem of
  * If `/var/log/journal` exists, then use `/var/log/journal`.
  * If `/var/log/journal` does not exist, then use `/run/log/journal`.

-:::note Notes:
+:::note

 If any value not described above is returned, Rancher Logging will not be able to collect control plane logs. To address this issue, you will need to perform the following actions on every control plane node:

@@ -20,7 +20,7 @@ Both provide choice for the what node(s) the pod will run on.
 - [Adding NodeSelector Settings and Tolerations for Custom Taints](#adding-nodeselector-settings-and-tolerations-for-custom-taints)


-### Default Implementation in Rancher's Logging Stack
+## Default Implementation in Rancher's Logging Stack

 By default, Rancher taints all Linux nodes with `cattle.io/os=linux`, and does not taint Windows nodes.
 The logging stack pods have `tolerations` for this taint, which enables them to run on Linux nodes.
@@ -47,7 +47,7 @@ In the above example, we ensure that our pod only runs on Linux nodes, and we ad

 You can do the same with Rancher's existing taints, or with your own custom ones.

-### Adding NodeSelector Settings and Tolerations for Custom Taints
+## Adding NodeSelector Settings and Tolerations for Custom Taints

 If you would like to add your own `nodeSelector` settings, or if you would like to add `tolerations` for additional taints, you can pass the following to the chart's values.

@@ -25,7 +25,7 @@ With Longhorn, you can:

 ![Longhorn Dashboard](/img/longhorn-screenshot.png)

-### Installing Longhorn with Rancher
+## Installing Longhorn with Rancher

 1. Fulfill all [Installation Requirements.](https://longhorn.io/docs/latest/deploy/install/#installation-requirements)
 1. Go to the cluster where you want to install Longhorn.
@@ -37,14 +37,14 @@ With Longhorn, you can:

 **Result:** Longhorn is deployed in the Kubernetes cluster.

-### Accessing Longhorn from the Rancher UI
+## Accessing Longhorn from the Rancher UI

 1. Go to the cluster where Longhorn is installed. In the left navigation menu, click **Longhorn**.
 1. On this page, you can edit Kubernetes resources managed by Longhorn. To view the Longhorn UI, click the **Longhorn** button in the **Overview** section.

 **Result:** You will be taken to the Longhorn UI, where you can manage your Longhorn volumes and their replicas in the Kubernetes cluster, as well as secondary backups of your Longhorn storage that may exist in another Kubernetes cluster or in S3.

-### Uninstalling Longhorn from the Rancher UI
+## Uninstalling Longhorn from the Rancher UI

 1. Go to the cluster where Longhorn is installed and click **Apps**.
 1. Click **Installed Apps**.
@@ -53,15 +53,15 @@ With Longhorn, you can:

 **Result:** Longhorn is uninstalled.

-### GitHub Repository
+## GitHub Repository

 The Longhorn project is available [here.](https://github.com/longhorn/longhorn)

-### Documentation
+## Documentation

 The Longhorn documentation is [here.](https://longhorn.io/docs/)

-### Architecture
+## Architecture

 Longhorn creates a dedicated storage controller for each volume and synchronously replicates the volume across multiple replicas stored on multiple nodes.

@@ -15,7 +15,7 @@ For information on V1 monitoring and alerting, available in Rancher v2.2 up to v

 Using the `rancher-monitoring` application, you can quickly deploy leading open-source monitoring and alerting solutions onto your cluster.

-### Features
+## Features

 Prometheus lets you view metrics from your Rancher and Kubernetes objects. Using timestamps, Prometheus lets you query and view these metrics in easy-to-read graphs and visuals, either through the Rancher UI or Grafana, which is an analytics viewing platform deployed along with Prometheus.

@@ -97,7 +97,6 @@ To be able to fully deploy Monitoring V2 for Windows, all of your Windows hosts

 For more details on how to upgrade wins on existing Windows hosts, see [Windows cluster support for Monitoring V2.](windows-support.md).

-
 ## Known Issues

 There is a [known issue](https://github.com/rancher/rancher/issues/28787#issuecomment-693611821) that K3s clusters require more than the allotted default memory. If you enable monitoring on a K3s cluster, set `prometheus.prometheusSpec.resources.memory.limit` to 2500 Mi and `prometheus.prometheusSpec.resources.memory.request` to 1750 Mi.
@@ -6,13 +6,11 @@ title: Overview
  <link rel="canonical" href="https://ranchermanager.docs.rancher.com/integrations-in-rancher/neuvector/overview"/>
 </head>

-### NeuVector Integration in Rancher
-
 [NeuVector 5.x](https://open-docs.neuvector.com/) is an open-source container-centric security platform that is integrated with 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](../../reference-guides/rancher-security/rancher-security.md).

 NeuVector can be enabled through a Helm chart that may be installed either through **Apps** 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).

-### Installing NeuVector with Rancher
+## Installing NeuVector with Rancher

 The Harvester Helm Chart is used to manage access to the NeuVector UI in Rancher where users can navigate directly to deploy and manage their NeuVector clusters.

@@ -44,12 +42,12 @@ Some examples are as follows:
 1. Click on **Cluster Tools** at the bottom of the left navigation bar.
 1. Repeat step 4 above to select your container runtime accordingly, then click **Install** again.

-### Accessing NeuVector from the Rancher UI
+## Accessing NeuVector from the Rancher UI

 1. Navigate to the cluster explorer of the cluster where NeuVector is installed. In the left navigation bar, click **NeuVector**.
 1. Click the external link to go to the NeuVector UI. Once the link is selected, users must accept the `END USER LICENSE AGREEMENT` to access the NeuVector UI.

-### Uninstalling NeuVector from the Rancher UI
+## Uninstalling NeuVector from the Rancher UI

 **To uninstall from Apps:**

@@ -62,15 +60,15 @@ Some examples are as follows:
 1. Click **☰ > Cluster Management**.
 1. Click on **Cluster Tools** at the bottom-left of the screen, then click on the trash can icon under the NeuVector chart. Select `Delete the CRD associated with this app` if desired, then click **Delete**.

-### GitHub Repository
+## GitHub Repository

 The NeuVector project is available [here](https://github.com/neuvector/neuvector).

-### Documentation
+## Documentation

 The NeuVector documentation is [here](https://open-docs.neuvector.com/).

-### Architecture
+## Architecture

 The NeuVector security solution contains four types of security containers: Controllers, Enforcers, Managers, and Scanners. A special container called an All-in-One is also provided to combine the Controller, Enforcer, and Manager functions all in one container, primarily for Docker-native deployments. There is also an Updater which, when run, will update the CVE database.

@@ -91,7 +89,7 @@ The NeuVector security solution contains four types of security containers: Cont

 To learn more about NeuVector's architecture, please refer [here](https://open-docs.neuvector.com/basics/overview#architecture).

-### CPU and Memory Allocations
+## CPU and Memory Allocations

 Below are the minimum recommended computing resources for the NeuVector chart installation in a default deployment. Note that the resource limit is not set.

@@ -105,7 +103,7 @@ Below are the minimum recommended computing resources for the NeuVector chart in
 \* Minimum 1GB of memory total required for Controller, Manager, and Scanner containers combined.


-### Hardened Cluster Support - Calico and Canal
+## Hardened Cluster Support - Calico and Canal

 <Tabs>
 <TabItem value="RKE1">
@@ -162,7 +160,7 @@ Below are the minimum recommended computing resources for the NeuVector chart in
 </Tabs>


-### SELinux-enabled Cluster Support - Calico and Canal
+## SELinux-enabled Cluster Support - Calico and Canal

 To enable SELinux on RKE2 clusters, follow the steps below:

@@ -179,12 +177,11 @@ kubectl patch deploy neuvector-scanner-pod -n cattle-neuvector-system --patch '{
 kubectl patch cronjob neuvector-updater-pod -n cattle-neuvector-system --patch '{"spec":{"jobTemplate":{"spec":{"template":{"spec":{"securityContext":{"runAsUser": 5400}}}}}}}'
 ```

-### Cluster Support in an Air-Gapped Environment
+## Cluster Support in an Air-Gapped Environment

 - All NeuVector components are deployable on a cluster in an air-gapped environment without any additional configuration needed.

-
-### Support Limitations
+## Support Limitations

 * Only admins and cluster owners are currently supported.

@@ -192,12 +189,10 @@ kubectl patch cronjob neuvector-updater-pod -n cattle-neuvector-system --patch '

 * NeuVector is not supported on a Windows cluster.

-
-### Other Limitations
+## Other Limitations

 * Currently, NeuVector feature chart installation fails when a NeuVector partner chart already exists. To work around this issue, uninstall the NeuVector partner chart and reinstall the NeuVector feature chart.

 * Sometimes when the controllers are not ready, the NeuVector UI is not accessible from the Rancher UI. During this time, controllers will try to restart, and it takes a few minutes for the controllers to be active.

 * Container runtime is not auto-detected for different cluster types when installing the NeuVector chart. To work around this, you can specify the runtime manually.
-