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

Fix links

Browse Source
This commit is contained in:
Billy Tat
2022-09-01 14:57:40 -07:00
parent 827906a2b7
commit ce19e2e8be
66 changed files with 175 additions and 177 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/how-to-guides/advanced-user-guides/manage-clusters/access-clusters/add-users-to-clusters.md
+5 -5
View File
@@ -7,7 +7,7 @@ If you want to provide a user with access and permissions to _all_ projects, nod
:::tip
Want to provide a user with access to a _specific_ project within a cluster? See [Adding Project Members](cluster-admin/projects-and-namespaces/project-members/) instead.
Want to provide a user with access to a _specific_ project within a cluster? See [Adding Project Members](../../manage-projects/add-users-to-projects.md) instead.
:::
@@ -43,19 +43,19 @@ Cluster administrators can edit the membership for a cluster, controlling which
- A drop-down allows you to add groups instead of individual users. The drop-down only lists groups that you, the logged in user, are part of.
:::note
If you are logged in as a local user, external users do not display in your search results. For more information, see [External Authentication Configuration and Principal Users](../../../../pages-for-subheaders/about-authentication.md#external-authentication-configuration-and-principal-users).
:::
1. Assign the user or group **Cluster** roles.
1. Assign the user or group **Cluster** roles.
[What are Cluster Roles?](../../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md)
:::tip
For Custom Roles, you can modify the list of individual roles available for assignment.
- To add roles to the list, [Add a Custom Role](../../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/custom-roles.md).
- To remove roles from the list, [Lock/Unlock Roles](../../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/locked-roles.md).
docs/how-to-guides/advanced-user-guides/manage-clusters/clean-cluster-nodes.md
+4 -4
View File
@@ -27,10 +27,10 @@ When cleaning nodes provisioned using Rancher, the following components are dele
| All resources create under the `management.cattle.io` API Group | ✓ | ✓ | ✓ | |
| All CRDs created by Rancher v2.x | ✓ | ✓ | ✓ | |
[1]: cluster-provisioning/rke-clusters/node-pools/
[2]: cluster-provisioning/rke-clusters/custom-nodes/
[3]: cluster-provisioning/hosted-kubernetes-clusters/
[4]: cluster-provisioning/registered-clusters/
[1]: ../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md
[2]: ../../../pages-for-subheaders/use-existing-nodes.md
[3]: ../../../pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers.md
[4]: ../../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md
## Removing a Node from a Cluster by Rancher UI
docs/how-to-guides/advanced-user-guides/manage-clusters/clone-cluster-configuration.md
+2 -2
View File
@@ -55,14 +55,14 @@ Use your favorite text editor to modify the cluster configuration in `cluster-te
:::note
Cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure in Rancher v2.3.0+.](cluster-provisioning/rke-clusters/options/#config-file-structure-in-rancher-v2-3-0)
Cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure in Rancher v2.3.0+.](../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#config-file-structure-in-rancher)
:::
1. Open `cluster-template.yml` (or whatever you named your config) in your favorite text editor.
:::caution
Only edit the cluster config values explicitly called out below. Many of the values listed in this file are used to provision your cloned cluster, and editing their values may break the provisioning process.
:::
docs/how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/provisioning-storage-examples/vsphere-storage.md
+1 -1
View File
@@ -15,7 +15,7 @@ In order to dynamically provision storage in vSphere, the vSphere provider must
### Prerequisites
In order to provision vSphere volumes in a cluster created with the [Rancher Kubernetes Engine (RKE)](../../../../../pages-for-subheaders/launch-kubernetes-with-rancher.md), the [vSphere cloud provider](https://rancher.com/docs/rke/latest/en/config-options/cloud-providers/vsphere) must be explicitly enabled in the [cluster options](cluster-provisioning/rke-clusters/options/).
In order to provision vSphere volumes in a cluster created with the [Rancher Kubernetes Engine (RKE)](../../../../../pages-for-subheaders/launch-kubernetes-with-rancher.md), the [vSphere cloud provider](https://rancher.com/docs/rke/latest/en/config-options/cloud-providers/vsphere) must be explicitly enabled in the [cluster options](../../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md).
### Creating a StorageClass
docs/how-to-guides/advanced-user-guides/manage-clusters/nodes-and-node-pools.md
+6 -6
View File
@@ -44,11 +44,11 @@ The following table lists which node options are available for each type of clus
| [Download Keys](#ssh-into-a-node-hosted-by-an-infrastructure-provider) | ✓ | | | | | Download SSH key in order to SSH into the node. |
| [Node Scaling](#scaling-nodes) | ✓ | | | ✓ | | Scale the number of nodes in the node pool up or down. |
[1]: cluster-provisioning/rke-clusters/node-pools/
[2]: cluster-provisioning/rke-clusters/custom-nodes/
[3]: cluster-provisioning/hosted-kubernetes-clusters/
[4]: cluster-provisioning/registered-clusters/
[5]: cluster-provisioning/registered-clusters/
[1]: ../../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md
[2]: ../../../pages-for-subheaders/use-existing-nodes.md
[3]: ../../../pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers.md
[4]: ../../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md
[5]: ../../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md
\* Delete option accessible via View API
@@ -197,7 +197,7 @@ cattle.rancher.io/node-status: ignore
**Result:** If you add the node to a cluster, Rancher will not attempt to sync with this node. The node can still be part of the cluster and can be listed with `kubectl`.
If the label is added before the node is added to the cluster, the node will not be shown in the Rancher UI.
If the label is added before the node is added to the cluster, the node will not be shown in the Rancher UI.
If the label is added after the node is added to a Rancher cluster, the node will not be removed from the UI.
docs/how-to-guides/advanced-user-guides/manage-projects/manage-namespaces.md
+3 -3
View File
@@ -41,7 +41,7 @@ When working with project resources that you can assign to a namespace (i.e., [w
1. Click **Cluster > Projects/Namespaces**.
1. Go to the project where you want to add a namespace and click **Create Namespace**. Alternately, go to **Not in a Project** to create a namespace not associated with a project.
1. **Optional:** If your project has [Resource Quotas](../../../pages-for-subheaders/manage-project-resource-quotas.md) in effect, you can override the default resource **Limits** (which places a cap on the resources that the namespace can consume).
1. **Optional:** If your project has [Resource Quotas](../../../pages-for-subheaders/manage-project-resource-quotas.md) in effect, you can override the default resource **Limits** (which places a cap on the resources that the namespace can consume).
1. Enter a **Name** and then click **Create**.
@@ -59,7 +59,7 @@ Cluster admins and members may occasionally need to move a namespace to another
1. Select the namespace(s) that you want to move to a different project. Then click **Move**. You can move multiple namespaces at one.
:::note Notes:
- Don't move the namespaces in the `System` project. Moving these namespaces can adversely affect cluster networking.
- You cannot move a namespace into a project that already has a [resource quota](../../../pages-for-subheaders/manage-project-resource-quotas.md)configured.
- If you move a namespace from a project that has a quota set to a project with no quota set, the quota is removed from the namespace.
@@ -72,4 +72,4 @@ Cluster admins and members may occasionally need to move a namespace to another
You can always override the namespace default limit to provide a specific namespace with access to more (or less) project resources.
For more information, see how to [edit namespace resource quotas](project-admin//resource-quotas/override-namespace-default/).
For more information, see how to [edit namespace resource quotas](./manage-project-resource-quotas/override-default-limit-in-namespaces.md).
docs/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheusrules.md
+4 -4
View File
@@ -21,7 +21,7 @@ The monitoring application needs to be installed.
To create rule groups in the Rancher UI,
1. Go to the cluster where you want to create rule groups. Click **Monitoring** and click **Prometheus Rules**.
1. Go to the cluster where you want to create rule groups. Click **Monitoring** and click **Prometheus Rules**.
1. Click **Create**.
1. Enter a **Group Name**.
1. Configure the rules. In Rancher's UI, we expect a rule group to contain either alert rules or recording rules, but not both. For help filling out the forms, refer to the configuration options below.
@@ -64,7 +64,7 @@ For examples, refer to the Prometheus documentation on [recording rules](https:/
|-------|----------------|
| Alert Name | The name of the alert. Must be a valid label value. |
| Wait To Fire For | Duration in seconds. Alerts are considered firing once they have been returned for this long. Alerts which have not yet fired for long enough are considered pending. |
| PromQL Expression | The PromQL expression to evaluate. Prometheus will evaluate the current value of this PromQL expression on every evaluation cycle and all resultant time series will become pending/firing alerts. For more information, refer to the [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/querying/basics/) or our [example PromQL expressions.](monitoring-alertimonitoring-alerting/configuration/advanced/expression) |
| PromQL Expression | The PromQL expression to evaluate. Prometheus will evaluate the current value of this PromQL expression on every evaluation cycle and all resultant time series will become pending/firing alerts. For more information, refer to the [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/querying/basics/) or our [example PromQL expressions.](../../../../explanations/integrations-in-rancher/monitoring-and-alerting/promql-expressions.md) |
| Labels | Labels to add or overwrite for each alert. |
| Severity | When enabled, labels are attached to the alert or record that identify it by the severity level. |
| Severity Label Value | Critical, warning, or none |
@@ -72,10 +72,10 @@ For examples, refer to the Prometheus documentation on [recording rules](https:/
### Recording Rules
[Recording rules](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#recording-rules) allow you to precompute frequently needed or computationally expensive PromQL (Prometheus Query Language) expressions and save their result as a new set of time series.
[Recording rules](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#recording-rules) allow you to precompute frequently needed or computationally expensive PromQL (Prometheus Query Language) expressions and save their result as a new set of time series.
| Field | Description |
|-------|----------------|
| Time Series Name | The name of the time series to output to. Must be a valid metric name. |
| PromQL Expression | The PromQL expression to evaluate. Prometheus will evaluate the current value of this PromQL expression on every evaluation cycle and the result will be recorded as a new set of time series with the metric name as given by 'record'. For more information about expressions, refer to the [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/querying/basics/) or our [example PromQL expressions.](monitoring-alerting/configuration/advanced/expression) |
| PromQL Expression | The PromQL expression to evaluate. Prometheus will evaluate the current value of this PromQL expression on every evaluation cycle and the result will be recorded as a new set of time series with the metric name as given by 'record'. For more information about expressions, refer to the [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/querying/basics/) or our [example PromQL expressions.](../../../../explanations/integrations-in-rancher/monitoring-and-alerting/promql-expressions.md) |
| Labels | Labels to add or overwrite before storing the result. |