Apply suggestions from code review

Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
This commit is contained in:
Lucas Saintarbor
2024-01-17 16:11:59 -08:00
committed by GitHub
parent 6353941d07
commit 3198dc92e0
7 changed files with 19 additions and 12 deletions

View File

@@ -1,6 +1,9 @@
---
title: AWS Marketplace Common Issues
---
This page covers some common issues that might arise when setting up the Rancher Prime PAYG offering on Amazon's AWS Marketplace.
### Migrating Rancher to a different EKS Cluster
When you migrate Rancher to a different EKS cluster by following the steps in [Rancher Backups and Disaster Recovery](../../../pages-for-subheaders/backup-restore-and-disaster-recovery.md), 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.

View File

@@ -57,7 +57,7 @@ eksctl create iamserviceaccount \
--password-stdin 709825985650.dkr.ecr.us-east-1.amazonaws.com
```
1. Install Rancher with Helm. Customize your Helm installation values if needed:
1. Install Rancher with Helm. Customize your Helm installation values if needed.
:::note
@@ -135,11 +135,11 @@ When Helm chart installation successfully completes, Rancher Prime will be insta
## Log into the Rancher Dashboard
You may now log in to the Rancher dashboard by pointing your browser to the Rancher server URL `https://<host-name>`. The `<host-name>` is the hostname you entered when you [installed Rancher](#installing-rancher).
You may now log in to the Rancher dashboard by pointing your browser to the Rancher server URL, `https://<host-name>`. The `<host-name>` is the hostname you entered when you [installed Rancher](#installing-rancher).
:::note
The Rancher hostname must be resolvable by public DNS. For more details, please refer to the [Prerequisites](prerequisites.md) section.
The Rancher hostname must be resolvable by public DNS. For more details, see [Prerequisites](prerequisites.md).
:::
@@ -156,5 +156,5 @@ Uninstalling Rancher Prime may not remove all of the Kubernetes resources create
The best practice for uninstalling the Rancher Prime PAYG offering is to migrate any non-Rancher workloads to a different cluster and destroy the Rancher cluster.
:::warning
Ensure you prepare and migrate any non-Rancher workloads off the cluster before destroying the cluster since these resources are not recoverable.
Ensure that you prepare and migrate any non-Rancher workloads off of the cluster before you destroy the cluster. These resources are nonrecoverable.
:::

View File

@@ -5,8 +5,8 @@ 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. For more details, see the [Rancher support matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/). 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 on the EKS cluster, so that Rancher is accessible from outside the cluster. See the [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.
- The Load Balancer IP address. See the [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`.
- An ingress on the EKS cluster, so that Rancher is accessible from outside the cluster. See the [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.
- The Load Balancer IP address. See the [Rancher documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md#6-get-load-balancer-ip) for how to find it, then save the `EXTERNAL-IP`.
- The Rancher hostname. The hostname must be a fully qualified domain name (FQDN), and its corresponding IP address must be resolvable from a public DNS. See the [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 points to the `EXTERNAL-IP`.
- [`aws`](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html).
- [`curl`](https://curl.se/docs/install.html).

View File

@@ -47,7 +47,7 @@ If a pod is not in a `Running` state, you can attempt to find the root cause wit
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
Error from server (NotFound): cspadapterusagerecords.susecloud.net "rancher-usage-record not found" Check Configuration, Retrieve generated configuration csp-config
```
To resolve the error, run:

View File

@@ -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 periodically updated as new versions of the billing adapter or Rancher Prime are released. When this happens, the Helm chart is updated with new tags and digests, and a new version of the Helm chart is 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. When a new update is available, the Helm chart is updated with new tags and digests, and a new version of the Helm chart is uploaded.
To upgrade the deployed Helm chart to the latest version, run the following Helm command:

View File

@@ -2,6 +2,10 @@
title: Azure Marketplace Common Issues
---
### Migrating Rancher to a different AKS Cluster
This page covers some common issues that might arise when setting up the Rancher Prime PAYG offering on Microsoft's Azure Marketplace.
### Migrating Rancher to a Different AKS Cluster
When you migrate Rancher to a different AKS cluster by following the steps in [Rancher Backups and Disaster Recovery](../../../pages-for-subheaders/backup-restore-and-disaster-recovery.md), you must reinstall Rancher Prime 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.

View File

@@ -2,9 +2,9 @@
title: Upgrading Rancher Prime PAYG Cluster in Azure
---
The Azure Marketplace PAYG offering is periodically updated as a new version of Rancher Prime is released and for optimizations in the integration with Azure.
The Azure Marketplace PAYG offering is periodically updated when a new version of Rancher Prime is released, and to optimize integration with Azure.
To update to the latest version of the Rancher Prime PAYG offering supported in the marketplace listing, run the following command in the cluster Cloud Shell:
To update to the latest supported version of the Rancher Prime PAYG offering, run the following command in the cluster Cloud Shell:
```shell
az k8s-extension update --name $CLUSTER_EXTENSION_RESOURCE_NAME --cluster-name $CLUSTER_NAME --resource-group $RESOURCE_GROUP --cluster-type managedClusters --version $VERSION_TO_BE_UPGRADED
@@ -12,6 +12,6 @@ az k8s-extension update --name $CLUSTER_EXTENSION_RESOURCE_NAME --cluster-name
:::warning
Rancher Prime PAYG customers have constraints on getting updates to the offer, based on the latest version SUSE has published to Azure. The latest available Rancher Prime version may trail slightly behind the latest Rancher release.
Rancher Prime PAYG customers have constraints on getting updates, based on the latest version SUSE has published to Azure. The latest available Rancher Prime version may trail slightly behind the latest Rancher release.
:::