wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Make sure it is clear that new commands require using the Galaxy 2.0 Beta site.

Browse source
This commit is contained in:
chouseknecht 2015-12-09 22:04:00 -05:00 committed by James Cammarata
parent 8bb598daa2
commit 6c48d52b4a
1 changed files with 40 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
docsite/rst/galaxy.rst
View file

@ -1,7 +1,7 @@
Ansible Galaxy Ansible Galaxy
++++++++++++++ ++++++++++++++
"Ansible Galaxy" can either refer to a website for sharing and downloading Ansible roles, or a command line tool that helps work with roles. "Ansible Galaxy" can either refer to a website for sharing and downloading Ansible roles, or a command line tool for managing and creating roles.
.. contents:: Topics .. contents:: Topics
@ -10,24 +10,36 @@ The Website
The website `Ansible Galaxy <https://galaxy.ansible.com>`_, is a free site for finding, downloading, and sharing community developed Ansible roles. Downloading roles from Galaxy is a great way to jumpstart your automation projects. The website `Ansible Galaxy <https://galaxy.ansible.com>`_, is a free site for finding, downloading, and sharing community developed Ansible roles. Downloading roles from Galaxy is a great way to jumpstart your automation projects.
You can sign up with social auth and use the download client 'ansible-galaxy' which is included in Ansible 1.4.2 and later. Access the Galaxy web site using GitHub OAuth, and to install roles use the 'ansible-galaxy' command line tool included in Ansible 1.4.2 and later.
Read the "About" page on the Galaxy site for more information. Read the "About" page on the Galaxy site for more information.
The ansible-galaxy command line tool The ansible-galaxy command line tool
```````````````````````````````````` ````````````````````````````````````
The command line ansible-galaxy has many different subcommands. The ansible-galaxy command has many different sub-commands for managing roles both locally and at `galaxy.ansible.com <https://galaxy.ansible.com>`_.
.. note::
The search, login, import, delete, and setup commands in the Ansible 2.0 version of ansible-galaxy require access to the
2.0 Beta release of the Galaxy web site available at `https://galaxy-qa.ansible.com <https://galaxy-qa.ansible.com>`_.
Use the ``--server`` option to access the beta site. For example::
$ ansible-galaxy search --server https://galaxy-qa.ansible.com mysql --author geerlingguy
Additionally, you can define a server in ansible.cfg::
[galaxy]
server=https://galaxy-qa.ansible.com
Installing Roles Installing Roles
---------------- ----------------
The most obvious is downloading roles from the Ansible Galaxy website:: The most obvious use of the ansible-galaxy command is downloading roles from `the Ansible Galaxy website <https://galaxy.ansible.com>`_::
$ ansible-galaxy install username.rolename $ ansible-galaxy install username.rolename
.. _galaxy_cli_roles_path:
roles_path roles_path
=============== ===============
@ -169,7 +181,9 @@ The search command will return a list of the first 1000 results matching your se
.. note:: .. note::
The format of results pictured here is new in Ansible 2.0. The search command in Ansible 2.0 requires using the Galaxy 2.0 Beta site. Use the ``--server`` option to access
`https://galaxy-qa.ansible.com <https://galaxy-qa.ansible.com>`_. You can also add a *server* definition in the [galaxy]
section of your ansible.cfg file.
Get More Information About a Role Get More Information About a Role
--------------------------------- ---------------------------------
@ -213,10 +227,6 @@ This returns everything found in Galaxy for the role:
version: version:
watchers_count: 1 watchers_count: 1
.. note::
The format of results pictured here is new in Ansible 2.0.
List Installed Roles List Installed Roles
-------------------- --------------------
@ -262,7 +272,13 @@ To use the import, delete and setup commands authentication with Galaxy is requi
As depicted above, the login command prompts for a GitHub username and password. It does NOT send your password to Galaxy. It actually authenticates with GitHub and creates a personal access token. It then sends the personal access token to Galaxy, which in turn verifies that you are you and returns a Galaxy access token. After authentication completes the GitHub personal access token is destroyed. As depicted above, the login command prompts for a GitHub username and password. It does NOT send your password to Galaxy. It actually authenticates with GitHub and creates a personal access token. It then sends the personal access token to Galaxy, which in turn verifies that you are you and returns a Galaxy access token. After authentication completes the GitHub personal access token is destroyed.
If you do not wish to use your GitHub password, or if you have two-factor authentication enabled with GitHub, use the --github-token option to pass a personal access token that you create. Log into GitHub, go to Settings and click on Personal Access Token to create a token. If you do not wish to use your GitHub password, or if you have two-factor authentication enabled with GitHub, use the --github-token option to pass a personal access token that you create. Log into GitHub, go to Settings and click on Personal Access Token to create a token.
.. note::
The login command in Ansible 2.0 requires using the Galaxy 2.0 Beta site. Use the ``--server`` option to access
`https://galaxy-qa.ansible.com <https://galaxy-qa.ansible.com>`_. You can also add a *server* definition in the [galaxy]
section of your ansible.cfg file.
Import a Role Import a Role
------------- -------------
@ -298,7 +314,9 @@ If the --no-wait option is present, the command will not wait for results. Resul
.. note:: .. note::
The import command is only available in Ansible 2.0. The import command in Ansible 2.0 requires using the Galaxy 2.0 Beta site. Use the ``--server`` option to access
`https://galaxy-qa.ansible.com <https://galaxy-qa.ansible.com>`_. You can also add a *server* definition in the [galaxy]
section of your ansible.cfg file.
Delete a Role Delete a Role
------------- -------------
@ -307,13 +325,15 @@ Remove a role from the Galaxy web site using the delete command. You can delete
:: ::
ansible-galaxy delete github_user github_repo $ ansible-galaxy delete github_user github_repo
This only removes the role from Galaxy. It does not impact the actual GitHub repo. This only removes the role from Galaxy. It does not impact the actual GitHub repo.
.. note:: .. note::
The delete command is only available in Ansible 2.0. The delete command in Ansible 2.0 requires using the Galaxy 2.0 Beta site. Use the ``--server`` option to access
`https://galaxy-qa.ansible.com <https://galaxy-qa.ansible.com>`_. You can also add a *server* definition in the [galaxy]
section of your ansible.cfg file.
Setup Travis Integerations Setup Travis Integerations
-------------------------- --------------------------
@ -324,7 +344,7 @@ Using the setup command you can enable notifications from `travis <http://travis
$ ansible-galaxy setup travis github_user github_repo xxxtravistokenxxx $ ansible-galaxy setup travis github_user github_repo xxxtravistokenxxx
Added integration for travis chouseknecht/ansible-role-sendmail Added integration for travis github_user/github_repo
The setup command requires your Travis token. The Travis token is not stored in Galaxy. It is used along with the GitHub username and repo to create a hash as described in `the Travis documentation <https://docs.travis-ci.com/user/notifications/>`_. The calculated hash is stored in Galaxy and used to verify notifications received from Travis. The setup command requires your Travis token. The Travis token is not stored in Galaxy. It is used along with the GitHub username and repo to create a hash as described in `the Travis documentation <https://docs.travis-ci.com/user/notifications/>`_. The calculated hash is stored in Galaxy and used to verify notifications received from Travis.
@ -339,7 +359,9 @@ When you create your .travis.yml file add the following to cause Travis to notif
.. note:: .. note::
The setup command is only available in Ansible 2.0. The setup command in Ansible 2.0 requires using the Galaxy 2.0 Beta site. Use the ``--server`` option to access
`https://galaxy-qa.ansible.com <https://galaxy-qa.ansible.com>`_. You can also add a *server* definition in the [galaxy]
section of your ansible.cfg file.
List Travis Integrtions List Travis Integrtions
@ -361,7 +383,7 @@ Use the --list option to display your Travis integrations:
Remove Travis Integrations Remove Travis Integrations
========================== ==========================
Use the --remove option to disable a Travis integration: Use the --remove option to disable and remove a Travis integration:
:: ::