Fix documentation for document plugin command

Sub-command documentation improved with real world plugin example

Change-Id: Ibf239470027b856018db38cabb56ba70fbcc5030
This commit is contained in:
Dmitry Ukov 2020-04-21 20:08:30 +04:00
parent 0cf53db3b6
commit c62a369fd0
2 changed files with 22 additions and 10 deletions

View File

@ -33,11 +33,17 @@ Example:
$ cat /tmp/generator.yaml
---
apiVersion: airshipit.org/v1alpha1
kind: BareMetalHostGenerator
spec:
hostList:
- mac: 00:aa:bb:cc:dd
powerAddress: redfish+http://1.2.3.4/
kind: ReplacementTransformer
metadata:
name: notImportantHere
replacements:
- source:
value: nginx:newtag
target:
objref:
kind: Deployment
fieldrefs:
- spec.template.spec.containers[name=nginx-latest].image
$ airshipctl document plugin /tmp/generator.yaml

View File

@ -8,11 +8,17 @@ Example:
$ cat /tmp/generator.yaml
---
apiVersion: airshipit.org/v1alpha1
kind: BareMetalHostGenerator
spec:
hostList:
- mac: 00:aa:bb:cc:dd
powerAddress: redfish+http://1.2.3.4/
kind: ReplacementTransformer
metadata:
name: notImportantHere
replacements:
- source:
value: nginx:newtag
target:
objref:
kind: Deployment
fieldrefs:
- spec.template.spec.containers[name=nginx-latest].image
$ airshipctl document plugin /tmp/generator.yaml