From 22cb0d134bfba0d52fa2a9137a57038f88dd8c9c Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Fri, 8 Jun 2018 17:54:06 -0700 Subject: [PATCH] fixing various typos --- .../v2.x/en/concepts/api-keys/_index.md | 2 +- .../authentication/_index.md | 2 +- .../users-permissions-roles/_index.md | 16 +++++++-------- .../adding-a-pod-security-policy/_index.md | 20 ++++++++++--------- .../authentication/github/_index.md | 6 +++--- .../pod-security-policies/_index.md | 3 +-- .../global-configuration/server-url/_index.md | 7 +++---- 7 files changed, 28 insertions(+), 28 deletions(-) diff --git a/content/rancher/v2.x/en/concepts/api-keys/_index.md b/content/rancher/v2.x/en/concepts/api-keys/_index.md index 6ef51c7a192..8f2f6db0a6c 100644 --- a/content/rancher/v2.x/en/concepts/api-keys/_index.md +++ b/content/rancher/v2.x/en/concepts/api-keys/_index.md @@ -11,4 +11,4 @@ Before you can use the Rancher CLI or write a program that calls the Rancher API After logging into Rancher, you can generate API keys for accessing Rancher externally using your user settings. If you need to revoke access to the Rancher API, you can delete the API key. -For instructions on how to create an API key, see [Creating an API Key]({{< baseurl >}}/rancher/v2.x/en/tasks/miscellaneous/). +For instructions on how to create an API key, see [Creating an API Key]({{< baseurl >}}/rancher/v2.x/en/tasks/user-settings/api-key/). diff --git a/content/rancher/v2.x/en/concepts/global-configuration/authentication/_index.md b/content/rancher/v2.x/en/concepts/global-configuration/authentication/_index.md index cded32c8152..06dbfa7591c 100644 --- a/content/rancher/v2.x/en/concepts/global-configuration/authentication/_index.md +++ b/content/rancher/v2.x/en/concepts/global-configuration/authentication/_index.md @@ -24,7 +24,7 @@ In most cases, you should use an external authentication service over local, as Configuration of external authentication requires: - A local user assigned the administrator role, called hereafter the _local principal_. -- An external user that can authentication with your external authentication service, called hereafter the _external principal_. +- An external user that can authenticate with your external authentication service, called hereafter the _external principal_. Configuration of external authentication affects how principal users are managed within Rancher. Follow the list below to better understand these effects. diff --git a/content/rancher/v2.x/en/concepts/global-configuration/users-permissions-roles/_index.md b/content/rancher/v2.x/en/concepts/global-configuration/users-permissions-roles/_index.md index 63267d81cef..adecc919f2e 100644 --- a/content/rancher/v2.x/en/concepts/global-configuration/users-permissions-roles/_index.md +++ b/content/rancher/v2.x/en/concepts/global-configuration/users-permissions-roles/_index.md @@ -1,11 +1,11 @@ --- -title: Users, Global Persmissions, and Roles +title: Users, Global Permissions, and Roles weight: 15 --- -Within Rancher, each user authenticates as a _user_, which is a login that grants you access to Rancher. As mentioned previously, users can either be local or external. +Within Rancher, each user authenticates as a _user_, which is a login that grants you access to Rancher. As mentioned in [Authenitcation]({{< baseurl >}}/rancher/v2.x/en/concepts/global-configuration/authentication), users can either be local or external. -After you configure external authentication, the users that display on Users page changes. +After you configure external authentication, the users that display on the **Users** page changes. - If you are logged in as a local user, only local users display. @@ -49,7 +49,7 @@ Assignment of global permissions to a user depends on their authentication sourc - **Local Authentication** - When you create a new local user, you assign them a global permission as you create complete the **Add User** form. + When you create a new local user, you assign them a global permission as you complete the **Add User** form. #### Custom Global Permissions @@ -82,14 +82,14 @@ The following table lists each custom global permission available and whether it Cluster and project roles define user authorization inside a cluster or project. You can manage these roles from the **Global > Security > Roles** page. From this page you can: - Create and manage new roles for use across all clusters and projects -- [Lock/unlock roles](#locked-roles) so that they may not be used in any new role assignments (existing assignments will still be enforce) +- [Lock/unlock roles](#locked-roles) so that they may not be used in any new role assignments (existing assignments will still be enforced). #### Membership and Role Assignment -The projects and clusters accessible to non-administrative user is determined by _membership_. Membership is a list of users who have access to a specific cluster or project based on the roles they were assigned in that cluster or project. Each cluster and project includes a tab that a user with the appropriate permissions can use to manage membership. +The projects and clusters accessible to non-administrative users is determined by _membership_. Membership is a list of users who have access to a specific cluster or project based on the roles they were assigned in that cluster or project. Each cluster and project includes a tab that a user with the appropriate permissions can use to manage membership. -When you create a cluster or project, Rancher automatically assigns you the `Owner` for it. Users assigned the `Owner` role can assign other users roles in the cluster or project. +When you create a cluster or project, Rancher automatically assigns you as the `Owner` for it. Users assigned the `Owner` role can assign other users roles in the cluster or project. > **Note:** Non-administrative users cannot access any existing projects/clusters by default. A user with appropriate permissions (typically the owner) must explicitly assign the user membership. @@ -123,7 +123,7 @@ The following table lists each built-in custom cluster role available in Rancher | View Cluster Members | ✓ | ✓ | | View Nodes | ✓ | ✓ | -> **Note:** Each cluster role listed above, including Owner and Member, is comprised of multiple rules granting access to various resources. You can view the roles and their rules on the Global > Security > Roles page. +> **Note:** Each cluster role listed above, including `Owner` and `Member`, is comprised of multiple rules granting access to various resources. You can view the roles and their rules on the Global > Security > Roles page. #### Project Roles diff --git a/content/rancher/v2.x/en/tasks/clusters/adding-a-pod-security-policy/_index.md b/content/rancher/v2.x/en/tasks/clusters/adding-a-pod-security-policy/_index.md index 96f7b65e3dc..1fab4c86788 100644 --- a/content/rancher/v2.x/en/tasks/clusters/adding-a-pod-security-policy/_index.md +++ b/content/rancher/v2.x/en/tasks/clusters/adding-a-pod-security-policy/_index.md @@ -38,7 +38,7 @@ If you don't apply a PSP as you create your cluster, you can always add one late >**Prerequisite:** >Create a Pod Security Policy within Rancher. Before you can assign a default PSP to an existing cluster, you must have a PSP available for assignment. For instruction, see [Creating Pod Security Policies]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/pod-security-policies/). -1. From the from the **Global** view, find the cluster that you want apply your PSP to. Select **Vertical Ellipsis (...) > Edit** for the cluster you want to enable PSPs for. +1. From the **Global** view, find the cluster that you want to apply your PSP to. Select **Vertical Ellipsis (...) > Edit** for the cluster you want to enable PSPs for. 2. Expand the **Cluster Options** accordion. @@ -61,12 +61,13 @@ If you don't apply a PSP as you create your cluster, you can always add one late When you create a new project, you can assign a PSP directly to the project. Assigning a PSP to a project will: - Override the cluster's default PSP. -- Apply the PSP to project. +- Apply the PSP to the project. - Apply the PSP to any namespaces you add to the project later. >**Prerequisites:** ->- Create a Pod Security Policy within Rancher. Before you can assign a default PSP to a new project, you must have a PSP available for assignment. For instruction, see [Creating Pod Security Policies]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/pod-security-policies/). ->- Assign a default Pod Security Policy to the project's cluster. You can't assign a PSP to a project until one is already applied to the cluster. For more information, see [Existing Cluster: Adding a Pod Security Policy](#existing-cluster--adding-a-pod-security-policy). +> +> - Create a Pod Security Policy within Rancher. Before you can assign a default PSP to a new project, you must have a PSP available for assignment. For instruction, see [Creating Pod Security Policies]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/pod-security-policies/). +> - Assign a default Pod Security Policy to the project's cluster. You can't assign a PSP to a project until one is already applied to the cluster. For more information, see [Existing Cluster: Adding a Pod Security Policy](#existing-cluster--adding-a-pod-security-policy). As you create the project, make a selection from the **Pod Security Policy** drop-down to assign a PSP. @@ -76,13 +77,14 @@ As you create the project, make a selection from the **Pod Security Policy** dro You can always assign a PSP to an existing project if you didn't assign one during creation. ->**Prerequisite:** ->Create a Pod Security Policy within Rancher. Before you can assign a default PSP to an existing project, you must have a PSP available for assignment. For instruction, see [Creating Pod Security Policies]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/pod-security-policies/). ->- Assign a default Pod Security Policy to the project's cluster. You can't assign a PSP to a project until one is already applied to the cluster. For more information, see [Existing Cluster: Adding a Pod Security Policy](#existing-cluster--adding-a-pod-security-policy). +>**Prerequisites:** +> +> - Create a Pod Security Policy within Rancher. Before you can assign a default PSP to an existing project, you must have a PSP available for assignment. For instruction, see [Creating Pod Security Policies]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/pod-security-policies/). +> - Assign a default Pod Security Policy to the project's cluster. You can't assign a PSP to a project until one is already applied to the cluster. For more information, see [Existing Cluster: Adding a Pod Security Policy](#existing-cluster--adding-a-pod-security-policy). -1. From the navigation menu, browse to the cluster containing the project you want to apply a PSP to. +1. From the **Global** view, find the cluster containing the project you want to apply a PSP to. -2. From the navigation menu, select **Projects/Namespaces**. +1. From the main menu, select **Projects/Namespaces**. 3. Find the project that you want to add a PSP to. From that project, select **Vertical Ellipsis (...) > Edit**. diff --git a/content/rancher/v2.x/en/tasks/global-configuration/authentication/github/_index.md b/content/rancher/v2.x/en/tasks/global-configuration/authentication/github/_index.md index fce70517eaa..860ee14968e 100644 --- a/content/rancher/v2.x/en/tasks/global-configuration/authentication/github/_index.md +++ b/content/rancher/v2.x/en/tasks/global-configuration/authentication/github/_index.md @@ -17,11 +17,11 @@ In environments using GitHub, you can configure Rancher to allow sign on using G >**What's an Authorization Callback URL?** > - >The Authorization Callback URL is the URL where users to begin using your application (i.e. the splash screen). + >The Authorization Callback URL is the URL where users go to begin using your application (i.e. the splash screen). - >When you use external authentication, sign on authentication does not actually take place in your application. Instead, authentication takes place externally (in this case, GitHub). After this external authorization completes successfully, the Authorization Callback URL is the location that the user reenters your application. + >When you use external authentication, authentication does not actually take place in your application. Instead, authentication takes place externally (in this case, GitHub). After this external authentication completes successfully, the Authorization Callback URL is the location where the user re-enters your application. -5. From GitHub, copy the **Client ID** and **Client Secret**. Paste them into {{< product >}}. +5. From GitHub, copy the **Client ID** and **Client Secret**. Paste them into Rancher. >**Where do I find the Client ID and Client Secret?** > diff --git a/content/rancher/v2.x/en/tasks/global-configuration/pod-security-policies/_index.md b/content/rancher/v2.x/en/tasks/global-configuration/pod-security-policies/_index.md index 1235493382e..e9eb69200a6 100644 --- a/content/rancher/v2.x/en/tasks/global-configuration/pod-security-policies/_index.md +++ b/content/rancher/v2.x/en/tasks/global-configuration/pod-security-policies/_index.md @@ -2,11 +2,10 @@ title: Pod Security Policies weight: 125 --- +Using Rancher, you can create a Pod Security Policy using our GUI rather than creating a YAML file. ## Creating Pod Security Policies -Using {{< product >}}, you can create a Pod Security Policy using our GUI rather than creating a YAML file. - 1. From the **Global** view, select **Security** > **Pod Security Policies** from the main menu. Then click **Add Policy**. **Step Result:** The **Add Policy** form opens. diff --git a/content/rancher/v2.x/en/tasks/global-configuration/server-url/_index.md b/content/rancher/v2.x/en/tasks/global-configuration/server-url/_index.md index f4d9df8e93f..6c62117577f 100644 --- a/content/rancher/v2.x/en/tasks/global-configuration/server-url/_index.md +++ b/content/rancher/v2.x/en/tasks/global-configuration/server-url/_index.md @@ -2,12 +2,11 @@ title: Rancher Server URL weight: 25 --- -## Updating the {{< product >}} Server URL -The first time that you log into {{< product >}}, the system prompts for the {{< product >}} Server URL, which is the IP address or host name that your Kubernetes nodes register with. +The first time that you log into {{< product >}}, the system prompts you for the Rancher Server URL, which is the IP address or host name that your Kubernetes nodes register with. If you need to update this URL, select **Settings** from the **Global** view. -### When Should I Update the {{< product >}} Server URL? +### When Should I Update the Rancher Server URL? -If URL of your {{< product >}} Server changes, you must update the {{< product >}} Server URL so that your nodes can continue communication with the {{< product >}} Server. +If the URL of your {{< product >}} Server changes, you must update the {{< product >}} Server URL so that your nodes can continue communicating with the {{< product >}} Server.