From 71e6928367b4f21a7cbfd4aff773814b61739ade Mon Sep 17 00:00:00 2001 From: danielgruesso Date: Fri, 26 Oct 2018 12:09:26 -0400 Subject: relocate runbooks folder under clusters --- doc/topics/runbooks/index.md | 36 --------------------- doc/user/project/clusters/runbooks/index.md | 49 +++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 36 deletions(-) delete mode 100644 doc/topics/runbooks/index.md create mode 100644 doc/user/project/clusters/runbooks/index.md 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. - - - -## 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. + +** +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 -- cgit v1.2.3