From ff5fca8e3f00d68f995ea53ae87ff0a81102c75f Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Fri, 20 Apr 2018 10:03:25 -0700 Subject: [PATCH] Finishing Doc Skeleton --- .../alerts-and-notifiers} | 0 .../_index.md => concepts/api-keys.md} | 0 content/rancher/concepts/architecture.md | 32 +++++++++++ .../_index.md => concepts/catalogs.md} | 0 .../_index.md => concepts/ci-cd-pipelines.md} | 0 content/rancher/concepts/clusters.md | 53 +++++++++++++++++++ .../rancher/concepts/global-configuration.md | 53 +++++++++++++++++++ .../_index.md => concepts/load-balancing.md} | 0 .../_index.md => concepts/logging.md} | 0 content/rancher/concepts/overview.md | 39 ++++++++++++++ content/rancher/concepts/projects.md | 25 +++++++++ content/rancher/concepts/resources.md | 25 +++++++++ content/rancher/concepts/service-discovery.md | 0 content/rancher/concepts/storage.md | 17 ++++++ content/rancher/concepts/volumes.md | 0 content/rancher/concepts/workloads.md | 17 ++++++ content/rancher/installation/index.md | 5 ++ .../installation/installation-checklist.md | 8 +++ .../server-installation/high-availability.md | 12 +++++ .../multi-node-installs/_index.md | 13 ----- .../single-node-installs.md | 16 ++++++ .../single-container-install.md | 28 ---------- .../rancher/tasks/clusters/adding-a-node.md | 16 ++++++ .../rancher/tasks/clusters/adding-alerts.md | 7 +++ .../adding-managing-cluster-members.md | 7 +++ .../tasks/clusters/adding-notifiers.md | 7 +++ .../rancher/tasks/clusters/adding-storage.md | 16 ++++++ .../clusters/adding-users-to-a-cluster.md | 7 +++ .../clusters/enabling-cluster-logging.md | 7 +++ .../enabling-pipelines-for-projects.md | 7 +++ .../using-kubectl-to-access-a-cluster.md | 15 ++++++ .../tasks/global-configuration/roles.md | 5 ++ content/rancher/tasks/miscellaneous.md | 17 ++++++ content/rancher/tasks/pipelines.md | 32 +++++++++++ content/rancher/tasks/projects.md | 46 ++++++++++++++++ content/rancher/tasks/workloads.md | 36 +++++++++++++ 36 files changed, 527 insertions(+), 41 deletions(-) rename content/rancher/{installation/server-installation/single-node-installs/_index.md => concepts/alerts-and-notifiers} (100%) rename content/rancher/{tasks/miscellaneous/_index.md => concepts/api-keys.md} (100%) create mode 100644 content/rancher/concepts/architecture.md rename content/rancher/{tasks/pipelines/_index.md => concepts/catalogs.md} (100%) rename content/rancher/{tasks/projects/_index.md => concepts/ci-cd-pipelines.md} (100%) create mode 100644 content/rancher/concepts/clusters.md create mode 100644 content/rancher/concepts/global-configuration.md rename content/rancher/{tasks/users/_index.md => concepts/load-balancing.md} (100%) rename content/rancher/{tasks/workloads/_index.md => concepts/logging.md} (100%) create mode 100644 content/rancher/concepts/overview.md create mode 100644 content/rancher/concepts/projects.md create mode 100644 content/rancher/concepts/resources.md create mode 100644 content/rancher/concepts/service-discovery.md create mode 100644 content/rancher/concepts/storage.md create mode 100644 content/rancher/concepts/volumes.md create mode 100644 content/rancher/concepts/workloads.md create mode 100644 content/rancher/installation/index.md create mode 100644 content/rancher/installation/installation-checklist.md create mode 100644 content/rancher/installation/server-installation/high-availability.md delete mode 100644 content/rancher/installation/server-installation/multi-node-installs/_index.md create mode 100644 content/rancher/installation/server-installation/single-node-installs.md delete mode 100644 content/rancher/installation/server-installation/single-node-installs/single-container-install.md create mode 100644 content/rancher/tasks/clusters/adding-a-node.md create mode 100644 content/rancher/tasks/clusters/adding-alerts.md create mode 100644 content/rancher/tasks/clusters/adding-managing-cluster-members.md create mode 100644 content/rancher/tasks/clusters/adding-notifiers.md create mode 100644 content/rancher/tasks/clusters/adding-storage.md create mode 100644 content/rancher/tasks/clusters/adding-users-to-a-cluster.md create mode 100644 content/rancher/tasks/clusters/enabling-cluster-logging.md create mode 100644 content/rancher/tasks/clusters/enabling-pipelines-for-projects.md create mode 100644 content/rancher/tasks/clusters/using-kubectl-to-access-a-cluster.md create mode 100644 content/rancher/tasks/miscellaneous.md create mode 100644 content/rancher/tasks/pipelines.md create mode 100644 content/rancher/tasks/projects.md create mode 100644 content/rancher/tasks/workloads.md diff --git a/content/rancher/installation/server-installation/single-node-installs/_index.md b/content/rancher/concepts/alerts-and-notifiers similarity index 100% rename from content/rancher/installation/server-installation/single-node-installs/_index.md rename to content/rancher/concepts/alerts-and-notifiers diff --git a/content/rancher/tasks/miscellaneous/_index.md b/content/rancher/concepts/api-keys.md similarity index 100% rename from content/rancher/tasks/miscellaneous/_index.md rename to content/rancher/concepts/api-keys.md diff --git a/content/rancher/concepts/architecture.md b/content/rancher/concepts/architecture.md new file mode 100644 index 00000000000..fba42cd72f6 --- /dev/null +++ b/content/rancher/concepts/architecture.md @@ -0,0 +1,32 @@ +--- +title: Rancher Architecture +draft: true +tags: [ "install" ] +layout: list +categories: + - "rancher" +--- + +# Rancher Architecture + +Coming Soon + +## Docker + +Coming Soon + +## Kubernetes + +Coming Soon + +### Master Components + +Coming Soon + +### Node Components + +Coming Soon + +### Rancher + +Coming Soon diff --git a/content/rancher/tasks/pipelines/_index.md b/content/rancher/concepts/catalogs.md similarity index 100% rename from content/rancher/tasks/pipelines/_index.md rename to content/rancher/concepts/catalogs.md diff --git a/content/rancher/tasks/projects/_index.md b/content/rancher/concepts/ci-cd-pipelines.md similarity index 100% rename from content/rancher/tasks/projects/_index.md rename to content/rancher/concepts/ci-cd-pipelines.md diff --git a/content/rancher/concepts/clusters.md b/content/rancher/concepts/clusters.md new file mode 100644 index 00000000000..220d1ab30a0 --- /dev/null +++ b/content/rancher/concepts/clusters.md @@ -0,0 +1,53 @@ +--- +title: Clusters +draft: true +layout: list +--- + +# Clusters + +Coming Soon + +## What's a Cluster? + +Coming Soon + +## Cluster Creation + +Coming Soon + +### Node Components + +Coming Soon + +#### etcd Requirements + +Coming Soon + +#### Control Requirements + +Coming Soon + +#### Worker Requirements and Best Practices + +Coming Soon + +### Cluster Providers + +Coming Soon + +#### RKE + +Coming Soon + +#### Cloud Cluster + +Coming Soon + +#### Import + +Coming Soon + +### Kubeconfig File + +Coming Soon diff --git a/content/rancher/concepts/global-configuration.md b/content/rancher/concepts/global-configuration.md new file mode 100644 index 00000000000..3056fa8c7b8 --- /dev/null +++ b/content/rancher/concepts/global-configuration.md @@ -0,0 +1,53 @@ +--- +title: Global Configuration +draft: true +layout: list +--- + +# Global Configuration + +Coming Soon + +## Authentication + +Coming Soon + +### External vs. Local Authentication + +Coming Soon + +## Users and Roles + +Coming Soon + +### Default Roles + +Coming Soon + +### Custom Roles + +Coming Soon + +### Membership + +Coming Soon + +## Rancher Server URL + +Coming Soon + +## Pod Security Policies + +Coming Soon + +### Best Practice: Set Pod Security as Cluster Level + +Coming Soon + +## Node Drivers + +Coming Soon + +## Node Templates + +Coming Soon diff --git a/content/rancher/tasks/users/_index.md b/content/rancher/concepts/load-balancing.md similarity index 100% rename from content/rancher/tasks/users/_index.md rename to content/rancher/concepts/load-balancing.md diff --git a/content/rancher/tasks/workloads/_index.md b/content/rancher/concepts/logging.md similarity index 100% rename from content/rancher/tasks/workloads/_index.md rename to content/rancher/concepts/logging.md diff --git a/content/rancher/concepts/overview.md b/content/rancher/concepts/overview.md new file mode 100644 index 00000000000..00e9f3c8def --- /dev/null +++ b/content/rancher/concepts/overview.md @@ -0,0 +1,39 @@ +--- +title: Rancher Overview +draft: true +layout: single +--- + +# Rancher Overview + +Coming Soon + +## What's Rancher? + +Coming Soon + +## What's New? + +Coming Soon + +## Why Rancher? + +Coming Soon + +### Ease of Use + +Coming Soon + +### RKE + +Coming Soon + +### Projects + +Coming Soon + +### Authentication + +Coming Soon + +### Access Control diff --git a/content/rancher/concepts/projects.md b/content/rancher/concepts/projects.md new file mode 100644 index 00000000000..8d7d96fc696 --- /dev/null +++ b/content/rancher/concepts/projects.md @@ -0,0 +1,25 @@ +--- +title: Projects +draft: true +layout: list +--- + +# Projects + +Coming Soon + +## What's a Project? + +Coming Soon + +### Authorization + +Coming Soon + +### Pod Security Policies + +Coming Soon + +## Namespaces + +Coming Soon diff --git a/content/rancher/concepts/resources.md b/content/rancher/concepts/resources.md new file mode 100644 index 00000000000..cf87ebd08d3 --- /dev/null +++ b/content/rancher/concepts/resources.md @@ -0,0 +1,25 @@ +--- +title: Resources +draft: true +layout: list +--- + +# Resources + +Coming Soon + +## Certificates + +Coming Soon + +## Configuration Maps + +Coming Soon + +## Registries + +Coming Soon + +## Secrets + +Coming Soon diff --git a/content/rancher/concepts/service-discovery.md b/content/rancher/concepts/service-discovery.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/content/rancher/concepts/storage.md b/content/rancher/concepts/storage.md new file mode 100644 index 00000000000..beede637f57 --- /dev/null +++ b/content/rancher/concepts/storage.md @@ -0,0 +1,17 @@ +--- +title: Storage +draft: true +layout: list +--- + +# Storage + +Coming Soon + +## Persistent Volumes + +Coming Soon + +## Storage Classes + +Coming Soon diff --git a/content/rancher/concepts/volumes.md b/content/rancher/concepts/volumes.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/content/rancher/concepts/workloads.md b/content/rancher/concepts/workloads.md new file mode 100644 index 00000000000..32a807b9a1d --- /dev/null +++ b/content/rancher/concepts/workloads.md @@ -0,0 +1,17 @@ +--- +title: Workloads +draft: true +layout: list +--- + +# Workloads + +Coming Soon + +## Workload Types + +Coming Soon + +## Service Types + +Coming Soon diff --git a/content/rancher/installation/index.md b/content/rancher/installation/index.md new file mode 100644 index 00000000000..dac3acfc63f --- /dev/null +++ b/content/rancher/installation/index.md @@ -0,0 +1,5 @@ +--- +title: Installation +layout: single +weight: +--- diff --git a/content/rancher/installation/installation-checklist.md b/content/rancher/installation/installation-checklist.md new file mode 100644 index 00000000000..3cbeb5130a1 --- /dev/null +++ b/content/rancher/installation/installation-checklist.md @@ -0,0 +1,8 @@ +--- +title: Installation Objectives +layout: single +weight: +--- +# Installation Objectives + +Coming Soon diff --git a/content/rancher/installation/server-installation/high-availability.md b/content/rancher/installation/server-installation/high-availability.md new file mode 100644 index 00000000000..4474ef5caf6 --- /dev/null +++ b/content/rancher/installation/server-installation/high-availability.md @@ -0,0 +1,12 @@ +--- +title: High-Availability Installation +draft: true +tags: [ "install" ] +layout: list +categories: + - "rancher" +--- + +# High-Availability Installation (a.k.a. Multi-Node Installation) + +## Installing Using RKE diff --git a/content/rancher/installation/server-installation/multi-node-installs/_index.md b/content/rancher/installation/server-installation/multi-node-installs/_index.md deleted file mode 100644 index 673507c7dca..00000000000 --- a/content/rancher/installation/server-installation/multi-node-installs/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Multi-Node Installation -draft: true -tags: [ "tag", "tag", "tag", "tag" ] -layout: single-left -categories: - - "" - - "" ---- - -# Multi-Node Installation - -## Part 1: Launch Using RKE diff --git a/content/rancher/installation/server-installation/single-node-installs.md b/content/rancher/installation/server-installation/single-node-installs.md new file mode 100644 index 00000000000..0af53cbcb6a --- /dev/null +++ b/content/rancher/installation/server-installation/single-node-installs.md @@ -0,0 +1,16 @@ +--- +title: Single Node Installation +draft: true +tags: [ "install" ] +layout: list +categories: + - "rancher" +--- + +# Single-Node Installation + +## Option 1: Single Container Install + +## Option 2: Single Container Install with etcd + +## Option 3: Local Cluster Install diff --git a/content/rancher/installation/server-installation/single-node-installs/single-container-install.md b/content/rancher/installation/server-installation/single-node-installs/single-container-install.md deleted file mode 100644 index 3b6baf9b26b..00000000000 --- a/content/rancher/installation/server-installation/single-node-installs/single-container-install.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Single Node Installation -draft: true -tags: [ "tag", "tag", "tag", "tag" ] -layout: single-left -categories: - - "" - - "" ---- -# Single Container Install - -{{< prereq_install >}} - -## To Install Rancher Server - -Install {{< product >}} by connecting to your Linux host and running the single container installation command. - -1. Log in to your Linux host using your preferred shell, such as PuTTy or a remote Terminal connection. - -2. From your shell, enter the following command: - - ``` - $ sudo docker run -d --restart=unless-stopped -p 80:80 -p 443:443 rancher/server - ``` - - >**Tip:** You can install different versions of {{< product >}} Server by using different [Server Tags](../../server-tags/). - -**Result:** Rancher is installed. diff --git a/content/rancher/tasks/clusters/adding-a-node.md b/content/rancher/tasks/clusters/adding-a-node.md new file mode 100644 index 00000000000..a7b436951fb --- /dev/null +++ b/content/rancher/tasks/clusters/adding-a-node.md @@ -0,0 +1,16 @@ +--- +title: Adding a Node +layout: single +--- + +# Adding a Node + +Coming Soon + +## By Node/Cloud Provider + +Coming Soon + +## By Custom + +Coming Soon diff --git a/content/rancher/tasks/clusters/adding-alerts.md b/content/rancher/tasks/clusters/adding-alerts.md new file mode 100644 index 00000000000..223ee652d2c --- /dev/null +++ b/content/rancher/tasks/clusters/adding-alerts.md @@ -0,0 +1,7 @@ +--- +title: Adding Alerts +layout: single +--- +# Adding Alerts + +Coming Soon diff --git a/content/rancher/tasks/clusters/adding-managing-cluster-members.md b/content/rancher/tasks/clusters/adding-managing-cluster-members.md new file mode 100644 index 00000000000..9da55e11da8 --- /dev/null +++ b/content/rancher/tasks/clusters/adding-managing-cluster-members.md @@ -0,0 +1,7 @@ +--- +title: Adding/Managing Cluster Members +layout: single +--- +# Adding/Managing Cluster Members + +Coming Soon diff --git a/content/rancher/tasks/clusters/adding-notifiers.md b/content/rancher/tasks/clusters/adding-notifiers.md new file mode 100644 index 00000000000..1dc7e4c7bb2 --- /dev/null +++ b/content/rancher/tasks/clusters/adding-notifiers.md @@ -0,0 +1,7 @@ +--- +title: Adding Notifiers +layout: single +--- +# Adding Notifiers + +Coming Soon diff --git a/content/rancher/tasks/clusters/adding-storage.md b/content/rancher/tasks/clusters/adding-storage.md new file mode 100644 index 00000000000..e684337c647 --- /dev/null +++ b/content/rancher/tasks/clusters/adding-storage.md @@ -0,0 +1,16 @@ +--- +title: Adding Storage +layout: single +--- + +# Adding Storage + +Coming Soon + +## Adding Persistent Volumes + +Coming Soon + +##Adding Storage Classes + +Coming Soon diff --git a/content/rancher/tasks/clusters/adding-users-to-a-cluster.md b/content/rancher/tasks/clusters/adding-users-to-a-cluster.md new file mode 100644 index 00000000000..f686aeb2bea --- /dev/null +++ b/content/rancher/tasks/clusters/adding-users-to-a-cluster.md @@ -0,0 +1,7 @@ +--- +title: Adding Users to a Cluster +layout: single +--- +# Adding Users to a Cluster + +Coming Soon diff --git a/content/rancher/tasks/clusters/enabling-cluster-logging.md b/content/rancher/tasks/clusters/enabling-cluster-logging.md new file mode 100644 index 00000000000..335d2784e23 --- /dev/null +++ b/content/rancher/tasks/clusters/enabling-cluster-logging.md @@ -0,0 +1,7 @@ +--- +title: Enabling Cluster Logging +layout: single +--- +# Enabling Cluster Logging + +Coming Soon diff --git a/content/rancher/tasks/clusters/enabling-pipelines-for-projects.md b/content/rancher/tasks/clusters/enabling-pipelines-for-projects.md new file mode 100644 index 00000000000..9bdd9b1c2e0 --- /dev/null +++ b/content/rancher/tasks/clusters/enabling-pipelines-for-projects.md @@ -0,0 +1,7 @@ +--- +title: Enabling Pipelines for Projects +layout: single +--- +#Enabling Pipelines for Projects + +Coming Soon diff --git a/content/rancher/tasks/clusters/using-kubectl-to-access-a-cluster.md b/content/rancher/tasks/clusters/using-kubectl-to-access-a-cluster.md new file mode 100644 index 00000000000..d04acb8242f --- /dev/null +++ b/content/rancher/tasks/clusters/using-kubectl-to-access-a-cluster.md @@ -0,0 +1,15 @@ +--- +title: Using kubectl to Access a Cluster +layout: single +--- +# Using kubectl to Access a Cluster + +Coming Soon + +## Using kubectl Shell + +Coming Soon + +## Configuring My kubectl + +Coming Soon diff --git a/content/rancher/tasks/global-configuration/roles.md b/content/rancher/tasks/global-configuration/roles.md index 52b0abc0e42..71416d83c05 100644 --- a/content/rancher/tasks/global-configuration/roles.md +++ b/content/rancher/tasks/global-configuration/roles.md @@ -1,3 +1,8 @@ +--- +title: Roles +layout: single +--- + # Roles While _users_ determine who can log into Rancher, _roles_ determine which Kubernetes API endpoints and Rancher roles that a user can access after login. In other words, roles determine the user's _permissions_ when using Rancher. diff --git a/content/rancher/tasks/miscellaneous.md b/content/rancher/tasks/miscellaneous.md new file mode 100644 index 00000000000..27922186e20 --- /dev/null +++ b/content/rancher/tasks/miscellaneous.md @@ -0,0 +1,17 @@ +--- +title: Miscellaneous +layout: single +weight: +--- + +# Miscellaneous + +Coming Soon + +## Deleting a Node Template + +Coming Soon + +## Creating an API Key + +Coming Soon diff --git a/content/rancher/tasks/pipelines.md b/content/rancher/tasks/pipelines.md new file mode 100644 index 00000000000..4075516738d --- /dev/null +++ b/content/rancher/tasks/pipelines.md @@ -0,0 +1,32 @@ +--- +title: Pipelines +layout: single +weight: +--- +# Pipelines + +Coming Soon + +## Creating CI Pipelines + +Coming Soon + +## Creating a New Stage + +Coming Soon + +## Creating a New Step + +Coming Soon + +### Adding a Build Script + +Coming Soon + +### Publishing an Image + +Coming Soon + +## Importing a Pipeline From YAML + +Coming Soon diff --git a/content/rancher/tasks/projects.md b/content/rancher/tasks/projects.md new file mode 100644 index 00000000000..6a2e619d379 --- /dev/null +++ b/content/rancher/tasks/projects.md @@ -0,0 +1,46 @@ +--- +title: Projects +layout: single +weight: +--- +# Projects + +Coming Soon + +## Creating a Project + +Coming Soon + +## Switching Projects + +Coming Soon + +## Adding / Managing Project Members + +Coming Soon + +## Adding SSL Certificates + +Coming Soon + +## Adding Configuration Maps + +Coming Soon + +## Enabling Project Logging + +Coming Soon + +## Adding Project Alerts + +Coming Soon + +## Using Private Registries + +Coming Soon + +## Adding a Secret + +Coming Soon + + diff --git a/content/rancher/tasks/workloads.md b/content/rancher/tasks/workloads.md new file mode 100644 index 00000000000..0915c247804 --- /dev/null +++ b/content/rancher/tasks/workloads.md @@ -0,0 +1,36 @@ +--- +title: Workloads +layout: single +weight: +--- +# Workloads + +Coming Soon + +## Deploying Workloads + +Coming Soon + +## Upgrading Workloads + +Coming Soon + +## Rolling Back Workloads + +Coming Soon + +## Adding a Sidecar + +Coming Soon + +## Adding Ingress + +Coming Soon + +## Adding a DNS Record + +Coming Soon + +## Adding a Persisten Volume Claim + +Coming Soon