docs: add "Installation" section

This commit is contained in:
Chi-En Wu
2020-04-24 10:17:57 +08:00
parent 13b0e663b8
commit 4e227b9daa

View File

@ -8,6 +8,7 @@ It provides utilities that reflect best practices of Kubernetes chart developmen
## Contents ## Contents
- [Installation](#installation)
- [Resource Kinds](#resource-kinds) - [Resource Kinds](#resource-kinds)
* [`common.configMap`](#commonconfigmap) * [`common.configMap`](#commonconfigmap)
* [`common.cronJob`](#commoncronjob) * [`common.cronJob`](#commoncronjob)
@ -33,6 +34,25 @@ It provides utilities that reflect best practices of Kubernetes chart developmen
## Installation
To use the library chart, `common` should be listed in `dependencies` field in your `Chart.yaml`:
```yaml
dependencies:
- name: common
version: 0.2.0
repository: https://hahow-helm-charts.storage.googleapis.com/
```
Once you have defined dependencies, you should run the following command to download this chart into your `charts/` directory:
```shell
$ helm dependency update
```
## Resource Kinds ## Resource Kinds
Kubernetes defines a variety of resource kinds, from `Secret` to `StatefulSet`. We define some of the most common kinds in a way that lets you easily work with them. Kubernetes defines a variety of resource kinds, from `Secret` to `StatefulSet`. We define some of the most common kinds in a way that lets you easily work with them.
@ -1099,4 +1119,4 @@ serviceAccountName: release-name-mychart
--- ---
# if serviceAccount.create is false, the value will be "default" # if serviceAccount.create is false, the value will be "default"
serviceAccountName: default serviceAccountName: default
``` ```