mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-25 04:28:15 +00:00
Add docs team feedback for AWS Marketplace PAYG section
This commit is contained in:
LucasSaintarbor
+6
-18
@@ -1,23 +1,11 @@
|
||||
---
|
||||
title: Common Issues
|
||||
title: AWS Marketplace Common Issues
|
||||
---
|
||||
|
||||
1. Uninstalling Rancher Prime:
|
||||
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.
|
||||
|
||||
```shell
|
||||
helm uninstall -n cattle-rancher-csp-deployer-system rancher-cloud
|
||||
```
|
||||
```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.
|
||||
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.
|
||||
|
||||
+5
-3
@@ -2,6 +2,8 @@
|
||||
title: Installing Rancher Prime on AWS
|
||||
---
|
||||
|
||||
This page covers installing Rancher...
|
||||
|
||||
## 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:
|
||||
@@ -20,10 +22,10 @@ title: Installing Rancher Prime on AWS
|
||||
|
||||
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 a public DNS. Please refer to the [Prerequisites](rancher-prime-aws.md#prerequisites) section for more details. For example, if the DNS name is rancher.my.org, HOST_NAME=rancher.my.org.
|
||||
|
||||
:::
|
||||
|
||||
The Rancher hostname must be resolvable by a public DNS. Please refer to the [Prerequisites](rancher-prime-aws.md#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 \
|
||||
@@ -72,7 +74,7 @@ title: Installing Rancher Prime on AWS
|
||||
|
||||
### Check Helm Chart Installation
|
||||
|
||||
To check if helm chart installation is completed, run following command:
|
||||
Check that the helm chart installation is completed:
|
||||
|
||||
```shell
|
||||
helm ls -n cattle-rancher-csp-deployer-system
|
||||
|
||||
+2
-2
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Rancher Prime in AWS
|
||||
title: Rancher Prime PAYG in AWS Marketplace
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
@@ -9,7 +9,7 @@ Before using Rancher Prime on AWS as a pay-as-you-go (PAYG) offering, you need t
|
||||
- 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.
|
||||
- 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`
|
||||
|
||||
+21
-45
@@ -4,60 +4,34 @@ title: Troubleshooting
|
||||
|
||||
This section contains information to help you troubleshoot issues when installing Rancher Prime PAYG.
|
||||
|
||||
Jobs and Pods:
|
||||
## Jobs and Pods
|
||||
|
||||
Check that pods or jobs have status Running/Completed
|
||||
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:
|
||||
|
||||
If a pod is not in Running state, you can debug into the root cause by running:
|
||||
- Describe pod: `kubectl describe pod <pod name> -n <namespaces>`
|
||||
- Pod container logs: `kubectl logs <pod name> -n <namespaces>`
|
||||
- Describe job: `kubectl describe job <job name> -n <namespaces>`
|
||||
- Logs from the containers of pods of the job: `kubectl logs -l job-name=<job name> -n <namespaces>`
|
||||
|
||||
Describe pod
|
||||
## Recovery from Failed Pods
|
||||
|
||||
If any of the pods aren't running, check the rancher-cloud Pod:
|
||||
|
||||
```
|
||||
kubectl describe pod <pod name> -n <namespaces>
|
||||
```
|
||||
|
||||
Pod container logs
|
||||
|
||||
|
||||
```
|
||||
kubectl logs <pod name> -n <namespaces>
|
||||
```
|
||||
|
||||
Describe job
|
||||
|
||||
|
||||
```
|
||||
kubectl describe job <job name> -n <namespaces>
|
||||
```
|
||||
|
||||
Logs from the containers of pods of the job
|
||||
|
||||
```
|
||||
kubectl logs -l job-name=<job name> -n <namespaces>
|
||||
```
|
||||
|
||||
###Recovery from Failed Pods
|
||||
|
||||
If any of the pods are not Running :
|
||||
|
||||
Check the rancher-cloud Pod
|
||||
|
||||
```
|
||||
```shell
|
||||
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.
|
||||
If the rancher-cloud pod is in an Error state, wait for the pod to be deleted. This should take about one minute.
|
||||
|
||||
Fix the problem and execute
|
||||
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}} \
|
||||
@@ -68,19 +42,21 @@ oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/suse/{{repository}}/rancher-c
|
||||
--set global.aws.roleName=$ROLE_NAME
|
||||
```
|
||||
|
||||
###Rancher Usage Record Not found:
|
||||
## 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
|
||||
```
|
||||
|
||||
Solution:
|
||||
To resolve the error, run:
|
||||
|
||||
```
|
||||
```shell
|
||||
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).
|
||||
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.
|
||||
|
||||
+4
-6
@@ -2,16 +2,14 @@
|
||||
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:
|
||||
|
||||
```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 \
|
||||
--version <upgraded_chart_version> \
|
||||
oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/suse/$REPOSITORY/rancher-cloud-helm/rancher-cloud \
|
||||
--version $UPGRADED_CHART_VERSION \
|
||||
--set rancherHostname=$HOST_NAME \
|
||||
--set rancherServerURL=https://$HOST_NAME \
|
||||
--set rancherReplicas=$REPLICAS \
|
||||
@@ -20,8 +18,8 @@ oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/suse/{{repository}}/rancher-c
|
||||
--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.
|
||||
To check if the upgraded Helm chart deployed successfully:
|
||||
|
||||
```
|
||||
```shell
|
||||
helm ls -n cattle-rancher-csp-deployer-system
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user