From 959b2539e3170ea526cd187e4aada25f0336ab40 Mon Sep 17 00:00:00 2001 From: Michael Bolot Date: Tue, 15 Nov 2022 11:25:25 -0600 Subject: [PATCH] Updating rancher-csp-adapter docs for 2.6.9/2.7.0 --- .../aws-cloud-marketplace/install-adapter.md | 36 ++++++++--------- .../aws-cloud-marketplace/install-adapter.md | 39 +++++++++---------- 2 files changed, 35 insertions(+), 40 deletions(-) diff --git a/docs/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md b/docs/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md index 60bd51a5e27..6640ab3fd39 100644 --- a/docs/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md +++ b/docs/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md @@ -17,9 +17,9 @@ In order to deploy and run the adapter successfully, you need to ensure its vers ::: | Rancher Version | Adapter Version | -| --------------- | :-------------: | -| v2.6.7 | v1.0.1 | -| v2.6.8 | v1.0.1 | +|-----------------|:---------------:| +| v2.7.0 | v2.0.0 | + ### 1. Gain Access to the Local Cluster @@ -71,31 +71,29 @@ helm repo add rancher-charts https://charts.rancher.io Next, install the CSP adapter. You must specify several values, including the account number, and the name of the role created in the prerequisites. -For the below instructions, replace `$MY_ACC_NUM` with your AWS account number and `$MY_ROLE_NAME` with the name of the role created in the prerequisites. +Ensure that you use the version of the CSP adapter that matches the version of Rancher that you are running, as defined [above](#rancher-vs-adapter-compatibility-matrix). + +For the below instructions, replace `$MY_ACC_NUM` with your AWS account number and `$MY_ROLE_NAME` with the name of the role created in the prerequisites. In addition, replace `$CSP_ADAPTER_VERSION` with the version that matches your Rancher version in the [version matrix](#rancher-vs-adapter-compatibility-matrix). > **Note:** If you use shell variables, do not specify quotation marks. For example, MY_ACC_NUM=123456789012 will work, but MY_ACC_NUM="123456789012" will fail. > **Note:** Accounts using the AWS Marketplace listing for the EU and the UK will need to specify an additional `--set image.repository=rancher/rancher-csp-adapter-eu` option. To see if your account needs this option when installing the adapter, refer to the usage instructions of the marketplace listing. -> **Note:** It is important that you follow the instructions below exactly. In particular, the command to install version 1.0.1 of the adapter (by using --set image.tag=v1.0.1) is key to ensure that node counts are accurate. - ```bash - helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter --namespace cattle-csp-adapter-system --set aws.enabled=true --set aws.roleName=$MY_ROLE_NAME --set-string aws.accountNumber=$MY_ACC_NUM --set image.tag=v1.0.1 + helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter --namespace cattle-csp-adapter-system --set aws.enabled=true --set aws.roleName=$MY_ROLE_NAME --set-string aws.accountNumber=$MY_ACC_NUM --version $CSP_ADAPTER_VERSION ``` Alternatively, you can use a `values.yaml` and specify options like below: ```yaml - image: - tag: v1.0.1 aws: - enabled: true - accountNumber: "$MY_ACC_NUM" - roleName: $MY_ROLE_NAME + enabled: true + accountNumber: "$MY_ACC_NUM" + roleName: $MY_ROLE_NAME ``` > **Note:** The account number needs to be specified in a string format, like the above, or the installation will fail. @@ -103,25 +101,23 @@ For the below instructions, replace `$MY_ACC_NUM` with your AWS account number a You can then install the adapter with the following command: ```bash - helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter -f values.yaml + helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter -f values.yaml --version $CSP_ADAPTER_VERSION ``` ```bash - helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter --namespace cattle-csp-adapter-system --set aws.enabled=true --set aws.roleName=$MY_ROLE_NAME --set-string aws.accountNumber=$MY_ACC_NUM --set additionalTrustedCAs=true --set image.tag=v1.0.1 + helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter --namespace cattle-csp-adapter-system --set aws.enabled=true --set aws.roleName=$MY_ROLE_NAME --set-string aws.accountNumber=$MY_ACC_NUM --set additionalTrustedCAs=true --version $CSP_ADAPTER_VERSION ``` Alternatively, you can use a `values.yaml` and specify options the below: ```yaml - image: - tag: v1.0.1 aws: - enabled: true - accountNumber: "$MY_ACC_NUM" - roleName: $MY_ROLE_NAME + enabled: true + accountNumber: "$MY_ACC_NUM" + roleName: $MY_ROLE_NAME additionalTrustedCAs: true ``` @@ -130,7 +126,7 @@ For the below instructions, replace `$MY_ACC_NUM` with your AWS account number a You can then install the adapter with the following command: ```bash - helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter -f values.yaml + helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter -f values.yaml --version $CSP_ADAPTER_VERSION ``` diff --git a/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md b/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md index 60bd51a5e27..04e82ab85b0 100644 --- a/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md +++ b/versioned_docs/version-2.6/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md @@ -17,9 +17,12 @@ In order to deploy and run the adapter successfully, you need to ensure its vers ::: | Rancher Version | Adapter Version | -| --------------- | :-------------: | -| v2.6.7 | v1.0.1 | -| v2.6.8 | v1.0.1 | +|-----------------|:---------------:| +| v2.6.7* | v1.0.1 | +| v2.6.8* | v1.0.1 | +| v2.6.9 | v1.0.1 | + +> **Note:** While the adapter can technically be installed on Rancher v2.6.7 and v2.6.8, it is recommended to use version 2.6.9 or higher to avoid unexpected issues ### 1. Gain Access to the Local Cluster @@ -71,31 +74,29 @@ helm repo add rancher-charts https://charts.rancher.io Next, install the CSP adapter. You must specify several values, including the account number, and the name of the role created in the prerequisites. -For the below instructions, replace `$MY_ACC_NUM` with your AWS account number and `$MY_ROLE_NAME` with the name of the role created in the prerequisites. +Ensure that you use the version of the CSP adapter that matches the version of Rancher that you are running, as defined [above](#rancher-vs-adapter-compatibility-matrix). + +For the below instructions, replace `$MY_ACC_NUM` with your AWS account number and `$MY_ROLE_NAME` with the name of the role created in the prerequisites. In addition, replace `$CSP_ADAPTER_VERSION` with the version that matches your Rancher version in the [version matrix](#rancher-vs-adapter-compatibility-matrix). > **Note:** If you use shell variables, do not specify quotation marks. For example, MY_ACC_NUM=123456789012 will work, but MY_ACC_NUM="123456789012" will fail. > **Note:** Accounts using the AWS Marketplace listing for the EU and the UK will need to specify an additional `--set image.repository=rancher/rancher-csp-adapter-eu` option. To see if your account needs this option when installing the adapter, refer to the usage instructions of the marketplace listing. -> **Note:** It is important that you follow the instructions below exactly. In particular, the command to install version 1.0.1 of the adapter (by using --set image.tag=v1.0.1) is key to ensure that node counts are accurate. - ```bash - helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter --namespace cattle-csp-adapter-system --set aws.enabled=true --set aws.roleName=$MY_ROLE_NAME --set-string aws.accountNumber=$MY_ACC_NUM --set image.tag=v1.0.1 + helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter --namespace cattle-csp-adapter-system --set aws.enabled=true --set aws.roleName=$MY_ROLE_NAME --set-string aws.accountNumber=$MY_ACC_NUM --version $CSP_ADAPTER_VERSION ``` Alternatively, you can use a `values.yaml` and specify options like below: ```yaml - image: - tag: v1.0.1 aws: - enabled: true - accountNumber: "$MY_ACC_NUM" - roleName: $MY_ROLE_NAME + enabled: true + accountNumber: "$MY_ACC_NUM" + roleName: $MY_ROLE_NAME ``` > **Note:** The account number needs to be specified in a string format, like the above, or the installation will fail. @@ -103,25 +104,23 @@ For the below instructions, replace `$MY_ACC_NUM` with your AWS account number a You can then install the adapter with the following command: ```bash - helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter -f values.yaml + helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter -f values.yaml --version $CSP_ADAPTER_VERSION ``` ```bash - helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter --namespace cattle-csp-adapter-system --set aws.enabled=true --set aws.roleName=$MY_ROLE_NAME --set-string aws.accountNumber=$MY_ACC_NUM --set additionalTrustedCAs=true --set image.tag=v1.0.1 + helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter --namespace cattle-csp-adapter-system --set aws.enabled=true --set aws.roleName=$MY_ROLE_NAME --set-string aws.accountNumber=$MY_ACC_NUM --set additionalTrustedCAs=true --version $CSP_ADAPTER_VERSION ``` Alternatively, you can use a `values.yaml` and specify options the below: ```yaml - image: - tag: v1.0.1 aws: - enabled: true - accountNumber: "$MY_ACC_NUM" - roleName: $MY_ROLE_NAME + enabled: true + accountNumber: "$MY_ACC_NUM" + roleName: $MY_ROLE_NAME additionalTrustedCAs: true ``` @@ -130,7 +129,7 @@ For the below instructions, replace `$MY_ACC_NUM` with your AWS account number a You can then install the adapter with the following command: ```bash - helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter -f values.yaml + helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter -f values.yaml --version $CSP_ADAPTER_VERSION ```