Improve doc formatting
This commit improves the formatting of the docs by wrapping literal text with double backticks (``) rather than single backtick (`). `` is what should be used for literal text [*]. [*] <http://docutils.sourceforge.net/docs/ref/rst/roles.html#literal> Change-Id: I447dc9dac1a6bcd90d5d9aa4634cd4fb1a7da574
This commit is contained in:
Éric Lemoine
parent
4f290171dc
commit
47fc188b9a
|
|
@ -7,10 +7,10 @@ Configuring ansible logs and plugins
|
|||
------------------------------------
|
||||
|
||||
Ansible logs and plugins are configured with the preinstall role and playbook
|
||||
located in the `utils/kargo` directory.
|
||||
located in the ``utils/kargo`` directory.
|
||||
|
||||
In order to make changes to logs configuration without running the
|
||||
`kargo_deploy.sh` completely, run the following Ansible command:
|
||||
``kargo_deploy.sh`` completely, run the following Ansible command:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
|
|
@ -21,16 +21,16 @@ In order to make changes to logs configuration without running the
|
|||
-e @${ws}utils/kargo/roles/configure_logs/defaults/main.yml \
|
||||
${ws}utils/kargo/preinstall.yml
|
||||
|
||||
Note that the `ws` var should point to the actual admin workspace directory.
|
||||
Note that the ``ws`` var should point to the actual admin workspace directory.
|
||||
|
||||
Collecting diagnostic info
|
||||
--------------------------
|
||||
|
||||
There is a diagnostic info helper script located in the
|
||||
`/usr/local/bin/collect_logs.sh` directory. It issues commands and collects
|
||||
files given in the `${ws}utils/kargo/roles/configure_logs/defaults/main.yml`
|
||||
``/usr/local/bin/collect_logs.sh`` directory. It issues commands and collects
|
||||
files given in the ``${ws}utils/kargo/roles/configure_logs/defaults/main.yml``
|
||||
file, from all of the cluster nodes online. Results are aggregated to the
|
||||
admin node in the `logs.tar.gz` tarball.
|
||||
admin node in the ``logs.tar.gz`` tarball.
|
||||
|
||||
In order to re-build the tarball with fresh info, run:
|
||||
|
||||
|
|
|
|||
|
|
@ -3,10 +3,10 @@ Inventory and deployment data management
|
|||
|
||||
Deployment data and ansible inventory are represented as a git repository,
|
||||
either remote or local. It is cloned and being updated on the admin node's
|
||||
`$ADMIN_WORKSPACE/inventory` directory. The `$ADMIN_WORKSPACE` copies a value
|
||||
of a given `$WORKSPACE` env var (defaults to the current directory of the
|
||||
admin node). Or it takes a `workspace`, when the `$ADMIN_IP` refers to not a
|
||||
`local` admin node. For example, if it is a VM.
|
||||
``$ADMIN_WORKSPACE/inventory`` directory. The ``$ADMIN_WORKSPACE`` copies
|
||||
a value of a given ``$WORKSPACE`` env var (defaults to the current directory of
|
||||
the admin node). Or it takes a ``workspace``, when the ``$ADMIN_IP`` refers to
|
||||
not a ``local`` admin node. For example, if it is a VM.
|
||||
|
||||
Installer passes that data and inventory to
|
||||
`Kargo <https://github.com/kubespray/kargo>`_ ansible installer.
|
||||
|
|
@ -14,24 +14,24 @@ Installer passes that data and inventory to
|
|||
For each inventory repo commit, it expects the following content of
|
||||
the repo root directory:
|
||||
|
||||
* `inventory.cfg` - a mandatory inventory file. It must be created manually
|
||||
or generated based on `$SLAVE_IPS` provided with the
|
||||
* ``inventory.cfg`` - a mandatory inventory file. It must be created manually
|
||||
or generated based on ``$SLAVE_IPS`` provided with the
|
||||
`helper script <https://github.com/openstack/fuel-ccp-installer/blob/master/utils/kargo/inventory.py>`_.
|
||||
* `kargo_default_common.yaml` - a mandatory vars file, overrides the kargo
|
||||
defaults in the `$ADMIN_WORKSPACE/kargo/inventory/group_vars/all.yml`)
|
||||
* ``kargo_default_common.yaml`` - a mandatory vars file, overrides the kargo
|
||||
defaults in the ``$ADMIN_WORKSPACE/kargo/inventory/group_vars/all.yml``)
|
||||
and defaults for roles.
|
||||
* `kargo_default_ubuntu.yaml` - a mandatory vars file for Ubuntu nodes,
|
||||
* ``kargo_default_ubuntu.yaml`` - a mandatory vars file for Ubuntu nodes,
|
||||
overrides the common file.
|
||||
* `custom.yaml` - not a mandatory vars file, overrides all vars.
|
||||
* ``custom.yaml`` - not a mandatory vars file, overrides all vars.
|
||||
|
||||
Note, that the `custom.yaml` make all data vars defined inside to override same
|
||||
vars defined at other place. The data priority precedes as the following: kargo
|
||||
defaults, then common defaults, then ubuntu defaults, then custom YAML.
|
||||
Note, that the ``custom.yaml`` make all data vars defined inside to override
|
||||
same vars defined at other place. The data priority precedes as the following:
|
||||
kargo defaults, then common defaults, then ubuntu defaults, then custom YAML.
|
||||
|
||||
Final data decisions is done automatically by the installer:
|
||||
|
||||
* If `$INVENTORY_REPO` is unset, make a local git repo and carry on and deploy.
|
||||
* Or clone the given repo and checkout to `$INVENTORY_COMMIT`, if any.
|
||||
* If ``$INVENTORY_REPO`` is unset, make a local git repo and carry on and deploy.
|
||||
* Or clone the given repo and checkout to ``$INVENTORY_COMMIT``, if any.
|
||||
* Copy installer defaults into the repo and decide on which data to accept:
|
||||
* If a file changes, do git reset (shall not overwrite a commited state).
|
||||
* If a new file, or has no changes, go with it (shall auto-populate defaults).
|
||||
|
|
@ -39,6 +39,6 @@ Final data decisions is done automatically by the installer:
|
|||
* If result is OK, submit changes as a gerrit review
|
||||
* Or fail deployment, as we usually would, don't submit anything to gerrit.
|
||||
|
||||
Ongoing inventory changes must be submitted by a user to `$INVENTORY_REPO`
|
||||
Ongoing inventory changes must be submitted by a user to ``$INVENTORY_REPO``
|
||||
manually. Installer only initializes the repo during the initial install if it
|
||||
is missing.
|
||||
|
|
|
|||
|
|
@ -63,6 +63,6 @@ run from the `./utils/packer` dir:
|
|||
UBUNTU_MAJOR_VERSION=16.04 UBUNTU_MINOR_VERSION=.1 UBUNTU_TYPE=server \
|
||||
ARCH=amd64 OSTYPE=ubuntu TYPE=virtualbox ATLAS_USER=doe ./deploy.sh
|
||||
|
||||
The first command creates a box named `john/foobox` which has the version
|
||||
`0.1.0` and the libvirt provider. The second one uses the version autoincrement
|
||||
and puts the box as `john/ubuntu-16.04.1-server-amd64` and virtualbox provider.
|
||||
The first command creates a box named ``john/foobox`` which has the version
|
||||
``0.1.0`` and the libvirt provider. The second one uses the version autoincrement
|
||||
and puts the box as ``john/ubuntu-16.04.1-server-amd64`` and virtualbox provider.
|
||||
|
|
|
|||
|
|
@ -9,8 +9,8 @@ Requirements:
|
|||
* Plugin vagrant-vbguest >= 0.13.0
|
||||
|
||||
To start with defaults, just run ``vagrant up``. To tweak defaults, see the
|
||||
`vagrant-settings.yaml_defaults` file. You can rename the file as
|
||||
`vagrant-settings.yaml` end edit it to override defaults as well.
|
||||
``vagrant-settings.yaml_defaults`` file. You can rename the file as
|
||||
``vagrant-settings.yaml`` end edit it to override defaults as well.
|
||||
|
||||
.. note:: Make sure the default network choice doesn't conflict with existing
|
||||
host networks!
|
||||
|
|
|
|||
Loading…
Reference in New Issue