From cbf95664315a2ac2b550a5631b8c6667e369858a Mon Sep 17 00:00:00 2001 From: Jennifer Travinski Date: Mon, 11 Jul 2022 14:07:53 -0400 Subject: [PATCH] Updating per feedback --- .../rbac/cluster-project-roles/cluster-project-roles.md | 2 +- .../gke-config-reference/private-clusters/private-clusters.md | 4 ++-- .../docker-install-commands/docker-install-commands.md | 4 +--- .../single-node-rollbacks/single-node-rollbacks.md | 2 +- .../single-node-upgrades/single-node-upgrades.md | 4 ++-- .../quota-type-reference/quota-type-reference.md | 2 +- .../deployment/amazon-aws-qs/amazon-aws-qs.md | 2 +- .../deployment/digital-ocean-qs/digital-ocean-qs.md | 2 +- .../deployment/equinix-metal-qs/equinix-metal-qs.md | 2 +- .../deployment/google-gcp-qs/google-gcp-qs.md | 2 +- .../deployment/hetzner-cloud-qs/hetzner-cloud-qs.md | 2 +- .../deployment/microsoft-azure-qs/microsoft-azure-qs.md | 2 +- .../deployment/quickstart-vagrant/quickstart-vagrant.md | 2 +- docs/en/quick-start-guide/quick-start-guide.md | 2 +- 14 files changed, 16 insertions(+), 18 deletions(-) diff --git a/docs/en/admin-settings/rbac/cluster-project-roles/cluster-project-roles.md b/docs/en/admin-settings/rbac/cluster-project-roles/cluster-project-roles.md index f54b0a817b3..a34d1c4653c 100644 --- a/docs/en/admin-settings/rbac/cluster-project-roles/cluster-project-roles.md +++ b/docs/en/admin-settings/rbac/cluster-project-roles/cluster-project-roles.md @@ -140,7 +140,7 @@ _Project roles_ are roles that can be used to grant users access to a project. T These users can view everything in the project but cannot create, update, or delete anything. - :::note Caveat + :::note danger Users assigned the `Owner` or `Member` role for a project automatically inherit the `namespace creation` role. However, this role is a [Kubernetes ClusterRole](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#role-and-clusterrole), meaning its scope extends to all projects in the cluster. Therefore, users explicitly assigned the `owner` or `member` role for a project can create namespaces in other projects they're assigned to, even with only the `Read Only` role assigned. diff --git a/docs/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/private-clusters.md b/docs/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/private-clusters.md index 69ea8f16489..aa326ebec32 100644 --- a/docs/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/private-clusters.md +++ b/docs/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/private-clusters.md @@ -11,7 +11,7 @@ Because the nodes in a private cluster only have internal IP addresses, they wil #### Cloud NAT -:::note +:::caution Cloud NAT will [incur charges](https://cloud.google.com/nat/pricing). @@ -21,7 +21,7 @@ If restricting outgoing internet access is not a concern for your organization, #### Private registry -:::note +:::caution This scenario is not officially supported, but is described for cases in which using the Cloud NAT service is not sufficient. diff --git a/docs/en/installation/other-installation-methods/air-gap/install-rancher/docker-install-commands/docker-install-commands.md b/docs/en/installation/other-installation-methods/air-gap/install-rancher/docker-install-commands/docker-install-commands.md index 8e38a449920..a0c9309ae20 100644 --- a/docs/en/installation/other-installation-methods/air-gap/install-rancher/docker-install-commands/docker-install-commands.md +++ b/docs/en/installation/other-installation-methods/air-gap/install-rancher/docker-install-commands/docker-install-commands.md @@ -16,9 +16,7 @@ For security purposes, SSL (Secure Sockets Layer) is required when using Rancher | `CATTLE_SYSTEM_DEFAULT_REGISTRY` | `` | Configure Rancher server to always pull from your private registry when provisioning clusters. | | `CATTLE_SYSTEM_CATALOG` | `bundled` | Configure Rancher server to use the packaged copy of Helm system charts. The [system charts](https://github.com/rancher/system-charts) repository contains all the catalog items required for features such as monitoring, logging, alerting and global DNS. These [Helm charts](https://github.com/rancher/system-charts) are located in GitHub, but since you are in an air gapped environment, using the charts that are bundled within Rancher is much easier than setting up a Git mirror. | -:::note - -**Do you want to..** +:::note Do you want to.. - Configure custom CA root certificate to access your services? See [Custom CA root certificate]({{}}/rancher/v2.6/en/installation/resources/custom-ca-root-certificate/). - Record all transactions with the Rancher API? See [API Auditing]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#api-audit-log). diff --git a/docs/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/single-node-rollbacks.md b/docs/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/single-node-rollbacks.md index 62161562653..d056b93a415 100644 --- a/docs/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/single-node-rollbacks.md +++ b/docs/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/single-node-rollbacks.md @@ -82,7 +82,7 @@ Rolling back to a previous version of Rancher destroys any changes made to Ranch ``` Privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher) - :::note Important: + :::danger **_Do not_** stop the rollback after initiating it, even if the rollback process seems longer than expected. Stopping the rollback may result in database issues during future upgrades. diff --git a/docs/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/single-node-upgrades.md b/docs/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/single-node-upgrades.md index 3fd403f8d79..bc3cd99c0d9 100644 --- a/docs/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/single-node-upgrades.md +++ b/docs/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/single-node-upgrades.md @@ -5,7 +5,7 @@ weight: 1010 The following instructions will guide you through upgrading a Rancher server that was installed with Docker. -:::note Important: +:::caution **Docker installs are not supported in production environments.** These instructions are provided for testing and development purposes only. If you have already deployed a Docker install in production and need to upgrade to a new Rancher version, we recommend [migrating to the Helm chart install]({{}}/rancher/v2.6/en/backups/migrating-rancher/) before upgrading. @@ -116,7 +116,7 @@ docker pull rancher/rancher: Start a new Rancher server container using the data from the `rancher-data` container. Remember to pass in all the environment variables that you had used when you started the original container. -:::note Important: +:::danger **_Do not_** stop the upgrade after initiating it, even if the upgrade process seems longer than expected. Stopping the upgrade may result in database migration errors during future upgrades. diff --git a/docs/en/project-admin/resource-quotas/quota-type-reference/quota-type-reference.md b/docs/en/project-admin/resource-quotas/quota-type-reference/quota-type-reference.md index a3c9a873790..f111346b07c 100644 --- a/docs/en/project-admin/resource-quotas/quota-type-reference/quota-type-reference.md +++ b/docs/en/project-admin/resource-quotas/quota-type-reference/quota-type-reference.md @@ -21,7 +21,7 @@ When you create a resource quota, you are configuring the pool of resources avai | Replications Controllers | The maximum number of replication controllers that can exist in the project/namespace. | | Secrets | The maximum number of secrets that can exist in the project/namespace. | -:::note Important: +:::note ***** When setting resource quotas, if you set anything related to CPU or Memory (i.e. limits or reservations) on a project / namespace, all containers will require a respective CPU or Memory field set during creation. A container default resource limit can be set at the same time to avoid the need to explicitly set these limits for every workload. See the [Kubernetes documentation](https://kubernetes.io/docs/concepts/policy/resource-quotas/#requests-vs-limits) for more details on why this is required. diff --git a/docs/en/quick-start-guide/deployment/amazon-aws-qs/amazon-aws-qs.md b/docs/en/quick-start-guide/deployment/amazon-aws-qs/amazon-aws-qs.md index caa8533219e..5c43eb5c1f0 100644 --- a/docs/en/quick-start-guide/deployment/amazon-aws-qs/amazon-aws-qs.md +++ b/docs/en/quick-start-guide/deployment/amazon-aws-qs/amazon-aws-qs.md @@ -5,7 +5,7 @@ weight: 100 --- The following steps will quickly deploy a Rancher server on AWS in a single-node K3s Kubernetes cluster, with a single-node downstream Kubernetes cluster attached. -:::note +:::caution The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see [Installation]({{}}/rancher/v2.6/en/installation/). diff --git a/docs/en/quick-start-guide/deployment/digital-ocean-qs/digital-ocean-qs.md b/docs/en/quick-start-guide/deployment/digital-ocean-qs/digital-ocean-qs.md index 6f79c04cd37..af37f6677d6 100644 --- a/docs/en/quick-start-guide/deployment/digital-ocean-qs/digital-ocean-qs.md +++ b/docs/en/quick-start-guide/deployment/digital-ocean-qs/digital-ocean-qs.md @@ -5,7 +5,7 @@ weight: 120 --- The following steps will quickly deploy a Rancher server on DigitalOcean in a single-node K3s Kubernetes cluster, with a single-node downstream Kubernetes cluster attached. -:::note +:::caution The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see [Installation]({{}}/rancher/v2.6/en/installation/). diff --git a/docs/en/quick-start-guide/deployment/equinix-metal-qs/equinix-metal-qs.md b/docs/en/quick-start-guide/deployment/equinix-metal-qs/equinix-metal-qs.md index 29844d1270a..eece16f895f 100644 --- a/docs/en/quick-start-guide/deployment/equinix-metal-qs/equinix-metal-qs.md +++ b/docs/en/quick-start-guide/deployment/equinix-metal-qs/equinix-metal-qs.md @@ -10,7 +10,7 @@ weight: 250 - Creation of your first cluster - Deployment of an application, Nginx -:::note +:::caution The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. The Docker install is not recommended for production environments. For comprehensive setup instructions, see [Installation]({{}}/rancher/v2.6/en/installation/). diff --git a/docs/en/quick-start-guide/deployment/google-gcp-qs/google-gcp-qs.md b/docs/en/quick-start-guide/deployment/google-gcp-qs/google-gcp-qs.md index 38fcf14ae7a..ca5da1892c9 100644 --- a/docs/en/quick-start-guide/deployment/google-gcp-qs/google-gcp-qs.md +++ b/docs/en/quick-start-guide/deployment/google-gcp-qs/google-gcp-qs.md @@ -5,7 +5,7 @@ weight: 130 --- The following steps will quickly deploy a Rancher server on GCP in a single-node K3s Kubernetes cluster, with a single-node downstream Kubernetes cluster attached. -:::note +:::caution The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see [Installation]({{}}/rancher/v2.6/en/installation/). diff --git a/docs/en/quick-start-guide/deployment/hetzner-cloud-qs/hetzner-cloud-qs.md b/docs/en/quick-start-guide/deployment/hetzner-cloud-qs/hetzner-cloud-qs.md index 526221d24c2..35ca28a143c 100644 --- a/docs/en/quick-start-guide/deployment/hetzner-cloud-qs/hetzner-cloud-qs.md +++ b/docs/en/quick-start-guide/deployment/hetzner-cloud-qs/hetzner-cloud-qs.md @@ -5,7 +5,7 @@ weight: 140 --- The following steps will quickly deploy a Rancher server on Hetzner Cloud in a single-node K3s Kubernetes cluster, with a single-node downstream Kubernetes cluster attached. -:::note +:::caution The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see [Installation]({{}}/rancher/v2.6/en/installation/). diff --git a/docs/en/quick-start-guide/deployment/microsoft-azure-qs/microsoft-azure-qs.md b/docs/en/quick-start-guide/deployment/microsoft-azure-qs/microsoft-azure-qs.md index 2f1b6561362..dbc50068525 100644 --- a/docs/en/quick-start-guide/deployment/microsoft-azure-qs/microsoft-azure-qs.md +++ b/docs/en/quick-start-guide/deployment/microsoft-azure-qs/microsoft-azure-qs.md @@ -6,7 +6,7 @@ weight: 115 The following steps will quickly deploy a Rancher server on Azure in a single-node K3s Kubernetes cluster, with a single-node downstream Kubernetes cluster attached. -:::note +:::caution The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see [Installation]({{}}/rancher/v2.6/en/installation/). diff --git a/docs/en/quick-start-guide/deployment/quickstart-vagrant/quickstart-vagrant.md b/docs/en/quick-start-guide/deployment/quickstart-vagrant/quickstart-vagrant.md index 25423322f32..987a9dcbdc2 100644 --- a/docs/en/quick-start-guide/deployment/quickstart-vagrant/quickstart-vagrant.md +++ b/docs/en/quick-start-guide/deployment/quickstart-vagrant/quickstart-vagrant.md @@ -4,7 +4,7 @@ weight: 200 --- The following steps quickly deploy a Rancher Server with a single node cluster attached. -:::note +:::caution The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see [Installation]({{}}/rancher/v2.6/en/installation/). diff --git a/docs/en/quick-start-guide/quick-start-guide.md b/docs/en/quick-start-guide/quick-start-guide.md index 7059f429421..d04067484fa 100644 --- a/docs/en/quick-start-guide/quick-start-guide.md +++ b/docs/en/quick-start-guide/quick-start-guide.md @@ -6,7 +6,7 @@ weight: 2 aliases: - /rancher/v2.x/en/quick-start-guide/ --- -:::note +:::caution The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see [Installation]({{}}/rancher/v2.6/en/installation/).