airship
/
armada
Code Issues Proposed changes

Fix documentation 

This patch set fixes the indentation of the sample yaml's in the doc,
also fixes one typo.

Change-Id: I5d2c761031d724754a734e6e7bee5709aea5bd01
Signed-off-by: Tin Lam <tin@irrational.io>
This commit is contained in:
Tin Lam 2018-03-18 21:38:19 -05:00
parent fb83c2dc4f
commit 79cfa7e1cf
1 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
docs/source/operations/guide-build-armada-yaml.rst
View File

@ -32,12 +32,12 @@ Example
--- ---
schema: armada/Manifest/v1 schema: armada/Manifest/v1
metadata: metadata:
schema: metadata/Document/v1 schema: metadata/Document/v1
name: simple-armada name: simple-armada
data: data:
release_prefix: armada release_prefix: armada
chart_groups: chart_groups:
- chart_group - chart_group
armada/ChartGroup/v1 armada/ChartGroup/v1
@ -63,14 +63,14 @@ Example
--- ---
schema: armada/ChartGroup/v1 schema: armada/ChartGroup/v1
metadata: metadata:
schema: metadata/Document/v1 schema: metadata/Document/v1
name: blog-group name: blog-group
data: data:
description: Deploys Simple Service description: Deploys Simple Service
sequenced: False sequenced: False
chart_group: chart_group:
- chart - chart
- chart - chart
armada/Chart/v1 armada/Chart/v1
--------------- ---------------
@ -93,7 +93,7 @@ Chart
+-----------------+----------+---------------------------------------------------------------------------------------+ +-----------------+----------+---------------------------------------------------------------------------------------+
| namespace | string | namespace of your chart | | namespace | string | namespace of your chart |
+-----------------+----------+---------------------------------------------------------------------------------------+ +-----------------+----------+---------------------------------------------------------------------------------------+
| wait | object | contains wait information such as (timeout, lables) | | wait | object | contains wait information such as (timeout, labels) |
+-----------------+----------+---------------------------------------------------------------------------------------+ +-----------------+----------+---------------------------------------------------------------------------------------+
| test | bool | run pre-defined helm tests helm in a chart | | test | bool | run pre-defined helm tests helm in a chart |
+-----------------+----------+---------------------------------------------------------------------------------------+ +-----------------+----------+---------------------------------------------------------------------------------------+
@ -277,20 +277,20 @@ Example
upgrade: upgrade:
no_hooks: false no_hooks: false
pre: pre:
update: update:
- name: test-daemonset - name: test-daemonset
type: daemonset type: daemonset
labels: labels:
foo: bar foo: bar
component: bar component: bar
rak1: enabled rak1: enabled
delete: delete:
- name: test-job - name: test-job
type: job type: job
labels: labels:
foo: bar foo: bar
component: bar component: bar
rak1: enabled rak1: enabled
values: {} values: {}
source: source:
type: git type: git