Merge "Added IaC sections to Fuel CLI"
This commit is contained in:
commit
736780dae3
|
@ -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
|
||||
|
|
|
@ -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 <ENV_ID> || --repo <REPO_ID>``
|
||||
* - List changes in an OpenStack environment.
|
||||
- ``fuel2 audit list outofsync --task <NOOP_TASK_ID> || --env <ENV_ID>``
|
||||
* - Perform an audit, verify changes, and enforce new configuration.
|
||||
- ``fuel2 audit enforce --env <ENV_ID> || --repo <REPO_ID>``
|
||||
* - Display the white list for an OpenStack environment.
|
||||
- ``fuel2 audit whitelist show <ENV_ID>``
|
||||
* - Add a rule to the white list of a specific OpenStack environment.
|
||||
- ``fuel2 audit whitelist add <ENV_ID> --task <FUEL_TASK> --rule <RULE>``
|
||||
* - Delete a rule or a set of rules from a white list.
|
||||
- ``fuel2 audit whitelist delete <RULE_ID> [<RULE_ID> ... ]``
|
||||
* - Add rules to a white list from a specific ``.yaml`` file.
|
||||
- ``fuel2 audit whitelist load fromfile <ENV_ID> <PATH_TO_YAML>``
|
|
@ -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 <ENV_ID> --name <REPO_NAME> --url
|
||||
--ref <REF> [--key <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 <ENV_ID>] [--key_path <PATH>]
|
||||
[--repo_dir <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.
|
|
@ -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 <https://github.com/openstack/fuel-nailgun-extension-iac/blob/stable/mitaka/doc/api.md>`_
|
||||
|
|
Loading…
Reference in New Issue