public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-04-30 02:03:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions for AWS section

Browse Source 
Co-authored-by: Marty Hernandez Avedon <marty.avedon@suse.com>
This commit is contained in:
Lucas Saintarbor
2024-01-16 15:29:33 -08:00
committed by GitHub
parent 084803bd4e
commit be0e4450e7
5 changed files with 44 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues.md
+1 -1
View File
@@ -3,4 +3,4 @@ title: AWS Marketplace Common Issues
---
### Migrating Rancher to a different EKS Cluster
When migrating Rancher to a different EKS cluster by following the steps specified in [Rancher Backups and Disaster Recovery](../../../pages-for-subheaders/backup-restore-and-disaster-recovery.md), you must reinstall Rancher Prime on the target EKS cluster after restoring from the backup. Furthermore, the restored Rancher version must not be newer than the version available in the AWS marketplace.
When you migrate Rancher to a different EKS cluster by following the steps in [Rancher Backups and Disaster Recovery](../../../pages-for-subheaders/backup-restore-and-disaster-recovery.md), you must reinstall Rancher Prime on the target EKS cluster after restoring from the backup. Furthermore, the restored Rancher version must not be newer than the version available in the AWS marketplace.
versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md
+32 -30
View File
@@ -8,39 +8,39 @@ This page covers installing the Rancher Prime PAYG offering on Amazon's AWS Mark
### OIDC provider
Your EKS cluster requires an OIDC provider to be installed. To check for 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:
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
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://` (e.g. `oidc.eks.region.amazonaws.com/id/1234567890ABCDEF`) will be referred to in later instructions as the OIDC Provider Identity. The final section of the URL, `1234567890ABCDEF`, is the `$OIDC_ID`.
This should return an 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.
Using the `$OIDC_ID` of the issuer found above, you can check if a provider is installed with the following command:
Use the OIDC ID to check if the EKS cluster has a provider:
```shell
aws iam list-open-id-connect-providers | grep $OIDC_ID
aws iam list-open-id-connect-providers | grep <oidc-id>
```
If there is no output, you will need to create an OIDC provider:
If the last command produces no output, create an OIDC provider:
```shell
eksctl utils associate-iam-oidc-provider --cluster $CLUSTER_NAME --region $REGION --approve
eksctl utils associate-iam-oidc-provider --cluster <cluster-name> --region <region> --approve
```
### IAM Role
An IAM role and an attached policy are required to provide the necessary permissions. The role name is passed as an argument during the Helm deployment.
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 the required policy attached to it:
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 \
--cluster <cluster-name> \
--region <region> \
--role-name <role-name> --role-only \
--attach-policy-arn 'arn:aws:iam::aws:policy/AWSMarketplaceMeteringFullAccess' \
--approve
```
@@ -57,32 +57,32 @@ eksctl create iamserviceaccount \
--password-stdin 709825985650.dkr.ecr.us-east-1.amazonaws.com
```
1. Install Rancher into your cluster using Helm. Customize your Helm installation values if needed:
1. Install Rancher with 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 certificate using that CA.
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, please refer to the [Prerequisites](prerequisites.md) section. For example, if the DNS name is `rancher.my.org`, then replace `$HOST_NAME` with `rancher.my.org` when running the `helm install` command.
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 \
--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
--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 1 minute after a successful or failed installation.
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
@@ -90,12 +90,14 @@ eksctl create iamserviceaccount \
:::
1. After a successful deployment, running the following command should produce a similar output:
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
@@ -115,25 +117,25 @@ eksctl create iamserviceaccount \
### Check Helm Chart Installation
Check that the Helm chart installation is complete:
1. Check that the Helm chart installation completed:
```shell
helm ls -n cattle-rancher-csp-deployer-system
```
After completing the Helm chart installation, you can verify the installation was successful:
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 for a failed installation.
Refer to the [Troubleshooting](troubleshooting.md) section if installation fails.
After the Helm chart installation is complete, Rancher Prime is successfully installed.
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://$RANCHER_HOSTNAME`, where`$RANCHER_HOSTNAME` is the hostname chosen when [installing Rancher](#installing-rancher).
You may now log in to the Rancher dashboard by pointing your browser to the Rancher server URL `https://<host-name>`. The `<host-name>` is the hostname you entered when you [installed Rancher](#installing-rancher).
:::note
@@ -149,7 +151,7 @@ Run the following command to uninstall Rancher Prime:
helm uninstall -n cattle-rancher-csp-deployer-system rancher-cloud
```
Uninstalling Rancher Prime may not cleanly remove all Kubernetes resources that Rancher created. You can use the [Rancher resource cleanup script](https://github.com/rancher/rancher-cleanup) to perform a more comprehensive cleanup.
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.
versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/prerequisites.md
+7 -8
View File
@@ -5,11 +5,10 @@ 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, please see the [Rancher support matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/). Please 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 is installed on the EKS cluster so that Rancher is accessible outside the cluster. Please refer to [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.
- Get the Load Balancer IP. Please refer to [Rancher documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md#6-get-load-balancer-ip) and save the EXTERNAL-IP.
- 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](../../../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 is set up to point to the EXTERNAL-IP saved.
- Installation requires you to have the following tools available and properly configured to access your AWS account and your EKS cluster:
- [`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)
- An ingress on the EKS cluster, so that Rancher is accessible from outside the cluster. See the [Rancher documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md#5-install-an-ingress) for instructions on deploying Ingress-NGINX on an EKS cluster.
- The Load Balancer IP address. See the [Rancher documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md#6-get-load-balancer-ip) and save the `EXTERNAL-IP`.
- 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).
versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/troubleshooting.md
+1 -1
View File
@@ -42,7 +42,7 @@ oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/suse/$REPOSITORY/rancher-clou
--set global.aws.roleName=$ROLE_NAME
```
## Rancher Usage Record Not found
## Rancher Usage Record Not Found
When you attempt to retrieve a usage record, you might see the following message:
versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/upgrading-rancher-payg-cluster.md
+3 -3
View File
@@ -2,9 +2,9 @@
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. 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.
The AWS Marketplace PAYG offering is tied to a billing adapter and the Rancher Prime version. These are periodically updated as new versions of the billing adapter or Rancher Prime are released. When this happens, the Helm chart is updated with new tags and digests, and a new version of the Helm chart is uploaded.
To upgrade the deployed Helm chart with the latest version, run the following Helm command:
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 \
@@ -26,6 +26,6 @@ helm ls -n cattle-rancher-csp-deployer-system
:::warning
Rancher Prime PAYG customers will have constraints on getting updates to the offering based on the latest version SUSE has published to AWS, which may trail slightly behind the latest Rancher release.
Rancher Prime PAYG customers have constraints on getting updates, based on the latest version SUSE has published to AWS. The latest available Rancher Prime version may trail slightly behind the latest Rancher release.
:::