[Docs] Migrate CLI reference to reference guide
The CLI usage shouldn't probably be directly given into guides, but should instead be moved into reference. Change-Id: I7085591f147d7dc0ff2c63be3380a06e6387e6b9
This commit is contained in:
parent
56194bcb5a
commit
4db3962281
@ -26,4 +26,3 @@ the major upgrades procedures.
|
||||
upgrades/minor-updates.rst
|
||||
upgrades/major-upgrades.rst
|
||||
advanced-config.rst
|
||||
ref-info.rst
|
||||
|
@ -1,61 +0,0 @@
|
||||
=====================
|
||||
Reference information
|
||||
=====================
|
||||
|
||||
This is a draft reference information page for the proposed OpenStack-Ansible
|
||||
operations guide.
|
||||
|
||||
Linux Container commands
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The following are some useful commands to manage LXC:
|
||||
|
||||
- List containers and summary information such as operational state and
|
||||
network configuration:
|
||||
|
||||
.. code-block:: shell-session
|
||||
|
||||
# lxc-ls --fancy
|
||||
|
||||
- Show container details including operational state, resource
|
||||
utilization, and ``veth`` pairs:
|
||||
|
||||
.. code-block:: shell-session
|
||||
|
||||
# lxc-info --name container_name
|
||||
|
||||
- Start a container:
|
||||
|
||||
.. code-block:: shell-session
|
||||
|
||||
# lxc-start --name container_name
|
||||
|
||||
- Attach to a container:
|
||||
|
||||
.. code-block:: shell-session
|
||||
|
||||
# lxc-attach --name container_name
|
||||
|
||||
- Stop a container:
|
||||
|
||||
.. code-block:: shell-session
|
||||
|
||||
# lxc-stop --name container_name
|
||||
|
||||
Finding Ansible scripts after installation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
All scripts used to install OpenStack with Ansible can be viewed from
|
||||
the repository on GitHub, and on the deployment host.
|
||||
|
||||
The repository containing the scripts and playbooks is located at
|
||||
https://github.com/openstack/openstack-ansible.
|
||||
|
||||
To access the scripts and playbooks on your deployment host,
|
||||
follow these steps.
|
||||
|
||||
#. Log into your deployment host.
|
||||
|
||||
#. Change to the ``/opt/openstack-ansible`` directory.
|
||||
|
||||
#. The ``scripts`` directory contains scripts used in the installation.
|
@ -1,21 +0,0 @@
|
||||
==========================================
|
||||
Finding Ansible scripts after installation
|
||||
==========================================
|
||||
|
||||
All scripts used to install OpenStack with Ansible can be viewed from
|
||||
the repository on GitHub, and on the local infrastructure server.
|
||||
|
||||
The repository containing the scripts and playbooks is located at
|
||||
https://github.com/openstack/openstack-ansible.
|
||||
|
||||
To access the scripts and playbooks on the local ``infra01`` server,
|
||||
follow these steps.
|
||||
|
||||
#. Log into the ``infra01`` server.
|
||||
|
||||
#. Change to the ``/opt/rpc-openstack/openstack-ansible`` directory.
|
||||
|
||||
#. The ``scripts`` directory contains scripts used in the installation.
|
||||
Generally, directories and subdirectories under ``rpcd``
|
||||
contain files related to RPCO. For example, the
|
||||
``rpcd/playbooks`` directory contains the RPCO playbooks.
|
@ -1,4 +1,7 @@
|
||||
========================
|
||||
======================
|
||||
Command Line Reference
|
||||
======================
|
||||
|
||||
Linux Container commands
|
||||
========================
|
||||
|
||||
@ -35,3 +38,7 @@ The following are some useful commands to manage LXC:
|
||||
.. code-block:: shell-session
|
||||
|
||||
# lxc-stop --name container_name
|
||||
|
||||
Systemd nspawn commands
|
||||
=======================
|
||||
|
46
doc/source/reference/conventions.rst
Normal file
46
doc/source/reference/conventions.rst
Normal file
@ -0,0 +1,46 @@
|
||||
===========
|
||||
Conventions
|
||||
===========
|
||||
|
||||
To avoid extra configuration, a series of conventions are set into code.
|
||||
|
||||
Default folders locations
|
||||
=========================
|
||||
|
||||
Ansible roles
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
The ansible roles are stored under ``/etc/ansible/roles``.
|
||||
|
||||
OpenStack-Ansible directory checkout
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The code is generally located into ``/opt/openstack-ansible``.
|
||||
|
||||
OpenStack-Ansible wrapper
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Our ``openstack-ansible`` cli is located in ``/usr/bin/openstack-ansible``.
|
||||
It sources an environment variable file located in:
|
||||
``/usr/bin/openstack-ansible.rc``.
|
||||
|
||||
Userspace configurations
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
All the userspace configurations are expected to be in
|
||||
``/etc/openstack_deploy/``.
|
||||
|
||||
Ansible configuration
|
||||
=====================
|
||||
|
||||
Ansible.cfg
|
||||
~~~~~~~~~~~
|
||||
|
||||
There is no ``ansible.cfg`` provided with OpenStack-Ansible.
|
||||
Environment variables are used to alter the default
|
||||
Ansible behavior if necessary.
|
||||
|
||||
Inventory conventions
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Please confer to the inventory section of this reference.
|
@ -8,5 +8,7 @@ to deploy, configure, or upgrade an OpenStack-Ansible cloud.
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
conventions.rst
|
||||
inventory/inventory.rst
|
||||
commands/reference.rst
|
||||
upgrades/reference.rst
|
||||
|
Loading…
x
Reference in New Issue
Block a user