From 64a24022d8ce7ec5fbf721ca27a65cecc5172c38 Mon Sep 17 00:00:00 2001 From: Svetlana Karslioglu Date: Mon, 5 Dec 2016 15:44:44 -0800 Subject: [PATCH] Added IaC sections to Fuel CLI Added the following sections to the Fuel CLI reference: * Fuel IaC: Audit commands * Fuel IaC: Git repository management commands Change-Id: I5628eb8343c5f0f6a13bd50c27dad821692b85a6 --- userdocs/fuel-user-guide/cli.rst | 2 + .../fuel-user-guide/cli/cli_audit_enforce.rst | 33 +++++++++++++ .../cli/cli_manage_gitrepo.rst | 49 +++++++++++++++++++ .../post-deployment-conf/lcm-git-repo.rst | 6 +++ 4 files changed, 90 insertions(+) create mode 100644 userdocs/fuel-user-guide/cli/cli_audit_enforce.rst create mode 100644 userdocs/fuel-user-guide/cli/cli_manage_gitrepo.rst diff --git a/userdocs/fuel-user-guide/cli.rst b/userdocs/fuel-user-guide/cli.rst index f0aabf49e..d2d15119a 100644 --- a/userdocs/fuel-user-guide/cli.rst +++ b/userdocs/fuel-user-guide/cli.rst @@ -47,3 +47,5 @@ This section includes the following topics: cli/cli_change_ip_range.rst cli/cli_modify_environment.rst cli/cli_noop.rst + cli/cli_manage_gitrepo.rst + cli/cli_audit_enforce.rst diff --git a/userdocs/fuel-user-guide/cli/cli_audit_enforce.rst b/userdocs/fuel-user-guide/cli/cli_audit_enforce.rst new file mode 100644 index 000000000..c30e6c521 --- /dev/null +++ b/userdocs/fuel-user-guide/cli/cli_audit_enforce.rst @@ -0,0 +1,33 @@ +.. _cli-audit-enforce: + +======================== +Fuel IaC: Audit commands +======================== + +.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst + +The following table describes the usage of the :command:`fuel2 audit` +command available in the Fuel CLI. This command is available after you install +the Fuel Infrastructure-as-Code extension. For more information, see: +:ref:`lcm-git-repo`. + +.. list-table:: **Audit commands** + :widths: 7 10 + :header-rows: 1 + + * - Description + - Command + * - Run an audit in an OpenStack environment. + - ``fuel2 audit noop --env || --repo `` + * - List changes in an OpenStack environment. + - ``fuel2 audit list outofsync --task || --env `` + * - Perform an audit, verify changes, and enforce new configuration. + - ``fuel2 audit enforce --env || --repo `` + * - Display the white list for an OpenStack environment. + - ``fuel2 audit whitelist show `` + * - Add a rule to the white list of a specific OpenStack environment. + - ``fuel2 audit whitelist add --task --rule `` + * - Delete a rule or a set of rules from a white list. + - ``fuel2 audit whitelist delete [ ... ]`` + * - Add rules to a white list from a specific ``.yaml`` file. + - ``fuel2 audit whitelist load fromfile `` diff --git a/userdocs/fuel-user-guide/cli/cli_manage_gitrepo.rst b/userdocs/fuel-user-guide/cli/cli_manage_gitrepo.rst new file mode 100644 index 000000000..5ca57dd68 --- /dev/null +++ b/userdocs/fuel-user-guide/cli/cli_manage_gitrepo.rst @@ -0,0 +1,49 @@ +.. _cli-manage-gitrepo: + +============================================ +Fuel IaC: Git repository management commands +============================================ + +.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst + +The following table describes the usage of the :command:`fuel2 gitrepo` +command available in the Fuel CLI. This command is available after you +install the Fuel Infrastructure-as-Code extension. For more information, see: +:ref:`lcm-git-repo`. + +.. list-table:: **Repository management commands** + :widths: 7 10 + :header-rows: 1 + + * - Description + - Command + * - Associate an OpenStack environment with a Git repository. + - ``fuel gitrepo create [-h] --env --name --url + --ref [--key ]`` + + **Example:** + + :: + + fuel2 gitrepo create --env 1 --name test --url \ + git@github.com:user/test.git --ref master --key .ssh/id_rsa + + + * ``--env`` - an OpenStack environment ID. + * ``--name`` - the name of the Git repository. It will be used + as a directory name for the repository. + * ``--url`` - URL to the Git repository. For example, + ``git@github.com:user/repo.git``. + * ``ref`` - a Git reference, such as a branch or Gerrit refspec. + * ``key`` - a path to the private SSH key. + + * - Download configuration files from an OpenStack environment and upload + them to the configured Git repository. + - ``fuel2 gitrepo get configs [-h] [--env ] [--key_path ] + [--repo_dir ]`` + + * ``--env`` - an OpenStack environment ID. + * ``--key_path`` - a path to the private SSH key file on the selected + node. + * ``--repo_dir`` - a directory in the Git repository to upload the + files. diff --git a/userdocs/fuel-user-guide/post-deployment-conf/lcm-git-repo.rst b/userdocs/fuel-user-guide/post-deployment-conf/lcm-git-repo.rst index fcf75a961..abf566ad9 100644 --- a/userdocs/fuel-user-guide/post-deployment-conf/lcm-git-repo.rst +++ b/userdocs/fuel-user-guide/post-deployment-conf/lcm-git-repo.rst @@ -32,3 +32,9 @@ This section includes the following topics: lcm-git-repo/configure-iac.rst lcm-git-repo/repo-structure.rst lcm-git-repo/set-up-git-repo.rst + +.. seealso:: + + * :ref:`cli-manage-gitrepo` + * :ref:`cli-audit-enforce` + * `Fuel IaC extension API documentation `_