Browse Source

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
Svetlana Karslioglu 2 years ago
parent
commit
64a24022d8

+ 2
- 0
userdocs/fuel-user-guide/cli.rst View File

@@ -47,3 +47,5 @@ This section includes the following topics:
47 47
    cli/cli_change_ip_range.rst
48 48
    cli/cli_modify_environment.rst
49 49
    cli/cli_noop.rst
50
+   cli/cli_manage_gitrepo.rst
51
+   cli/cli_audit_enforce.rst

+ 33
- 0
userdocs/fuel-user-guide/cli/cli_audit_enforce.rst View File

@@ -0,0 +1,33 @@
1
+.. _cli-audit-enforce:
2
+
3
+========================
4
+Fuel IaC: Audit commands
5
+========================
6
+
7
+.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
8
+
9
+The following table describes the usage of the :command:`fuel2 audit`
10
+command available in the Fuel CLI. This command is available after you install
11
+the Fuel Infrastructure-as-Code extension. For more information, see:
12
+:ref:`lcm-git-repo`.
13
+
14
+.. list-table:: **Audit commands**
15
+   :widths: 7 10
16
+   :header-rows: 1
17
+
18
+   * - Description
19
+     - Command
20
+   * - Run an audit in an OpenStack environment.
21
+     - ``fuel2 audit noop --env <ENV_ID> || --repo <REPO_ID>``
22
+   * - List changes in an OpenStack environment.
23
+     - ``fuel2 audit list outofsync --task <NOOP_TASK_ID> || --env <ENV_ID>``
24
+   * - Perform an audit, verify changes, and enforce new configuration.
25
+     - ``fuel2 audit enforce --env <ENV_ID> || --repo <REPO_ID>``
26
+   * - Display the white list for an OpenStack environment.
27
+     - ``fuel2 audit whitelist show <ENV_ID>``
28
+   * - Add a rule to the white list of a specific OpenStack environment.
29
+     - ``fuel2 audit whitelist add <ENV_ID> --task <FUEL_TASK> --rule <RULE>``
30
+   * - Delete a rule or a set of rules from a white list.
31
+     - ``fuel2 audit whitelist delete <RULE_ID> [<RULE_ID> ... ]``
32
+   * - Add rules to a white list from a specific ``.yaml`` file.
33
+     - ``fuel2 audit whitelist load fromfile <ENV_ID> <PATH_TO_YAML>``

+ 49
- 0
userdocs/fuel-user-guide/cli/cli_manage_gitrepo.rst View File

@@ -0,0 +1,49 @@
1
+.. _cli-manage-gitrepo:
2
+
3
+============================================
4
+Fuel IaC: Git repository management commands
5
+============================================
6
+
7
+.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
8
+
9
+The following table describes the usage of the :command:`fuel2 gitrepo`
10
+command available in the Fuel CLI. This command is available after you
11
+install the Fuel Infrastructure-as-Code extension. For more information, see:
12
+:ref:`lcm-git-repo`.
13
+
14
+.. list-table:: **Repository management commands**
15
+   :widths: 7 10
16
+   :header-rows: 1
17
+
18
+   * - Description
19
+     - Command
20
+   * - Associate an OpenStack environment with a Git repository.
21
+     - ``fuel gitrepo create [-h] --env <ENV_ID> --name <REPO_NAME> --url
22
+       --ref <REF> [--key <KEY>]``
23
+
24
+       **Example:**
25
+
26
+       ::
27
+
28
+         fuel2 gitrepo create --env 1 --name test --url \
29
+         git@github.com:user/test.git --ref master --key .ssh/id_rsa
30
+
31
+
32
+       * ``--env`` - an OpenStack environment ID.
33
+       * ``--name`` - the name of the Git repository. It will be used
34
+         as a directory name for the repository.
35
+       * ``--url`` - URL to the Git repository. For example,
36
+         ``git@github.com:user/repo.git``.
37
+       * ``ref`` - a Git reference, such as a branch or Gerrit refspec.
38
+       * ``key`` - a path to the private SSH key.
39
+
40
+   * - Download configuration files from an OpenStack environment and upload
41
+       them to the configured Git repository.
42
+     - ``fuel2 gitrepo get configs [-h] [--env <ENV_ID>] [--key_path <PATH>]
43
+       [--repo_dir <REPO_DIR>]``
44
+
45
+       * ``--env`` - an OpenStack  environment ID.
46
+       * ``--key_path`` - a path to the private SSH key file on the selected
47
+         node.
48
+       * ``--repo_dir`` - a directory in the Git repository to upload the
49
+         files.

+ 6
- 0
userdocs/fuel-user-guide/post-deployment-conf/lcm-git-repo.rst View File

@@ -32,3 +32,9 @@ This section includes the following topics:
32 32
    lcm-git-repo/configure-iac.rst
33 33
    lcm-git-repo/repo-structure.rst
34 34
    lcm-git-repo/set-up-git-repo.rst
35
+
36
+.. seealso::
37
+
38
+   *   :ref:`cli-manage-gitrepo`
39
+   *   :ref:`cli-audit-enforce`
40
+   *   `Fuel IaC extension API documentation <https://github.com/openstack/fuel-nailgun-extension-iac/blob/stable/mitaka/doc/api.md>`_

Loading…
Cancel
Save