Grammar / formatting review

2026-09-26 21:18:04 +00:00 · 2024-01-04 11:55:17 -08:00
parent 36ef7b30ba
commit 5569325344
12 changed files with 35 additions and 33 deletions
@@ -2,7 +2,7 @@
 title: AWS Marketplace Common Issues
 ---

-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.
+1. Uninstalling Rancher Prime may not cleanly remove all the resources that Rancher created. 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
@@ -2,7 +2,7 @@
 title: Installing Rancher Prime PAYG on AWS
 ---

-This page covers how to install the Rancher Prime PAYG offering on Amazon's AWS Marketplace.
+This page covers installing the Rancher Prime PAYG offering on Amazon's AWS Marketplace.

 ## Preparing your cluster

@@ -65,7 +65,7 @@ eksctl create iamserviceaccount \

  :::

-  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`.
+  The Rancher hostname must be resolvable by a public DNS. For more details, please refer to the [Prerequisites](prerequisites.md) section. 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 \
@@ -137,7 +137,7 @@ You may now log in to the Rancher dashboard by pointing your browser to the Ranc

 :::note

-The Rancher hostname must be resolvable by public DNS. Please refer to the [Prerequisites](prerequisites.md) section for more details.
+The Rancher hostname must be resolvable by public DNS. For more details, please refer to the [Prerequisites](prerequisites.md) section.

 :::

@@ -4,11 +4,11 @@ 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](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md) for bringing up an EKS cluster to [install Rancher Prime PAYG](installing-rancher-prime.md).
- An ingress is installed on the EKS cluster so that Rancher is accessible outside the cluster. Please refer to [Rancher documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md#5-install-an-ingress) for instructions on deployings Ingress-NGINX on an EKS cluster.
+- A Rancher-compatible EKS cluster. For more details, please see the [Rancher support matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/). Please refer to [Creating an EKS cluster](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md) for bringing up an EKS cluster to [install Rancher Prime PAYG](installing-rancher-prime.md).
+- An ingress is installed on the EKS cluster so that Rancher is accessible outside the cluster. Please refer to [Rancher documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md#5-install-an-ingress) for instructions on deploying Ingress-NGINX on an EKS cluster.
 - Get the Load Balancer IP. Please refer to [Rancher documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md#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](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md#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:
+- Installation requires you to have the following tools available and properly configured to access your AWS account and your EKS cluster:
  - `aws`
  - `curl`
  - `eksctl`
@@ -2,7 +2,7 @@
 title: Troubleshooting Rancher Prime PAYG Cluster in AWS
 ---

-This section contains information to help troubleshoot issues when installing the Rancher Prime PAYG offer.
+This section contains information to help troubleshoot issues when installing the Rancher Prime PAYG offering.

 ## Jobs and Pods

@@ -19,9 +19,9 @@ If a pod is not in a `Running` state, you can attempt to find the root cause wit
 - Describe job: `kubectl describe job <job name> -n <namespaces>`
 - Logs from the containers of pods of the job: `kubectl logs -l job-name=<job name> -n <namespaces>`

-## Recovery from Failed Pods
+## Recovering 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
@@ -2,7 +2,7 @@
 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 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.
+The AWS Marketplace PAYG offering is tied to a billing adapter and the Rancher Prime version. These are periodically updated 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:

@@ -26,6 +26,6 @@ helm ls -n cattle-rancher-csp-deployer-system

 :::warning

-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.
+Rancher Prime PAYG customers will have constraints on getting updates to the offering based on the latest version SUSE has published to AWS, which may trail slightly behind the latest Rancher release.

 :::
@@ -2,6 +2,6 @@
 title: Azure 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 Rancher created. 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. When migrating Rancher to a different AKS cluster by following the steps specified in [Rancher Backups and Disaster Recovery](../../../pages-for-subheaders/backup-restore-and-disaster-recovery.md), Rancher Prime must be reinstalled via the Azure Marketplace on the target AKS cluster after restoring from the backup. Furthermore, the restored Rancher version must not be newer than the version available in the Azure Marketplace.
@@ -2,7 +2,7 @@
 title: Installing Rancher Prime PAYG on Azure
 ---

-This page covers how to install the Rancher Prime PAYG offering on Microsoft's Azure Marketplace.
+This page covers installing the Rancher Prime PAYG offering on Microsoft's Azure Marketplace.

 ## How to Install Rancher Prime PAYG

@@ -16,17 +16,19 @@ Refer to the following steps for creating a new deployment of Rancher Prime from

 On the **Basics** tab, specify the **Project details** and **Instance details**:

-1. Select an existing subscription from the dropdown list.
-1. Select an existing Resource group from the dropdown list.
+1. Select an existing **Subscription** from the dropdown list.
+1. Select an existing **Resource group** from the dropdown list.
+
   :::note

   The **Create new** resource group feature is not supported.

   :::
   ![Create new resource group not supported](/img/install-rancher-prime-basics-create-new.png)
-1. Select an existing AKS Cluster Name from the dropdown list.
-1. Choose a name for the Cluster extension resource name. It can consist of alphanumeric characters and dots, and the length must be between 2 and 253 characters.
-![Basics tab](/img/install-rancher-prime-basics.png)
+1. Select an existing **AKS Cluster Name** from the dropdown list.
+1. Choose an **Extension Resource name**. It can consist of alphanumeric characters and dots; the length must be between 2 and 253 characters.
+
+   ![Basics tab](/img/install-rancher-prime-basics.png)
 1. Select **Next**.

 ### Rancher Configuration
@@ -80,7 +82,7 @@ After logging into Rancher Prime, you should notice the Welcome to Rancher Prime

 ![Rancher Prime Home](/img/install-rancher-prime-home.png)

-If your Rancher Prime PAYG deployment only has **Welcome to Rancher** at the top of the screen, please ensure you've updated to the latest version, and reset the branding to default (i.e. "suse") from **Global Settings**.
+If your Rancher Prime PAYG deployment only has **Welcome to Rancher** at the top of the screen, please ensure you've updated to the latest version, and reset the branding to default (i.e., "suse") from **Global Settings**.

 ![Global Settings](/img/install-rancher-prime-global-settings.png)

@@ -4,6 +4,6 @@ title: Prerequisites

 Before using Rancher Prime on Azure as a pay-as-you-go (PAYG) offering, you need the following resources, information, and tools:

- A Rancher-compatible AKS cluster. Please see the [Rancher support matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/) for more details. The Rancher Prime PAYG offering can only be installed onto clusters in regions where both the AKS and Azure Container Apps service are available. See the [Azure documentation](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=container-apps,kubernetes-service&regions=all) for details. Please see [Creating an AKS cluster](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md#3-create-the-aks-cluster) for bringing up an AKS cluster to [install Rancher Prime PAYG](installing-rancher-prime.md).
- An ingress installed on the AKS cluster so that Rancher is accessible outside of the cluster. Please refer to [Rancher documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md#5-install-an-ingress) for instructions on how to deploy Ingress-NGINX on AKS 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](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md#7-set-up-dns) for instructions on how to setup DNS.
+- A Rancher-compatible AKS cluster. For more details, please see the [Rancher support matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/). You can only install the Rancher Prime PAYG offering onto clusters in regions where AKS and Azure Container Apps are available. See the [Azure documentation](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=container-apps,kubernetes-service&regions=all) for details. Please see [Creating an AKS cluster](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md#3-create-the-aks-cluster) for bringing up an AKS cluster to [install Rancher Prime PAYG](installing-rancher-prime.md).
+- An ingress installed on the AKS cluster so that Rancher is accessible outside the cluster. Please refer to [Rancher documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md#5-install-an-ingress) for instructions on how to deploy Ingress-NGINX on an AKS 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](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md#7-set-up-dns) for instructions on how to set up DNS.
@@ -2,7 +2,7 @@
 title: Troubleshooting Rancher Prime PAYG Cluster in Azure
 ---

-This section contains information to help troubleshoot issues when installing the Rancher Prime PAYG offer 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

@@ -42,7 +42,7 @@ Check the status of pods or jobs:
 kubectl get pods --all-namespaces
 ```

-if a pod is not in Running state, you can attempt to find the root cause with the following commands:
+If a pod is not in Running state, you can attempt to find the root cause with the following commands:

 - Describe pod: `kubectl describe pod <pod name> -n <namespaces>`
 - Pod container logs: `kubectl logs <pod name> -n <namespaces>`
@@ -51,7 +51,7 @@ if a pod is not in Running state, you can attempt to find the root cause with th

 ## 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
@@ -65,9 +65,9 @@ kubectl get configmap -n cattle-csp-billing-adapter-system csp-config -o yaml

 If a configuration is not listed, you can attempt to find the root cause by checking the pod status and log. See [Jobs and Pods](#jobs-and-pods) for more details.

-## Multiple extensions of same type
+## Multiple Extensions of the Same Type

-When you attept to install an extension of the same type, you will see the following message:
+When you attempt to install an extension of the same type, you will see the following message:

 ```shell
 Multiple extensions of same type is not allowed at this scope. (Code: ValidationFailed)"
@@ -75,9 +75,9 @@ Multiple extensions of same type is not allowed at this scope. (Code: Validation

 AKS cluster already has the extension with the same type. To resolve the error, uninstall the extension and re-deploy with the same cluster.

-## Resource already existing in your cluster
+## Resource Already Existing in your Cluster

-When you attept to install a resource or extension that already exists, you will see the following message:
+When you attempt to install a resource or extension that already exists, you will see the following message:

 ```shell
 Helm installation failed : Resource already existing in your cluster : Recommendation Manually delete the resource(s) that currently exist in your cluster and try installation again. To delete these resources run the following commands: kubectl delete <resource type> -n <resource namespace> <resource name> : InnerError [rendered manifests contain a resource that already exists. Unable to continue with install: ServiceAccount "rancher" in namespace "cattle-system" exists and cannot be imported into the current release: invalid ownership metadata; annotation validation error: key "meta.helm.sh/release-name" must equal "test-nv2-reinstall": current value is "testnv2-plan"]
@@ -8,7 +8,7 @@ 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, 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 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)
@@ -8,14 +8,14 @@ title: Azure Marketplace Pay-as-you-go (PAYG) Integration

 ## Overview

-Rancher Prime integrates with the Azure Marketplace as a pay-as-you-go (PAYG) offering. This brings the value of running and managing Kubernetes environments to Azure customers, with the benefit of a new pay monthly pricing model available through the Azure Marketplace. This listing will enable you to manage any CNCF-certified Kubernetes distribution in Azure, on-prem, or at the edge. To learn more, see our non-EMEMA and EMEA Azure Marketplace offerings for Rancher Prime:
+Rancher Prime integrates with the Azure Marketplace as a pay-as-you-go (PAYG) offering. This brings the value of running and managing Kubernetes environments to Azure customers, benefiting from a new pay-monthly pricing model available through the Azure Marketplace. This listing will enable you to manage any CNCF-certified Kubernetes distribution in Azure, on-prem, or at the edge. To learn more, see our non-EMEMA and EMEA Azure Marketplace offerings for Rancher Prime:

 - [Rancher Prime with 24x7 Support](https://portal.azure.com/#view/Microsoft_Azure_Marketplace/GalleryItemDetailsBladeNopdl/id/suse.rancher-prime-llc/selectionMode~/false/resourceGroupId//resourceGroupLocation//dontDiscardJourney~/false/selectedMenuId/home/launchingContext~/%7B%22galleryItemId%22%3A%22suse.rancher-prime-llcpay-as-you-go%22%2C%22source%22%3A%5B%22GalleryFeaturedMenuItemPart%22%2C%22VirtualizedTileDetails%22%5D%2C%22menuItemId%22%3A%22home%22%2C%22subMenuItemId%22%3A%22Search%20results%22%2C%22telemetryId%22%3A%221dafcf16-920e-46ea-80c9-dc85c6bd3a17%22%7D/searchTelemetryId/c2300fb7-ba7b-462a-ba57-a37cb5e2822d)
 - [Rancher Prime with 24x7 Support (EMEA Orders Only)](https://portal.azure.com/#view/Microsoft_Azure_Marketplace/GalleryItemDetailsBladeNopdl/id/suseirelandltd1692213356027.rancher-prime-ltd/selectionMode~/false/resourceGroupId//resourceGroupLocation//dontDiscardJourney~/false/selectedMenuId/home/launchingContext~/%7B%22galleryItemId%22%3A%22suseirelandltd1692213356027.rancher-prime-ltdpay-as-you-go%22%2C%22source%22%3A%5B%22GalleryFeaturedMenuItemPart%22%2C%22VirtualizedTileDetails%22%5D%2C%22menuItemId%22%3A%22home%22%2C%22subMenuItemId%22%3A%22Search%20results%22%2C%22telemetryId%22%3A%22c6b1d79a-b577-47b0-90e5-41e6c49688ab%22%7D/searchTelemetryId/1793144d-e0d9-466e-8e36-dfeddc73163b)

 ## Limitations

- Currently, you must be running Rancher v2.7.9. When you deploy a supported PAYG version, you will be able to update to newer versions of Rancher when the listing is updated.
+- Currently, you must be running Rancher v2.7.9. When you deploy a supported PAYG version, you can update to newer versions of Rancher when the listing is updated.

 ## How to Use