Skip to content

Commit

Permalink
Updated ansible-galaxy man page. Removed -b option for import.
Browse files Browse the repository at this point in the history
  • Loading branch information
ansiblegalaxy authored and chouseknecht committed Dec 13, 2015
1 parent 989604b commit bc73920
Show file tree
Hide file tree
Showing 2 changed files with 201 additions and 5 deletions.
202 changes: 199 additions & 3 deletions docs/man/man1/ansible-galaxy.1.asciidoc.in
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ ansible-galaxy - manage roles using galaxy.ansible.com

SYNOPSIS
--------
ansible-galaxy [init|info|install|list|remove] [--help] [options] ...
ansible-galaxy [delete|import|info|init|install|list|login|remove|search|setup] [--help] [options] ...


DESCRIPTION
-----------

*Ansible Galaxy* is a shared repository for Ansible roles.
The ansible-galaxy command can be used to manage these roles,
or by creating a skeleton framework for roles you'd like to upload to Galaxy.
or for creating a skeleton framework for roles you'd like to upload to Galaxy.

COMMON OPTIONS
--------------
Expand All @@ -29,7 +29,6 @@ COMMON OPTIONS

Show a help message related to the given sub-command.


INSTALL
-------

Expand Down Expand Up @@ -145,6 +144,203 @@ The path to the directory containing your roles. The default is the *roles_path*
configured in your *ansible.cfg* file (/etc/ansible/roles if not configured)


SEARCH
------

The *search* sub-command returns a filtered list of roles found at
galaxy.ansible.com.

USAGE
~~~~~

$ ansible-galaxy search [options] [searchterm1 searchterm2]


OPTIONS
~~~~~~~
*--galaxy-tags*::

Provide a comma separated list of Galaxy Tags on which to filter.

*--platforms*::

Provide a comma separated list of Platforms on which to filter.

*--author*::

Specify the username of a Galaxy contributor on which to filter.

*-c*, *--ingore-certs*::

Ignore TLS certificate errors.

*-s*, *--server*::

Override the default server https://galaxy.ansible.com.


INFO
----

The *info* sub-command shows detailed information for a specific role.
Details returned about the role included information from the local copy
as well as information from galaxy.ansible.com.

USAGE
~~~~~

$ ansible-galaxy info [options] role_name[, version]

OPTIONS
~~~~~~~

*-p* 'ROLES_PATH', *--roles-path=*'ROLES_PATH'::

The path to the directory containing your roles. The default is the *roles_path*
configured in your *ansible.cfg* file (/etc/ansible/roles if not configured)

*-c*, *--ingore-certs*::

Ignore TLS certificate errors.

*-s*, *--server*::

Override the default server https://galaxy.ansible.com.


LOGIN
-----

The *login* sub-command is used to authenticate with galaxy.ansible.com.
Authentication is required to use the import, delete and setup commands.
It will authenticate the user,retrieve a token from Galaxy, and store it
in the user's home directory.

USAGE
~~~~~

$ ansible-galaxy login [options]

The *login* sub-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.

OPTIONS
~~~~~~~

*-c*, *--ingore-certs*::

Ignore TLS certificate errors.

*-s*, *--server*::

Override the default server https://galaxy.ansible.com.

*--github-token*::

Authenticate using a *GitHub* personal access token rather than a password.


IMPORT
------

Import a role from *GitHub* to galaxy.ansible.com. Requires the user first
authenticate with galaxy.ansible.com using the *login* subcommand.

USAGE
~~~~~

$ ansible-galaxy import [options] github_user github_repo

OPTIONS
~~~~~~~
*-c*, *--ingore-certs*::

Ignore TLS certificate errors.

*-s*, *--server*::

Override the default server https://galaxy.ansible.com.

*--branch*::

Provide a specific branch to import. When a branch is not specified the
branch found in meta/main.yml is used. If no branch is specified in
meta/main.yml, the repo's default branch (usually master) is used.


DELETE
------

The *delete* sub-command will delete a role from galaxy.ansible.com. Requires
the user first authenticate with galaxy.ansible.com using the *login* subcommand.

USAGE
~~~~~

$ ansible-galaxy delete [options] github_user github_repo

OPTIONS
~~~~~~~

*-c*, *--ingore-certs*::

Ignore TLS certificate errors.

*-s*, *--server*::

Override the default server https://galaxy.ansible.com.


SETUP
-----

The *setup* sub-command creates an integration point for *Travis CI*, enabling
galaxy.ansible.com to receive notifications from *Travis* on build completion.
Requires the user first authenticate with galaxy.ansible.com using the *login*
subcommand.

USAGE
~~~~~

$ ansible-galaxy setup [options] source github_user github_repo secret

* Use *travis* as the source value. In the future additional source values may
be added.

* Provide your *Travis* user token as the secret. The token is not stored by
galaxy.ansible.com. A hash is created using github_user, github_repo
and your token. The hash value is what actually gets stored.

OPTIONS
~~~~~~~

*-c*, *--ingore-certs*::

Ignore TLS certificate errors.

*-s*, *--server*::

Override the default server https://galaxy.ansible.com.

--list::

Show your configured integrations. Provids the ID of each integration
which can be used with the remove option.

--remove::

Remove a specific integration. Provide the ID of the integration to
be removed.

AUTHOR
------

Expand Down
4 changes: 2 additions & 2 deletions lib/ansible/cli/galaxy.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ def parse(self):
self.parser.set_usage("usage: %prog list [role_name]")
elif self.action == "login":
self.parser.set_usage("usage: %prog login [options]")
self.parser.add_option('-g','--github-token', dest='token', default=None,
self.parser.add_option('--github-token', dest='token', default=None,
help='Identify with github token rather than username and password.')
elif self.action == "search":
self.parser.add_option('--platforms', dest='platforms',
Expand All @@ -118,7 +118,7 @@ def parse(self):
help='List all of your integrations.')

# options that apply to more than one action
if not self.action in ("import","init","login","setup"):
if not self.action in ("delete","import","init","login","setup"):
self.parser.add_option('-p', '--roles-path', dest='roles_path', default=C.DEFAULT_ROLES_PATH,
help='The path to the directory containing your roles. '
'The default is the roles_path configured in your '
Expand Down

0 comments on commit bc73920

Please sign in to comment.