From 732c354b806b32e6cf8098c2f8726cdb6fdf42a7 Mon Sep 17 00:00:00 2001 From: Lucas Saintarbor Date: Tue, 16 Jan 2024 15:36:25 -0800 Subject: [PATCH] Apply suggestions for Azure section Co-authored-by: Marty Hernandez Avedon --- .../installing-rancher-prime.md | 32 +++++++++---------- .../troubleshooting.md | 14 ++++---- 2 files changed, 24 insertions(+), 22 deletions(-) diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md index 8f737cfc889..1cd7a9bad76 100644 --- a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md @@ -6,10 +6,10 @@ This page covers installing the Rancher Prime PAYG offering on Microsoft's Azure ## How to Install Rancher Prime PAYG -Refer to the following steps for creating a new deployment of Rancher Prime from the Azure Marketplace page. +The following steps describe how to create a new deployment of Rancher Prime from the [Azure Marketplace](https://azuremarketplace.microsoft.com) 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. Choose a plan from the dropdown menu. View the **Plans + Pricing** tab for more details about the plan. 1. Select **Create**. ### Basics @@ -18,8 +18,8 @@ On the **Basics** tab, specify the **Project details** and **Instance details**: ![Basics tab](/img/install-rancher-prime-basics.png) -1. Select an existing **Subscription** from the dropdown list. -1. Select an existing **Resource group** from the dropdown list. +1. Select an existing **Subscription** from the dropdown menu. +1. Select an existing **Resource group** from the dropdown menu. :::note @@ -29,8 +29,8 @@ On the **Basics** tab, specify the **Project details** and **Instance details**: ::: -1. Select an existing **AKS Cluster Name** from the dropdown list. -1. Choose an **Extension Resource name**. It can consist of alphanumeric characters and dots; the length must be between 2 and 253 characters. +1. Select an existing **AKS Cluster Name** from the dropdown menu. +1. Choose an **Extension Resource name**. It can consist of alphanumeric characters and dots and must be between 2 and 253 characters long. 1. Select **Next**. ### Rancher Configuration @@ -39,7 +39,7 @@ On the **Rancher Configuraion** tab, specify the following information: ![Rancher Configuration](/img/install-rancher-prime-bootstrap-password.png) -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. +1. Enter the **Hostname** for Rancher. The Rancher hostname 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. @@ -49,19 +49,19 @@ On the **Rancher Configuraion** tab, specify the following information: 1. Choose and confirm a **Bootstrap Password**. During the first login, you will use the bootstrap password to authenticate to the Rancher dashboard. :::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 the Azure Portal. Until this security issue is resolved, we suggest changing the Admin password after initial login, by editing your profile in the Rancher dashboard. ::: 1. Select **Next**. -### Review + create +### 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. ### Deployment Complete -After the deployment is completed, the Rancher Prime Kubernetes service extension is successfully installed. +When the deployment successfully completes, Rancher Prime will be installed. :::note @@ -71,21 +71,21 @@ On the **Extensions + applications** page, the **Provisioning State** may show * ## Log into the Rancher Dashboard -You may now login to Rancher dashboard by pointing your browser to the Rancher server URL `https://$RANCHER_HOSTNAME`, where $RANCHER_HOSTNAME is the [hostname](#rancher-configuration) you have chosen when configuring Rancher. +You may now log in to the Rancher dashboard by pointing your browser to the Rancher server URL `https://`. The `` is the hostname you entered when you [installed Rancher](#installing-rancher). :::note -The Rancher hostname must be resolvable by public DNS. Please refer to the [Prerequisites](prerequisites.md) section for more details. +The Rancher hostname must be resolvable by public DNS. See the [Prerequisites](prerequisites.md) for more details. ::: ## How to Use Rancher -After logging into Rancher Prime, you should notice the **Welcome to Rancher Prime** message at the top of the screen. +After you login to Rancher Prime, you should notice the **Welcome to Rancher Prime** message at the top of the screen. ![Rancher Prime Home](/img/install-rancher-prime-home.png) -If your Rancher Prime PAYG deployment only has **Welcome to Rancher** at the top of the screen, please ensure you've updated to the latest version, and reset the branding to default (i.e., "suse") from **Global Settings**. +If your Rancher Prime PAYG deployment only has **Welcome to Rancher** at the top of the screen, make sure that you've updated to the latest version, and reset the branding to default (i.e., "suse") from **Global Settings**. ![Global Settings](/img/install-rancher-prime-global-settings.png) @@ -95,10 +95,10 @@ View billing information in the Azure Portal by going to **Home** > **Cost Manag ## Uninstalling Rancher Prime PAYG Offering -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. :::important -Ensure you prepare and migrate any non-Rancher workloads off the cluster before destroying the cluster since these resources are not recoverable. +Ensure that you prepare and migrate any non-Rancher workloads off of the cluster before you destroy the cluster. These resources are nonrecoverable. ::: diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/troubleshooting.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/troubleshooting.md index 882193656c9..a9d21f35bd0 100644 --- a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/troubleshooting.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/troubleshooting.md @@ -6,12 +6,14 @@ This section contains information to help troubleshoot issues when installing th ## Deployment -After a successful deployment, check the status of the deployment, it should list similar pod and chart output. +After a successful deployment, check the status of the deployment. It should list similar pod and chart output as the example below. ```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 8h @@ -42,19 +44,19 @@ Check the status of pods or jobs: 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 a `Running` state, you can attempt to find the root cause with the following commands: - Describe pod: `kubectl describe pod $POD_NAME -n $NAMESPACE` - Pod container logs: `kubectl logs $POD_NAME -n $NAMESPACE` - Describe job: `kubectl describe job $JOB_NAME -n $NAMESPACE` - Logs from the containers of pods of the job: `kubectl logs -l job-name=$JOB_NAME -n $NAMESPACE` -## Rancher Usage Record Not found +## Rancher Usage Record Not Found When you attempt to retrieve 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: @@ -73,7 +75,7 @@ When you attempt to install an extension of the same type, you will see the foll Multiple extensions of same type is not allowed at this scope. (Code: ValidationFailed)" ``` -AKS cluster already has the extension with the same type. To resolve the error, uninstall the extension and re-deploy with the same cluster. +The AKS cluster already has the extension with the same type. To resolve the error, uninstall the extension and re-deploy to the same cluster. ## Resource Already Existing in your Cluster @@ -83,4 +85,4 @@ When you attempt to install a resource or extension that already exists, you wil 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"] ``` -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. +The 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 the Azure Console and re-deploy to the same cluster.