fuel-nailgun-extension-iac/doc/cli.md

Fuel CLI

Create association of environment and git repository

fuel2 gitrepo create [-h] --env ENV --name NAME --url URL --ref REF
                            [--key KEY]

  --env ENV    ID of environment to configure.
  --name NAME  Name of the git repository. Will be used as directory name for
               repository.
  --url URL    Url of Git repository. User should be specified in this url.
  --ref REF    Git ref. This can be either a branch or Gerrit refspec.
  --key KEY    Path to private key file for accessing repo

For example:

fuel2 gitrepo create --env 1 --name oscnf1 --url git@github.com:dukov/oscnf.git --ref master --key .ssh/id_rsa

(Optional) User can download supported config files from the environment and upload them to configured git repository

fuel2 gitrepo get configs [-h] [--env ENV] [--key_path KEY_PATH]
                             [--repo_dir REPO_DIR]

  --env ENV            Env ID
  --key_path KEY_PATH  Path to nodes private key file
  --repo_dir REPO_DIR  Directory to Git repo download

For example download configs from all environment and push them to configured repo:

fuel2 gitrepo get configs

Other commands

You can update,delete and list git repo association executing corresponding command

fuel2 gitrepo <command>

To get more detailed description use:

fuel2 help <command>

Audit and enforce

These commands allow to perform audit and enforce configuration on the environment as well as to list the changes made to it.

To perform the audit run on the environment:

fuel2 audit noop --env <env-id> || --repo <repo-id>

To list the changes:

fuel2 audit list outofsync --task <noop-task-id> || --env <env-id>

To perform audit run, inspect changes and enforce configuration, if needed:

fuel2 audit enforce --env <env-id> || --repo <repo-id>

Changes whitelist commands

These commands manage the rules, that allow to ignore certain changes to configuration.

To show rules whitelist for the environment:

fuel2 audit whitelist show <env-id>

To add a rule:

fuel2 audit whitelist add <env-id> --task <fuel-task> --rule <rule>

To delete a rule or set of rules:

fuel2 audit whitelist delete <rule-id> [<rule-id> ... ]

To add rules from YAML file:

fuel2 audit whitelist load fromfile <env-id> <path-to-yaml>