From cb62042a277afc0a44a493c4086ba612244a6446 Mon Sep 17 00:00:00 2001 From: LucasSaintarbor Date: Mon, 18 Dec 2023 14:58:50 -0800 Subject: [PATCH] Capitalized Helm and syntax changes --- .../installing-rancher-prime.md | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md index 76a15a3f87b..951dfe029a7 100644 --- a/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md +++ b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md @@ -8,15 +8,15 @@ This page covers how to install the Rancher Prime PAYG offering on Amazon's AWS ### OIDC provider -Your EKS cluster is required to have an OIDC provider installed. To check for an OIDC provider first find the OIDC issuer with the following command. Substitute `$CLUSTER_NAME` with the *Name* of your EKS cluster and $REGION with *region* where it is running: +Your EKS cluster is required to have an OIDC provider installed. To check for an OIDC provider first find the OIDC issuer with the following command. Substitute `$CLUSTER_NAME` with the *name* of your EKS cluster and `$REGION` with *region* where it is running: ```shell aws eks describe-cluster --name $CLUSTER_NAME --region $REGION --query cluster.identity.oidc.issuer --output text ``` -A URL is returned, like `https://oidc.eks.region.amazonaws.com/id/1234567890ABCDEF`. The part after `https://` will be referred to in later instructions as the *OIDC Provider Identity* (e.g. `oidc.eks.region.amazonaws.com/id/1234567890ABCDEF`). The final section of the URL, `1234567890ABCDEF`, is the $OIDC_ID. +A URL is returned, like `https://oidc.eks.region.amazonaws.com/id/1234567890ABCDEF`. The part after `https://` will be referred to in later instructions as the *OIDC Provider Identity* (e.g. `oidc.eks.region.amazonaws.com/id/1234567890ABCDEF`). The final section of the URL, `1234567890ABCDEF`, is the `$OIDC_ID`. -Using the $OIDC_ID of the issuer found above, you can check if a provider is installed with the following command: +Using the `$OIDC_ID` of the issuer found above, you can check if a provider is installed with the following command: ```shell aws iam list-open-id-connect-providers | grep $OIDC_ID @@ -30,9 +30,9 @@ eksctl utils associate-iam-oidc-provider --cluster $CLUSTER_NAME --region $REGIO ### IAM Role -To provide the necessary permissions, an IAM role and an attached policy are required. The role name is passed as an argument during the *helm* deployment. +To provide the necessary permissions, an IAM role and an attached policy are required. The role name is passed as an argument during the Helm deployment. -Create the role with a *role name* of your choosing (for example, `rancher-csp-iam-role`), and the required policy attached to it: +Create the role with a `$ROLE_NAME` of your choosing (for example, `rancher-csp-iam-role`), and the required policy attached to it: ```shell eksctl create iamserviceaccount \ @@ -47,7 +47,7 @@ eksctl create iamserviceaccount \ ## Installing Rancher -1. Log helm into the AWS Marketplace Elastic Container Registry (ECR) to fetch the application. The AWS Marketplace ECR is always in the `us-east-1` region: +1. Log Helm into the AWS Marketplace Elastic Container Registry (ECR) to fetch the application. The AWS Marketplace ECR is always in the `us-east-1` region: ```shell export HELM_EXPERIMENTAL_OCI=1 @@ -57,7 +57,7 @@ eksctl create iamserviceaccount \ --password-stdin 709825985650.dkr.ecr.us-east-1.amazonaws.com ``` -1. Install Rancher into your cluster using `helm`. Customize your `helm` installation values if needed: +1. Install Rancher into your cluster using Helm. Customize your Helm installation values if needed: :::note @@ -65,7 +65,7 @@ eksctl create iamserviceaccount \ ::: - The Rancher hostname must be resolvable by a public DNS. Please refer to the [Prerequisites](./rancher-prime-aws.md#prerequisites) section for more details. For example, if the DNS name is rancher.my.org, HOST_NAME=rancher.my.org. + The Rancher hostname must be resolvable by a public DNS. Please refer to the [Prerequisites](./rancher-prime-aws.md#prerequisites) section for more details. For example, if the DNS name is rancher.my.org, `$HOST_NAME`=`rancher.my.org`. ```shell helm install -n cattle-rancher-csp-deployer-system rancher-cloud --create-namespace \ @@ -82,14 +82,14 @@ eksctl create iamserviceaccount \ :::note - Monitor the rancher-cloud pod logs as the rancher-cloud pod is deleted 1 minute after a successful or failed installation. - - ::: + Monitor the logs for the `rancher-cloud` pod since it is deleted 1 minute after a successful or failed installation. ```shell - kubectl logs -f $POD -n cattle-rancher-csp-deployer-system + kubectl logs -f rancher-cloud -n cattle-rancher-csp-deployer-system ``` + ::: + 1. After a successful deployment, running the following command should produce a similar output. ```shell @@ -115,13 +115,13 @@ eksctl create iamserviceaccount \ ### Check Helm Chart Installation -Check that the helm chart installation is completed: +Check that the Helm chart installation is completed: ```shell helm ls -n cattle-rancher-csp-deployer-system ``` -After completing the helm chart installation, you can verify the installation was successful: +After completing the Helm chart installation, you can verify the installation was successful: ```shell helm status rancher-cloud -n cattle-rancher-csp-deployer-system @@ -129,11 +129,11 @@ helm status rancher-cloud -n cattle-rancher-csp-deployer-system Refer to the [Troubleshooting](troubleshooting.md) section for a failed installation. -After the helm chart installation is completed, Rancher Prime is successfully installed. +After the Helm chart installation is completed, Rancher Prime is successfully installed. ## Log into the Rancher Dashboard -You may now login to Rancher dashboard by pointing your browser to the Rancher server URL *https://$RANCHER_HOSTNAME*, where *Rancher hostname* is the [hostname](#installing-rancher) you have chosen when installing Rancher. +You may now login to Rancher dashboard by pointing your browser to the Rancher server URL `https://$RANCHER_HOSTNAME`, where *Rancher hostname* is the [hostname](#installing-rancher) you have chosen when installing Rancher. :::note