Lines Matching refs:msgid

6 msgid ""
20 msgid "Galaxy Developer Guide"
24 msgid "You can host collections and roles on Galaxy to share with the Ansible community. Galaxy con…
28 msgid "Creating collections for Galaxy"
32 msgid "Collections are a distribution format for Ansible content. You can use collections to packag…
36 msgid "See :ref:`developing_collections` for details on how to create collections."
40 msgid "Creating roles for Galaxy"
44 msgid "Use the ``init`` command to initialize the base structure of a new role, saving time on crea…
48 msgid "The above will create the following directory structure in the current working directory:"
52 msgid "If you want to create a repository for the role the repository root should be `role_name`."
56 msgid "Force"
60 msgid "If a directory matching the name of the role already exists in the current working directory…
64 msgid "Container enabled"
68 msgid "If you are creating a Container Enabled role, pass ``--type container`` to ``ansible-galaxy …
72 msgid "Using a custom role skeleton"
76 msgid "A custom role skeleton directory can be supplied as follows:"
80 msgid "When a skeleton is provided, init will:"
84 msgid "copy all files and directories from the skeleton to the new role"
88 msgid "any .j2 files found outside of a templates folder will be rendered as templates. The only us…
92 msgid "The .git folder and any .git_keep files will not be copied"
96 msgid "Alternatively, the role_skeleton and ignoring of files can be configured via ansible.cfg"
100 msgid "Authenticate with Galaxy"
104 msgid "Using the ``import``, ``delete`` and ``setup`` commands to manage your roles on the Galaxy w…
108 msgid "The ``login`` command requires using your GitHub credentials. You can use your username and …
112 msgid "The following shows authenticating with the Galaxy website using a GitHub username and passw…
116 msgid "When you choose to use your username and password, your password is not sent to Galaxy. It i…
120 msgid "If you do not want to use your GitHub password, or if you have two-factor authentication ena…
124 msgid "Import a role"
128 msgid "The ``import`` command requires that you first authenticate using the ``login`` command. Onc…
132 msgid "Use the following to import to role:"
136 msgid "By default the command will wait for Galaxy to complete the import process, displaying the r…
140 msgid "Branch"
144 msgid "Use the ``--branch`` option to import a specific branch. If not specified, the default branc…
148 msgid "Role name"
152 msgid "By default the name given to the role will be derived from the GitHub repository name. Howev…
156 msgid "No wait"
160 msgid "If the ``--no-wait`` option is present, the command will not wait for results. Results of th…
164 msgid "Delete a role"
168 msgid "The ``delete`` command requires that you first authenticate using the ``login`` command. Onc…
172 msgid "Use the following to delete a role:"
176 msgid "This only removes the role from Galaxy. It does not remove or alter the actual GitHub reposi…
180 msgid "Travis integrations"
184 msgid "You can create an integration or connection between a role in Galaxy and `Travis <https://tr…
188 msgid "You create the integration using the ``setup`` command, but before an integration can be cre…
192 msgid "The setup command requires your Travis token, however the token is not stored in Galaxy. It …
196 msgid "The setup command enables Galaxy to respond to notifications. To configure Travis to run a b…
200 msgid "To instruct Travis to notify Galaxy when a build completes, add the following to your .travi…
204 msgid "List Travis integrations"
208 msgid "Use the ``--list`` option to display your Travis integrations:"
212 msgid "Remove Travis integrations"
216 msgid "Use the ``--remove`` option to disable and remove a Travis integration:"
220 msgid "Provide the ID of the integration to be disabled. You can find the ID by using the ``--list`…
224 msgid ":ref:`collections`"
228 msgid "Shareable collections of modules, playbooks and roles"
232 msgid ":ref:`playbooks_reuse_roles`"
236 msgid "All about ansible roles"
240 msgid "`Mailing List <https://groups.google.com/group/ansible-project>`_"
244 msgid "Questions? Help? Ideas? Stop by the list on Google Groups"
248 msgid "`irc.libera.chat <https://libera.chat/>`_"
252 msgid "#ansible IRC chat channel"
256 msgid "Galaxy User Guide"
260 msgid ":dfn:`Ansible Galaxy` refers to the `Galaxy <https://galaxy.ansible.com>`_ website, a free …
264 msgid "Use Galaxy to jump-start your automation project with great content from the Ansible communi…
268 msgid "Finding collections on Galaxy"
272 msgid "To find collections on Galaxy:"
276 msgid "Click the :guilabel:`Search` icon in the left-hand navigation."
280 msgid "Set the filter to *collection*."
284 msgid "Set other filters and press :guilabel:`enter`."
288 msgid "Galaxy presents a list of collections that match your search criteria."
292 msgid "Installing collections"
296 msgid "Installing a collection from Galaxy"
300 msgid "By default, ``ansible-galaxy collection install`` uses https://galaxy.ansible.com as the Gal…
304 msgid "See :ref:`Configuring the ansible-galaxy client <galaxy_server_config>` if you are using any…
308 msgid "To install a collection hosted in Galaxy:"
312 msgid "To upgrade a collection to the latest available version from the Galaxy server you can use t…
316 msgid "You can also directly use the tarball from your build:"
320 msgid "You can build and install a collection from a local source directory. The ``ansible-galaxy``…
324 msgid "You can also install multiple collections in a namespace directory."
328 msgid "The install command automatically appends the path ``ansible_collections`` to the one specif…
332 msgid "When using the ``-p`` option to specify the install path, use one of the values configured i…
336 msgid "You can also keep a collection adjacent to the current playbook, under a ``collections/ansib…
340 msgid "See :ref:`collection_structure` for details on the collection directory structure."
344 msgid "Downloading a collection from Automation Hub"
348 msgid "You can download collections from Automation Hub at the command line. Automation Hub content…
352 msgid "Get your Automation Hub API token. Go to https://cloud.redhat.com/ansible/automation-hub/tok…
356 msgid "Configure Red Hat Automation Hub server in the ``server_list`` option under the ``[galaxy]`…
360 msgid "Download the collection hosted in Automation Hub."
364 msgid "`Getting started with Automation Hub <https://www.ansible.com/blog/getting-started-with-ansi…
368 msgid "An introduction to Automation Hub"
372 msgid "Installing an older version of a collection"
376 msgid "You can only have one version of a collection installed at a time. By default ``ansible-gala…
380 msgid "You can specify multiple range identifiers separated by ``,``. Use single quotes so the shel…
384 msgid "Ansible will always install the most recent version that meets the range identifiers you spe…
388 msgid "``*``: The most recent version. This is the default."
392 msgid "``!=``: Not equal to the version specified."
396 msgid "``==``: Exactly the version specified."
400 msgid "``>=``: Greater than or equal to the version specified."
404 msgid "``>``: Greater than the version specified."
408 msgid "``<=``: Less than or equal to the version specified."
412 msgid "``<``: Less than the version specified."
416 msgid "By default ``ansible-galaxy`` ignores pre-release versions. To install a pre-release version…
420 msgid "Install multiple collections with a requirements file"
424 msgid "You can also setup a ``requirements.yml`` file to install multiple collections in one comman…
428 msgid "The supported keys for collection requirement entries are ``name``, ``version``, ``source``,…
432 msgid "The ``version`` key can take in the same range identifier format documented above. If you're…
436 msgid "The ``type`` key can be set to ``galaxy``, ``url``, ``file``, and ``git``. If ``type`` is om…
440 msgid "Roles can also be specified and placed under the ``roles`` key. The values follow the same f…
444 msgid "To install both roles and collections at the same time with one command, run the following:"
448 msgid "Running ``ansible-galaxy collection install -r`` or ``ansible-galaxy role install -r`` will …
452 msgid "Installing both roles and collections from the same requirements file will not work when spe…
456 msgid "Downloading a collection for offline use"
460 msgid "To download the collection tarball from Galaxy for offline use:"
464 msgid "Navigate to the collection page."
468 msgid "Click on :guilabel:`Download tarball`."
472 msgid "You may also need to manually download any dependent collections."
476 msgid "Installing a collection from a git repository"
480 msgid "You can install a collection in a git repository by providing the URI to the repository inst…
484 msgid "Embedding credentials into a git URI is not secure. Make sure to use safe auth options for s…
488 msgid "In a ``requirements.yml`` file, you can also use the ``type`` and ``version`` keys in additi…
492 msgid "Git repositories can be used for collection dependencies as well. This can be helpful for lo…
496 msgid "Default repository search locations"
500 msgid "There are two paths searched in a repository for collections by default."
504 msgid "The first is the ``galaxy.yml`` or ``MANIFEST.json`` file in the top level of the repository…
508 msgid "The second is a ``galaxy.yml`` or ``MANIFEST.json`` file in each directory in the repository…
512 msgid "Specifying the location to search for collections"
516 msgid "If you have a different repository structure or only want to install a subset of collections…
520 msgid "Listing installed collections"
524 msgid "To list installed collections, run ``ansible-galaxy collection list``. See :ref:`collections…
528 msgid "Configuring the ``ansible-galaxy`` client"
532 msgid "By default, ``ansible-galaxy`` uses https://galaxy.ansible.com as the Galaxy server (as list…
536 msgid "You can use either option below to configure ``ansible-galaxy collection`` to use other serv…
540 msgid "Set the server list in the :ref:`galaxy_server_list` configuration option in :ref:`ansible_c…
544 msgid "Use the ``--server`` command line argument to limit to an individual server."
548 msgid "To configure a Galaxy server list in ``ansible.cfg``:"
552 msgid "Add the ``server_list`` option under the ``[galaxy]`` section to one or more server names."
556 msgid "Create a new section for each server name."
560 msgid "Set the ``url`` option for each server name."
564 msgid "Optionally, set the API token for each server name. Go to https://galaxy.ansible.com/me/pref…
568 msgid "The ``url`` option for each server name must end with a forward slash ``/``. If you do not s…
572 msgid "For Automation Hub, you additionally need to:"
576 msgid "Set the ``auth_url`` option for each server name."
580 msgid "Set the API token for each server name. Go to https://cloud.redhat.com/ansible/automation-hu…
584 msgid "The following example shows how to configure multiple servers:"
588 msgid "You can use the ``--server`` command line argument to select an explicit Galaxy server in th…
592 msgid "**Galaxy server list configuration options**"
596 msgid "The :ref:`galaxy_server_list` option is a list of server identifiers in a prioritized order.…
600 msgid "``url``: The URL of the Galaxy instance to connect to. Required."
604 msgid "``token``: An API token key to use for authentication against the Galaxy instance. Mutually …
608 msgid "``username``: The username to use for basic authentication against the Galaxy instance. Mutu…
612 msgid "``password``: The password to use, in conjunction with ``username``, for basic authenticatio…
616 msgid "``auth_url``: The URL of a Keycloak server 'token_endpoint' if using SSO authentication (for…
620 msgid "As well as defining these server options in the ``ansible.cfg`` file, you can also define th…
624 msgid "For operations that use only one Galaxy server (for example, the ``publish``, ``info``, or `…
628 msgid "Once a collection is found, any of its requirements are only searched within the same Galaxy…
632 msgid "Finding roles on Galaxy"
636 msgid "Search the Galaxy database by tags, platforms, author and multiple keywords. For example:"
640 msgid "The search command will return a list of the first 1000 results matching your search:"
644 msgid "Get more information about a role"
648 msgid "Use the ``info`` command to view more detail about a specific role:"
652 msgid "This returns everything found in Galaxy for the role:"
656 msgid "Installing roles from Galaxy"
660 msgid "The ``ansible-galaxy`` command comes bundled with Ansible, and you can use it to install rol…
664 msgid "The command line tool by default communicates with the Galaxy website API using the server a…
668 msgid "Installing roles"
672 msgid "Use the ``ansible-galaxy`` command to download roles from the `Galaxy website <https://galax…
676 msgid "Setting where to install roles"
680 msgid "By default, Ansible downloads roles to the first writable directory in the default list of p…
684 msgid "You can override this with one of the following options:"
688 msgid "Set the environment variable :envvar:`ANSIBLE_ROLES_PATH` in your session."
692 msgid "Use the ``--roles-path`` option for the ``ansible-galaxy`` command."
696 msgid "Define ``roles_path`` in an ``ansible.cfg`` file."
700 msgid "The following provides an example of using ``--roles-path`` to install the role into the cur…
704 msgid ":ref:`intro_configuration`"
708 msgid "All about configuration files"
712 msgid "Installing a specific version of a role"
716 msgid "When the Galaxy server imports a role, it imports any git tags matching the `Semantic Versio…
720 msgid "To see the available versions for a role:"
724 msgid "Locate the role on the Galaxy search page."
728 msgid "Click on the name to view more details, including the available versions."
732 msgid "You can also navigate directly to the role using the /<namespace>/<role name>. For example, …
736 msgid "To install a specific version of a role from Galaxy, append a comma and the value of a GitHu…
740 msgid "It is also possible to point directly to the git repository and specify a branch name or com…
744 msgid "Installing multiple roles from a file"
748 msgid "You can install multiple roles by including the roles in a :file:`requirements.yml` file. Th…
752 msgid "Use the following command to install roles included in :file:`requirements.yml:`"
756 msgid "Again, the extension is important. If the *.yml* extension is left off, the ``ansible-galaxy…
760 msgid "Each role in the file will have one or more of the following attributes:"
764 msgid "src"
768 msgid "The source of the role. Use the format *namespace.role_name*, if downloading from Galaxy; ot…
772 msgid "scm"
776 msgid "Specify the SCM. As of this writing only *git* or *hg* are allowed. See the examples below. …
780 msgid "version:"
784 msgid "The version of the role to download. Provide a release tag value, commit hash, or branch nam…
788 msgid "name:"
792 msgid "Download the role to a specific name. Defaults to the Galaxy name when downloading from Gala…
796 msgid "Use the following example as a guide for specifying roles in *requirements.yml*:"
800 msgid "Embedding credentials into a SCM URL is not secure. Make sure to use safe auth options for s…
804 msgid "Installing roles and collections from the same requirements.yml file"
808 msgid "You can install roles and collections from the same requirements files"
812 msgid "Installing multiple roles from multiple files"
816 msgid "For large projects, the ``include`` directive in a :file:`requirements.yml` file provides th…
820 msgid "For example, a project may have a :file:`requirements.yml` file, and a :file:`webserver.yml`…
824 msgid "Below are the contents of the :file:`webserver.yml` file:"
828 msgid "The following shows the contents of the :file:`requirements.yml` file that now includes the …
832 msgid "To install all the roles from both files, pass the root file, in this case :file:`requiremen…
836 msgid "Dependencies"
840 msgid "Roles can also be dependent on other roles, and when you install a role that has dependencie…
844 msgid "There are two ways to define the dependencies of a role:"
848 msgid "using ``meta/requirements.yml``"
852 msgid "using ``meta/main.yml``"
856 msgid "Using ``meta/requirements.yml``"
860 msgid "You can create the file ``meta/requirements.yml`` and define dependencies in the same format…
864 msgid "From there, you can import or include the specified roles in your tasks."
868 msgid "Using ``meta/main.yml``"
872 msgid "Alternatively, you can specify role dependencies in the ``meta/main.yml`` file by providing …
876 msgid "Dependencies installed that way, depending on other factors described below, will also be ex…
880 msgid "The following shows an example ``meta/main.yml`` file with dependent roles:"
884 msgid "Tags are inherited *down* the dependency chain. In order for tags to be applied to a role an…
888 msgid "Roles listed as dependencies are subject to conditionals and tag filtering, and may not exec…
892 msgid "If the source of a role is Galaxy, specify the role in the format *namespace.role_name*:"
896 msgid "Alternately, you can specify the role dependencies in the complex form used in :file:`requi…
900 msgid "Galaxy expects all role dependencies to exist in Galaxy, and therefore dependencies to be sp…
904 msgid "List installed roles"
908 msgid "Use ``list`` to show the name and version of each role installed in the *roles_path*."
912 msgid "Remove an installed role"
916 msgid "Use ``remove`` to delete a role from *roles_path*:"
920 msgid "Reusable tasks, handlers, and other files in a known directory structure"
923 #~ msgid "You can install a collection in a git repository by providing the URI to the repository i…
926 #~ msgid "The first is the ``galaxy.yml`` file in the top level of the repository path. If the ``ga…
929 #~ msgid "The second is a ``galaxy.yml`` file in each directory in the repository path (one level d…
932 #~ msgid "If you have a different repository structure or only want to install a subset of collecti…
935 #~ msgid "You can install roles and collections from the same requirements files, with some caveats…
938 #~ msgid "While both roles and collections can be specified in one requirements file, they need to …
941 #~ msgid "`.. versionadded:: 2.10`"
944 #~ msgid "`irc.freenode.net <http://irc.freenode.net>`_"