From d985128eebe7b8cb61f6a0d03a375680e176f4ff Mon Sep 17 00:00:00 2001 From: LucasSaintarbor Date: Tue, 28 Nov 2023 11:17:32 -0800 Subject: [PATCH] Draft Rancher PAYG offerings for AWS and Azure --- .../common-issues.md | 23 ++++ .../installing-rancher-prime.md | 86 +++++++++++++ .../rancher-prime-aws.md | 68 ++++++++++ .../troubleshooting.md | 88 +++++++++++++ .../upgrading-rancher-payg-cluster.md | 26 ++++ .../common-issues.md | 17 +++ .../installing-rancher-prime.md | 112 +++++++++++++++++ .../rancher-prime-azure.md | 19 +++ .../troubleshooting.md | 117 ++++++++++++++++++ .../upgrading-rancher-payg-cluster.md | 14 +++ .../aws-marketplace-payg-integration.md | 36 ++++++ .../azure-marketplace-payg-integration.md | 32 +++++ sidebars.js | 32 +++++ 13 files changed, 670 insertions(+) create mode 100644 docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues.md create mode 100644 docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md create mode 100644 docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/rancher-prime-aws.md create mode 100644 docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/troubleshooting.md create mode 100644 docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/upgrading-rancher-payg-cluster.md create mode 100644 docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/common-issues.md create mode 100644 docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md create mode 100644 docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/rancher-prime-azure.md create mode 100644 docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/troubleshooting.md create mode 100644 docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/upgrading-rancher-payg-cluster.md create mode 100644 docs/pages-for-subheaders/aws-marketplace-payg-integration.md create mode 100644 docs/pages-for-subheaders/azure-marketplace-payg-integration.md 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 new file mode 100644 index 00000000000..b3a84582593 --- /dev/null +++ b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues.md @@ -0,0 +1,23 @@ +--- +title: Common Issues +--- + +1. Uninstalling Rancher Prime: + + ```shell + helm uninstall -n cattle-rancher-csp-deployer-system rancher-cloud + ``` + + 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. + +2. 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), + 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 new file mode 100644 index 00000000000..a3c197a2e15 --- /dev/null +++ b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md @@ -0,0 +1,86 @@ +--- +title: Installing Rancher Prime on AWS +--- + +## Installing Rancher + +Log *helm* into the AWS Marketplace ECR to fetch the application. The AWS Marketplace ECR is always in the `us-east-1` region: + +``` +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 +``` + +Install Rancher into your cluster using *helm*. Customize your helm installation values if needed: + +**NOTE** + +Rancher Prime utilizes cert-manager to issue and maintain its certificates. Rancher will generate a CA certificate of its own, and sign a cert using that CA. + +The Rancher hostname must be resolvable by public DNS. Please refer to the [Prerequisites](#prerequisites) 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 \ +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 rancher-cloud pod logs as the rancher-cloud pod is deleted 1 minute after a successful or failed installation. + +```shell +kubectl logs -f -n cattle-rancher-csp-deployer-system +``` + +After a successful deployment, running the following command should produce a similar 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 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 +``` + +Refer to the Troubleshooting section for a failed installation. + +To check if helm chart installation is completed, run following command: + +```shell +helm ls -n cattle-rancher-csp-deployer-system +``` + +After the helm chart installation is complete, you can verify the installation. +Verify the status of the helm charts installation by running the following command: + +```shell +helm status rancher-cloud -n cattle-rancher-csp-deployer-system +``` + +### Helm Chart Installed Successfully + +After it is completed, the Rancher Prime is successfully installed. 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 new file mode 100644 index 00000000000..7931f9bcb9f --- /dev/null +++ b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/rancher-prime-aws.md @@ -0,0 +1,68 @@ +--- +title: Rancher Prime in AWS +--- + +## Prerequisites + +Before using Rancher Prime on AWS as a 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. +- 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. +- Installation requires you have the following tools available and properly configured to access your AWS account, and your EKS cluster: + - `aws` + - `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 new file mode 100644 index 00000000000..820de8cb018 --- /dev/null +++ b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/troubleshooting.md @@ -0,0 +1,88 @@ +--- +title: Troubleshooting +--- + +## Troubleshooting + +This section contains information to help you troubleshoot issues when installing Rancher Prime PAYG. + +Jobs and Pods: + +Check that pods or jobs have status Running/Completed + + +``` +kubectl get pods --all-namespaces +``` + + +If a pod is not in Running state, you can debug into the root cause by running: + +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 +``` + +###Recovery from Failed Pods + +If any of the pods are not Running : + +Check the rancher-cloud Pod + +``` +kubectl get pods --all-namespaces | grep rancher-cloud +``` + +If the rancher-cloud pod is in Error state, wait for the pod to be deleted which takes approx 1 min after it goes in Error State. + +Fix the problem and execute + +``` +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: + +Error: + +``` +Error from server (NotFound): cspadapterusagerecords.susecloud.net "rancher-usage-record" not found" + Check Configuration, Retrieve generated configuration csp-config +``` + +Solution: + +``` +kubectl get cm -n cattle-csp-billing-adapter-system csp-config -o yaml +``` + +if a configuration is not listed, you can debug into the root cause by checking the pod status and log (Refer Jobs and Pods section). \ No newline at end of file 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 new file mode 100644 index 00000000000..d3e12630f30 --- /dev/null +++ b/docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/upgrading-rancher-payg-cluster.md @@ -0,0 +1,26 @@ +--- +title: Upgrading Rancher PAYG Cluster +--- + +## Upgrading a Rancher Prime PAYG Cluster + +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. +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 + +``` +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 \ + --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 upgraded helm chart installation is deployed, run following command. It should display the upgraded chart version and REVISION incremented by 1 from previous install. + +``` +helm ls -n cattle-rancher-csp-deployer-system +``` \ No newline at end of file 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 new file mode 100644 index 00000000000..4f307449363 --- /dev/null +++ b/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/common-issues.md @@ -0,0 +1,17 @@ +--- +title: 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. + +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. 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 new file mode 100644 index 00000000000..55e85b3d4d3 --- /dev/null +++ b/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md @@ -0,0 +1,112 @@ +--- +title: Installing Rancher Prime on Azure +--- + +## How to install Rancher Prime PAYG + +The following is a step by step walk-through for creating a new deployment of +Rancher Prime from the Azure Marketplace page. + +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' + +### 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. + + --- + **NOTE** + + The **Create new** resource group feature is not supported. + + --- + +click '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. + + --- + **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. + + --- + **NOTE** + + 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' + +### Review + create + + + This will summarize the offer and link to "view automation template" (Azure Resource Manager Template) + + + Price + Basics + Rancher Configuration + +click 'Create' + +### Deployment Complete + +Deployment will be in progress. After it is completed, the Rancher Prime +Kubernetes service extension is successfully installed. + + --- + ** NOTE: ** + + 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. + + --- + +## 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. + + --- + **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 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 new file mode 100644 index 00000000000..887613cd569 --- /dev/null +++ b/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/rancher-prime-azure.md @@ -0,0 +1,19 @@ +--- +title: Rancher Prime in Azure +--- + +## Prerequisites + +- 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. +- 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. \ No newline at end of file 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 new file mode 100644 index 00000000000..1e777b5ac6c --- /dev/null +++ b/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/troubleshooting.md @@ -0,0 +1,117 @@ +--- +title: Troubleshooting +--- + +This section contains information to help you troubleshoot issues when install Rancher and configure Billing-adapter + +After successful deployment, it should list similar pod and chart output + +``` +kubectl get deployments --all-namespaces=true +``` + +``` +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 +cattle-fleet-local-system fleet-agent 1/1 1 1 8h +cattle-fleet-system fleet-controller 1/1 1 1 8h +cattle-fleet-system gitjob 1/1 1 1 8h +cattle-provisioning-capi-system capi-controller-manager 1/1 1 1 8h +cattle-system rancher 3/3 3 3 8h +cattle-system rancher-webhook 1/1 1 1 8h +cert-manager cert-manager 1/1 1 1 8h +cert-manager cert-manager-cainjector 1/1 1 1 8h +cert-manager cert-manager-webhook 1/1 1 1 8h +ingress-nginx ingress-nginx-controller 1/1 1 1 9h +kube-system coredns 2/2 2 2 20h +kube-system coredns-autoscaler 1/1 1 1 20h +kube-system extension-agent 1/1 1 1 8h +kube-system extension-operator 1/1 1 1 8h +kube-system konnectivity-agent 2/2 2 2 20h +kube-system metrics-server 2/2 2 2 20h +``` + + +Jobs and Pods: + +Check that pods or jobs have status Running/Completed + + +``` +kubectl get pods --all-namespaces +``` + + +if a pod is not in Running state, you can dig into the root cause by running: + +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: + +Error: + +``` +Error from server (NotFound): cspadapterusagerecords.susecloud.net "rancher-usage-record" not found" + Check Configuration, Retrieve generated configuration csp-config +``` + + +Solution: + +``` +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). + + +###Multiple extensions of same type: + +Error: + +``` +Multiple extensions of same type is not allowed at this scope. (Code: ValidationFailed)" +``` + +Solution: + +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: + +Error: + +``` +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 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 new file mode 100644 index 00000000000..eeb818170b3 --- /dev/null +++ b/docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/upgrading-rancher-payg-cluster.md @@ -0,0 +1,14 @@ +--- +title: Upgrading Rancher PAYG Cluster +--- + +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. + +Execute the following command in Cluster Cloud 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 new file mode 100644 index 00000000000..d0882f881f9 --- /dev/null +++ b/docs/pages-for-subheaders/aws-marketplace-payg-integration.md @@ -0,0 +1,36 @@ +--- +title: AWS Marketplace Pay-as-you-go (PAYG) Integration +--- + + + + + +## Overview + +Rancher integrates with AWS Marketplace as a Pay-as-you-go 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. + +## 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). + +## 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 new file mode 100644 index 00000000000..67f849ea7f6 --- /dev/null +++ b/docs/pages-for-subheaders/azure-marketplace-payg-integration.md @@ -0,0 +1,32 @@ +--- +title: Azure Marketplace Pay-as-you-go (PAYG) Integration +--- + +## Overview + +Rancher integrates with Azure Marketplace as a Pay-as-you-go 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). + +## 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 ce3687e759b..9cb4f143494 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1148,6 +1148,38 @@ const sidebars = { 'integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/common-issues' ] }, + { + type: 'category', + label: 'AWS Marketplace PAYG Integration', + link: { + type: 'doc', + id: "pages-for-subheaders/aws-marketplace-payg-integration" + }, + items: [ + 'integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/rancher-prime-aws', + 'integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime', + 'integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/upgrading-rancher-payg-cluster', + 'integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/troubleshooting', + 'integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues' + + ] + }, + { + type: 'category', + label: 'Azure Marketplace PAYG Integration', + link: { + type: 'doc', + id: "pages-for-subheaders/azure-marketplace-payg-integration" + }, + items: [ + 'integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/rancher-prime-azure', + 'integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime', + 'integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/upgrading-rancher-payg-cluster', + 'integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/troubleshooting', + 'integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/common-issues' + + ] + }, 'integrations-in-rancher/cloud-marketplace/supportconfig' ] },