From de01e74dc7b5f50fc24c50e714c33acb40c05497 Mon Sep 17 00:00:00 2001 From: LucasSaintarbor Date: Wed, 20 Dec 2023 12:46:19 -0800 Subject: [PATCH] Grammar/style review for AWS section --- .../common-issues.md | 4 ++-- .../installing-rancher-prime.md | 22 +++++++++---------- .../prerequisites.md | 6 ++--- .../troubleshooting.md | 12 +++++----- .../upgrading-rancher-payg-cluster.md | 8 +++---- .../troubleshooting.md | 2 +- .../aws-marketplace-payg-integration.md | 7 +++--- 7 files changed, 30 insertions(+), 31 deletions(-) diff --git a/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues.md b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues.md index e4e3f28674b..4ca9a0e6b91 100644 --- a/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues.md +++ b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues.md @@ -2,10 +2,10 @@ title: AWS Marketplace Common Issues --- -1. Uninstalling Rancher Prime may not cleanly remove all the resources that were created by Rancher. Users are encouraged to use the [Rancher resource cleanup script](https://github.com/rancher/rancher-cleanup) to perform a more comprehensive cleanup if necessary. However, it is recommended to migrate any other workloads off the cluster and prepare to destroy the cluster to complete the uninstallation since cleanup is not recoverable. +1. Uninstalling Rancher Prime may not cleanly remove all the resources that were created by Rancher. You are encouraged to use the [Rancher resource cleanup script](https://github.com/rancher/rancher-cleanup) to perform a more comprehensive cleanup if necessary. However, we recommend first preparing and migrating any other workloads off the cluster to destroy the cluster to complete the uninstallation since cleanup is not recoverable. ```shell helm uninstall -n cattle-rancher-csp-deployer-system rancher-cloud ``` -1. When migrating Rancher to a different EKS cluster by following the steps specified in [Rancher Backups and Disaster Recovery](https://ranchermanager.docs.rancher.com/pages-for-subheaders/backup-restore-and-disaster-recovery), Rancher Prime must be reinstalled on the target EKS cluster after restoring from the backup. Furthermore, the restored Rancher version must not be newer than the version available in the AWS Marketplace. +1. When migrating Rancher to a different EKS by following the steps specified in [Rancher Backups and Disaster Recovery](https://ranchermanager.docs.rancher.com/pages-for-subheaders/backup-restore-and-disaster-recovery), you must reinstall Rancher Prime on the target EKS cluster after restoring from the backup. Furthermore, the restored Rancher version must not be newer than the version available in the AWS marketplace. 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 951dfe029a7..c15b3af1493 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,13 +8,13 @@ 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 requires an OIDC provider to be installed. To check for an OIDC provider, find the OIDC issuer with the following command. Substitute `$CLUSTER_NAME` with the name of your EKS cluster and `$REGION` with the 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: @@ -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. +An IAM role and an attached policy are required to provide the necessary permissions. 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 \ @@ -61,11 +61,11 @@ eksctl create iamserviceaccount \ :::note - Rancher Prime utilizes cert-manager to issue and maintain its certificates. Rancher will generate a CA certificate of its own, and sign a certificate using that CA. + Rancher Prime utilizes cert-manager to issue and maintain its certificates. Rancher will generate a CA certificate of its own and sign a certificate using that CA. ::: - 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](prerequisites.md) 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 \ @@ -90,7 +90,7 @@ eksctl create iamserviceaccount \ ::: -1. After a successful deployment, running the following command should produce a similar output. +1. After a successful deployment, running the following command should produce a similar output: ```shell kubectl get deployments --all-namespaces @@ -115,7 +115,7 @@ eksctl create iamserviceaccount \ ### Check Helm Chart Installation -Check that the Helm chart installation is completed: +Check that the Helm chart installation is complete: ```shell helm ls -n cattle-rancher-csp-deployer-system @@ -129,15 +129,15 @@ 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 complete, 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 log in to the Rancher dashboard by pointing your browser to the Rancher server URL `https://$RANCHER_HOSTNAME`, where the Rancher hostname is the [hostname](#installing-rancher) is your chosen hostname when installing Rancher. :::note -The Rancher hostname must be resolvable by public DNS. Please refer to the [Prerequisites](rancher-prime-aws.md#prerequisites) section for more details. +The Rancher hostname must be resolvable by public DNS. Please refer to the [Prerequisites](prerequisites.md) section for more details. ::: diff --git a/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/prerequisites.md b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/prerequisites.md index 92279e460b3..56e64ec4fe8 100644 --- a/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/prerequisites.md +++ b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/prerequisites.md @@ -5,10 +5,10 @@ title: Prerequisites Before using Rancher Prime on AWS as a pay-as-you-go (PAYG) offering, you need the following resources, information, and tools: - A Rancher-compatible EKS cluster. Please see the [Rancher support matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/) for more details. Please refer to [Creating an EKS cluster](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks#creating-an-eks-cluster-for-the-rancher-server) for bringing up an EKS cluster to [install Rancher Prime PAYG](installing-rancher-prime.md). -- An ingress installed on the EKS cluster so that Rancher is accessible outside of the cluster. Please refer to [Rancher documentation](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks#5-install-an-ingress) for instructions on how to deploy Ingress-NGINX on an EKS cluster. +- An ingress is installed on the EKS cluster so that Rancher is accessible outside the cluster. Please refer to [Rancher documentation](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks#5-install-an-ingress) for instructions on deployings Ingress-NGINX on an EKS cluster. - Get the Load Balancer IP. Please refer to [Rancher documentation](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks#6-get-load-balancer-ip) and save the EXTERNAL-IP. -- The Rancher hostname must be a fully qualified domain name (FQDN) and its corresponding IP address must be resolvable from a public DNS. Please refer to [Rancher documentation](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks#7-set-up-dns) for instructions on how to setup DNS. This DNS is setup to point at the EXTERNAL-IP saved. -- Installation requires you have the following tools available and properly configured to access your AWS account, and your EKS cluster: +- The Rancher hostname must be a fully qualified domain name (FQDN), and its corresponding IP address must be resolvable from a public DNS. Please refer to [Rancher documentation](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks#7-set-up-dns) for instructions on how to set up DNS. This DNS is set up to point to the EXTERNAL-IP saved. +- Installation requires you to have the following tools available and properly configured to access your AWS account and your EKS cluster: - `aws` - `curl` - `eksctl` diff --git a/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/troubleshooting.md b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/troubleshooting.md index 1c649e9d5af..7ef364ffcfe 100644 --- a/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/troubleshooting.md +++ b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/troubleshooting.md @@ -2,7 +2,7 @@ title: Troubleshooting Rancher Prime PAYG Cluster in AWS --- -This section contains information to help you troubleshoot issues when installing Rancher Prime PAYG. +This section contains information to help troubleshoot issues when installing the Rancher Prime PAYG offer. ## Jobs and Pods @@ -12,7 +12,7 @@ Check the status of pods or jobs: kubectl get pods --all-namespaces ``` -If a pod is not in a Running state, you can attempt to find the root cause with the following commands: +If a pod is not in a `Running` state, you can attempt to find the root cause with the following commands: - Describe pod: `kubectl describe pod -n ` - Pod container logs: `kubectl logs -n ` @@ -21,15 +21,15 @@ If a pod is not in a Running state, you can attempt to find the root cause with ## Recovery from Failed Pods -If any of the pods aren't running, check the rancher-cloud Pod: +If any of the pods aren't running, check the `rancher-cloud` Pod: ```shell kubectl get pods --all-namespaces | grep rancher-cloud ``` -If the rancher-cloud pod is in an Error state, wait for the pod to be deleted. This should take about one minute. +If the `rancher-cloud` pod is in an `Error` state, wait for the pod to be deleted. This should take about one minute. -Fix the problem and run: +Fix the problem and run: ```shell helm upgrade -n cattle-rancher-csp-deployer-system rancher-cloud --create-namespace \ @@ -44,7 +44,7 @@ oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/suse/$REPOSITORY/rancher-clou ## Rancher Usage Record Not found -When you attempt to retrive a usage record, you might see the following message: +When you attempt to retrieve a usage record, you might see the following message: ```shell Error from server (NotFound): cspadapterusagerecords.susecloud.net "rancher-usage-record" not found" Check Configuration, Retrieve generated configuration csp-config diff --git a/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/upgrading-rancher-payg-cluster.md b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/upgrading-rancher-payg-cluster.md index 52b82ac3f1e..a9c5e0909b0 100644 --- a/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/upgrading-rancher-payg-cluster.md +++ b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/upgrading-rancher-payg-cluster.md @@ -2,9 +2,9 @@ title: Upgrading Rancher Prime PAYG Cluster in AWS --- -The AWS Marketplace PAYG offering is tied to a billing adapter and the Rancher Prime version. These are updated periodically as new version of the billing adapter or Rancher Prime are released. In this situation, the helm chart will be updated with new tags and digests, and a new version of the helm chart will be uploaded. +The AWS Marketplace PAYG offering is tied to a billing adapter and the Rancher Prime version. These are updated periodically as new versions of the billing adapter or Rancher Prime are released. In this situation, the Helm chart will be updated with new tags and digests, and a new version of the Helm chart will be uploaded. -To upgrade the deployed helm chart with the latest version, run the following helm command: +To upgrade the deployed Helm chart with the latest version, run the following Helm command: ```shell helm upgrade -n cattle-rancher-csp-deployer-system rancher-cloud --create-namespace \ @@ -18,7 +18,7 @@ oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/suse/$REPOSITORY/rancher-clou --set global.aws.roleName=$ROLE_NAME ``` -To check if the upgraded Helm chart deployed successfully: +To check if the upgraded Helm chart deployed successfully, run the following Helm command: ```shell helm ls -n cattle-rancher-csp-deployer-system @@ -26,6 +26,6 @@ helm ls -n cattle-rancher-csp-deployer-system :::warning -PAYG customers will have constraints on getting updates to the offer based on the latest version SUSE has published to AWS, which may trail slightly behind the latest Rancher release. +Rancher Prime PAYG customers will have constraints on getting updates to the offer based on the latest version SUSE has published to AWS, which may trail slightly behind the latest Rancher release. ::: diff --git a/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/troubleshooting.md b/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/troubleshooting.md index 3d5e2fa6d65..f94ad7f8611 100644 --- a/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/troubleshooting.md +++ b/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/troubleshooting.md @@ -2,7 +2,7 @@ title: Troubleshooting Rancher Prime PAYG Cluster in Azure --- -This section contains information to help you troubleshoot issues when installing Rancher Prime PAYG and configuring the Billing-adapter. +This section contains information to help troubleshoot issues when installing the Rancher Prime PAYG offer and configuring the Billing-adapter. ## Deployment diff --git a/docs/pages-for-subheaders/aws-marketplace-payg-integration.md b/docs/pages-for-subheaders/aws-marketplace-payg-integration.md index d0a3a968187..9672d7dfed0 100644 --- a/docs/pages-for-subheaders/aws-marketplace-payg-integration.md +++ b/docs/pages-for-subheaders/aws-marketplace-payg-integration.md @@ -8,19 +8,18 @@ title: AWS Marketplace Pay-as-you-go (PAYG) Integration ## Overview -Rancher Prime integrates with the AWS Marketplace as a pay-as-you-go (PAYG) offering. This brings the value of running and managing Kubernetes environments to AWS customers, with the benefit of a new pay monthly pricing model available through the AWS Marketplace. This listing will enable you to manage any CNCF-certified Kubernetes -distribution in AWS, on-prem, or at the edge. To learn more, see our non-EMEMA and EMEA AWS Marketplace offerings for Rancher Prime: +Rancher Prime integrates with the AWS Marketplace as a pay-as-you-go (PAYG) offering. This brings the value of running and managing Kubernetes environments to AWS customers, benefiting from a new pay monthly pricing model available through the AWS Marketplace. This listing will enable you to manage any CNCF-certified Kubernetes distribution in AWS, on-prem, or at the edge. To learn more, see our non-EMEMA and EMEA AWS Marketplace offerings for Rancher Prime: - [Rancher Prime](https://aws.amazon.com/marketplace/pp/prodview-f2bvszurj2p2c) - [Rancher Prime (EMEA Orders Only)](https://aws.amazon.com/marketplace/pp/prodview-ocgjwd5c2aj5i) ## Limitations -- Currently, you must be running Rancher Manager v2.7.9. When you deploy a supported PAYG version, you will be able to update to newer versions of Rancher Manager when the listing is updated. +- Currently, you must be running Rancher Manager v2.7.9. When you deploy a supported PAYG version, you can update to newer versions of Rancher Manager when the listing is updated. ## How to Use -1. Complete the [prerequisite steps](../integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/rancher-prime-aws.md). +1. Complete the [prerequisite steps](../integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/prerequisites.md). 2. [Install the Rancher Prime PAYG offering on the AWS Marketplace](../integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md). ## FAQ