From 106e84d3c0f25ccdce1a059b6f5389ff0c2d4a09 Mon Sep 17 00:00:00 2001 From: Jennifer Travinski Date: Fri, 8 Jul 2022 10:07:12 -0400 Subject: [PATCH] Updating notes in Docu format --- .../creating-apps/creating-apps.md | 18 ++++++++-- .../install-rancher-on-k8s.md | 36 +++++++++++++++---- 2 files changed, 45 insertions(+), 9 deletions(-) diff --git a/docs/en/helm-charts/creating-apps/creating-apps.md b/docs/en/helm-charts/creating-apps/creating-apps.md index b4376f81ef7..1b4bf548ece 100644 --- a/docs/en/helm-charts/creating-apps/creating-apps.md +++ b/docs/en/helm-charts/creating-apps/creating-apps.md @@ -5,7 +5,11 @@ weight: 400 Rancher's App Marketplace is based on Helm Repositories and Helm Charts. You can add HTTP based standard Helm Repositories as well as any Git Repository which contains charts. -> For a complete walkthrough of developing charts, see the [Chart Template Developer's Guide](https://helm.sh/docs/chart_template_guide/) in the official Helm documentation. +:::tip + +For a complete walkthrough of developing charts, see the [Chart Template Developer's Guide](https://helm.sh/docs/chart_template_guide/) in the official Helm documentation. + +::: - [Chart types](#chart-types) - [Helm charts](#helm-charts) @@ -94,7 +98,11 @@ Inside the `questions.yml`, most of the content will be around the questions to For each chart, you can add the minimum and/or maximum Rancher version, which determines whether or not this chart is available to be deployed from Rancher. -> **Note:** Even though Rancher release versions are prefixed with a `v`, there is *no* prefix for the release version when using this option. +:::note + +Even though Rancher release versions are prefixed with a `v`, there is *no* prefix for the release version when using this option. + +::: ``` rancher_min_version: 2.3.0 @@ -125,4 +133,8 @@ This reference contains variables that you can use in `questions.yml` nested und | show_if | string | false | Show current variable if conditional variable is true. For example `show_if: "serviceType=Nodeport"` | | show\_subquestion_if | string | false | Show subquestions if is true or equal to one of the options. for example `show_subquestion_if: "true"`| ->**Note:** `subquestions[]` cannot contain `subquestions` or `show_subquestions_if` keys, but all other keys in the above table are supported. +:::note + +`subquestions[]` cannot contain `subquestions` or `show_subquestions_if` keys, but all other keys in the above table are supported. + +::: diff --git a/docs/en/installation/install-rancher-on-k8s/install-rancher-on-k8s.md b/docs/en/installation/install-rancher-on-k8s/install-rancher-on-k8s.md index 55522d6caa9..1475548856e 100644 --- a/docs/en/installation/install-rancher-on-k8s/install-rancher-on-k8s.md +++ b/docs/en/installation/install-rancher-on-k8s/install-rancher-on-k8s.md @@ -53,7 +53,11 @@ To choose a Rancher version to install, refer to [Choosing a Rancher Version.]({ To choose a version of Helm to install Rancher with, refer to the [Helm version requirements]({{}}/rancher/v2.6/en/installation/resources/helm-version) -> **Note:** The installation instructions assume you are using Helm 3. +:::note + +The installation instructions assume you are using Helm 3. + +::: To set up Rancher, @@ -87,7 +91,11 @@ kubectl create namespace cattle-system The Rancher management server is designed to be secure by default and requires SSL/TLS configuration. -> **Note:** If you want terminate SSL/TLS externally, see [TLS termination on an External Load Balancer]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination). +:::note + +If you want terminate SSL/TLS externally, see [TLS termination on an External Load Balancer]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination). + +::: There are three recommended options for the source of the certificate used for TLS termination at the Rancher server: @@ -112,7 +120,11 @@ This step is only required to use certificates issued by Rancher's generated CA {{% accordion id="cert-manager" label="Click to Expand" %}} -> **Important:** Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.11.0, please see our [upgrade documentation]({{}}/rancher/v2.6/en/installation/resources/upgrading-cert-manager/). +:::note Important: + +Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.11.0, please see our [upgrade documentation]({{}}/rancher/v2.6/en/installation/resources/upgrading-cert-manager/). + +::: These instructions are adapted from the [official cert-manager documentation](https://cert-manager.io/docs/installation/kubernetes/#installing-with-helm). @@ -152,7 +164,11 @@ The exact command to install Rancher differs depending on the certificate config However, irrespective of the certificate configuration, the name of the Rancher installation in the `cattle-system` namespace should always be `rancher`. -> **Tip for testing and development:** This final command to install Rancher requires a domain name that forwards traffic to Rancher. If you are using the Helm CLI to set up a proof-of-concept, you can use a fake domain name when passing the `hostname` option. An example of a fake domain name would be `.sslip.io`, which would expose Rancher on an IP where it is running. Production installs would require a real domain name. +:::tip Testing and Development: + +This final command to install Rancher requires a domain name that forwards traffic to Rancher. If you are using the Helm CLI to set up a proof-of-concept, you can use a fake domain name when passing the `hostname` option. An example of a fake domain name would be `.sslip.io`, which would expose Rancher on an IP where it is running. Production installs would require a real domain name. + +::: {{% tabs %}} {{% tab "Rancher-generated Certificates" %}} @@ -187,7 +203,11 @@ deployment "rancher" successfully rolled out This option uses `cert-manager` to automatically request and renew [Let's Encrypt](https://letsencrypt.org/) certificates. This is a free service that provides you with a valid certificate as Let's Encrypt is a trusted CA. ->**Note:** You need to have port 80 open as the HTTP-01 challenge can only be done on port 80. +:::note + +You need to have port 80 open as the HTTP-01 challenge can only be done on port 80. + +::: In the following command, @@ -224,7 +244,11 @@ When you run this command, the `hostname` option must match the `Common Name` or Although an entry in the `Subject Alternative Names` is technically required, having a matching `Common Name` maximizes compatibility with older browsers and applications. -> If you want to check if your certificates are correct, see [How do I check Common Name and Subject Alternative Names in my server certificate?]({{}}/rancher/v2.6/en/faq/technical/#how-do-i-check-common-name-and-subject-alternative-names-in-my-server-certificate) +:::note + +If you want to check if your certificates are correct, see [How do I check Common Name and Subject Alternative Names in my server certificate?]({{}}/rancher/v2.6/en/faq/technical/#how-do-i-check-common-name-and-subject-alternative-names-in-my-server-certificate) + +::: - Set the `hostname`. - Set the `bootstrapPassword` to something unique for the `admin` user.