diff options
Diffstat (limited to 'docs/docsite/rst/quickstart')
| -rw-r--r-- | docs/docsite/rst/quickstart/create_credential.rst | 31 | ||||
| -rw-r--r-- | docs/docsite/rst/quickstart/create_inventory.rst | 46 | ||||
| -rw-r--r-- | docs/docsite/rst/quickstart/create_job.rst | 31 | ||||
| -rw-r--r-- | docs/docsite/rst/quickstart/create_organization.rst | 36 | ||||
| -rw-r--r-- | docs/docsite/rst/quickstart/create_project.rst | 42 | ||||
| -rw-r--r-- | docs/docsite/rst/quickstart/create_user.rst | 23 | ||||
| -rw-r--r-- | docs/docsite/rst/quickstart/examine_dashboard.rst | 50 | ||||
| -rw-r--r-- | docs/docsite/rst/quickstart/index.rst | 34 | ||||
| -rw-r--r-- | docs/docsite/rst/quickstart/launch.rst | 35 | ||||
| -rw-r--r-- | docs/docsite/rst/quickstart/login_superuser.rst | 16 | ||||
| -rw-r--r-- | docs/docsite/rst/quickstart/quick_start.rst | 11 | ||||
| -rw-r--r-- | docs/docsite/rst/quickstart/setup.rst | 6 |
12 files changed, 0 insertions, 361 deletions
diff --git a/docs/docsite/rst/quickstart/create_credential.rst b/docs/docsite/rst/quickstart/create_credential.rst deleted file mode 100644 index 0ead155e2d..0000000000 --- a/docs/docsite/rst/quickstart/create_credential.rst +++ /dev/null @@ -1,31 +0,0 @@ -Create a Credential -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. index:: - single: credentials; create - -Credentials authenticate the AWX user to launch Ansible playbooks, which can include passwords and SSH keys, against inventory hosts. You can also require the AWX user to enter a password or key phrase when a playbook launches using the credentials feature of AWX. - -Access the list of credentials by clicking **Credentials** from the left navigation bar. - -|Credentials - list view| - -.. |Credentials - list view| image:: ../common/images/qs-credentials-list-view.png - -For the purpose of this Quick Start, a demo credential and a Galaxy credential have been provided for your use. The provided Galaxy credential serves as a template and can only be copied and not edited. You may add more credentials as necessary. Refer to :ref:`ug_credentials_add` in the |atu| for detail. - - -.. note:: - When setting up additional credentials, keep in mind that the user you assign must have root access or be able to use SSH to connect to the host machine. - - -Click **Demo Credential** to view its details. - - -|Credentials - review demo credential| - -.. |Credentials - review demo credential| image:: ../common/images/qs-credentials-demo-details.png - -For the purpose of this Quick Start Guide, leave the default demo credential as is. But to edit the default credential later - from the Details tab, click **Edit**, or from the Credentials list view, click the Edit (|edit|) button next to the credential name to edit the appropriate details, then save your changes. - -.. |edit| image:: ../common/images/edit-button.png
\ No newline at end of file diff --git a/docs/docsite/rst/quickstart/create_inventory.rst b/docs/docsite/rst/quickstart/create_inventory.rst deleted file mode 100644 index 1479913ee9..0000000000 --- a/docs/docsite/rst/quickstart/create_inventory.rst +++ /dev/null @@ -1,46 +0,0 @@ -Create a new Inventory -~~~~~~~~~~~~~~~~~~~~~~~~ - -.. index:: - single: inventory; create new - single: inventory; add to organization - -An inventory is a collection of hosts managed by AWX. Organizations are assigned to inventories, while permissions to launch playbooks against inventories are controlled at the user and/or team level. For more information, refer to :ref:`Inventories <ug_inventories>`, :ref:`Users - Permissions <ug_users_permissions>`, and :ref:`Teams - Permissions <ug_teams_permissions>` in the |atu|. - -To view existing inventories, click **Inventories** from the left navigation bar. - -.. image:: ../common/images/qs-inventories-default-list-view.png - -|at| provides a demo inventory for you to use as you learn how AWX works. It can be used as is or edited later as needed. You may create another inventory if necessary. Refer to :ref:`ug_inventories_add` in the |atu| for detail. - -For the purpose of this Quick Start Guide, leave the default inventory as is. - -Click **Demo Inventory** to view its details. - -|Inventories - Demo inventory details| - -.. |Inventories - Demo inventory details| image:: ../common/images/qs-inventories-demo-details.png - -As with organizations, inventories also have associated users and teams that you can view through the **Access** tab. - -.. image:: ../common/images/qs-inventories-default-access-list-view.png - -A default admin user with the role of System Administrator has been automatically populated for this demo inventory. - - -Groups and Hosts -^^^^^^^^^^^^^^^^^ - -Note that inventories are divided into groups and hosts. A group might represent a particular environment (e.g. "Datacenter 1" or "Stage Testing"), a server type (e.g. "Application Servers" or "DB Servers"), or any other representation of your environment. The groups and hosts that belong to the Demo inventory are shown in the **Groups** and **Hosts** tabs, respectively. - -To add new groups, click the **Add** button in the Groups screen. - -Similarly, in the **Hosts** tab, click the **Add** button to add hosts to groups. - -For the purposes of this Quick Start and to test that AWX is setup properly, a local host has been added for your use. - -.. image:: ../common/images/qs-inventories-default-host.png - -Suppose that the organization you created earlier has a group of web server hosts supporting a particular application. To add these hosts to the inventory, create a group and add the web server hosts. - -Click **Cancel** (if no changes were made) or use the breadcrumb navigational links at the top of the |at| browser to return to the Inventories list view. Clicking **Save** does not exit the Details dialog. diff --git a/docs/docsite/rst/quickstart/create_job.rst b/docs/docsite/rst/quickstart/create_job.rst deleted file mode 100644 index ca25e85271..0000000000 --- a/docs/docsite/rst/quickstart/create_job.rst +++ /dev/null @@ -1,31 +0,0 @@ -Create a new Job Template -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. index:: - single: job templates; creation - -A job template combines an Ansible playbook from a project and the settings required to launch it. Review existing job templates by clicking **Templates** from the left navigation bar. - -|Job templates - home| - -.. |Job templates - home| image:: ../common/images/qs-job-templates-list-view.png - -For the purpose of this Quick Start, a Demo Job Template has been created for your initial use. - -Click **Demo Job Template** to view its details. - -|Job templates - review demo template| - -.. |Job templates - review demo template| image:: ../common/images/qs-job-template-demo-details.png - -For the purpose of this Quick Start Guide, leave the default demo job template as is. But to edit the default template later - from the Details tab, click **Edit**, or from the Templates list view, click the Edit (|edit|) button next to the template name to edit the appropriate details, then save your changes. - -.. |edit| image:: ../common/images/edit-button.png - - -|Job templates - edit demo| - -.. |Job templates - edit demo| image:: ../common/images/qs-job-templates-demo-edit.png - - -Click **Cancel** (if no changes were made) or use the breadcrumb navigational links at the top of the |at| browser to return to the Templates list view. Clicking **Save** does not exit the Details dialog.
\ No newline at end of file diff --git a/docs/docsite/rst/quickstart/create_organization.rst b/docs/docsite/rst/quickstart/create_organization.rst deleted file mode 100644 index 544ad3419c..0000000000 --- a/docs/docsite/rst/quickstart/create_organization.rst +++ /dev/null @@ -1,36 +0,0 @@ -Review the Organization -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. index:: - single: organizations - -An organization is a logical collection of users, teams, projects, and inventories. It is the highest level object in the AWX object hierarchy. - -From the left navigation bar, click **Organizations**. - -.. note:: - AWX creates a default organization automatically. - -|Organizations - default view| - -.. |Organizations - default view| image:: ../common/images/organizations-home-showing-example-organization.png - -.. index:: - single: organization; default - - -A default organization has been automatically created and is available to all users of AWX. It can be used as is or edited later as needed, but deleting it is not recommended. - -For the purpose of this Quick Start Guide, leave the default organization as is. - -To edit the default organization later, expand its properties by clicking the Edit (|edit|) button and entering the appropriate details, then save your changes. - -.. |edit| image:: ../common/images/edit-button.png - -.. image:: ../common/images/qs-organization-list-view-edit-icon.png - -|Organizations - default expanded| - -.. |Organizations - default expanded| image:: ../common/images/qs-organization-default-expand-properties.png - -To add a new organization, refer to the :ref:`ug_organizations` section in the |atu|. diff --git a/docs/docsite/rst/quickstart/create_project.rst b/docs/docsite/rst/quickstart/create_project.rst deleted file mode 100644 index 14ba6d1bea..0000000000 --- a/docs/docsite/rst/quickstart/create_project.rst +++ /dev/null @@ -1,42 +0,0 @@ -Setting up a Project -~~~~~~~~~~~~~~~~~~~~~~~ - -.. index:: - single: projects - - -A Project is a logical collection of Ansible playbooks, represented in AWX. - -You can manage playbooks and playbook directories by either placing them manually under the Project Base Path on your AWX server, or by placing your playbooks into a source code management (SCM) system supported by AWX, including Git, Subversion, and Mercurial. - -.. note:: - - It is recommended that, whenever possible, you use source control to manage your playbooks. This type of best practice provides the ability to treat your infrastructure as code and is in line with DevOps ideals. While this Quick Start Guide uses lightweight examples to get you up and running, we suggest using source control to manage your actual playbooks. - -To review existing projects, click **Projects** from the left navigation bar. - -|Projects - home| - -.. |Projects - home| image:: ../common/images/qs-projects-home.png - -The |at| simplifies the startup process by providing you with a Demo Project to work with initially. - -Click on **Demo Project** to view its details. - -|Projects - demo project| - -.. |Projects - demo project| image:: ../common/images/qs-demo-project-details.png - -For the purpose of this Quick Start Guide, leave the default demo project as is. But to edit the default project later - from the Details tab, click **Edit**, or from the Projects list view, click the Edit (|edit|) button next to the project name to edit the appropriate details, then save your changes. - -.. |edit| image:: ../common/images/edit-button.png - -If you want to fetch the project for latest changes, you can manually start an SCM sync for this project. Update the SCM-based demo project from the Details tab, click **Sync**, or from the Projects list view, click the Sync (|sync|) button next to the project name. - -.. image:: ../common/images/qs-demo-project-sync-icon-hover.png - -.. note:: - - Please note that immediately after adding new projects setup to use source control, a "sync" automatically starts that fetches the project details from the configured source control. - -.. |sync| image:: ../common/images/refresh-button.png diff --git a/docs/docsite/rst/quickstart/create_user.rst b/docs/docsite/rst/quickstart/create_user.rst deleted file mode 100644 index aac62ebaa1..0000000000 --- a/docs/docsite/rst/quickstart/create_user.rst +++ /dev/null @@ -1,23 +0,0 @@ -Create a User -~~~~~~~~~~~~~~~~ - -.. index:: - single: users; add new - single: users; add to organization - -Users associated with an organization are shown in the **Access** tab of the Organization. - -|Organizations - default admin user| - -.. |Organizations - default admin user| image:: ../common/images/qs-organizations-admin-user-default-organization.png - - -A default `admin` user with the role of System Administrator has been automatically created and is available to all users of AWX. It can be used as is or edited later as needed. You may add other users to an organization, but you must create the user(s) first. Refer to the :ref:`Users <ug_users_create>` section in the |atu| for detail. - -For the purpose of this Quick Start Guide, leave the default user as is. - - - - - -
\ No newline at end of file diff --git a/docs/docsite/rst/quickstart/examine_dashboard.rst b/docs/docsite/rst/quickstart/examine_dashboard.rst deleted file mode 100644 index cbe645e614..0000000000 --- a/docs/docsite/rst/quickstart/examine_dashboard.rst +++ /dev/null @@ -1,50 +0,0 @@ -Examine the AWX Dashboard -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. index:: - pair: dashboard; examine - pair: settings menu; organization - pair: settings menu; users - pair: settings menu; teams - pair: settings menu; credentials - pair: settings menu; management jobs - pair: settings menu; inventory scripts - pair: settings menu; notifications - pair: settings menu; credential types - pair: settings menu; instance groups - pair: settings menu; help about - - -The Dashboard offers a friendly graphical framework for your Ansible needs. Along the left side of the Dashboard is the navigation menu, where you can quickly display different views, navigate to your resources, grant access, and administer certain AWX features in the UI. - -.. note:: - - The new AWX User Interface is available for tech preview and is subject to change in a future release. To preview the new UI, click the **Enable Preview of New User Interface** toggle to **On** from the Miscellaneous System option of the Settings menu. - - .. image:: ../common/images/configure-awx-system-misc-preview-newui.png - - After saving, logout and log back in to access the new UI from the preview banner. To return to the current UI, click the link on the top banner where indicated. - - .. image:: ../common/images/ug-dashboard-preview-banner.png - - -Click on the Menu |menu| icon at the top of the left navigation to hide or display the navigation bar. - -.. |menu| image:: ../common/images/menu-icon.png - -On the main Dashboard view, a summary appears listing your current **Job Status**. You can filter the job status within a period of time or by job type. Also available in their respective tabs are summaries of **Recent Jobs** ran and **Recent Templates** used. These can be sorted by various attributes. - -|Home dashboard| - -.. |Home dashboard| image:: ../common/images/home-dashboard.png - -The very last item in the navigation bar is **Settings**, which provides access to the AWX configuration Settings. - -The Settings page allows administrators to configure authentication, jobs, system-level attributes, and customize the user interface. Refer to :ref:`ag_configure_awx` section for more detail. - -Regardless of the window or action you're performing, the very top of each page next to the your user icon is the About (|about|) icon, which provides you the versions of AWX and Ansible you are currently running. - -.. |about| image:: ../common/images/help-about-icon.png - -.. note:: - Keep in mind that the goal of this Quick Start is to launch a simple playbook. To do this, a number of configuration options must be setup. Completing the quick start configuration tasks now ensures that AWX is configured properly and allows for easier executions of more involved playbooks later on.
\ No newline at end of file diff --git a/docs/docsite/rst/quickstart/index.rst b/docs/docsite/rst/quickstart/index.rst deleted file mode 100644 index 4e60d7cee1..0000000000 --- a/docs/docsite/rst/quickstart/index.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. _qs_start: - -============== -AWX Quickstart -============== - -Complete the basic steps for using AWX and running your first playbook. - -This guide applies to the latest version of AWX only. -The content in this guide is updated frequently and might contain functionality that is not available in previous versions. -Likewise content in this guide can be removed or replaced if it applies to functionality that is no longer available in the latest version. - -**Join us online** - -Need help or want to discuss AWX including the documentation? See the :ref:`Communication guide<communication>` to learn how to join the conversation! - -.. toctree:: - :maxdepth: 2 - :numbered: - - self - quick_start - login_superuser - examine_dashboard - setup - create_organization - create_user - create_inventory - create_credential - create_project - create_job - launch - -.. excluded 'configure authentication' from toctree intentionally per doc issue #172. diff --git a/docs/docsite/rst/quickstart/launch.rst b/docs/docsite/rst/quickstart/launch.rst deleted file mode 100644 index d34d4c7502..0000000000 --- a/docs/docsite/rst/quickstart/launch.rst +++ /dev/null @@ -1,35 +0,0 @@ -Launch it! -~~~~~~~~~~~~~~ - -.. index:: - pair: job templates; launch - - - -From the Templates list view, click the Launch (|launch|) button to run the Demo Job Template. - -.. |launch| image:: ../common/images/launch-button.png - -|Job templates - home launch| - -.. |Job templates - home launch| image:: ../common/images/qs-job-templates-list-view-click-launch.png - - -The initial job launch returns a status page which updates automatically using AWX's Live Event feature until the job is complete. Once complete, the job results look like the following: - -|Job templates - demo run complete| - -.. |Job templates - demo run complete| image:: ../common/images/qs-job-templates-demo-complete.png - -For more details on the job results, refer to :ref:`ug_jobs`. - -Congratulations! Your AWX installation is officially setup and running properly. To learn more about these AWX features or to learn about administration tasks, the AWX API, etc., refer to the following documentation sets: - -- :ref:`AWX User Guide <ug_start>` -- :ref:`AWX Administration Guide <ag_start>` -- :ref:`AWX API Guide<api_start>` -- :ref:`AWX Release Notes <releasenotes_start>` -- `Ansible Documentation`_ - -.. _Ansible Documentation: http://docs.ansible.com/ - diff --git a/docs/docsite/rst/quickstart/login_superuser.rst b/docs/docsite/rst/quickstart/login_superuser.rst deleted file mode 100644 index ece13bf074..0000000000 --- a/docs/docsite/rst/quickstart/login_superuser.rst +++ /dev/null @@ -1,16 +0,0 @@ -Login as a Superuser -~~~~~~~~~~~~~~~~~~~~~~~ - -.. index:: - pair: log in; AWX - -Using the login information provided after your installation completed, open a web browser and log in to AWX by browsing to its server URL at: ``https://<AWX_SERVER_NAME>/`` - -Once the AWX UI is accessible, use the credentials specified during the installation process to login. The default username is ``admin``. The password for ``admin`` is the value specified for ``admin_password`` in your inventory file. - -These defaults can be changed later by clicking **Users** from the left navigation bar. - -|Login form| - -.. |Login form| image:: ../common/images/qs-login-form.png - diff --git a/docs/docsite/rst/quickstart/quick_start.rst b/docs/docsite/rst/quickstart/quick_start.rst deleted file mode 100644 index 506aa97efa..0000000000 --- a/docs/docsite/rst/quickstart/quick_start.rst +++ /dev/null @@ -1,11 +0,0 @@ -Quick Start ------------ - -.. index:: - single: quick start, intro - -Welcome to the AWX Quick Start Guide. At the end of the Quick Start, you will have a functioning AWX application that you can use to launch more sophisticated playbooks. You can expect the Quick Start process to take less than thirty minutes. - -To begin, you must install AWX and you must choose a target system where an initial playbook can be deployed (provided by AWX). - -This first playbook executes simple Ansible tasks, while teaching you how to use AWX, as well as ensuring its proper setup. This can be any sort of system manageable by Ansible, as described in the `Managed nodes <https://docs.ansible.com/ansible/latest/user_guide/basic_concepts.html#managed-nodes>`_ section of the Ansible documentation. diff --git a/docs/docsite/rst/quickstart/setup.rst b/docs/docsite/rst/quickstart/setup.rst deleted file mode 100644 index f8d04b74c4..0000000000 --- a/docs/docsite/rst/quickstart/setup.rst +++ /dev/null @@ -1,6 +0,0 @@ - -The Settings Page -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: ../common/settings-menu.rst - |