rancher · LucasSaintarbor · Jul 11, 2024 · Aug 9, 2024 · Sep 6, 2024 · Sep 6, 2024
@@ -13,9 +13,14 @@ Rancher Prime integrates with the [AWS Marketplace](https://aws.amazon.com/marke
 
 For more details on how Rancher pay-as-you-go offerings work, refer to the [pay-as-you-go FAQ](../cloud-marketplace-payg-integration.md#faq).
 
-## Limitations
+## Supported Versions
 
-- 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.
+- Rancher v2.8.4
+- Rancher v2.7.9
+
+We recommend using v2.8.4 for the latest features and security fixes.
+
+When you deploy a supported PAYG version, you can update to newer versions of Rancher when the listing is updated.
 
 ## How to Use
 

@@ -13,9 +13,14 @@ Rancher Prime integrates with the [Azure Marketplace](https://azuremarketplace.m
 
 For more details on how Rancher pay-as-you-go offerings work, refer to the [pay-as-you-go FAQ](../cloud-marketplace-payg-integration.md#faq).
 
-## Limitations
+## Supported Versions
 
-- 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.
+- Rancher v2.8.4
+- Rancher v2.7.9
+
+We recommend using v2.8.4 for the latest features and security fixes.
+
+When you deploy a supported PAYG version, you can update to newer versions of Rancher when the listing is updated.
 
 ## How to Use
 

@@ -8,9 +8,14 @@ title: Cloud Marketplace Pay-as-you-go (PAYG) Integration
 
 Rancher Prime integrates with the [AWS Marketplace](https://aws.amazon.com/marketplace) and [Azure Marketplace](https://azuremarketplace.microsoft.com/) as a pay-as-you-go (PAYG) offering. This brings the value of running and managing Kubernetes environments to cloud customers, who benefit from a new pay-monthly pricing model available through their preferred cloud provider's marketplace. This listing will enable you to manage any CNCF-certified Kubernetes distribution in AWS, Azure, on-prem, or at the edge.
 
-## Limitations
+## Supported Versions
 
-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.
+- Rancher v2.8.4
+- Rancher v2.7.9
+
+We recommend using v2.8.4 for the latest features and security fixes.
+
+When you deploy a supported PAYG version, you can update to newer versions of Rancher when the listing is updated.
 
 ## How to Use
 

@@ -0,0 +1,28 @@
+---
+title: AWS Marketplace Pay-as-you-go (PAYG) Integration
+---
+
+## Overview
+
+Rancher Prime integrates with the [AWS Marketplace](https://aws.amazon.com/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-EMEA 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)
+
+## FAQ
+
+For more details on how Rancher pay-as-you-go offerings work, refer to the [pay-as-you-go FAQ](../cloud-marketplace-payg-integration.md#faq).
+
+## Supported Versions
+
+- Rancher v2.8.4
+- Rancher v2.7.9
+
+We recommend using v2.8.4 for the latest features and security fixes.
+
+When you deploy a supported PAYG version, you can update to newer versions of Rancher when the listing is updated.
+
+## How to Use
+
+1. Complete the [prerequisite steps](prerequisites.md).
+2. [Install the Rancher Prime PAYG offering on the AWS Marketplace](installing-rancher-prime.md).
@@ -0,0 +1,9 @@
+---
+title: Common Issues for Rancher Prime PAYG on AWS
+---
+
+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](../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/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.
@@ -0,0 +1,160 @@
+---
+title: Installing Rancher Prime PAYG on AWS
+---
+
+This page covers installing the Rancher Prime PAYG offering on Amazon's AWS Marketplace.
+
+## Preparing your cluster
+
+### OIDC provider
+
+Your EKS cluster requires that you install an OIDC provider. To check that you've installed 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
+```
+
+This should return a URL, such as `https://oidc.eks.region.amazonaws.com/id/1234567890ABCDEF`. The part after `https://` (e.g. `oidc.eks.region.amazonaws.com/id/1234567890ABCDEF`) is the OIDC Provider Identity. The final section of the URL, `1234567890ABCDEF`, is the OIDC ID.
+
+Use the OIDC ID to check if the EKS cluster has a provider:
+
+```shell
+aws iam list-open-id-connect-providers | grep <oidc-id>
+```
+
+If the last command produces no output, create an OIDC provider:
+
+```shell
+eksctl utils associate-iam-oidc-provider --cluster <cluster-name> --region <region> --approve
+```
+
+### IAM Role
+
+You must create an IAM role and an attached policy 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 attach the required policy:
+
+```shell
+eksctl create iamserviceaccount \
+  --name rancher-csp-billing-adapter \
+  --namespace cattle-csp-billing-adapter-system \
+  --cluster <cluster-name> \
+  --region <region> \
+  --role-name <role-name> --role-only \
+  --attach-policy-arn 'arn:aws:iam::aws:policy/AWSMarketplaceMeteringFullAccess' \
+  --approve
+```
+
+## 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:
+
+  ```shell
+  export HELM_EXPERIMENTAL_OCI=1
+
+  aws --region us-east-1 ecr get-login-password \
+    | helm registry login --username AWS \
+    --password-stdin 709825985650.dkr.ecr.us-east-1.amazonaws.com
+  ```
+
+1. Install Rancher with Helm. Customize your Helm installation values if needed.
+
+  :::note
+
+  Rancher Prime uses cert-manager to issue and maintain its certificates. Rancher generates its own CA certificate and signs certificates with that CA.
+
+  :::
+
+  The Rancher hostname must be resolvable by a public DNS. For more details, see [Prerequisites](prerequisites.md). For example, if the DNS name is `rancher.my.org`, then replace `<host-name>` with `rancher.my.org` when running the `helm install` command.
+
+  ```shell
+  helm install -n cattle-rancher-csp-deployer-system rancher-cloud --create-namespace \
+  oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/suse/$REPOSITORY/rancher-cloud-helm/rancher-cloud \
+    --version <chart-version> \
+    --set rancherHostname=<host-name>\
+    --set rancherServerURL=https://<host-name>\
+    --set rancherReplicas=<replicas> \
+    --set rancherBootstrapPassword=<bootstrap-password>\
+    --set rancherIngressClassName=nginx \
+    --set global.aws.accountNumber=<aws-account-id>\
+    --set global.aws.roleName=<role-name>
+  ```
+
+  :::note
+
+  Monitor the logs for the `rancher-cloud` pod since it is deleted one minute after a successful or failed installation.
+
+  ```shell
+  kubectl logs -f rancher-cloud -n cattle-rancher-csp-deployer-system
+  ```
+
+  :::
+
+1. After a successful deployment, the following command should produce similar output:
+
+  ```shell
+  kubectl get deployments --all-namespaces
+  ```
+
+**Response:**
+
+  ```shell
+  NAMESPACE                           NAME                          READY   UP-TO-DATE   AVAILABLE   AGE
+  cattle-csp-billing-adapter-system   csp-rancher-usage-operator    1/1     1            1           30m
+  cattle-csp-billing-adapter-system   rancher-csp-billing-adapter   1/1     1            1           30m
+  cattle-fleet-local-system           fleet-agent                   1/1     1            1           29m
+  cattle-fleet-system                 fleet-controller              1/1     1            1           29m
+  cattle-fleet-system                 gitjob                        1/1     1            1           29m
+  cattle-provisioning-capi-system     capi-controller-manager       1/1     1            1           28m
+  cattle-system                       rancher                       1/1     1            1           32m
+  cattle-system                       rancher-webhook               1/1     1            1           29m
+  cert-manager                        cert-manager                  1/1     1            1           32m
+  cert-manager                        cert-manager-cainjector       1/1     1            1           32m
+  cert-manager                        cert-manager-webhook          1/1     1            1           32m
+  ingress-nginx                       ingress-nginx-controller      1/1     1            1           33m
+  kube-system                         coredns                       2/2     2            2           38m
+  ```
+
+### Check Helm Chart Installation
+
+1. Check that the Helm chart installation completed:
+
+```shell
+helm ls -n cattle-rancher-csp-deployer-system
+```
+
+2. Verify the status of the installation:
+
+```shell
+helm status rancher-cloud -n cattle-rancher-csp-deployer-system
+```
+
+Refer to the [Troubleshooting](troubleshooting.md) section if installation fails.
+
+When Helm chart installation successfully completes, Rancher Prime will be installed.
+
+## 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).
+
+:::note
+
+The Rancher hostname must be resolvable by public DNS. For more details, see [Prerequisites](prerequisites.md).
+
+:::
+
+## Uninstalling Rancher Prime PAYG Offering
+
+Run the following command to uninstall Rancher Prime:
+
+```shell
+helm uninstall -n cattle-rancher-csp-deployer-system rancher-cloud
+```
+
+Uninstalling Rancher Prime may not remove all of the Kubernetes resources created by Rancher. Run the [Rancher resource cleanup script](https://github.com/rancher/rancher-cleanup) to perform a more comprehensive cleanup.
+
+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 that you prepare and migrate any non-Rancher workloads off of the cluster before you destroy the cluster. These resources are nonrecoverable.
+:::
@@ -0,0 +1,14 @@
+---
+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) 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).
+- [`eksctl`](https://eksctl.io/installation/).
+- [`helm` (v3 or greater)](https://helm.sh/docs/intro/quickstart/#install-helm).
@@ -0,0 +1,59 @@
+---
+title: Troubleshooting Rancher Prime PAYG Cluster in AWS
+---
+
+This section contains information to help troubleshoot issues when installing the Rancher Prime PAYG offering.
+
+## Jobs and Pods
+
+Check the status of pods or jobs:
+
+```shell
+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:
+
+- Describe pod: `kubectl describe pod <pod-name> -n <namespace>`
+- Pod container logs: `kubectl logs <pod-name> -n <namespace>`
+- Describe job: `kubectl describe job <job-name> -n <namespace>`
+- Logs from the containers of pods of the job: `kubectl logs -l job-name=<job-name> -n <namespace>`
+
+## Recovering from Failed Pods
+
+1. If any of the pods aren't running, check the `rancher-cloud` pod:
+
+  ```shell
+  kubectl get pods --all-namespaces | grep rancher-cloud
+  ```
+
+1. If the `rancher-cloud` pod is in an `Error` state, wait for the pod to be deleted. This should take about one minute.
+
+1. Fix the problem and run:
+
+  ```shell
+  helm upgrade -n cattle-rancher-csp-deployer-system rancher-cloud --create-namespace \
+  oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/suse/<repository>/rancher-cloud-helm/rancher-cloud --install \
+    --version <chart-version> \
+    --set rancherHostname=<host-name> \
+    --set rancherServerURL=https://<host-name> \
+    --set rancherReplicas=<replicas> \
+    --set global.aws.accountNumber=<aws-account-id> \
+    --set global.aws.roleName=<role-name>
+  ```
+
+## Rancher Usage Record Not Found
+
+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
+```
+
+To resolve the error, run:
+
+```shell
+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.
@@ -0,0 +1,31 @@
+---
+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 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:
+
+```shell
+helm upgrade -n cattle-rancher-csp-deployer-system rancher-cloud --create-namespace \
+oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/suse/<respository>/rancher-cloud-helm/rancher-cloud \
+  --version <upgraded-chart-version> \
+  --set rancherHostname=<host-name> \
+  --set rancherServerURL=https://<host-name> \
+  --set rancherReplicas=<replicas> \
+  --set rancherIngressClassName=nginx \
+  --set global.aws.accountNumber=<aws-account-id> \
+  --set global.aws.roleName=<role-name>
+```
+
+To check if the upgraded Helm chart deployed successfully, run the following Helm command:
+
+```shell
+helm ls -n cattle-rancher-csp-deployer-system
+```
+
+:::warning
+
+Rancher Prime PAYG customers have constraints on getting updates, based on the latest version SUSE has published to AWS. The latest available Rancher Prime version may trail slightly behind the latest Rancher release.
+
+:::
@@ -0,0 +1,23 @@
+---
+title: Azure Marketplace Pay-as-you-go (PAYG) Integration
+---
+
+## Overview
+
+Rancher Prime integrates with the [Azure Marketplace](https://azuremarketplace.microsoft.com) 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)
+
+## FAQ
+
+For more details on how Rancher pay-as-you-go offerings work, refer to the [pay-as-you-go FAQ](../cloud-marketplace-payg-integration.md#faq).
+
+## Supported Versions
+
+- We currently recommend running Rancher v2.8.4. When you deploy a supported PAYG version, you can update to newer versions of Rancher when the listing is updated.
+
+## How to Use
+
+1. Complete the [prerequisite steps](prerequisites.md).
+2. [Install the Rancher Prime PAYG offering on the Azure Marketplace](installing-rancher-prime.md).
@@ -0,0 +1,9 @@
+---
+title: Common Issues for Rancher Prime PAYG on Azure
+---
+
+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](../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/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.