Merge pull request #472 from deniseschannon/reorg-other

re-org other stuff
2026-09-13 04:27:14 +00:00 · 2018-07-16 21:17:18 -07:00
parent 5d0522a3d5 a3d84bbe37
commit 7f34bbd3e5
30 changed files with 106 additions and 166 deletions
@@ -2,7 +2,8 @@
 title: Admin Settings
 weight: 1100
 aliases:
-  - /rancher/v2.x/en/concepts/global-configuration
+  - /rancher/v2.x/en/concepts/global-configuration/
+  - /rancher/v2.x/en/tasks/global-configuration/
 ---

 After installing Rancher 2.0, you should
@@ -11,4 +12,4 @@ After installing Rancher 2.0, you should

 2. Set up external user authentication and permissions so that your organization can log into Rancher.

-After making these initial configurations, you might also want to configure one or more _pod security policies_, which are sets of conditions that your pods must meet for Kubernetes to allow them to run.
+After making these initial configurations, you might also want to configure one or more _pod security policies_, which are sets of conditions that your pods must meet for Kubernetes to allow them to run.
@@ -1,8 +1,18 @@
 ---
 title: Catalogs and Charts
-weight: 2250
+weight: 4000
+aliases:
+  - /rancher/v2.x/en/concepts/global-configuration/catalog/
+  - /rancher/v2.x/en/tasks/global-configuration/catalog/
 ---

+This section includes step-by-step instruction on how to configure default and custom catalogs.
+
+- [Enabling Default Catalogs]({{< baseurl >}}/rancher/v2.x/en/catalog-and-charts/enabling-default-catalogs)
+- [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/catalog-and-charts/adding-custom-catalogs)
+- [Customizing Charts]({{< baseurl >}}/rancher/v2.x/en/catalog-and-charts/customizing-charts)
+
+
 _Catalogs_ are GitHub repositories filled with applications that are ready-made for deployment. Applications are bundled in objects called _charts_.

 _Charts_ are a packaging format popularized by [Helm](https://docs.helm.sh/). Think of them as templates for deployments. Per Helm, charts are:
@@ -18,7 +28,7 @@ Within Rancher, you can access several different catalogs either by default or t
 - **Library**

 	The Library Catalog includes charts curated by Rancher. Rancher stores charts in a Git repository to expedite the fetch and update of charts. In Rancher 2.0, only global catalogs are supported. Support for cluster-level and project-level charts will be added in the future.
-	
+
 	This catalog features Rancher Charts, which include some [notable advantages](#chart-types) over native Helm charts.

 - **Helm Stable**
@@ -32,9 +42,9 @@ Within Rancher, you can access several different catalogs either by default or t
 - **Custom**

 	Finally, you have the option of building your own catalogs. Custom catalogs are useful when you have a handful of apps that you deploy regularly in a specific configuration.
- 
+
 ### Custom Catalog Creation
-	
+
 Creating a custom catalog for Rancher is straightforward. Create a Git repo and then direct Rancher toward the repo.

 Custom catalog requirements include:
@@ -42,7 +52,7 @@ Custom catalog requirements include:
 - A unique name.
 - A URL that `git clone` can handle.

-For step-by-step directions, see [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/adding-custom-catalogs).
+For step-by-step directions, see [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/catalog-and-charts/adding-custom-catalogs).

 When you're done creating the catalog, populate it with charts. Custom catalogs can support both native Helm charts and Rancher charts. See [Custom Chart Creation](#custom-chart-creation).

@@ -132,15 +142,15 @@ The following table demonstrates the directory structure for a chart, which can
 Before you create your own custom catalog, you should have a basic understanding about how a Rancher chart differs from a native Helm chart. Rancher charts differ slightly from Helm charts in their directory structures. Rancher charts include two files that Helm charts do not.

 - `app-readme.md`
-      
+
    A file that provides descriptive text in the chart's UI header. The following image displays the difference between a Rancher chart (which includes `app-readme.md`) and a native Helm chart (which does not).

 	<small>Rancher Chart with <code>app-readme.md</code> (left) vs. Helm Chart without (right)</small>

 	![app-readme.md]({{< baseurl >}}/img/rancher/app-readme.png)
-      
+
 - `questions.yml`
-    
+
    A file that contains questions for a form. These form questions simplify deployment of a chart. Without it, you must configure the deployment using key value pairs, which is more difficult. The following image displays the difference between a Rancher chart (which includes `questions.yml`) and a native Helm chart (which does not).


@@ -153,6 +163,6 @@ Before you create your own custom catalog, you should have a basic understanding

 You can fill your custom catalogs with either Helm Charts or Rancher Charts, although we recommend Rancher Charts due to their enhanced user experience.

- For information on how to add and customize charts for a custom catalog, see [Customizing Charts]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/customizing-charts).
+ For information on how to add and customize charts for a custom catalog, see [Customizing Charts]({{< baseurl >}}/rancher/v2.x/en/catalog-and-charts/customizing-charts).

 >**Note:** For a complete walkthrough of developing charts, see the upstream Helm chart [developer reference](https://docs.helm.sh/developing_charts/).
@@ -1,6 +1,8 @@
 ---
 title: Adding Custom Catalogs
-weight: 50
+weight: 4015
+aliases:
+  - /rancher/v2.x/en/tasks/global-configuration/catalog/adding-custom-catalogs/
 ---

 You can create custom catalogs of charts for use in Rancher. Custom catalogs are helpful for fast deployment of applications unique to your environment.
@@ -23,8 +25,8 @@ You can create custom catalogs of charts for use in Rancher. Custom catalogs are
 2. Click **Add Catalog**.
 3. Complete the form and click **Create**.

-**Result**: Your catalog is added to Rancher. 
+**Result**: Your catalog is added to Rancher.

 ## What's Next?

-Add native Helm charts, Rancher charts, or both to your repository. For more information, see [Customizing Charts]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/customizing-charts/).
+Add native Helm charts, Rancher charts, or both to your repository. For more information, see [Customizing Charts]({{< baseurl >}}/rancher/v2.x/en/catalog-and-charts/customizing-charts/).
@@ -1,6 +1,8 @@
 ---
 title: Customizing Charts
-weight: 75
+weight: 4020
+aliases:
+  - /rancher/v2.x/en/tasks/global-configuration/catalog/customizing-charts/
 ---

 Before you can deploy customized catalog apps using Rancher, you must add charts to the GitHub repository serving as your custom catalog.
@@ -11,7 +13,7 @@ The custom catalog can contain native Helm charts, Rancher charts, or a combinat

 >- Recommended: Read [Catalogs and Charts]({{< baseurl >}}/rancher/v2.x/en/concepts/catalogs).
 >- Create a GitHub repository to serve as your custom catalog.
->- Complete [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/adding-custom-catalogs).
+>- Complete [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/catalog-and-charts/adding-custom-catalogs).

 >**Note:** Customization of Helm charts takes place outside of the Rancher UI.

@@ -19,7 +21,7 @@ The custom catalog can contain native Helm charts, Rancher charts, or a combinat

    Rancher requires this directory structure, although `app-readme.md` and `questions.yml` are optional.

-    >**Tip:** 
+    >**Tip:**
    >
    >- To begin customizing a chart, copy one from either the [Rancher Library](https://github.com/rancher/charts) or the [Helm Stable](https://github.com/kubernetes/charts/tree/master/stable).
    >- For a complete walk through of developing charts, see the upstream Helm chart [developer reference](https://docs.helm.sh/developing_charts/).
@@ -1,21 +1,23 @@
 ---
 title: Enabling Default Catalogs
-weight: 25
+weight: 4005
+aliases:
+  - /rancher/v2.x/en/tasks/global-configuration/catalog/enabling-default-catalogs/
 ---

-Out-of-the-box, you can enable several different catalog repositories to simplify deployment of applications. 
+Out-of-the-box, you can enable several different catalog repositories to simplify deployment of applications.

 1. From the **Global** view, choose **Catalogs** from the main menu.
 2. Toggle the default catalogs that you want use to a setting of **Enabled**. The [default catalogs]({{< baseurl >}}/rancher/v2.x/en/concepts/catalogs/#catalog-types) are:
-    
+
    - **Library**
    - **Helm Stable**
    - **Helm Incubator**

-    >**Note:** If you want to use a custom catalog, see [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/adding-custom-catalogs) instead of this topic.
+    >**Note:** If you want to use a custom catalog, see [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/catalog-and-charts/adding-custom-catalogs) instead of this topic.

 **Result:** The chosen catalogs are enabled. Wait a few minutes for Rancher to replicate the catalog charts. When replication completes, you'll be able to see them in any of your projects by selecting **Catalog Apps** from the main menu.

 ## What's Next?

-Deploy catalog applications to your cluster nodes. For more information, see [Launching a Catalog App]({{< baseurl >}}/rancher/v2.x/en/tasks/projects/launch-a-catalog-app).
+Deploy catalog applications to your cluster nodes. For more information, see [Launching a Catalog App]({{< baseurl >}}/rancher/v2.x/en/tasks/projects/launch-a-catalog-app).
@@ -0,0 +1,4 @@
+---
+title: Launching Catalog Applications
+weight: 4010
+---
@@ -1,6 +1,8 @@
 ---
 title: Rancher CLI
-weight: 1
+weight: 6000
+aliases:
+  - /rancher/v2.x/en/concepts/cli-configuration/
 ---

 Rancher CLI (Command Line Interface) is a unified tool that you can use to interact with Rancher. With this tool, you can operate Rancher using a command line rather than the GUI.
@@ -14,7 +16,7 @@ The binary can be downloaded directly from the UI. The link can be found in the
 After you download the Rancher CLI, you need to make a few configurations. Rancher CLI requires:

 - Your [Rancher Server URL]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/server-url), which is used to connect to Rancher Server.
- An API Bearer Token, which is used to authenticate with Rancher. For more information about obtaining a Bearer Token, see [Creating an API Key]({{< baseurl >}}/rancher/v2.x/en/tasks/user-settings/api-keys/).
+- An API Bearer Token, which is used to authenticate with Rancher. For more information about obtaining a Bearer Token, see [Creating an API Key]({{< baseurl >}}/rancher/v2.x/en/user-settings/api-keys/).

 ### CLI Authentication

@@ -1,14 +0,0 @@
---
-title: API Keys
-weight: 2400
---
-
-Some users may want to access their Rancher clusters and projects through the Rancher API. Before you can access Rancher through the API, you must generate API keys so that you can authenticate with Rancher externally.
-
-Before you can use the Rancher CLI or write a program that calls the Rancher API, you must obtain API keys using the Rancher UI.
-
-### API Keys and User Authentication
-
-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/user-settings/api-keys/).
@@ -1,17 +0,0 @@
---
-title: Pipelines
-weight: 2350
---
-
-Pipelines help you automate the software delivery process. You can integrate Rancher with GitHub to create a pipeline.
-
-You can set up your pipeline to run a series of stages and steps to test your code and deploy it.
-
-<dl>
-	<dt>Pipelines</dt>
-	<dd>Contain a series of stages and steps. Out-of-the-box, the pipelines feature supports fan out and in capabilities.</dd>
-	<dt>Stages</dt>
-	<dd>Executed sequentially. The next stage will not execute until all of the steps within the stage execute.</dd>
-	<dt>Steps</dt>
-	<dd>Are executed in parallel within a stage. </dd>
-</dl>
@@ -1,10 +0,0 @@
---
-title: Logging
-weight: 2325
-draft: true
---
-
-
-## Related Links
-
-[Configuring Logging]({{< baseurl >}}/rancher/v2.x/en/tasks/logging/)
@@ -1,6 +1,8 @@
 ---
-  title: Contributing to Rancher
-  weight: 5001
+title: Contributing to Rancher
+weight: 9000
+aliases:
+  - /rancher/v2.x/en/faq/contributing/
 ---

 ### Repositories
@@ -1,6 +1,6 @@
 ---
 title: FAQ
-weight: 5000
+weight: 8000
 aliases:
  - /rancher/v2.x/en/about/
 ---
@@ -17,7 +17,7 @@ Rancher v2.0 is a complete container management platform built on 100% on Kubern

 #### Do you plan to implement upstream Kubernetes, or continue to work on your own fork?

-We're still going to provide our distribution when you select the default option of having us create your Kubernetes cluster, but it will be very close to upstream. 
+We're still going to provide our distribution when you select the default option of having us create your Kubernetes cluster, but it will be very close to upstream.

 #### Does this release mean that we need to re-train our support staff in Kubernetes?

@@ -1,6 +1,6 @@
 ---
  title: Technical
-  weight: 5000
+  weight: 8005
 ---

 ### How can I reset the admin password?
@@ -1,9 +0,0 @@
---
-title: Adding and Managing Alerts
-weight: 3575
-draft: true
---
-
-## Adding Alerts
-
-## Managing Alerts
@@ -1,11 +0,0 @@
---
-title: Adding and Managing Notifiers
-weight: 3550
-draft: true
---
-
-
-## Adding Notifiers
-
-## Managing Notifiers
-
@@ -1,9 +0,0 @@
---
-title: Enabling and Managing Cluster Logging
-weight: 3600
-draft: true
---
-
-## Enabling Cluster Logging
-
-## Managing Cluster Logging
@@ -1,9 +0,0 @@
---
-title: Enabling and Managing Pipelines for Projects
-weight: 3625
-draft: true
---
-
-## Enabling Pipelines for Projects
-
-## Managing Pipelines for Projects
@@ -1,5 +0,0 @@
---
-title: Global Configuration
-weight: 3025
---
-This section contains step-by-step instruction for configuring Rancher to work in your environment.
@@ -1,10 +0,0 @@
---
-title: Catalogs and Charts
-weight: 3026
---
-
-This section includes step-by-step instruction on how to configure default and custom catalogs.
-
- [Enabling Default Catalogs]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/enabling-default-catalogs)
- [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/adding-custom-catalogs)
- [Customizing Charts]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/customizing-charts)
@@ -1,27 +0,0 @@
---
-title: Node Drivers
-weight: 150
---
-
->**Prerequisites:** To create, edit, or delete drivers, you need _one_ of the following permissions:
->
->- [Administrator Global Permissions]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/#global-permissions)
->- [Custom Global Permissions]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/#custom-global-permissions) with the [Manage Node Drivers]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/#global-permissions-reference) role assigned.
-
-## Adding Custom Node Drivers
-
-If you create a cluster using a cloud provider that {{< product >}} doesn't support out-of-the-box, you may need to add the provider's drivers (or create them yourself) so that your nodes function properly.
-
-1.	From the **Global** view, select **Node Drivers** from the main menu.
-
-2.	Click **Add Node Driver**.
-
-3.	Complete the **Add Node Driver** form. Then click **Create**.
-
-## Activating Node Drivers
-
-Using the **Custom** option, you can create a cluster using virtually any cloud provider. However, by default, {{< product >}} only activates drivers for the most popular cloud providers. If you want to use another provider, you'll have to activate their drivers.
-
-1.	From the **Global** view, select **Node Drivers** from the main menu.
-
-2.	Select the inactive drivers that you want to use. Then click **Add Node Driver**.
@@ -1,7 +0,0 @@
---
-title: Password Reset
-weight: 75
-draft: true
---
-
-Content here.
@@ -0,0 +1,4 @@
+---
+title: Rancher Tools
+weight: 5000
+---
@@ -1,6 +1,8 @@
 ---
 title: Logging
-weight: 3725
+weight: 5015
+aliases:
+  - /rancher/v2.x/en/tasks/logging/
 ---

 Rancher has the capability to push out cluster and project logs to an external
@@ -1,6 +1,8 @@
 ---
 title: Splunk
 weight: 3725
+aliases:
+  - /rancher/v2.x/en/tasks/logging/splunk/
 ---

 The following guide will demonstrate how to monitor your container
@@ -1,7 +1,6 @@
 ---
-title: Alerts and Notifiers
-weight: 2300
-draft: true
+title:  Notifiers and Alerts
+weight: 5010
 ---

 Alerts and notifications are built on top of the [Prometheus Alertmanager](https://prometheus.io/docs/alerting/alertmanager/). Leveraging these tools, Rancher is able to provide the first step in notifications for events operators and application owners need to know about.
@@ -1,7 +1,24 @@
 ---
 title:  Pipelines
-weight: 3700
+weight: 5005
+aliases:
+  - /rancher/v2.x/en/concepts/ci-cd-pipelines/
+  - /rancher/v2.x/en/tasks/pipelines/
 ---
+
+Pipelines help you automate the software delivery process. You can integrate Rancher with GitHub to create a pipeline.
+
+You can set up your pipeline to run a series of stages and steps to test your code and deploy it.
+
+<dl>
+	<dt>Pipelines</dt>
+	<dd>Contain a series of stages and steps. Out-of-the-box, the pipelines feature supports fan out and in capabilities.</dd>
+	<dt>Stages</dt>
+	<dd>Executed sequentially. The next stage will not execute until all of the steps within the stage execute.</dd>
+	<dt>Steps</dt>
+	<dd>Are executed in parallel within a stage. </dd>
+</dl>
+
 ## Enabling CI Pipelines

 1. Select cluster from drop down.
@@ -1,13 +1,15 @@
 ---
 title: User Settings
-weight: 3725
+weight: 7000
+aliases:
+  - /rancher/v2.x/en/tasks/user-settings/
 ---

 Within Rancher, each user has a number of settings associated with their login: personal preferences, API keys, etc. You can configure these settings by choosing from the **User Settings** menu. You can open this menu by clicking your avatar, located within the main menu.

 The available user settings are:

- [API & Keys]({{< baseurl >}}/rancher/v2.x/en/tasks/user-settings/api-keys/)
+- [API & Keys]({{< baseurl >}}/rancher/v2.x/en/user-settings/api-keys/)

 <!-- - Node Templates

@@ -1,8 +1,20 @@
 ---
 title: Creating an API Key
-weight: 3726
+weight: 7005
+aliases:
+  - /rancher/v2.x/en/concepts/api-keys/
+  - /rancher/v2.x/en/tasks/user-settings/api-keys/
 ---

+Some users may want to access their Rancher clusters and projects through the Rancher API. Before you can access Rancher through the API, you must generate API keys so that you can authenticate with Rancher externally.
+
+Before you can use the Rancher CLI or write a program that calls the Rancher API, you must obtain API keys using the Rancher UI.
+
+### API Keys and User Authentication
+
+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.
+
+### Creating an API Key
 Create a Rancher API key so that other applications can make requests to the Rancher API. You can create API keys using the Rancher UI.

 1. From any Rancher view, select **User Avatar** > **API & Keys** from the menu on the upper-right.
@@ -0,0 +1,5 @@
+---
+title: Managing Node Templates
+weight: 7010
+draft: true
+---
@@ -1,5 +1,5 @@
 ---
 title: User Preferences
-weight: 3728
+weight: 7010
 draft: true
 ---