diff options
| -rw-r--r-- | README.md | 16 | ||||
| -rw-r--r-- | docs/cluster-config.md | 13 | ||||
| -rw-r--r-- | docs/resource-sets.md | 17 | ||||
| -rw-r--r-- | docs/templates.md | 13 | ||||
| -rw-r--r-- | docs/tips-and-tricks.md | 10 |
5 files changed, 68 insertions, 1 deletions
diff --git a/README.md b/README.md index d287f6001bea..17e0a6d24104 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,22 @@ In my experience this is often enough and more complex solutions such as Check out a Kontemplate setup example and the feature list below! +<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc --> +**Table of Contents** + +- [Kontemplate - A simple Kubernetes templater](#kontemplate---a-simple-kubernetes-templater) + - [Features](#features) + - [Example](#example) + - [Installation](#installation) + - [Homebrew](#homebrew) + - [Arch Linux](#arch-linux) + - [Building repeatably from source](#building-repeatably-from-source) + - [Building from source](#building-from-source) + - [Usage](#usage) + - [Contributing](#contributing) + +<!-- markdown-toc end --> + ## Features * [Simple, yet powerful templates](docs/templates.md) diff --git a/docs/cluster-config.md b/docs/cluster-config.md index 3bc59a63057f..a87c3fb2a0be 100644 --- a/docs/cluster-config.md +++ b/docs/cluster-config.md @@ -31,6 +31,19 @@ include: - name: pub-service ``` +<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc --> +**Table of Contents** + +- [Cluster configuration](#cluster-configuration) + - [Fields](#fields) + - [`context`](#context) + - [`global`](#global) + - [`import`](#import) + - [`include`](#include) + - [External variables](#external-variables) + +<!-- markdown-toc end --> + ## Fields This is documentation for the individual fields in a cluster context file. diff --git a/docs/resource-sets.md b/docs/resource-sets.md index 1d5eeabc5ac4..94d402f9a75c 100644 --- a/docs/resource-sets.md +++ b/docs/resource-sets.md @@ -5,6 +5,23 @@ Resource sets are collections of Kubernetes resources that should be passed to ` Technically a resource set is simply a folder with a few YAML and/or JSON templates in it. +<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc --> +**Table of Contents** + +- [Resource Sets](#resource-sets) +- [Creating resource sets](#creating-resource-sets) + - [Default variables](#default-variables) +- [Including resource sets](#including-resource-sets) + - [Fields](#fields) + - [`name`](#name) + - [`path`](#path) + - [`values`](#values) + - [`include`](#include) + - [Multiple includes](#multiple-includes) + - [Nesting resource sets](#nesting-resource-sets) + - [Caveats](#caveats) + +<!-- markdown-toc end --> # Creating resource sets diff --git a/docs/templates.md b/docs/templates.md index 8dff28dd1c38..8bcc2c7f5665 100644 --- a/docs/templates.md +++ b/docs/templates.md @@ -12,6 +12,19 @@ or in which conditionals are evaluated for more complex template logic. It is recommended that you check out the Golang [documentation][] for the templating engine in addition to the cherry-picked features listed here. +<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc --> +**Table of Contents** + +- [Kontemplate templates](#kontemplate-templates) + - [Basic variable interpolation](#basic-variable-interpolation) + - [Example:](#example) + - [Template functions](#template-functions) + - [Examples:](#examples) + - [Conditionals & ranges](#conditionals--ranges) + - [Caveats](#caveats) + +<!-- markdown-toc end --> + ## Basic variable interpolation The basic template format uses `{{ .variableName }}` as the interpolation format. diff --git a/docs/tips-and-tricks.md b/docs/tips-and-tricks.md index debf014cf684..73328fa0a1f7 100644 --- a/docs/tips-and-tricks.md +++ b/docs/tips-and-tricks.md @@ -1,6 +1,14 @@ Kontemplate tips & tricks ========================= +<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc --> +**Table of Contents** + +- [Kontemplate tips & tricks](#kontemplate-tips--tricks) + - [Update Deployments when ConfigMaps change](#update-deployments-when-configmaps-change) + - [direnv & pass](#direnv--pass) + +<!-- markdown-toc end --> ## Update Deployments when ConfigMaps change @@ -64,4 +72,4 @@ per project, it is easy to use [direnv][] to switch to the correct `PASSWORD_STORE_DIR` variable when entering the folder. [not currently]: https://github.com/kubernetes/kubernetes/issues/22368 -[direnv]: https://direnv.net/ \ No newline at end of file +[direnv]: https://direnv.net/ |