public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-25 04:28:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update terminology 'Apps' vs 'Apps & Marketplace'

Browse Source 
'Apps' applies to Rancher v2.6.5+
'Apps & Marketplace' applies to v2.6.0-v2.6.4
Ref: https://github.com/rancher/dashboard/pull/5489
This commit is contained in:
Billy Tat
2022-12-08 17:26:28 -08:00
parent 37e2e6e63b
commit 6eb75c1d21
48 changed files with 472 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md
+1 -1
View File
@@ -35,7 +35,7 @@ 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](../../../pages-for-subheaders/helm-charts-in-rancher.md#charts) for more information.
If the Rancher Backups app is not visible, you will need to install it from the Charts page in **Apps**. Refer [here](../../../pages-for-subheaders/helm-charts-in-rancher.md#charts) for more information.
:::
docs/how-to-guides/advanced-user-guides/cis-scan-guides/install-rancher-cis-benchmark.md
+1 -1
View File
@@ -4,7 +4,7 @@ title: Install Rancher CIS Benchmark
1. In the upper left corner, click **☰ > Cluster Management**.
1. On the **Clusters** page, go to the cluster where you want to install CIS Benchmark and click **Explore**.
1. In the left navigation bar, click **Apps & Marketplace > Charts**.
1. In the left navigation bar, click **Apps > Charts**.
1. Click **CIS Benchmark**
1. Click **Install**.
docs/how-to-guides/advanced-user-guides/cis-scan-guides/uninstall-rancher-cis-benchmark.md
+1 -1
View File
@@ -2,7 +2,7 @@
title: Uninstall Rancher CIS Benchmark
---
1. From the **Cluster Dashboard,** go to the left navigation bar and click **Apps & Marketplace > Installed Apps**.
1. From the **Cluster Dashboard,** go to the left navigation bar and click **Apps > Installed Apps**.
1. Go to the `cis-operator-system` namespace and check the boxes next to `rancher-cis-benchmark-crd` and `rancher-cis-benchmark`.
1. Click **Delete** and confirm **Delete**.
docs/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md
+1 -1
View File
@@ -13,7 +13,7 @@ title: 1. Enable Istio in the Cluster
1. Click **☰ > Cluster Management**.
1. Go to the where you want to enable Istio and click **Explore**.
1. Click **Apps & Marketplace**.
1. Click **Apps**.
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.
docs/how-to-guides/advanced-user-guides/monitoring-alerting-guides/enable-monitoring.md
+2 -2
View File
@@ -29,7 +29,7 @@ If you want to set up Alertmanager, Grafana or Ingress, it has to be done with t
#Setting Resource Limits and Requests
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.
The resource requests and limits can be configured when installing `rancher-monitoring`. To configure Prometheus resources from the Rancher UI, click **Apps > Monitoring** in the upper left corner.
For more information about the default limits, see [this page.](../../../reference-guides/monitoring-v2-configuration/helm-chart-options.md#configuring-resource-limits-and-requests)
@@ -52,7 +52,7 @@ For more information about the default limits, see [this page.](../../../referen
- Add the `ca`, `cert`, and `key` files to the secret.
1. In the upper left corner, click **☰ > Cluster Management**.
1. On the **Clusters** page, go to the cluster where you want to enable monitoring for use with SSL and click **Explore**.
1. Click **Apps & Marketplace > Charts**.
1. Click **Apps > Charts**.
1. Click **Monitoring**.
1. Click **Install** or **Update**, depending on whether you have already installed Monitoring.
1. Check the box for **Customize Helm options before install** and click **Next**.
docs/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/uninstall-prometheus-federator.md
+1 -1
View File
@@ -4,7 +4,7 @@ title: Uninstall Prometheus Federator
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps & Marketplace**.
1. In the left navigation bar, click **Apps**.
1. Click **Installed Apps**.
1. Go to the `cattle-monitoring-system` namespace and check the boxes for `rancher-monitoring-crd` and `rancher-monitoring`.
1. Click **Delete**.
docs/how-to-guides/advanced-user-guides/monitoring-alerting-guides/uninstall-monitoring.md
+1 -1
View File
@@ -4,7 +4,7 @@ title: Uninstall Monitoring
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps & Marketplace**.
1. In the left navigation bar, click **Apps**.
1. Click **Installed Apps**.
1. Go to the `cattle-monitoring-system` namespace and check the boxes for `rancher-monitoring-crd` and `rancher-monitoring`.
1. Click **Delete**.
docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-cluster-templates.md
+5 -5
View File
@@ -38,7 +38,7 @@ In this section, you'll learn how to add the cluster template to the `local` clu
1. Optional: Edit the cluster options by editing the `values.yaml` file. For help editing the file, see the cluster template's Helm chart README.
1. Add the chart repository to Rancher. Click **☰ > Cluster Management**.
1. Go to the `local` cluster and click **Explore.**
1. In the left navigation bar, click **Apps & Marketplace > Chart Repositories.**
1. In the left navigation bar, click **Apps > Chart Repositories.**
1. Click **Create.**
1. Enter a name for the cluster template repository.
1. Click **Git Repository containing Helm chart definitions.**
@@ -46,7 +46,7 @@ In this section, you'll learn how to add the cluster template to the `local` clu
1. In the **Git Branch** field, enter the branch to use as the source for the template. Rancher's example repository uses `main`.
1. Click **Create.**
**Result:** The cluster template available from the **Apps & Marketplace** in Rancher's `local` cluster. It can now be used to deploy clusters.
**Result:** The cluster template available from the **Apps** in Rancher's `local` cluster. It can now be used to deploy clusters.
:::note Restricted Admin access:
@@ -73,7 +73,7 @@ If you are a restricted admin and don’t have access to the `local` cluster, yo
## Updating a Cluster Created from a Cluster Template
You can update any clusters using a template from the **Apps & Marketplace > Installed Apps** page, given there is a new version of a template being used by those clusters.
You can update any clusters using a template from the **Apps > Installed Apps** page, given there is a new version of a template being used by those clusters.
## Deploying Clusters from a Template with Fleet
@@ -97,13 +97,13 @@ You can update any clusters using a template from the **Apps & Marketplace > Ins
## Uninstalling Cluster Templates
1. Click **☰ > Cluster Management**.
1. Go to the `local` cluster and click **Apps & Marketplace > Chart Repositories.**
1. Go to the `local` cluster and click **Apps > Chart Repositories.**
1. Go to the chart repository for your cluster template and click **⋮ > Delete.**
1. Confirm the deletion.
**Result:** The cluster template is uninstalled. This action does not affect clusters created with the cluster template.
An admin with access to the `local` cluster can also remove a cluster deployed via cluster templates through the **Apps & Marketplace > Installed Apps** page.
An admin with access to the `local` cluster can also remove a cluster deployed via cluster templates through the **Apps > Installed Apps** page.
## Configuration Options
docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md
+1 -1
View File
@@ -28,7 +28,7 @@ Backups are created as .tar.gz files. These files can be pushed to S3 or Minio,
1. In the upper left corner, click **☰ > Cluster Management**.
1. On the **Clusters** page, go to the `local` cluster and click **Explore**. The `local` cluster runs the Rancher server.
1. Click **Apps & Marketplace > Charts**.
1. Click **Apps > Charts**.
1. Click **Rancher Backups**.
1. Click **Install**.
1. Configure the default storage location. For help, refer to the [storage configuration section.](../../../reference-guides/backup-restore-configuration/storage-configuration.md)
docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/configure-out-of-tree-vsphere.md
+2 -2
View File
@@ -34,7 +34,7 @@ The Cloud Provider Interface (CPI) should be installed first before installing t
1. Click **☰ > Cluster Management**.
1. Go to the cluster where the vSphere CPI plugin will be installed and click **Explore**.
1. Click **Apps & Marketplace > Charts**.
1. Click **Apps > Charts**.
1. Click **vSphere CPI**.
1. Fill out the required vCenter details.
1. vSphere CPI initializes all nodes with ProviderID which is needed by the vSphere CSI driver. Check if all nodes are initialized with the ProviderID before installing CSI driver with the following command:
@@ -47,7 +47,7 @@ The Cloud Provider Interface (CPI) should be installed first before installing t
1. Click **☰ > Cluster Management**.
1. Go to the cluster where the vSphere CSI plugin will be installed and click **Explore**.
1. Click **Apps & Marketplace > Charts**.
1. Click **Apps > Charts**.
1. Click **vSphere CSI**.
1. Click **Install**.
1. Fill out the required vCenter details. On the **Features** tab, set **Enable CSI Migration** to **false**.
docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-from-in-tree-to-out-of-tree.md
+2 -2
View File
@@ -58,7 +58,7 @@ Once all nodes are tainted by the running the script, launch the Helm vSphere CP
1. Click **☰ > Cluster Management**.
1. Go to the cluster where the vSphere CPI chart will be installed and click **Explore**.
1. Click **Apps & Marketplace > Charts**.
1. Click **Apps > Charts**.
1. Click **vSphere CPI**..
1. Click **Install**.
1. Fill out the required vCenter details and click **Install**.
@@ -75,7 +75,7 @@ kubectl describe nodes | grep "ProviderID"
1. Click **☰ > Cluster Management**.
1. Go to the cluster where the vSphere CSI chart will be installed and click **Explore**.
1. Click **Apps & Marketplace > Charts**.
1. Click **Apps > Charts**.
1. Click **vSphere CSI**..
1. Click **Install**.
1. Fill out the required vCenter details and click **Install**.
docs/integrations-in-rancher/istio/configuration-options/install-istio-on-rke2-cluster.md
+1 -1
View File
@@ -2,7 +2,7 @@
title: Additional Steps for Installing Istio on an RKE2 Cluster
---
When installing or upgrading the Istio Helm chart through **Apps & Marketplace,**
When installing or upgrading the Istio Helm chart through **Apps,**
1. If you are installing the chart, click **Customize Helm options before install** and click **Next**.
1. You will see options for configuring the Istio Helm chart. On the **Components** tab, check the box next to **Enabled CNI**.
docs/integrations-in-rancher/istio/configuration-options/pod-security-policies.md
+1 -1
View File
@@ -33,7 +33,7 @@ Set the PSP to `unrestricted` in the project where is Istio is installed, or the
### 2. Enable the CNI
When installing or upgrading Istio through **Apps & Marketplace,**
When installing or upgrading Istio through **Apps,**
1. Click **Components**.
2. Check the box next to **Enabled CNI**.
docs/integrations-in-rancher/istio/cpu-and-memory-allocations.md
+1 -1
View File
@@ -38,7 +38,7 @@ To configure the resources allocated to an Istio component,
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps & Marketplace**.
1. In the left navigation bar, click **Apps**.
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](../../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)
docs/integrations-in-rancher/istio/disable-istio.md
+1 -1
View File
@@ -10,7 +10,7 @@ To uninstall Istio,
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps & Marketplace > Installed Apps**.
1. In the left navigation bar, click **Apps > Installed Apps**.
1. In the `istio-system` namespace, go to `rancher-istio` and click **⋮ > Delete**.
1. After `rancher-istio` is deleted, you can then select all the remaining apps in the `istio-system` namespace and click **Delete**.
docs/integrations-in-rancher/longhorn.md
+2 -2
View File
@@ -25,7 +25,7 @@ With Longhorn, you can:
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.
1. Click **Apps & Marketplace**.
1. Click **Apps**.
1. Click **Charts**.
1. Click **Longhorn**.
1. Optional: To customize the initial settings, click **Longhorn Default Settings** and edit the configuration. For help customizing the settings, refer to the [Longhorn documentation.](https://longhorn.io/docs/latest/references/settings/)
@@ -42,7 +42,7 @@ With Longhorn, you can:
### Uninstalling Longhorn from the Rancher UI
1. Go to the cluster where Longhorn is installed and click **Apps & Marketplace**.
1. Go to the cluster where Longhorn is installed and click **Apps**.
1. Click **Installed Apps**.
1. Go to the `longhorn-system` namespace and check the boxes next to the `longhorn` and `longhorn-crd` apps.
1. Click **Delete,** and confirm **Delete**.
docs/integrations-in-rancher/neuvector.md
+7 -7
View File
@@ -6,17 +6,17 @@ title: NeuVector Integration
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).
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
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.
**To navigate to and install the NeuVector chart through Apps & Marketplace:**
**To navigate to and install the NeuVector chart through Apps:**
1. Click **☰ > Cluster Management**.
1. On the Clusters page, go to the cluster where you want to deploy NeuVector, and click **Explore**.
1. Go to **Apps & Marketplace > Charts**, and install **NeuVector** from the chart repo.
1. Go to **Apps > Charts**, and install **NeuVector** from the chart repo.
1. Different cluster types require different container runtimes. When configuring Helm chart values, go to the **Container Runtime** section, and select your runtime in accordance with the cluster type. Finally, click **Install** again.
Some examples are as follows:
@@ -47,10 +47,10 @@ Some examples are as follows:
### Uninstalling NeuVector from the Rancher UI
**To uninstall from Apps & Marketplace:**
**To uninstall from Apps:**
1. Click **☰ > Cluster Management**.
1. Under **Apps & Marketplace**, click **Installed Apps**.
1. Under **Apps**, click **Installed Apps**.
1. Under `cattle-neuvector-system`, select both the NeuVector app (and the associated CRD if desired), then click **Delete**.
**To uninstall from Cluster Tools:**
@@ -114,7 +114,7 @@ Below are the minimum recommended computing resources for the NeuVector chart in
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps & Marketplace**.
1. In the left navigation bar, click **Apps**.
1. Install (or upgrade to) NeuVector version `100.0.1+up2.2.2`.
- Under **Edit Options** > **Other Configuration**, enable **Pod Security Policy** by checking the box (no other config needed):
@@ -149,7 +149,7 @@ Below are the minimum recommended computing resources for the NeuVector chart in
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps & Marketplace**.
1. In the left navigation bar, click **Apps**.
1. Install (or upgrade to) NeuVector version `100.0.1+up2.2.2`.
- Under **Edit Options** > **Other Configuration**, enable **Pod Security Policy** by checking the box. Note that you must also enter a value greater than `zero` for `Manager runAsUser ID`, `Scanner runAsUser ID`, and `Updater runAsUser ID`:
docs/integrations-in-rancher/opa-gatekeeper.md
+2 -2
View File
@@ -35,13 +35,13 @@ Only administrators and cluster owners can enable OPA Gatekeeper.
:::
The OPA Gatekeeper Helm chart can be installed from **Apps & Marketplace**.
The OPA Gatekeeper Helm chart can be installed from **Apps**.
### Enabling OPA Gatekeeper
1. In the upper left corner, click **☰ > Cluster Management**.
1. In the **Clusters** page, go to the cluster where you want to enable OPA Gatekeeper and click **Explore**.
1. In the left navigation bar, click **Apps & Marketplace**.
1. In the left navigation bar, click **Apps**.
1. Click **Charts** and click **OPA Gatekeeper**.
1. Click **Install**.
docs/integrations-in-rancher/rancher-extensions.md
+4 -4
View File
@@ -4,7 +4,7 @@ title: Rancher Extensions
New in Rancher v2.7.0, Rancher introduces **extensions**. Extensions allow users, developers, partners, and customers to extend and enhance the Rancher Manager UI. In addition, users can make changes and create enhancements to their UI functionality independent of Rancher Manager releases. Extensions will enable users to build on top of Rancher to better tailor it to their respective environments. Note that users will also have the ability to update to new versions as well as roll back to a previous version.
Extensions are Helm charts that can only be installed once into a cluster; therefore, these charts have been simplified and separated from the general Helm charts listed under **Apps & Marketplace**.
Extensions are Helm charts that can only be installed once into a cluster; therefore, these charts have been simplified and separated from the general Helm charts listed under **Apps**.
Examples of built-in Rancher Manager extensions are Fleet, Explorer, and Harvester. Examples of other extensions that use the Extensions API that can be manually added are Kubewarden and Elemental.
@@ -16,7 +16,7 @@ Examples of built-in Rancher Manager extensions are Fleet, Explorer, and Harvest
1. Click **☰ > Extensions** under **Configuration**.
2. If not already installed in **Apps & Marketplace**, you must enable the extension operator by clicking the **Enable** button.
2. If not already installed in **Apps**, you must enable the extension operator by clicking the **Enable** button.
- Click **OK** to add the Rancher extension repository if your installation is not air-gapped. Otherwise, uncheck the box to do so and click **OK**.
@@ -31,8 +31,8 @@ In v2.7.0, the built-in extensions will not be displayed under the **Available**
:::
<br/>
4. If no extensions are showing as available, you may manually add repos as follows:
4. If no extensions are showing as available, you may manually add repos as follows:
4.1. On the upper right of screen, click on **⋮ > Manage Repositories > Create**.
4.2. Add the desired repo name, making sure to also specify the Git Repo URL and the Git Branch.
docs/pages-for-subheaders/backup-restore-and-disaster-recovery.md
+2 -2
View File
@@ -4,7 +4,7 @@ title: Backups and Disaster Recovery
In this section, you'll learn how to create backups of Rancher, how to restore Rancher from backup, and how to migrate Rancher to a new Kubernetes cluster.
The `rancher-backup` operator is used to backup and restore Rancher on any Kubernetes cluster. This application is a Helm chart, and it can be deployed through the Rancher **Apps & Marketplace** page, or by using the Helm CLI. The `rancher-backup` Helm chart is [here.](https://github.com/rancher/charts/tree/release-v2.6/charts/rancher-backup)
The `rancher-backup` operator is used to backup and restore Rancher on any Kubernetes cluster. This application is a Helm chart, and it can be deployed through the Rancher **Apps** page, or by using the Helm CLI. The `rancher-backup` Helm chart is [here.](https://github.com/rancher/charts/tree/release-v2.6/charts/rancher-backup)
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.
@@ -51,7 +51,7 @@ There is a known issue in Fleet that occurs after performing a restoration using
1. In the upper left corner, click **☰ > Cluster Management**.
1. On the **Clusters** page, go to the `local` cluster and click **Explore**.
1. In the left navigation bar, **Apps & Marketplace > Charts**.
1. In the left navigation bar, **Apps > Charts**.
1. Click **Rancher Backups**.
1. Click **Install**.
1. Optional: Configure the default storage location. For help, refer to the [configuration section.](../reference-guides/backup-restore-configuration/storage-configuration.md)
docs/pages-for-subheaders/helm-charts-in-rancher.md
+6 -6
View File
@@ -2,13 +2,13 @@
title: Helm Charts in Rancher
---
In this section, you'll learn how to manage Helm chart repositories and applications in Rancher. Helm chart repositories are managed using **Apps & Marketplace**. It uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Helm applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster.
In this section, you'll learn how to manage Helm chart repositories and applications in Rancher. Helm chart repositories are managed using **Apps**. It uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Helm applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster.
### Changes in Rancher v2.6
Starting in Rancher v2.6.0, a new versioning scheme for Rancher feature charts was implemented. The changes are centered around the major version of the charts and the +up annotation for upstream charts, where applicable.
**Major Version:** The major version of the charts is tied to Rancher minor versions. When you upgrade to a new Rancher minor version, you should ensure that all of your **Apps & Marketplace** charts are also upgraded to the correct release line for the chart.
**Major Version:** The major version of the charts is tied to Rancher minor versions. When you upgrade to a new Rancher minor version, you should ensure that all of your **Apps** charts are also upgraded to the correct release line for the chart.
:::note
@@ -47,7 +47,7 @@ Any major versions that are less than the ones mentioned in the table below are
### Charts
From the top-left menu select _"Apps & Marketplace"_ and you will be taken to the Charts page.
From the top-left menu select _"Apps"_ and you will be taken to the Charts page.
The charts page contains all Rancher, Partner, and Custom Charts.
@@ -59,7 +59,7 @@ All three types are deployed and managed in the same way.
:::note
Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) should continue to be managed only by the Cluster Manager, and apps managed with <b>Apps & Marketplace</b> in the new UI must be managed only by <b>Apps & Marketplace</b>.
Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) should continue to be managed only by the Cluster Manager, and apps managed with <b>Apps</b> in the new UI must be managed only by <b>Apps</b>.
:::
@@ -123,7 +123,7 @@ To view all recent changes, go to the _"Recent Operations"_ tab. From there you
After installing a chart, you can find it in the _"Installed Apps"_ tab. In this section you can upgrade or delete the installation, and see further details. When choosing to upgrade, the form and values presented will be the same as installation.
Most Rancher tools have additional pages located in the toolbar below the _"Apps & Marketplace"_ section to help manage and use the features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information.
Most Rancher tools have additional pages located in the toolbar below the _"Apps"_ section to help manage and use the features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information.
:::caution
@@ -137,7 +137,7 @@ If you are upgrading your chart using _"Customize Helm options before upgrade"_
#### Changes in Rancher v2.6.3
The upgrade button has been removed for legacy apps from the **Apps & Marketplace > Installed Apps** page.
The upgrade button has been removed for legacy apps from the **Apps > Installed Apps** page.
If you have a legacy app installed and want to upgrade it:
docs/pages-for-subheaders/logging.md
+2 -2
View File
@@ -11,7 +11,7 @@ For an overview of the changes in v2.5, see [this section.](../integrations-in-r
You can enable the logging for a Rancher managed cluster by going to the Apps page and installing the logging app.
1. Go to the cluster where you want to install logging and click **Apps & Marketplace**.
1. Go to the cluster where you want to install logging and click **Apps**.
1. Click the **Logging** app.
1. Scroll to the bottom of the Helm chart README and click **Install**.
@@ -19,7 +19,7 @@ You can enable the logging for a Rancher managed cluster by going to the Apps pa
## Uninstall Logging
1. Go to the cluster where you want to install logging and click **Apps & Marketplace**.
1. Go to the cluster where you want to install logging and click **Apps**.
1. Click **Installed Apps**.
1. Go to the `cattle-logging-system` namespace and check the boxes for `rancher-logging` and `rancher-logging-crd`.
1. Click **Delete**.
docs/pages-for-subheaders/manage-clusters.md
+1 -1
View File
@@ -35,4 +35,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.**
Tools can be installed through **Apps.**
docs/reference-guides/monitoring-v2-configuration/receivers.md
+1 -1
View File
@@ -142,7 +142,7 @@ The YAML provided here will be directly appended to your receiver within the Ale
The Teams receiver is not a native receiver and must be enabled before it can be used. You can enable the Teams receiver for a Rancher managed cluster by going to the Apps page and installing the rancher-alerting-drivers app with the Teams option selected.
1. In the Rancher UI, go to the cluster where you want to install rancher-alerting-drivers and click **Apps & Marketplace**.
1. In the Rancher UI, go to the cluster where you want to install rancher-alerting-drivers and click **Apps**.
1. Click the **Alerting Drivers** app.
1. Click the **Helm Deploy Options** tab.
1. Select the **Teams** option and click **Install**.
versioned_docs/version-2.6/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md
+1 -1
View File
@@ -35,7 +35,7 @@ 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](../../../pages-for-subheaders/helm-charts-in-rancher.md#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** (Rancher before v2.6.5) or **Apps** (Rancher v2.6.5+). Refer [here](../../../pages-for-subheaders/helm-charts-in-rancher.md#charts) for more information.
:::
versioned_docs/version-2.6/how-to-guides/advanced-user-guides/cis-scan-guides/install-rancher-cis-benchmark.md
+15
View File
@@ -2,10 +2,25 @@
title: Install Rancher CIS Benchmark
---
<Tabs>
<TabItem value="Rancher v2.6.5+">
1. In the upper left corner, click **☰ > Cluster Management**.
1. On the **Clusters** page, go to the cluster where you want to install CIS Benchmark and click **Explore**.
1. In the left navigation bar, click **Apps > Charts**.
1. Click **CIS Benchmark**
1. Click **Install**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. In the upper left corner, click **☰ > Cluster Management**.
1. On the **Clusters** page, go to the cluster where you want to install CIS Benchmark and click **Explore**.
1. In the left navigation bar, click **Apps & Marketplace > Charts**.
1. Click **CIS Benchmark**
1. Click **Install**.
</TabItem>
</Tabs>
**Result:** The CIS scan application is deployed on the Kubernetes cluster.
versioned_docs/version-2.6/how-to-guides/advanced-user-guides/cis-scan-guides/uninstall-rancher-cis-benchmark.md
+13
View File
@@ -2,8 +2,21 @@
title: Uninstall Rancher CIS Benchmark
---
<Tabs>
<TabItem value="Rancher v2.6.5+">
1. From the **Cluster Dashboard,** go to the left navigation bar and click **Apps > Installed Apps**.
1. Go to the `cis-operator-system` namespace and check the boxes next to `rancher-cis-benchmark-crd` and `rancher-cis-benchmark`.
1. Click **Delete** and confirm **Delete**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. From the **Cluster Dashboard,** go to the left navigation bar and click **Apps & Marketplace > Installed Apps**.
1. Go to the `cis-operator-system` namespace and check the boxes next to `rancher-cis-benchmark-crd` and `rancher-cis-benchmark`.
1. Click **Delete** and confirm **Delete**.
</TabItem>
</Tabs>
**Result:** The `rancher-cis-benchmark` application is uninstalled.
versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md
+20
View File
@@ -11,6 +11,23 @@ title: 1. Enable Istio in the Cluster
:::
<Tabs>
<TabItem value="Rancher v2.6.5+">
1. Click **☰ > Cluster Management**.
1. Go to the where you want to enable Istio and click **Explore**.
1. Click **Apps**.
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](../../../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.](../../../pages-for-subheaders/configuration-options.md#overlay-file)
1. Click **Install**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Click **☰ > Cluster Management**.
1. Go to the where you want to enable Istio and click **Explore**.
1. Click **Apps & Marketplace**.
@@ -22,6 +39,9 @@ title: 1. Enable Istio in the Cluster
1. Optional: Add additional resources or configuration via the [overlay file.](../../../pages-for-subheaders/configuration-options.md#overlay-file)
1. Click **Install**.
</TabItem>
</Tabs>
**Result:** Istio is installed at the cluster level.
## Additional Config Options
versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-alerting-guides/enable-monitoring.md
+22 -1
View File
@@ -29,7 +29,7 @@ If you want to set up Alertmanager, Grafana or Ingress, it has to be done with t
#Setting Resource Limits and Requests
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.
The resource requests and limits can be configured when installing `rancher-monitoring`. To configure Prometheus resources from the Rancher UI, click **Apps & Marketplace > Monitoring** (Rancher before v2.6.5) or **Apps > Monitoring** (Rancher v2.6.5+) in the upper left corner.
For more information about the default limits, see [this page.](../../../reference-guides/monitoring-v2-configuration/helm-chart-options.md#configuring-resource-limits-and-requests)
@@ -47,6 +47,24 @@ For more information about the default limits, see [this page.](../../../referen
### Enable Monitoring for use with SSL
<Tabs>
<TabItem value="Rancher v2.6.5+">
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**.
1. On the **Clusters** page, go to the cluster where you want to enable monitoring for use with SSL and click **Explore**.
1. Click **Apps > Charts**.
1. Click **Monitoring**.
1. Click **Install** or **Update**, depending on whether you have already installed Monitoring.
1. Check the box for **Customize Helm options before install** and click **Next**.
1. Click **Alerting**.
1. In the **Additional Secrets** field, add the secrets created earlier.
</TabItem>
<TabItem value="Rancher before v2.6.5">
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.
@@ -59,6 +77,9 @@ For more information about the default limits, see [this page.](../../../referen
1. Click **Alerting**.
1. In the **Additional Secrets** field, add the secrets created earlier.
</TabItem>
</Tabs>
**Result:** The monitoring app is deployed in the `cattle-monitoring-system` namespace.
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`.
versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-alerting-guides/prometheus-federator-guides/uninstall-prometheus-federator.md
+17
View File
@@ -2,6 +2,20 @@
title: Uninstall Prometheus Federator
---
<Tabs>
<TabItem value="Rancher v2.6.5+">
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps**.
1. Click **Installed Apps**.
1. Go to the `cattle-monitoring-system` namespace and check the boxes for `rancher-monitoring-crd` and `rancher-monitoring`.
1. Click **Delete**.
1. Confirm **Delete**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps & Marketplace**.
@@ -10,4 +24,7 @@ title: Uninstall Prometheus Federator
1. Click **Delete**.
1. Confirm **Delete**.
</TabItem>
</Tabs>
**Result:** `prometheus-federator` is uninstalled.
versioned_docs/version-2.6/how-to-guides/advanced-user-guides/monitoring-alerting-guides/uninstall-monitoring.md
+17
View File
@@ -2,6 +2,20 @@
title: Uninstall Monitoring
---
<Tabs>
<TabItem value="Rancher v2.6.5+">
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps**.
1. Click **Installed Apps**.
1. Go to the `cattle-monitoring-system` namespace and check the boxes for `rancher-monitoring-crd` and `rancher-monitoring`.
1. Click **Delete**.
1. Confirm **Delete**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps & Marketplace**.
@@ -10,6 +24,9 @@ title: Uninstall Monitoring
1. Click **Delete**.
1. Confirm **Delete**.
</TabItem>
</Tabs>
**Result:** `rancher-monitoring` is uninstalled.
:::note Persistent Grafana Dashboards:
versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-cluster-templates.md
+40 -2
View File
@@ -33,6 +33,27 @@ In this section, you'll learn how to add the cluster template to the `local` clu
:::
<Tabs>
<TabItem value="Rancher v2.6.5+">
1. Go to a cluster template example repository. Rancher's examples are in [this GitHub repository.](https://github.com/rancher/cluster-template-examples) As of Rancher v2.6.0, we provide an RKE2 cluster template and add to more in the future.
1. Fork the repository.
1. Optional: Edit the cluster options by editing the `values.yaml` file. For help editing the file, see the cluster template's Helm chart README.
1. Add the chart repository to Rancher. Click **☰ > Cluster Management**.
1. Go to the `local` cluster and click **Explore.**
1. In the left navigation bar, click **Apps > Chart Repositories.**
1. Click **Create.**
1. Enter a name for the cluster template repository.
1. Click **Git Repository containing Helm chart definitions.**
1. In the **Git Repo URL** field, enter the URL for the repository. For example, `https://github.com/rancher/cluster-template-examples.git`.
1. In the **Git Branch** field, enter the branch to use as the source for the template. Rancher's example repository uses `main`.
1. Click **Create.**
**Result:** The cluster template available from the **Apps** in Rancher's `local` cluster. It can now be used to deploy clusters.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Go to a cluster template example repository. Rancher's examples are in [this GitHub repository.](https://github.com/rancher/cluster-template-examples) As of Rancher v2.6.0, we provide an RKE2 cluster template and add to more in the future.
1. Fork the repository.
1. Optional: Edit the cluster options by editing the `values.yaml` file. For help editing the file, see the cluster template's Helm chart README.
@@ -48,6 +69,9 @@ In this section, you'll learn how to add the cluster template to the `local` clu
**Result:** The cluster template available from the **Apps & Marketplace** in Rancher's `local` cluster. It can now be used to deploy clusters.
</TabItem>
</Tabs>
:::note Restricted Admin access:
If you are a restricted admin and don’t have access to the `local` cluster, you may still add new RKE2 templates and manage cluster repositories. To navigate to the chart repository, go to the left navigation bar and click **☰ > Cluster Management > Advanced > Repositories**. You will bypass steps 1 - 6 above, then proceed to follow steps 7 - 12 to create the cluster template.
@@ -73,7 +97,7 @@ If you are a restricted admin and don’t have access to the `local` cluster, yo
## Updating a Cluster Created from a Cluster Template
You can update any clusters using a template from the **Apps & Marketplace > Installed Apps** page, given there is a new version of a template being used by those clusters.
You can update any clusters using a template from the **Apps & Marketplace > Installed Apps** (Rancher before v2.6.5) or **Apps > Installed Apps** (Rancher v2.6.5++) page, given there is a new version of a template being used by those clusters.
## Deploying Clusters from a Template with Fleet
@@ -96,14 +120,28 @@ You can update any clusters using a template from the **Apps & Marketplace > Ins
## Uninstalling Cluster Templates
<Tabs>
<TabItem value="Rancher v2.6.5+">
1. Click **☰ > Cluster Management**.
1. Go to the `local` cluster and click **Apps > Chart Repositories.**
1. Go to the chart repository for your cluster template and click **⋮ > Delete.**
1. Confirm the deletion.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Click **☰ > Cluster Management**.
1. Go to the `local` cluster and click **Apps & Marketplace > Chart Repositories.**
1. Go to the chart repository for your cluster template and click **⋮ > Delete.**
1. Confirm the deletion.
</TabItem>
</Tabs>
**Result:** The cluster template is uninstalled. This action does not affect clusters created with the cluster template.
An admin with access to the `local` cluster can also remove a cluster deployed via cluster templates through the **Apps & Marketplace > Installed Apps** page.
An admin with access to the `local` cluster can also remove a cluster deployed via cluster templates through the **Apps & Marketplace > Installed Apps** (Rancher before v2.6.5) or **Apps > Installed Apps** (Rancher v2.6.5+) page.
## Configuration Options
versioned_docs/version-2.6/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md
+17
View File
@@ -26,6 +26,20 @@ The backup storage location is an operator-level setting, so it needs to be conf
Backups are created as .tar.gz files. These files can be pushed to S3 or Minio, or they can be stored in a persistent volume.
<Tabs>
<TabItem value="Rancher v2.6.5+">
1. In the upper left corner, click **☰ > Cluster Management**.
1. On the **Clusters** page, go to the `local` cluster and click **Explore**. The `local` cluster runs the Rancher server.
1. Click **Apps > Charts**.
1. Click **Rancher Backups**.
1. Click **Install**.
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**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. In the upper left corner, click **☰ > Cluster Management**.
1. On the **Clusters** page, go to the `local` cluster and click **Explore**. The `local` cluster runs the Rancher server.
1. Click **Apps & Marketplace > Charts**.
@@ -34,6 +48,9 @@ Backups are created as .tar.gz files. These files can be pushed to S3 or Minio,
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**.
</TabItem>
</Tabs>
:::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](../deploy-apps-across-clusters/fleet.md#troubleshooting) for a workaround.
versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/configure-out-of-tree-vsphere.md
+37
View File
@@ -32,6 +32,23 @@ The Cloud Provider Interface (CPI) should be installed first before installing t
### 2. Install the CPI plugin
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
1. Click **☰ > Cluster Management**.
1. Go to the cluster where the vSphere CPI plugin will be installed and click **Explore**.
1. Click **Apps > Charts**.
1. Click **vSphere CPI**.
1. Fill out the required vCenter details.
1. vSphere CPI initializes all nodes with ProviderID which is needed by the vSphere CSI driver. Check if all nodes are initialized with the ProviderID before installing CSI driver with the following command:
```
kubectl describe nodes | grep "ProviderID"
```
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Click **☰ > Cluster Management**.
1. Go to the cluster where the vSphere CPI plugin will be installed and click **Explore**.
1. Click **Apps & Marketplace > Charts**.
@@ -43,8 +60,26 @@ The Cloud Provider Interface (CPI) should be installed first before installing t
kubectl describe nodes | grep "ProviderID"
```
</TabItem>
</Tabs>
### 3. Installing the CSI plugin
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
1. Click **☰ > Cluster Management**.
1. Go to the cluster where the vSphere CSI plugin will be installed and click **Explore**.
1. Click **Apps > Charts**.
1. Click **vSphere CSI**.
1. Click **Install**.
1. Fill out the required vCenter details. On the **Features** tab, set **Enable CSI Migration** to **false**.
3. On the **Storage** tab, fill out the details for the StorageClass. This chart creates a StorageClass with the `csi.vsphere.vmware.com` as the provisioner.
1. Click **Install**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Click **☰ > Cluster Management**.
1. Go to the cluster where the vSphere CSI plugin will be installed and click **Explore**.
1. Click **Apps & Marketplace > Charts**.
@@ -54,6 +89,8 @@ The Cloud Provider Interface (CPI) should be installed first before installing t
3. On the **Storage** tab, fill out the details for the StorageClass. This chart creates a StorageClass with the `csi.vsphere.vmware.com` as the provisioner.
1. Click **Install**.
</TabItem>
</Tabs>
## Using the CSI driver for provisioning volumes
versioned_docs/version-2.6/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-from-in-tree-to-out-of-tree.md
+36
View File
@@ -56,6 +56,19 @@ chmod +x taints.sh
Once all nodes are tainted by the running the script, launch the Helm vSphere CPI chart.
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
1. Click **☰ > Cluster Management**.
1. Go to the cluster where the vSphere CPI chart will be installed and click **Explore**.
1. Click **Apps > Charts**.
1. Click **vSphere CPI**..
1. Click **Install**.
1. Fill out the required vCenter details and click **Install**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Click **☰ > Cluster Management**.
1. Go to the cluster where the vSphere CPI chart will be installed and click **Explore**.
1. Click **Apps & Marketplace > Charts**.
@@ -63,6 +76,9 @@ Once all nodes are tainted by the running the script, launch the Helm vSphere CP
1. Click **Install**.
1. Fill out the required vCenter details and click **Install**.
</TabItem>
</Tabs>
vSphere CPI initializes all nodes with ProviderID, which is needed by the vSphere CSI driver.
Check if all nodes are initialized with the ProviderID with the following command:
@@ -73,6 +89,23 @@ kubectl describe nodes | grep "ProviderID"
### 2. Install the CSI driver
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
1. Click **☰ > Cluster Management**.
1. Go to the cluster where the vSphere CSI chart will be installed and click **Explore**.
1. Click **Apps > Charts**.
1. Click **vSphere CSI**..
1. Click **Install**.
1. Fill out the required vCenter details and click **Install**.
1. Check **Customize Helm options before install** and click **Next**.
1. On the **Features** tab, check **Enable CSI Migration**.
1. Optionally, go to the **Storage** tab and set up a datastore. This chart creates a StorageClass with the `csi.vsphere.vmware.com` as the provisioner. You can provide the URL of the datastore to be used for CSI volume provisioning while creating this StorageClass. The datastore URL can be found in the vSphere client by selecting the datastore and going to the Summary tab. Fill out the details for the StorageClass.
1. Click **Install**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Click **☰ > Cluster Management**.
1. Go to the cluster where the vSphere CSI chart will be installed and click **Explore**.
1. Click **Apps & Marketplace > Charts**.
@@ -84,6 +117,9 @@ kubectl describe nodes | grep "ProviderID"
1. Optionally, go to the **Storage** tab and set up a datastore. This chart creates a StorageClass with the `csi.vsphere.vmware.com` as the provisioner. You can provide the URL of the datastore to be used for CSI volume provisioning while creating this StorageClass. The datastore URL can be found in the vSphere client by selecting the datastore and going to the Summary tab. Fill out the details for the StorageClass.
1. Click **Install**.
</TabItem>
</Tabs>
### 3. Edit the cluster to enable CSI migration feature flags
1. While editing the cluster, if the Kubernetes version is less than 1.19, select Kubernetes version 1.19 or higher from the **Kubernetes Version** dropdown.
versioned_docs/version-2.6/integrations-in-rancher/istio/configuration-options/install-istio-on-rke2-cluster.md
+1 -1
View File
@@ -2,7 +2,7 @@
title: Additional Steps for Installing Istio on an RKE2 Cluster
---
When installing or upgrading the Istio Helm chart through **Apps & Marketplace,**
When installing or upgrading the Istio Helm chart through **Apps & Marketplace** (Rancher before v2.6.5) or **Apps** (Rancher v2.6.5+),
1. If you are installing the chart, click **Customize Helm options before install** and click **Next**.
1. You will see options for configuring the Istio Helm chart. On the **Components** tab, check the box next to **Enabled CNI**.
versioned_docs/version-2.6/integrations-in-rancher/istio/configuration-options/pod-security-policies.md
+1 -1
View File
@@ -33,7 +33,7 @@ Set the PSP to `unrestricted` in the project where is Istio is installed, or the
### 2. Enable the CNI
When installing or upgrading Istio through **Apps & Marketplace,**
When installing or upgrading Istio through **Apps & Marketplace** (Rancher before v2.6.5) or **Apps** (Rancher v2.6.5+)
1. Click **Components**.
2. Check the box next to **Enabled CNI**.
versioned_docs/version-2.6/integrations-in-rancher/istio/cpu-and-memory-allocations.md
+18
View File
@@ -36,6 +36,21 @@ You can find more information about Istio configuration in the [official Istio d
To configure the resources allocated to an Istio component,
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps**.
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](../../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
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps & Marketplace**.
@@ -45,6 +60,9 @@ To configure the resources allocated to an Istio component,
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
</TabItem>
</Tabs>
**Result:** The resource allocations for the Istio components are updated.
### Editing the Overlay File
versioned_docs/version-2.6/integrations-in-rancher/istio/disable-istio.md
+15
View File
@@ -8,12 +8,27 @@ This section describes how to uninstall Istio in a cluster or disable a namespac
To uninstall Istio,
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps > Installed Apps**.
1. In the `istio-system` namespace, go to `rancher-istio` and click **⋮ > Delete**.
1. After `rancher-istio` is deleted, you can then select all the remaining apps in the `istio-system` namespace and click **Delete**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps & Marketplace > Installed Apps**.
1. In the `istio-system` namespace, go to `rancher-istio` and click **⋮ > Delete**.
1. After `rancher-istio` is deleted, you can then select all the remaining apps in the `istio-system` namespace and click **Delete**.
</TabItem>
</Tabs>
**Result:** The `rancher-istio` app in the cluster gets removed. The Istio sidecar cannot be deployed on any workloads in the cluster.
:::note
versioned_docs/version-2.6/integrations-in-rancher/longhorn.md
+31
View File
@@ -23,6 +23,20 @@ With Longhorn, you can:
### Installing Longhorn with Rancher
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
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.
1. Click **Apps**.
1. Click **Charts**.
1. Click **Longhorn**.
1. Optional: To customize the initial settings, click **Longhorn Default Settings** and edit the configuration. For help customizing the settings, refer to the [Longhorn documentation.](https://longhorn.io/docs/latest/references/settings/)
1. Click **Install**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
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.
1. Click **Apps & Marketplace**.
@@ -31,6 +45,9 @@ With Longhorn, you can:
1. Optional: To customize the initial settings, click **Longhorn Default Settings** and edit the configuration. For help customizing the settings, refer to the [Longhorn documentation.](https://longhorn.io/docs/latest/references/settings/)
1. Click **Install**.
</TabItem>
</Tabs>
**Result:** Longhorn is deployed in the Kubernetes cluster.
### Accessing Longhorn from the Rancher UI
@@ -42,11 +59,25 @@ With Longhorn, you can:
### Uninstalling Longhorn from the Rancher UI
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
1. Go to the cluster where Longhorn is installed and click **Apps**.
1. Click **Installed Apps**.
1. Go to the `longhorn-system` namespace and check the boxes next to the `longhorn` and `longhorn-crd` apps.
1. Click **Delete,** and confirm **Delete**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Go to the cluster where Longhorn is installed and click **Apps & Marketplace**.
1. Click **Installed Apps**.
1. Go to the `longhorn-system` namespace and check the boxes next to the `longhorn` and `longhorn-crd` apps.
1. Click **Delete,** and confirm **Delete**.
</TabItem>
</Tabs>
**Result:** Longhorn is uninstalled.
### GitHub Repository
versioned_docs/version-2.6/integrations-in-rancher/neuvector.md
+28 -2
View File
@@ -14,11 +14,25 @@ The Harvester Helm Chart is used to manage access to the NeuVector UI in Rancher
**To navigate to and install the NeuVector chart through Apps & Marketplace:**
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
1. Click **☰ > Cluster Management**.
1. On the Clusters page, go to the cluster where you want to deploy NeuVector, and click **Explore**.
1. Go to **Apps > Charts**, and install **NeuVector** from the chart repo.
1. Different cluster types require different container runtimes. When configuring Helm chart values, go to the **Container Runtime** section, and select your runtime in accordance with the cluster type. Finally, click **Install** again.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Click **☰ > Cluster Management**.
1. On the Clusters page, go to the cluster where you want to deploy NeuVector, and click **Explore**.
1. Go to **Apps & Marketplace > Charts**, and install **NeuVector** from the chart repo.
1. Different cluster types require different container runtimes. When configuring Helm chart values, go to the **Container Runtime** section, and select your runtime in accordance with the cluster type. Finally, click **Install** again.
</TabItem>
</Tabs>
Some examples are as follows:
- RKE1: `docker`
@@ -49,10 +63,23 @@ Some examples are as follows:
**To uninstall from Apps & Marketplace:**
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
1. Click **☰ > Cluster Management**.
1. Under **Apps**, click **Installed Apps**.
1. Under `cattle-neuvector-system`, select both the NeuVector app (and the associated CRD if desired), then click **Delete**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Click **☰ > Cluster Management**.
1. Under **Apps & Marketplace**, click **Installed Apps**.
1. Under `cattle-neuvector-system`, select both the NeuVector app (and the associated CRD if desired), then click **Delete**.
</TabItem>
</Tabs>
**To uninstall from Cluster Tools:**
1. Click **☰ > Cluster Management**.
@@ -114,7 +141,7 @@ Below are the minimum recommended computing resources for the NeuVector chart in
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps & Marketplace**.
1. In the left navigation bar, click **Apps**.
1. Install (or upgrade to) NeuVector version `100.0.1+up2.2.2`.
- Under **Edit Options** > **Other Configuration**, enable **Pod Security Policy** by checking the box (no other config needed):
@@ -123,7 +150,6 @@ Below are the minimum recommended computing resources for the NeuVector chart in
1. Click **Install** at the bottom-right to complete.
</TabItem>
<TabItem value="RKE2">
versioned_docs/version-2.6/integrations-in-rancher/opa-gatekeeper.md
+15 -2
View File
@@ -35,16 +35,29 @@ Only administrators and cluster owners can enable OPA Gatekeeper.
:::
The OPA Gatekeeper Helm chart can be installed from **Apps & Marketplace**.
### Enabling OPA Gatekeeper
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
1. In the upper left corner, click **☰ > Cluster Management**.
1. In the **Clusters** page, go to the cluster where you want to enable OPA Gatekeeper and click **Explore**.
1. In the left navigation bar, click **Apps**.
1. Click **Charts** and click **OPA Gatekeeper**.
1. Click **Install**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. In the upper left corner, click **☰ > Cluster Management**.
1. In the **Clusters** page, go to the cluster where you want to enable OPA Gatekeeper and click **Explore**.
1. In the left navigation bar, click **Apps & Marketplace**.
1. Click **Charts** and click **OPA Gatekeeper**.
1. Click **Install**.
</TabItem>
</Tabs>
**Result:** OPA Gatekeeper is deployed in your Kubernetes cluster.
## Constraint Templates
versioned_docs/version-2.6/pages-for-subheaders/backup-restore-and-disaster-recovery.md
+18 -1
View File
@@ -4,7 +4,7 @@ title: Backups and Disaster Recovery
In this section, you'll learn how to create backups of Rancher, how to restore Rancher from backup, and how to migrate Rancher to a new Kubernetes cluster.
The `rancher-backup` operator is used to backup and restore Rancher on any Kubernetes cluster. This application is a Helm chart, and it can be deployed through the Rancher **Apps & Marketplace** page, or by using the Helm CLI. The `rancher-backup` Helm chart is [here.](https://github.com/rancher/charts/tree/release-v2.6/charts/rancher-backup)
The `rancher-backup` operator is used to backup and restore Rancher on any Kubernetes cluster. This application is a Helm chart, and it can be deployed through the Rancher **Apps & Marketplace** (Rancher before v2.6.5) or **Apps** (Rancher v2.6.5+) page, or by using the Helm CLI. The `rancher-backup` Helm chart is [here.](https://github.com/rancher/charts/tree/release-v2.6/charts/rancher-backup)
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.
@@ -49,6 +49,20 @@ There is a known issue in Fleet that occurs after performing a restoration using
### Installing rancher-backup with the Rancher UI
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
1. In the upper left corner, click **☰ > Cluster Management**.
1. On the **Clusters** page, go to the `local` cluster and click **Explore**.
1. In the left navigation bar, **Apps > Charts**.
1. Click **Rancher Backups**.
1. Click **Install**.
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**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. In the upper left corner, click **☰ > Cluster Management**.
1. On the **Clusters** page, go to the `local` cluster and click **Explore**.
1. In the left navigation bar, **Apps & Marketplace > Charts**.
@@ -57,6 +71,9 @@ There is a known issue in Fleet that occurs after performing a restoration using
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**.
</TabItem>
</Tabs>
**Result:** The `rancher-backup` operator is installed.
From the **Cluster Dashboard,** you can see the `rancher-backup` operator listed under **Deployments**.
versioned_docs/version-2.6/pages-for-subheaders/helm-charts-in-rancher.md
+15 -4
View File
@@ -2,13 +2,13 @@
title: Helm Charts in Rancher
---
In this section, you'll learn how to manage Helm chart repositories and applications in Rancher. Helm chart repositories are managed using **Apps & Marketplace**. It uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Helm applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster.
In this section, you'll learn how to manage Helm chart repositories and applications in Rancher. Helm chart repositories are managed using **Apps & Marketplace** (Rancher before v2.6.5) or **Apps** (Rancher v2.6.5+). It uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Helm applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster.
### Changes in Rancher v2.6
Starting in Rancher v2.6.0, a new versioning scheme for Rancher feature charts was implemented. The changes are centered around the major version of the charts and the +up annotation for upstream charts, where applicable.
**Major Version:** The major version of the charts is tied to Rancher minor versions. When you upgrade to a new Rancher minor version, you should ensure that all of your **Apps & Marketplace** charts are also upgraded to the correct release line for the chart.
**Major Version:** The major version of the charts is tied to Rancher minor versions. When you upgrade to a new Rancher minor version, you should ensure that all of your **Apps & Marketplace** (Rancher before v2.6.5) or **Apps** (Rancher v2.6.5+) charts are also upgraded to the correct release line for the chart.
:::note
@@ -47,7 +47,18 @@ Any major versions that are less than the ones mentioned in the table below are
### Charts
From the top-left menu select _"Apps & Marketplace"_ and you will be taken to the Charts page.
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
From the top-left menu select **Apps** and you will be taken to the Charts page.
</TabItem>
<TabItem value="Rancher before v2.6.5">
From the top-left menu select **Apps & Marketplace** and you will be taken to the Charts page.
</TabItem>
</Tabs>
The charts page contains all Rancher, Partner, and Custom Charts.
@@ -59,7 +70,7 @@ All three types are deployed and managed in the same way.
:::note
Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) should continue to be managed only by the Cluster Manager, and apps managed with <b>Apps & Marketplace</b> in the new UI must be managed only by <b>Apps & Marketplace</b>.
Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) should continue to be managed only by the Cluster Manager, and apps managed with **Apps & Marketplace** (Rancher before v2.6.5) or **Apps** (Rancher v2.6.5+) in the new UI must be managed only by **Apps & Marketplace** or **Apps**.
:::
versioned_docs/version-2.6/pages-for-subheaders/istio.md
+2 -2
View File
@@ -67,7 +67,7 @@ To remove Istio components from a cluster, namespace, or workload, refer to the
## Migrate From Previous Istio Version
There is no upgrade path for Istio versions less than 1.7.x. To successfully install Istio through **Apps & Marketplace,** you will need to disable your existing Istio from the global view in the legacy Rancher UI.
There is no upgrade path for Istio versions less than 1.7.x. To successfully install Istio through **Apps & Marketplace** (Rancher before v2.6.5) or **App** (Rancher v2.6.5+), you will need to disable your existing Istio from the global view in the legacy Rancher UI.
If you have a significant amount of additional Istio CRDs you might consider manually migrating CRDs that are supported in both versions of Istio. You can do this by running `kubectl get <resource> -n istio-system -o yaml`, save the output yaml and re-apply in the new version.
@@ -93,7 +93,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](../integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations.md) 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](../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.
versioned_docs/version-2.6/pages-for-subheaders/logging.md
+28
View File
@@ -12,20 +12,48 @@ For an overview of the changes in v2.5, see [this section.](../integrations-in-r
You can enable the logging for a Rancher managed cluster by going to the Apps page and installing the logging app.
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
1. Go to the cluster where you want to install logging and click **Apps**.
1. Click the **Logging** app.
1. Scroll to the bottom of the Helm chart README and click **Install**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Go to the cluster where you want to install logging and click **Apps & Marketplace**.
1. Click the **Logging** app.
1. Scroll to the bottom of the Helm chart README and click **Install**.
</TabItem>
</Tabs>
**Result:** The logging app is deployed in the `cattle-logging-system` namespace.
## Uninstall Logging
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
1. Go to the cluster where you want to install logging and click **Apps**.
1. Click **Installed Apps**.
1. Go to the `cattle-logging-system` namespace and check the boxes for `rancher-logging` and `rancher-logging-crd`.
1. Click **Delete**.
1. Confirm **Delete**.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. Go to the cluster where you want to install logging and click **Apps & Marketplace**.
1. Click **Installed Apps**.
1. Go to the `cattle-logging-system` namespace and check the boxes for `rancher-logging` and `rancher-logging-crd`.
1. Click **Delete**.
1. Confirm **Delete**.
</TabItem>
</Tabs>
**Result** `rancher-logging` is uninstalled.
## Architecture
versioned_docs/version-2.6/pages-for-subheaders/manage-clusters.md
+1 -1
View File
@@ -35,4 +35,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.**
Tools can be installed through **Apps & Marketplace** (Rancher before v2.6.5) or **Apps** (Rancher v2.6.5+).
versioned_docs/version-2.6/reference-guides/monitoring-v2-configuration/receivers.md
+15
View File
@@ -142,12 +142,27 @@ The YAML provided here will be directly appended to your receiver within the Ale
The Teams receiver is not a native receiver and must be enabled before it can be used. You can enable the Teams receiver for a Rancher managed cluster by going to the Apps page and installing the rancher-alerting-drivers app with the Teams option selected.
<Tabs groupId="rancher-version">
<TabItem value="Rancher v2.6.5+">
1. In the Rancher UI, go to the cluster where you want to install rancher-alerting-drivers and click **Apps**.
1. Click the **Alerting Drivers** app.
1. Click the **Helm Deploy Options** tab.
1. Select the **Teams** option and click **Install**.
1. Take note of the namespace used as it will be required in a later step.
</TabItem>
<TabItem value="Rancher before v2.6.5">
1. In the Rancher UI, go to the cluster where you want to install rancher-alerting-drivers and click **Apps & Marketplace**.
1. Click the **Alerting Drivers** app.
1. Click the **Helm Deploy Options** tab.
1. Select the **Teams** option and click **Install**.
1. Take note of the namespace used as it will be required in a later step.
</TabItem>
</Tabs>
### Configure the Teams Receiver
The Teams receiver can be configured by updating its ConfigMap. For example, the following is a minimal Teams receiver configuration.