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 c3348192ce0..e4e3f28674b 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 @@ -8,4 +8,4 @@ title: AWS Marketplace Common Issues 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 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. 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 bd73a63c2f7..55b9d756f5c 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 @@ -1,8 +1,49 @@ --- -title: Installing Rancher Prime on AWS +title: Installing Rancher Prime PAYG on AWS --- -This page covers installing Rancher... +This page covers how to install the Rancher Prime PAYG offering on Amazon's AWS Marketplace. + +## Preparing your cluster + +### 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: + +```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. + +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 +``` + +If there is no output, you will need to create an OIDC provider: + +```shell +eksctl utils associate-iam-oidc-provider --cluster $CLUSTER_NAME --region $REGION --approve +``` + +### 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. + +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 \ + --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 @@ -89,3 +130,13 @@ 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. + +## Log into the Rancher Dashboard + +You may now login to Rancher dashboard by pointing your browser to the Rancher server URL **https://**, where **Rancher hostname** is the [hostname](#rancher-configuration) you have chosen. + +:::note + +The Rancher hostname must be resolvable by public DNS. Please refer to the [Prerequisites](rancher-prime-aws.md#prerequisites) section for more details. + +::: diff --git a/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/rancher-prime-aws.md b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/rancher-prime-aws.md index 26f97589017..54c19783ea8 100644 --- a/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/rancher-prime-aws.md +++ b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/rancher-prime-aws.md @@ -1,12 +1,10 @@ --- -title: Rancher Prime PAYG in AWS Marketplace +title: Prerequisites --- -## 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 [Rancher support matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/) for more details. Please see [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 which is covered in the later section of this document. +- 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-INGINX on 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. @@ -15,44 +13,3 @@ Before using Rancher Prime on AWS as a pay-as-you-go (PAYG) offering, you need t - `curl` - `eksctl` - `helm` (v3 or greater) - -## Preparing your cluster - -### 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: - -```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. - -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 -``` - -If there is no output, you will need to create an OIDC provider: - -```shell -eksctl utils associate-iam-oidc-provider --cluster $CLUSTER_NAME --region $REGION --approve -``` - -### 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. - -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 \ - --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 -``` 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 cd9630e0954..b5dbe2ac9c7 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 @@ -1,5 +1,5 @@ --- -title: Troubleshooting +title: Troubleshooting Rancher Prime PAYG Cluster in AWS --- This section contains information to help you troubleshoot issues when installing Rancher Prime PAYG. @@ -44,13 +44,10 @@ oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/suse/{{repository}}/rancher-c ## Rancher Usage Record Not found -Error: - When you attempt to retrive 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: 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 8e0d2ff9825..d7e672223a8 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 @@ -1,10 +1,10 @@ --- -title: Upgrading Rancher PAYG Cluster +title: Upgrading Rancher Prime PAYG Cluster in AWS --- -The marketplace PAYG offer is tied to a billing adapter AND Rancher Prime version. These are updated periodically as new version of the billing adapter or Rancher are released. +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 that case the helm chart will be updated with new tags and digests and new version of helm chart will be uploaded. In order to upgrade the deployed helm chart with new version, execute the following helm command: +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: ```shell helm upgrade -n cattle-rancher-csp-deployer-system rancher-cloud --create-namespace \ diff --git a/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/common-issues.md b/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/common-issues.md index 4f307449363..86543ed301a 100644 --- a/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/common-issues.md +++ b/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/common-issues.md @@ -1,17 +1,7 @@ --- -title: Common Issues +title: Azure Marketplace Common Issues --- -1. When migrating Rancher to a different AKS 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 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. +1. When migrating Rancher to a different AKS 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 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. Uninstalling Rancher Prime may not cleanly remove all the resources that were - created by Rancher. Users are encouraged to use - [Rancher 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. 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. diff --git a/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md b/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md index 55e85b3d4d3..e6d7a9d3e41 100644 --- a/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md +++ b/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md @@ -1,112 +1,81 @@ --- -title: Installing Rancher Prime on Azure +title: Installing Rancher Prime PAYG on Azure --- -## How to install Rancher Prime PAYG +This page covers how to install the Rancher Prime PAYG offering on Microsoft's Azure Marketplace. -The following is a step by step walk-through for creating a new deployment of -Rancher Prime from the Azure Marketplace page. +## How to Install Rancher Prime PAYG -1. Click "Rancher Prime with 24x7 Support" offer (either "EU and UK only" or - "non-EU and non-UK only") that corresponds to the location where your account - is registered. -2. Choose the plan from the dropdown list. ( "Plans + Pricing" tab more details about Software plan) -3. Click 'Create' +Refer to the following steps for creating a new deployment of Rancher Prime from the Azure Marketplace page. + +1. Select the **Rancher Prime with 24x7 Support** offer (either **EU and UK only** or **non-EU and non-UK only**) that corresponds to the location where your account is registered. +1. Choose the plan from the dropdown list. View the **Plans + Pricing** tab for more details about the plan. +1. Select **Create**. ### Basics -1. Select existing subscription from the dropdown list. -2. Select existing Resource group from the dropdown list. -3. Select existing AKS Cluster Name from the dropdown list. -4. Choose name for Cluster extension resource name. It can be consisted of - alphanumeric and dots, and the length must be between 2 and 253 characters. +On the **Basics** tab, specify the **Project details** and **Instance details**: - --- - **NOTE** +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. - --- - -click 'Next' + ::: + ![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 **Next**. ### Rancher Configuration -1. Enter the hostname for Rancher, and it must be a fully qualified domain - name (FQDN). The Rancher server URL will be created using this hostname. +On the **Rancher Configuraion** tab, specify the following informaiton: - --- - **NOTE** +1. Enter the **Hostname** for Rancher. The Rancher hostname must be a fully qualified domain name (FQDN) and the Rancher server URL will be created using this hostname. + + :::note The IP address of the Rancher hostname must be resolvable by a public DNS. - --- + ::: -2. Using the slide bar, select the number of Rancher replicas. -3. Choose bootstrap password as it is suggested by the tip. The bootstrap - password will be used to authenticate to the Rancher dashboard during first - login. +1. Using the slide bar, select the number of **Replicas**. +1. Choose and confirm a **Bootstrap Password**. During the first login, you will use the bootstrap password to authenticate to the Rancher dashboard. + :::note - --- - **NOTE** + The current Rancher deployment exposes the bootstrap password in the Cluster configuration settings in Azure Portal. Until this is resolved, we suggest changing the Admin password after initial login by editing your profile in the Rancher dashboard. - The current Rancher deployment exposes the bootstrap password in the Cluster - configuration settings in Azure Portal. Until this is resolved, it is - suggested to change the Admin password after the initial login. Edit profile - in the Rancher dashboard to change password. - - --- - -click 'Next' + ::: + ![Rancher Confgiuration](/img/install-rancher-prime-configuration.png) +1. Select **Next**. ### Review + create +1. On the **Review + create** tab, review the summary of the offer (Price, Basics, Rancher Configuration) and the link to **view automation template** (Azure Resource Manager Template). +1. Select **Create** to start the deployment. - This will summarize the offer and link to "view automation template" (Azure Resource Manager Template) +### Deployment Complete +After the deployment is completed, the Rancher Prime Kubernetes service extension is successfully installed. - Price - Basics - Rancher Configuration +:::note -click 'Create' +On the **Extensions + applications** page, the **Provisioning State** may show **Succeeded** even though the deployment may still be in progress. You can monitor the deployment progress by logging into the AKS cluster and looking at the **rancher-cloud** deployment. -### Deployment Complete +::: -Deployment will be in progress. After it is completed, the Rancher Prime -Kubernetes service extension is successfully installed. +## Log into the Rancher Dashboard - --- - ** NOTE: ** +You may now login to Rancher dashboard by pointing your browser to the Rancher server URL **https://**, where **Rancher hostname** is the [hostname](#rancher-configuration) you have chosen. - In the "Extensions + applications" page, the "Provisioning State" may show - "Succeeded" even though the provision may still be in progress. You may monitor - the actual progragress by logging into the AKS cluster and follow the - "rancher-cloud" deployment. +:::note - --- +The Rancher hostname must be resolvable by public DNS. Please refer to the [Prerequisites](rancher-prime-azure.md#prerequisites) section for more details. -## Log into the Rancher dashboard +::: -You may now login to Rancher dashboard by point your browser to Rancher server -URL **https://**, where **Rancher hostname** is the hostname -you have chosen previously. +## Rancher Prime PAYG Billing - --- - **NOTE** - - The Rancher hostname must be resolvable by public DNS. Please refer to the - [Prerequisites](#prerequisites) section for more details. - - --- - -## How To Use Rancher - -Please refer to the [Rancher documentation](https://ranchermanager.docs.rancher.com/) -on how to use Rancher. - -## Rancher Prime PAYG billing - -Billing will be available in the Azure Portal billing - -Home > Cost Management | Cost analysis \ No newline at end of file +View billing information in the Azure Portal by going to **Home** > **Subscriptions** > **Cost Management - Cost analysis**. diff --git a/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/rancher-prime-azure.md b/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/rancher-prime-azure.md index c687a882f42..fbf650e4c31 100644 --- a/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/rancher-prime-azure.md +++ b/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/rancher-prime-azure.md @@ -1,11 +1,11 @@ --- -title: Rancher Prime in Azure +title: Prerequisites --- ## Prerequisites -Before using Rancher Prime on Azure as a PAYG offering, you need the following resources, information, and tools: +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 [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 Azure Kubernetes service 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®ions=all) for details. Please see [Creating an AKS cluster](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks#3-create-the-aks-cluster) for bringing up an AKS cluster to install Rancher Prime PAYG which is covered in the later section of this document. +- 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®ions=all) for details. Please see [Creating an AKS cluster](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks#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](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks#5-install-an-ingress) for instructions on how to deploy Ingress-INGINX 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](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks#7-set-up-dns) for instructions on how to setup DNS. 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 1e777b5ac6c..2c73e2462be 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 @@ -1,16 +1,18 @@ --- -title: Troubleshooting +title: Troubleshooting Rancher Prime PAYG Cluster in Azure --- -This section contains information to help you troubleshoot issues when install Rancher and configure Billing-adapter +This section contains information to help you troubleshoot issues when installing Rancher Prime PAYG and configuring the Billing-adapter. -After successful deployment, it should list similar pod and chart output +## Deployment -``` +After a successful deployment, check the status of the deployment, it should list similar pod and chart output. + +```shell kubectl get deployments --all-namespaces=true ``` -``` +```shell NAMESPACE NAME READY UP-TO-DATE AVAILABLE AGE cattle-csp-billing-adapter-system csp-rancher-usage-operator 1/1 1 1 8h cattle-csp-billing-adapter-system rancher-csp-billing-adapter 1/1 1 1 8h @@ -32,86 +34,53 @@ kube-system konnectivity-agent 2/2 2 kube-system metrics-server 2/2 2 2 20h ``` +## Jobs and Pods -Jobs and Pods: +Check the status of pods or jobs: -Check that pods or jobs have status Running/Completed - - -``` +```shell 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 dig into the root cause by running: - -Describe pod +- Describe pod: `kubectl describe pod -n ` +- Pod container logs: `kubectl logs -n ` +- Describe job: `kubectl describe job -n ` +- Logs from the containers of pods of the job: `kubectl logs -l job-name= -n ` +## Rancher Usage Record Not found -``` -kubectl describe pod -n +When you attempt to retrive 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 ``` -Pod container logs +To resolve the error, run: - -``` -kubectl logs -n -``` - -Describe job - - -``` -kubectl describe job -n -``` - -Logs from the containers of pods of the job - -``` -kubectl logs -l job-name= -n -``` - - -###Rancher Usage Record Not found: - -Error: - -``` -Error from server (NotFound): cspadapterusagerecords.susecloud.net "rancher-usage-record" not found" - Check Configuration, Retrieve generated configuration csp-config -``` - - -Solution: - -``` +```shell kubectl get cm -n cattle-csp-billing-adapter-system csp-config -o yaml ``` -if a configuration is not listed, you can dig into the root cause by checking the pod status and log (Refer Jobs and Pods section). +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 same type: +When you attept to install an extension of the same type, you will see the following message: -Error: - -``` +```shell Multiple extensions of same type is not allowed at this scope. (Code: ValidationFailed)" ``` -Solution: +AKS cluster already has the extension with the same type. To resolve the error, uninstall the extension and re-deploy with the same cluster. -AKS cluster already has the extension with the same type. 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: -Error: - -``` +```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 -n : 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"] ``` -Solution: - -AKS cluster already has the extension. Uninstall the extension as it suggested in the Error by deleting the resource via the kubectl command. or Uninstall the extension in Azure Console and re-deploy with the same cluster. \ No newline at end of file +AKS cluster already has the extension installed. To resolve the error, uninstall the extension as suggested in the error message by deleting the resource via the kubectl command, or uninstall the extension in Azure Console and re-deploy with the same cluster. diff --git a/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/upgrading-rancher-payg-cluster.md b/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/upgrading-rancher-payg-cluster.md index eeb818170b3..6150bc87ca7 100644 --- a/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/upgrading-rancher-payg-cluster.md +++ b/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/upgrading-rancher-payg-cluster.md @@ -1,14 +1,13 @@ --- -title: Upgrading Rancher PAYG Cluster +title: Upgrading Rancher Prime PAYG Cluster in Azure --- -The Azure marketplace PAYG offer is periodically updated as a new version of -Rancher Prime are released, and for optimizations in the integration with Azure. -To update the latest version of the Rancher Prime PAYG offering supported in -the marketplace listing, use the "az k8s-extension update" command. +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. -Execute the following command in Cluster Cloud Shell: +To update to the latest version of the Rancher Prime PAYG offering supported in the marketplace listing, use the `az k8s-extension update` command. -``` +Run the following command in Cluster Cloud Shell: + +```shell az k8s-extension update --name --cluster-name --resource-group --cluster-type managedClusters --version -``` \ No newline at end of file +``` diff --git a/docs/pages-for-subheaders/aws-marketplace-payg-integration.md b/docs/pages-for-subheaders/aws-marketplace-payg-integration.md index cc32bca945c..15a7022c1df 100644 --- a/docs/pages-for-subheaders/aws-marketplace-payg-integration.md +++ b/docs/pages-for-subheaders/aws-marketplace-payg-integration.md @@ -8,29 +8,13 @@ title: AWS Marketplace Pay-as-you-go (PAYG) Integration ## Overview -Rancher integrates with AWS Marketplace as a pay-as-you-go (PAYG) offering. This will be in addition to the existing [AWS License integration](https://ranchermanager.docs.rancher.com/pages-for-subheaders/aws-cloud-marketplace) which is currently available. Customers will need information about their options and the features and limitations of the PAYG offerings. +Rancher Prime integrates with the AWS Marketplace as a pay-as-you-go (PAYG) offering. ## Limitations -- You must be running Rancher v2.6.7 or higher -- Rancher must be deployed with additional metrics enabled. -- Rancher must be installed on an EKS cluster. -- You must purchase at least one entitlement to Rancher support through AWS Marketplace. -- You may need additional setup to support proxy/airgap use cases. See the [prerequisites](../integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/adapter-requirements.md) for more information. - ## How to Use -1. Complete the [prerequisite steps](../integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/adapter-requirements.md). -2. [Install the CSP Adapter](../integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md). +1. Complete the [prerequisite steps](../integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/rancher-prime-aws.md). +2. [Install the Rancher Prime PAYG offering in the Azure Marketplace](../integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md). ## FAQ - -**Can I purchase support for more nodes later on?** - -Yes. Simply go to the AWS Marketplace entry that you used to initially purchase support and increase the number of entitlements. - -**Can I use multiple instances of Rancher in the same AWS account?** - -Yes. However, each cluster that Rancher is installed in will need to adhere to the prerequisites. - -In addition, keep in mind that a given entitlement can only be used by one Rancher management server at a time. \ No newline at end of file diff --git a/docs/pages-for-subheaders/azure-marketplace-payg-integration.md b/docs/pages-for-subheaders/azure-marketplace-payg-integration.md index 19d9595eb02..790a964aa2d 100644 --- a/docs/pages-for-subheaders/azure-marketplace-payg-integration.md +++ b/docs/pages-for-subheaders/azure-marketplace-payg-integration.md @@ -4,29 +4,13 @@ title: Azure Marketplace Pay-as-you-go (PAYG) Integration ## Overview -Rancher integrates with Azure Marketplace as a pay-as-you-go (PAYG) offering. +Rancher Prime integrates with the Azure Marketplace as a pay-as-you-go (PAYG) offering. ## Limitations -- You must be running Rancher v2.6.7 or higher -- Rancher must be deployed with additional metrics enabled. -- Rancher must be installed on an EKS cluster. -- You must purchase at least one entitlement to Rancher support through AWS Marketplace. -- You may need additional setup to support proxy/airgap use cases. See the [prerequisites](../integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/adapter-requirements.md) for more information. - ## How to Use -1. Complete the [prerequisite steps](../integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/adapter-requirements.md). -2. [Install the CSP Adapter](../integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md). +1. Complete the [prerequisite steps](../integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/rancher-prime-azure.md). +2. [Install the Rancher Prime PAYG offering in the Azure Marketplace](../integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md). ## FAQ - -**Can I purchase support for more nodes later on?** - -Yes. Simply go to the AWS Marketplace entry that you used to initially purchase support and increase the number of entitlements. - -**Can I use multiple instances of Rancher in the same AWS account?** - -Yes. However, each cluster that Rancher is installed in will need to adhere to the prerequisites. - -In addition, keep in mind that a given entitlement can only be used by one Rancher management server at a time. diff --git a/sidebars.js b/sidebars.js index 9cb4f143494..8bbfae54523 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1150,7 +1150,7 @@ const sidebars = { }, { type: 'category', - label: 'AWS Marketplace PAYG Integration', + label: 'AWS Marketplace Pay-as-you-go (PAYG)', link: { type: 'doc', id: "pages-for-subheaders/aws-marketplace-payg-integration" @@ -1166,7 +1166,7 @@ const sidebars = { }, { type: 'category', - label: 'Azure Marketplace PAYG Integration', + label: 'Azure Marketplace Pay-as-you-go (PAYG)', link: { type: 'doc', id: "pages-for-subheaders/azure-marketplace-payg-integration" diff --git a/static/img/install-rancher-prime-basics-create-new.png b/static/img/install-rancher-prime-basics-create-new.png new file mode 100644 index 00000000000..38e2ca329f3 Binary files /dev/null and b/static/img/install-rancher-prime-basics-create-new.png differ diff --git a/static/img/install-rancher-prime-basics.png b/static/img/install-rancher-prime-basics.png new file mode 100644 index 00000000000..2186b15a9d7 Binary files /dev/null and b/static/img/install-rancher-prime-basics.png differ diff --git a/static/img/install-rancher-prime-configuration.png b/static/img/install-rancher-prime-configuration.png new file mode 100644 index 00000000000..d4fee301354 Binary files /dev/null and b/static/img/install-rancher-prime-configuration.png differ