add-on deprecation notice

2026-05-15 09:33:30 +00:00 · 2018-10-09 18:00:17 -05:00
parent 01c4a6383b
commit 4b8927f9c7
15 changed files with 96 additions and 49 deletions
@@ -37,4 +37,13 @@ The following CLI tools are required for this install. Please make sure these to
 ## Additional Install Options

 * [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/)
-* [RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/installation/ha/rke-add-on/)
+
+## Previous Methods
+
+> ### 🛑 IMPORTANT: RKE Add-On install is Deprecated as of the 2.1.0 release.
+>
+>Please use the official Helm Chart to install HA Rancher. For details see the [HA Install - Installation Outline]({{< baseurl >}}/rancher/v2.x/en/installation/ha/#installation-outline).
+>
+>If you are currently using the RKE Add-On install method see [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) for details on moving to the Helm Chart.
+
+* **DEPRECATED** [RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/installation/ha/rke-add-on/)
@@ -3,7 +3,12 @@ title: Advanced Install - RKE Add-on
 weight: 276
 ---

-Rancher can be installed by providing the appropriate Kubernetes manifest configurations to RKE's `addons` feature. See the following instructions for examples appropriate to your environment.
+> ### 🛑 IMPORTANT: RKE Add-On install is Deprecated as of the 2.1.0 release.
+>
+>Please use the official Helm Chart to install HA Rancher. For details see the [HA Install - Installation Outline]({{< baseurl >}}/rancher/v2.x/en/installation/ha/#installation-outline).
+>
+>If you are currently using the RKE Add-On install method see [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) for details on moving to the Helm Chart.
+

 * [High Availability Installation with External Load Balancer (TCP/Layer 4)]({{< baseurl >}}/rancher/v2.x/en/installation/ha/rke-add-on/layer-4-lb)
 * [High Availability Installation with External Load Balancer (HTTPS/Layer 7)]({{< baseurl >}}/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb)
@@ -4,6 +4,13 @@ weight: 275
 aliases:
 - /rancher/v2.x/en/installation/ha-server-install/
 ---
+
+> ### 🛑 IMPORTANT: RKE Add-On install is Deprecated as of the 2.1.0 release.
+>
+>Please use the official Helm Chart to install HA Rancher. For details see the [HA Install - Installation Outline]({{< baseurl >}}/rancher/v2.x/en/installation/ha/#installation-outline).
+>
+>If you are currently using the RKE Add-On install method see [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) for details on moving to the Helm Chart.
+
 This procedure walks you through setting up a 3-node cluster using the Rancher Kubernetes Engine (RKE). The cluster's sole purpose is running pods for Rancher. The setup is based on:

 - Layer 4 load balancer (TCP)
@@ -4,6 +4,13 @@ weight: 277
 aliases:
 - /rancher/v2.x/en/installation/ha-server-install/nlb/
 ---
+
+> ### 🛑 IMPORTANT: RKE Add-On install is Deprecated as of the 2.1.0 release.
+>
+>Please use the official Helm Chart to install HA Rancher. For details see the [HA Install - Installation Outline]({{< baseurl >}}/rancher/v2.x/en/installation/ha/#installation-outline).
+>
+>If you are currently using the RKE Add-On install method see [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) for details on moving to the Helm Chart.
+
 ## Objectives

 Configuring an Amazon NLB is a multistage process. We've broken it down into multiple tasks so that it's easy to follow.
@@ -4,6 +4,13 @@ weight: 276
 aliases:
 - /rancher/v2.x/en/installation/ha-server-install-external-lb/
 ---
+
+> ### 🛑 IMPORTANT: RKE Add-On install is Deprecated as of the 2.1.0 release.
+>
+>Please use the official Helm Chart to install HA Rancher. For details see the [HA Install - Installation Outline]({{< baseurl >}}/rancher/v2.x/en/installation/ha/#installation-outline).
+>
+>If you are currently using the RKE Add-On install method see [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) for details on moving to the Helm Chart.
+
 This procedure walks you through setting up a 3-node cluster using the Rancher Kubernetes Engine (RKE). The cluster's sole purpose is running pods for Rancher. The setup is based on:

 - Layer 7 Loadbalancer with SSL termination (HTTPS)
@@ -4,6 +4,13 @@ weight: 277
 aliases:
 - /rancher/v2.x/en/installation/ha-server-install-external-lb/alb/
 ---
+
+> ### 🛑 IMPORTANT: RKE Add-On install is Deprecated as of the 2.1.0 release.
+>
+>Please use the official Helm Chart to install HA Rancher. For details see the [HA Install - Installation Outline]({{< baseurl >}}/rancher/v2.x/en/installation/ha/#installation-outline).
+>
+>If you are currently using the RKE Add-On install method see [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) for details on moving to the Helm Chart.
+
 ## Objectives

 Configuring an Amazon ALB is a multistage process. We've broken it down into multiple tasks so that it's easy to follow.
@@ -4,6 +4,13 @@ weight: 277
 aliases:
 - /rancher/v2.x/en/installation/ha-server-install-external-lb/nginx/
 ---
+
+> ### 🛑 IMPORTANT: RKE Add-On install is Deprecated as of the 2.1.0 release.
+>
+>Please use the official Helm Chart to install HA Rancher. For details see the [HA Install - Installation Outline]({{< baseurl >}}/rancher/v2.x/en/installation/ha/#installation-outline).
+>
+>If you are currently using the RKE Add-On install method see [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) for details on moving to the Helm Chart.
+
 ## Install NGINX

 Start by installing NGINX on your load balancer host. NGINX has packages available for all known operating systems.
@@ -2,6 +2,13 @@
 title: HTTP Proxy Configuration
 weight: 277
 ---
+
+> ### 🛑 IMPORTANT: RKE Add-On install is Deprecated as of the 2.1.0 release.
+>
+>Please use the official Helm Chart to install HA Rancher. For details see the [HA Install - Installation Outline]({{< baseurl >}}/rancher/v2.x/en/installation/ha/#installation-outline).
+>
+>If you are currently using the RKE Add-On install method see [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) for details on moving to the Helm Chart.
+
 If you operate Rancher behind a proxy and you want to access services through the proxy (such as retrieving catalogs), you must provide Rancher information about your proxy. As Rancher is written in Go, it uses the common proxy environment variables as shown below.

 Make sure `NO_PROXY` contains the network addresses, network address ranges and domains that should be excluded from using the proxy.
@@ -5,6 +5,12 @@ aliases:
 - /rancher/v2.x/en/installation/troubleshooting-ha/404-default-backend/
 ---

+> ### 🛑 IMPORTANT: RKE Add-On install is Deprecated as of the 2.1.0 release.
+>
+>Please use the official Helm Chart to install HA Rancher. For details see the [HA Install - Installation Outline]({{< baseurl >}}/rancher/v2.x/en/installation/ha/#installation-outline).
+>
+>If you are currently using the RKE Add-On install method see [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) for details on moving to the Helm Chart.
+
 To debug issues around this error, you will need to download the command-line tool `kubectl`. See [Install and Set Up kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) how to download `kubectl` for your platform.

 When you have made changes to `rancher-cluster.yml`, you will have to run `rke remove --config rancher-cluster.yml` to clean the nodes, so it cannot conflict with previous configuration errors.
@@ -4,6 +4,13 @@ weight: 370
 aliases:
 - /rancher/v2.x/en/installation/troubleshooting-ha/
 ---
+
+> ### 🛑 IMPORTANT: RKE Add-On install is Deprecated as of the 2.1.0 release.
+>
+>Please use the official Helm Chart to install HA Rancher. For details see the [HA Install - Installation Outline]({{< baseurl >}}/rancher/v2.x/en/installation/ha/#installation-outline).
+>
+>If you are currently using the RKE Add-On install method see [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) for details on moving to the Helm Chart.
+
 This section contains common errors seen when setting up a High Availability Installation.

 Choose from the following options:
@@ -5,6 +5,12 @@ aliases:
 - /rancher/v2.x/en/installation/troubleshooting-ha/generic-troubleshooting/
 ---

+> ### 🛑 IMPORTANT: RKE Add-On install is Deprecated as of the 2.1.0 release.
+>
+>Please use the official Helm Chart to install HA Rancher. For details see the [HA Install - Installation Outline]({{< baseurl >}}/rancher/v2.x/en/installation/ha/#installation-outline).
+>
+>If you are currently using the RKE Add-On install method see [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) for details on moving to the Helm Chart.
+
 Below are steps that you can follow to determine what is wrong in your cluster.

 ### Double check if all the required ports are opened in your (host) firewall
@@ -5,6 +5,12 @@ aliases:
 - /rancher/v2.x/en/installation/troubleshooting-ha/job-complete-status/
 ---

+> ### 🛑 IMPORTANT: RKE Add-On install is Deprecated as of the 2.1.0 release.
+>
+>Please use the official Helm Chart to install HA Rancher. For details see the [HA Install - Installation Outline]({{< baseurl >}}/rancher/v2.x/en/installation/ha/#installation-outline).
+>
+>If you are currently using the RKE Add-On install method see [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) for details on moving to the Helm Chart.
+
 To debug issues around this error, you will need to download the command-line tool `kubectl`. See [Install and Set Up kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) how to download `kubectl` for your platform.

 When you have made changes to `rancher-cluster.yml`, you will have to run `rke remove --config rancher-cluster.yml` to clean the nodes, so it cannot conflict with previous configuration errors.
@@ -17,5 +17,11 @@ This section contains information about how to upgrade your Rancher server to a

 ### Upgrading an RKE Add-on Install

+> ### 🛑 IMPORTANT: RKE Add-On install is Deprecated as of the 2.1.0 release.
+>
+>Please use the official Helm Chart to install HA Rancher. For details see the [HA Install - Installation Outline]({{< baseurl >}}/rancher/v2.x/en/installation/ha/#installation-outline).
+>
+>If you are currently using the RKE Add-On install method see [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) for details on moving to the Helm Chart.
+
 - [Upgrading a High Availability Install - RKE Add-On Install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade/)

@@ -5,6 +5,13 @@ aliases:
  - /rancher/v2.x/en/upgrades/ha-server-upgrade/
 ---

+> ### 🛑 IMPORTANT: RKE Add-On install is Deprecated as of the 2.1.0 release.
+>
+>Please use the official Helm Chart to install HA Rancher. For details see the [HA Install - Installation Outline]({{< baseurl >}}/rancher/v2.x/en/installation/ha/#installation-outline).
+>
+>If you are currently using the RKE Add-On install method see [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) for details on moving to the Helm Chart.
+
+
 This document is for upgrading Rancher HA installed with the RKE Add-On yaml. See these docs to migrate to or upgrade Rancher installed with the Helm chart.

 * [Migrating from a High Availability RKE Add-on Install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/)
@@ -1,47 +0,0 @@
---
-title: API Auditing
-weight: 10000
---
-
-If you're using RKE to install Rancher, you can use directives to enable API Auditing for your Rancher install. You can know what happened, when it happened, who initiated it, and what cluster it affected. API auditing records all requests and responses to and from the Rancher API, which includes use of the Rancher UI and any other use of the Rancher API through programmatic use.
-
-## In-line Arguments
-
-Enable API Auditing using RKE by adding arguments to your Rancher container.
-
-To enable API auditing:
-
- Add API Auditing arguments (`args`) to your Rancher container.
- Declare a `mountPath` in the `volumeMounts` directive of the container.
- Declare a `path` in the `volumes` directive.
-
-For more information about each argument, its syntax, and how to view API Audit logs, see [Rancher v2.0 Documentation: API Auditing]({{< baseurl >}}/rancher/v2.x/en/installation/api-auditing).
-
-```yaml
-...
-containers:
-        - image: rancher/rancher:latest
-          imagePullPolicy: Always
-          name: cattle-server
-          args: ["--audit-log-path", "/var/log/auditlog/rancher-api-audit.log", "--audit-log-maxbackup", "5", "--audit-log-maxsize", "50", "--audit-level", "2"]
-          ports:
-          - containerPort: 80
-            protocol: TCP
-          - containerPort: 443
-            protocol: TCP
-          volumeMounts:
-          - mountPath: /etc/rancher/ssl
-            name: cattle-keys-volume
-            readOnly: true
-          - mountPath: /var/log/auditlog
-            name: audit-log-dir
-        volumes:
-        - name: cattle-keys-volume
-          secret:
-            defaultMode: 420
-            secretName: cattle-keys-server
-        - name: audit-log-dir
-          hostPath:
-            path: /var/log/rancher/auditlog
-            type: Directory
-```