9ffc305392
This commit cleans up the command constructors in an attempt to make the codebase more uniform and approachable. This includes several refactors: * Removed the FlagConstants - this makes the help messages and examples significantly more readable without needed to compile and run airshipctl * Long help messages and examples are now constant * Short, Long, and Examples all begin with a capitol letter * Flag descriptions begin with a lowercase letter. This matches the flag description for the builtin "help" flag, making formatting uniform for all flags * Removed redundant unit tests on non-leaf commands This change also updates the documentation for the affected commands. Change-Id: I8b9dcbfd9846b3deaab06dec17f80643dae78de9
38 lines
1.0 KiB
Plaintext
38 lines
1.0 KiB
Plaintext
This command is meant to be used as a kustomize exec plugin.
|
|
|
|
The command reads the configuration file CONFIG passed as a first argument and
|
|
determines a particular plugin to execute. Additional arguments may be passed
|
|
to this command and can be used by the particular plugin.
|
|
|
|
CONFIG must be a structured kubernetes manifest (i.e. resource) and must have
|
|
'apiVersion' and 'kind' keys. If the appropriate plugin was not found, the
|
|
command returns an error.
|
|
|
|
Usage:
|
|
plugin CONFIG [ARGS] [flags]
|
|
|
|
Examples:
|
|
|
|
# Perform a replacement on a deployment. Prior to running this command,
|
|
# the file '/tmp/replacement.yaml' should be created as follows:
|
|
---
|
|
apiVersion: airshipit.org/v1alpha1
|
|
kind: ReplacementTransformer
|
|
metadata:
|
|
name: notImportantHere
|
|
replacements:
|
|
- source:
|
|
value: nginx:newtag
|
|
target:
|
|
objref:
|
|
kind: Deployment
|
|
fieldrefs:
|
|
- spec.template.spec.containers[name=nginx-latest].image
|
|
|
|
# The replacement can then be performed. Output defaults to stdout.
|
|
airshipctl document plugin /tmp/replacement.yaml
|
|
|
|
|
|
Flags:
|
|
-h, --help help for plugin
|