airship/images
Code Issues Proposed changes

Minor documentation fixes

Browse Source 
Change-Id: If3c1abb34dcde12d8e704dbc60b64f5d19efd13a
This commit is contained in:
Ian Howell 2020-07-06 12:54:14 -05:00
parent 116eb2cc93
commit 9f2d5bfb20
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
helm-chart-collator/README.md
View File

@ -11,7 +11,7 @@ Charts can be sourced from various locations. Each entry must be recorded in a
user-defined file before building the image. When the list of charts has been created, user-defined file before building the image. When the list of charts has been created,
the `build-image.sh` script can be used to create the image via the command: the `build-image.sh` script can be used to create the image via the command:
``` ```shell
./build-image.sh $CHARTSFILE ./build-image.sh $CHARTSFILE
``` ```
@ -25,7 +25,6 @@ heading. Each listing must include the following:
* `name`: The name of the desired chart (e.g. `mariadb`) * `name`: The name of the desired chart (e.g. `mariadb`)
* `version`: The version of the desired chart (e.g. `7.3.14`) * `version`: The version of the desired chart (e.g. `7.3.14`)
### Charts from Git Repos ### Charts from Git Repos
A Chart can be pulled and packaged from a git repo by listing it under the `git_repos` A Chart can be pulled and packaged from a git repo by listing it under the `git_repos`
@ -54,6 +53,7 @@ require the following:
## Example ## Example
The following shows an example file for including various helm charts: The following shows an example file for including various helm charts:
* rook-ceph as a tarball from a git repo * rook-ceph as a tarball from a git repo
* mariadb from the helm stable repo * mariadb from the helm stable repo
* rook-ceph from the rook repo * rook-ceph from the rook repo
@ -61,7 +61,7 @@ The following shows an example file for including various helm charts:
* keystone from the openstack-helm git repo * keystone from the openstack-helm git repo
* The helm-toolkit is also pulled, since it is a dependency of keystone * The helm-toolkit is also pulled, since it is a dependency of keystone
``` ```yaml
tarred_charts: tarred_charts:
- url: https://github.com/project-azorian/rook-ceph-aio/raw/master/rook-ceph-aio/charts/rook-ceph-0.0.1.tgz - url: https://github.com/project-azorian/rook-ceph-aio/raw/master/rook-ceph-aio/charts/rook-ceph-0.0.1.tgz
helm_repos: helm_repos:
@ -94,6 +94,6 @@ git_repos:
Once this file has been created, the image can be built with the following: Once this file has been created, the image can be built with the following:
``` ```yaml
./build-image.sh charts.yaml ./build-image.sh charts.yaml
``` ```