flatten and touch up the index page

parent e8f76c2f
......@@ -73,8 +73,6 @@ resource fields, unless specified.
Any usage errors or connection exceptions are thrown as subclasses of ``tower_cli.exceptions.TowerCLIError``, see
'Exceptions' section below for details.
Table of Contents
-----------------
.. toctree::
:maxdepth: 1
:caption: Environment Setup
......@@ -82,6 +80,9 @@ Table of Contents
conf.rst
exceptions.rst
API Reference Table of Contents
===============================
.. toctree::
:maxdepth: 1
:caption: Resource List
......
## Example Commands
Examples here are intended to give concrete examples of how the CLI
can be used in an automated way. It can also help with testing or the defining of
feature requests.
Expect the setup script to take up to 2 minutes to run. Most of this time is
waiting for the project source control to sync the examples
from github to the tower server.
### Setup
You should have a version of tower running and configured in the CLI
in order to run any scripts or commands here. With your specific data, that
can done by the following commands:
```bash
$ tower-cli config host tower.example.com
$ tower-cli config username leeroyjenkins
$ tower-cli config password myPassw0rd
```
Jobs demonstrated in the script do not connect to another machine, and do
not require valid machine credentials, so tower-cli config information
should be all the unique information necessary.
### Create Fake Data
You may want to reference the
[fake data creator](https://github.com/ansible/tower-cli/blob/master/docs/examples/fake_data_creator.sh) for
examples on how to create different types of resources.
If you want to run the script, which auto-populates your Tower server
with a small set of fake data, run the following:
```bash
# Populate the server with fake data and run test jobs
$ cd docs/examples/
$ source fake_data_creator.sh
```
### Cleaning Up
The teardown script removes all of the objects that the CLI can easily
remove. This is not a perfect cleanup, but it performs well enough to get the system
ready to run the fake data creator script again.
```bash
# Delete the data that was created (with some exceptions)
$ source fake_data_teardown.sh
```
### Warnings
It is strongly suggested that you only run these scripts on testing versions
of an Ansible Tower host in order to avoid unintended naming conflicts.
### Python Module Use Example
This bash script example borrows fake data elements from the
[tower populator script](https://github.com/jsmartin/tower_populator).
The tower_populator script provides an example of how to use the tower-cli python modules.
Example Commands
----------------
Examples here are intended to give concrete examples of how the CLI can
be used in an automated way. It can also help with testing or the
defining of feature requests.
Expect the setup script to take up to 2 minutes to run. Most of this
time is waiting for the project source control to sync the examples from
github to the tower server.
Setup
~~~~~
You should have a version of tower running and configured in the CLI in
order to run any scripts or commands here. With your specific data, that
can done by the following commands:
.. code:: bash
$ tower-cli config host tower.example.com
$ tower-cli config username leeroyjenkins
$ tower-cli config password myPassw0rd
Jobs demonstrated in the script do not connect to another machine, and
do not require valid machine credentials, so tower-cli config
information should be all the unique information necessary.
Create Fake Data
~~~~~~~~~~~~~~~~
You may want to reference the `fake data
creator <https://github.com/ansible/tower-cli/blob/master/docs/examples/fake_data_creator.sh>`__
for examples on how to create different types of resources.
If you want to run the script, which auto-populates your Tower server
with a small set of fake data, run the following:
.. code:: bash
# Populate the server with fake data and run test jobs
$ cd docs/source/cli_ref/examples/
$ source fake_data_creator.sh
Cleaning Up
~~~~~~~~~~~
The teardown script removes all of the objects that the CLI can easily
remove. This is not a perfect cleanup, but it performs well enough to
get the system ready to run the fake data creator script again.
.. code:: bash
# Delete the data that was created (with some exceptions)
$ source fake_data_teardown.sh
Warnings
~~~~~~~~
It is strongly suggested that you only run these scripts on testing
versions of an Ansible Tower host in order to avoid unintended naming
conflicts.
Python Module Use Example
~~~~~~~~~~~~~~~~~~~~~~~~~
This bash script example borrows fake data elements from the `tower
populator script <https://github.com/jsmartin/tower_populator>`__. The
tower\_populator script provides an example of how to use the tower-cli
python modules.
......@@ -207,10 +207,11 @@ exists in Tower backend; global options are used to set runtime configuration se
as context manager ``tower_cli.conf.Settings.runtime_values`` in :ref:`api-ref-conf`.
.. toctree::
:maxdepth: 1
:maxdepth: 0
:caption: Usage Guides
usage/CONFIG_CMD_OPTIONS.rst
usage/VERSIONING.rst
usage/NOTIFICATION_TEMPLATE_MANAGEMENT.rst
usage/ROLE_MANAGEMENT.rst
usage/SURVEYS.rst
......@@ -221,6 +222,4 @@ as context manager ``tower_cli.conf.Settings.runtime_values`` in :ref:`api-ref-c
:caption: Examples
examples/README.rst
examples/fake_data_creator.rst
examples/workflow_demo.rst
.. _cli_ref:
Config Command Options
======================
key-value options available for ``tower-cli config <key> <value>`` command
--------------------------------------------------------------------------
......@@ -57,16 +60,34 @@ All of the above options can also be set using environment variables.
The default behavior is to allow environment variables to override your
tower-cli.cfg settings, but they will not override config values that
are passed in on the command line at runtime. Below is a table of the
available environment variables. ## Variable Mapping \| *Environment
Variable* \| *Tower Config Key* \|
\|------------------------\|--------------------\| \| ``TOWER_COLOR`` \|
``color`` \| \| ``TOWER_FORMAT`` \| ``format`` \| \| ``TOWER_HOST`` \|
``host`` \| \| ``TOWER_PASSWORD`` \| ``password`` \| \|
``TOWER_USERNAME`` \| ``username`` \| \| ``TOWER_VERIFY_SSL`` \|
``verify_ssl`` \| \| ``TOWER_VERBOSE`` \| ``verbose`` \| \|
``TOWER_DESCRIPTION_ON`` \| ``description_on`` \| \|
``TOWER_CERTIFICATE`` \| ``certificate`` \| \| ``TOWER_USE_TOKEN`` \|
``use_token`` \|
available environment variables.
Variable Mapping
~~~~~~~~~~~~~~~~
+---------------------------+--------------------+
| *Environment Variable* | *Tower Config Key* |
+===========================+====================+
| ``TOWER_COLOR`` | ``color`` |
+---------------------------+--------------------+
| ``TOWER_FORMAT`` | ``format`` |
+---------------------------+--------------------+
| ``TOWER_HOST`` | ``host`` |
+---------------------------+--------------------+
| ``TOWER_PASSWORD`` | ``password`` |
+---------------------------+--------------------+
| ``TOWER_USERNAME`` | ``username`` |
+---------------------------+--------------------+
| ``TOWER_VERIFY_SSL`` | ``verify_ssl`` |
+---------------------------+--------------------+
| ``TOWER_VERBOSE`` | ``verbose`` |
+---------------------------+--------------------+
| ``TOWER_DESCRIPTION_ON`` | ``description_on`` |
+---------------------------+--------------------+
| ``TOWER_CERTIFICATE`` | ``certificate`` |
+---------------------------+--------------------+
| ``TOWER_USE_TOKEN`` | ``use_token`` |
+---------------------------+--------------------+
Notes
-----
......
.. _cli_ref:
Notification Template Management
================================
Introduction - What Notification Templates Are
----------------------------------------------
......@@ -17,14 +20,6 @@ To see the commands available for notification templates, see
get the help text with
``tower-cli notification_template <command> --help``.
The arguments for all notification template commands follow the same
pattern, although not all arguments are mandatory for all commands. The
structure follows the following pattern:
::
tower-cli role <action> <options>
Notification templates suppport all typical CRUD operations that control
other resources through tower-cli: ``get``, ``list``, ``create``,
``modify`` and ``delete``. On the other hand, uses can use new command
......
.. _cli_ref:
Role Management
===============
Introduction - What Roles Are
-----------------------------
......
.. _cli_ref:
How to manage surveys of job templates and workflows through tower-cli
======================================================================
Survey Management
=================
This feature is added in v3.1.0, and v3.1.3 or higher, at least, is
recommended.
......
.. _cli_ref:
Workflow Management
===================
These docs show how to populate an example workflow in Tower and how to
automate the creation or copying of workflows.
......
......@@ -34,11 +34,10 @@ Table of Contents
-----------------
.. toctree::
:maxdepth: 3
:maxdepth: 2
install.rst
quickstart.rst
VERSIONING.rst
cli_ref/index.rst
api_ref/index.rst
CONTRIBUTING.rst
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment