summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordanielgruesso <dgruesso@gitlab.com>2018-10-26 12:09:26 -0400
committerdanielgruesso <dgruesso@gitlab.com>2018-10-26 12:09:26 -0400
commit71e6928367b4f21a7cbfd4aff773814b61739ade (patch)
treef5fafdf588f9f416cfa5760551cfe6dd514cc848
parentc265fc25f7d3664d71763767d18d3b02ab83cb03 (diff)
downloadgitlab-ce-71e6928367b4f21a7cbfd4aff773814b61739ade.tar.gz
relocate runbooks folder under clusters
-rw-r--r--doc/topics/runbooks/index.md36
-rw-r--r--doc/user/project/clusters/runbooks/index.md49
2 files changed, 49 insertions, 36 deletions
diff --git a/doc/topics/runbooks/index.md b/doc/topics/runbooks/index.md
deleted file mode 100644
index f55d2868f20..00000000000
--- a/doc/topics/runbooks/index.md
+++ /dev/null
@@ -1,36 +0,0 @@
-# Runbooks
-
-Runbooks are a collection of documented procedures that explain how to
-carry out a particular process, be it starting, stopping, debugging,
-or troubleshooting a particular system.
-
-## Overview
-
-Historically, runbooks took the form of a decision tree or a detailed
-step-by-step guide depending on the condition or system.
-
-Modern implementations have introduced the concept of an "executable
-runbooks", where along with a well define process, operators can execute
-code blocks or database queries against a given environment.
-
-## Nurtch Executable Runbooks
-
-> [Introduced][ce-45912] in GitLab 11.4.
-
-The JupyterHub app offered via GitLab’s Kubernetes integration now ships
-with Nurtch’s Rubix library, providing a simple way to create DevOps
-runbooks. A sample runbook is provided, showcasing common operations.
-
-The below video provides an overview of how this is acomplished in GitLab.
-
-<iframe width="560" height="315" src="https://www.youtube.com/embed/Q_OqHIIUPjE"
-frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
-
-## Requirements
-
-To create an executable runbook, you will need:
-
-1. **Kubernetes Cluster** -
-1. **Helm Tiller** -
-1. **Ingress** -
-1. **JupyterHub** - \ No newline at end of file
diff --git a/doc/user/project/clusters/runbooks/index.md b/doc/user/project/clusters/runbooks/index.md
new file mode 100644
index 00000000000..9dea0379c99
--- /dev/null
+++ b/doc/user/project/clusters/runbooks/index.md
@@ -0,0 +1,49 @@
+# Runbooks
+
+Runbooks are a collection of documented procedures that explain how to
+carry out a particular process, be it starting, stopping, debugging,
+or troubleshooting a particular system.
+
+## Overview
+
+Historically, runbooks took the form of a decision tree or a detailed
+step-by-step guide depending on the condition or system.
+
+Modern implementations have introduced the concept of an "executable
+runbooks", where along with a well define process, operators can execute
+code blocks or database queries against a given environment.
+
+## Nurtch Executable Runbooks
+
+> [Introduced](ce-45912) in GitLab 11.4.
+
+The JupyterHub app offered via GitLab’s Kubernetes integration now ships
+with Nurtch’s Rubix library, providing a simple way to create DevOps
+runbooks. A sample runbook is provided, showcasing common operations.
+
+**<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
+Watch this [video](https://www.youtube.com/watch?v=Q_OqHIIUPjE)
+for an overview of how this is acomplished in GitLab!**
+
+## Requirements
+
+To create an executable runbook, you will need:
+
+1. **Kubernetes** - A Kubernetes cluster is required to deploy the rest of the applications.
+ The simplest way to get started is to add a cluster using [GitLab's GKE integration](https://docs.gitlab.com/ee/user/project/clusters/#adding-and-creating-a-new-gke-cluster-via-gitlab).
+1. **Helm Tiller** - Helm is a package manager for Kubernetes and is required to install
+ all the other applications. It is installed in its own pod inside the cluster which
+ can run the helm CLI in a safe environment.
+1. **Ingress** - Ingress can provide load balancing, SSL termination, and name-based
+ virtual hosting. It acts as a web proxy for your applications.
+1. **JupyterHub** - JupyterHub is a multi-user service for managing notebooks across
+ a team. Jupyter Notebooks provide a web-based interactive programming environment
+ used for data analysis, visualization, and machine learning.
+
+## Nurtch
+
+Nurtch is the company behind the [Rubix library](https://github.com/Nurtch/rubix). Rubix is
+an open-source python library that makes it easy to perform common DevOps tasks inside Jupyter Notebooks.
+Tasks such as plotting Cloudwatch metrics and rolling your ECS/Kubernetes app are simplified
+down to a couple of lines of code. Check the [Nurtch Documentation](http://docs.nurtch.com/en/latest)
+for more information. \ No newline at end of file