diff options
| author | danielgruesso <dgruesso@gitlab.com> | 2018-10-23 19:42:01 -0400 |
|---|---|---|
| committer | danielgruesso <dgruesso@gitlab.com> | 2018-10-23 19:42:01 -0400 |
| commit | c265fc25f7d3664d71763767d18d3b02ab83cb03 (patch) | |
| tree | ae71546ef94998d9a5119d6dcfc8b79ecd8104cb | |
| parent | 742f8d64547c3e922afd8cb9bd2e5e64ae155924 (diff) | |
| download | gitlab-ce-c265fc25f7d3664d71763767d18d3b02ab83cb03.tar.gz | |
Add first draft for runbook docs
| -rw-r--r-- | doc/README.md | 1 | ||||
| -rw-r--r-- | doc/topics/runbooks/index.md | 36 |
2 files changed, 37 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md index 03371226041..f6c1a4f1d88 100644 --- a/doc/README.md +++ b/doc/README.md @@ -165,6 +165,7 @@ configuration. Then customize everything from buildpacks to CI/CD. - [Deployment of Helm, Ingress, and Prometheus on Kubernetes](user/project/clusters/index.md#installing-applications) - [Protected variables](ci/variables/README.md#protected-variables) - [Easy creation of Kubernetes clusters on GKE](user/project/clusters/index.md#adding-and-creating-a-new-gke-cluster-via-gitlab) +- [Executable Runbooks](topics/runbooks/index.md) ### Monitor diff --git a/doc/topics/runbooks/index.md b/doc/topics/runbooks/index.md new file mode 100644 index 00000000000..f55d2868f20 --- /dev/null +++ b/doc/topics/runbooks/index.md @@ -0,0 +1,36 @@ +# 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 |