public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-25 12:38:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated to style/grammar

Browse Source
This commit is contained in:
LucasSaintarbor
2023-11-29 14:15:20 -08:00
parent 4748bbf5a5
commit 65142d5228
7 changed files with 77 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md
+58 -55
View File
@@ -4,69 +4,73 @@ 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:
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:
```
export HELM_EXPERIMENTAL_OCI=1
```shell
export HELM_EXPERIMENTAL_OCI=1
aws --region us-east-1 ecr get-login-password \
| helm registry login --username AWS \
--password-stdin 709825985650.dkr.ecr.us-east-1.amazonaws.com
```
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:
1. Install Rancher into your cluster using `helm`. Customize your `helm` installation values if needed:
**NOTE**
:::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.
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
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 \
--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
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
```
```shell
kubectl logs -f <pod> -n cattle-rancher-csp-deployer-system
```
:::note
After a successful deployment, running the following command should produce a similar output.
Monitor the rancher-cloud pod logs as the rancher-cloud pod is deleted 1 minute after a successful or failed installation.
```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
```
```shell
kubectl logs -f <pod> -n cattle-rancher-csp-deployer-system
```
Refer to the <a>Troubleshooting</a> section for a failed installation.
1. 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
```
### Check Helm Chart Installation
To check if helm chart installation is completed, run following command:
@@ -74,13 +78,12 @@ To check if helm chart installation is completed, run following command:
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:
After completing the helm chart installation, you can verify the installation was successful:
```shell
```shell
helm status rancher-cloud -n cattle-rancher-csp-deployer-system
```
### Helm Chart Installed Successfully
Refer to the [Troubleshooting](troubleshooting.md) section for a failed installation.
After it is completed, the Rancher Prime is successfully installed.
After the helm chart installation is completed, Rancher Prime is successfully installed.
docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/rancher-prime-aws.md
+8 -18
View File
@@ -4,26 +4,17 @@ title: Rancher Prime in AWS
## Prerequisites
Before using Rancher Prime on AWS as a PAYG offering, you need the following resources, information, and tools:
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.
- 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.
- 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`
- `eksctl`
- `helm` (v3 or greater)
- `aws`
- `curl`
- `eksctl`
- `helm` (v3 or greater)
## Preparing your cluster
@@ -65,4 +56,3 @@ eksctl create iamserviceaccount \
--attach-policy-arn 'arn:aws:iam::aws:policy/AWSMarketplaceMeteringFullAccess' \
--approve
```
docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/troubleshooting.md
-2
View File
@@ -2,8 +2,6 @@
title: Troubleshooting
---
## Troubleshooting
This section contains information to help you troubleshoot issues when installing Rancher Prime PAYG.
Jobs and Pods:
docs/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/upgrading-rancher-payg-cluster.md
+4 -3
View File
@@ -5,9 +5,10 @@ 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
```
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> \
@@ -23,4 +24,4 @@ To check if upgraded helm chart installation is deployed, run following command.
```
helm ls -n cattle-rancher-csp-deployer-system
```
```
docs/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/rancher-prime-azure.md
+5 -13
View File
@@ -4,16 +4,8 @@ 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&regions=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.
Before using Rancher Prime on Azure as a 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&regions=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.
docs/pages-for-subheaders/aws-marketplace-payg-integration.md
+1 -1
View File
@@ -8,7 +8,7 @@ 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.
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.
## Limitations
docs/pages-for-subheaders/azure-marketplace-payg-integration.md
+1 -1
View File
@@ -4,7 +4,7 @@ title: Azure Marketplace Pay-as-you-go (PAYG) Integration
## Overview
Rancher integrates with Azure Marketplace as a Pay-as-you-go offering.
Rancher integrates with Azure Marketplace as a pay-as-you-go (PAYG) offering.
## Limitations