diff --git a/docs/commands/lagoon.md b/docs/commands/lagoon.md index 32811fd3..1f3836b0 100644 --- a/docs/commands/lagoon.md +++ b/docs/commands/lagoon.md @@ -34,7 +34,9 @@ lagoon [flags] * [lagoon config](lagoon_config.md) - Configure Lagoon CLI * [lagoon delete](lagoon_delete.md) - Delete a project, or delete notifications and variables from projects or environments * [lagoon deploy](lagoon_deploy.md) - Deploy a branch or environment +* [lagoon export](lagoon_export.md) - Export lagoon output to yaml * [lagoon get](lagoon_get.md) - Get info on a resource +* [lagoon import](lagoon_import.md) - Import a config from a yaml file * [lagoon kibana](lagoon_kibana.md) - Launch the kibana interface * [lagoon list](lagoon_list.md) - List projects, deployments, variables or notifications * [lagoon login](lagoon_login.md) - Log into a Lagoon instance diff --git a/docs/commands/lagoon_config.md b/docs/commands/lagoon_config.md index 1cb3a847..f28dee17 100644 --- a/docs/commands/lagoon_config.md +++ b/docs/commands/lagoon_config.md @@ -32,7 +32,7 @@ Configure Lagoon CLI * [lagoon](lagoon.md) - Command line integration for Lagoon * [lagoon config add](lagoon_config_add.md) - Add information about an additional Lagoon instance to use -* [lagoon config current](lagoon_config_current.md) - Display the current lagoon +* [lagoon config current](lagoon_config_current.md) - Display the current lagoon that commands would be executed against * [lagoon config default](lagoon_config_default.md) - Set the default Lagoon to use * [lagoon config delete](lagoon_config_delete.md) - Delete a Lagoon instance configuration * [lagoon config feature](lagoon_config_feature.md) - Enable or disable CLI features diff --git a/docs/commands/lagoon_config_current.md b/docs/commands/lagoon_config_current.md index a126b1bc..ad7d9d5f 100644 --- a/docs/commands/lagoon_config_current.md +++ b/docs/commands/lagoon_config_current.md @@ -1,10 +1,10 @@ ## lagoon config current -Display the current lagoon +Display the current lagoon that commands would be executed against ### Synopsis -Display the current lagoon +Display the current lagoon that commands would be executed against ``` lagoon config current [flags] diff --git a/docs/commands/lagoon_export.md b/docs/commands/lagoon_export.md new file mode 100644 index 00000000..275fcf6b --- /dev/null +++ b/docs/commands/lagoon_export.md @@ -0,0 +1,40 @@ +## lagoon export + +Export lagoon output to yaml + +### Synopsis + +Export lagoon output to yaml +You must specify to export a specific project by using the '-p ' flag + +``` +lagoon export [flags] +``` + +### Options + +``` + --exclude strings Exclude data from the export. Valid options (others are ignored): users, project-users, groups, notifications, project-private-keys (default [project-private-keys]) + -h, --help help for export +``` + +### Options inherited from parent commands + +``` + --debug Enable debugging output (if supported) + -e, --environment string Specify an environment to use + --force Force yes on prompts (if supported) + -l, --lagoon string The Lagoon instance to interact with + --no-header No header on table (if supported) + --output-csv Output as CSV (if supported) + --output-json Output as JSON (if supported) + --pretty Make JSON pretty (if supported) + -p, --project string Specify a project to use + --skip-update-check Skip checking for updates + -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication +``` + +### SEE ALSO + +* [lagoon](lagoon.md) - Command line integration for Lagoon + diff --git a/docs/commands/lagoon_import.md b/docs/commands/lagoon_import.md new file mode 100644 index 00000000..410e6aa9 --- /dev/null +++ b/docs/commands/lagoon_import.md @@ -0,0 +1,43 @@ +## lagoon import + +Import a config from a yaml file + +### Synopsis + +Import a config from a yaml file. +By default this command will exit on encountering an error (such as an existing object). +You can get it to continue anyway with --keep-going. To disable any prompts, use --force. + +``` +lagoon import [flags] +``` + +### Options + +``` + -h, --help help for import + -I, --import-file string path to the file to import + --keep-going on error, just log and continue instead of aborting + --openshiftID uint ID of the openshift to target for import +``` + +### Options inherited from parent commands + +``` + --debug Enable debugging output (if supported) + -e, --environment string Specify an environment to use + --force Force yes on prompts (if supported) + -l, --lagoon string The Lagoon instance to interact with + --no-header No header on table (if supported) + --output-csv Output as CSV (if supported) + --output-json Output as JSON (if supported) + --pretty Make JSON pretty (if supported) + -p, --project string Specify a project to use + --skip-update-check Skip checking for updates + -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication +``` + +### SEE ALSO + +* [lagoon](lagoon.md) - Command line integration for Lagoon +