Skip to content

Commit 656df69

Browse files
Introduce Ansible Module Collection guide (#3859)
* Unify 'getting help' sections for Hammer, API, and Ansible guides * Create Ansible Collection guide * Remove Ansible Module Collection docs from Admin * Add Ansible Collection guide to navigation (nightly) * Ensure users first install pkg and then view modules * Drop playbook template Co-authored-by: Lena Ansorgová <[email protected]>
1 parent 87fb643 commit 656df69

26 files changed

+232
-185
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
include::modules/con_example-playbooks-based-on-modules-from-project-ansible-collection.adoc[]
4+
5+
include::modules/ref_playbook-example-enable-repositories-and-create-a-content-view.adoc[leveloffset=+1]
6+
7+
include::modules/ref_playbook-example-synchronize-repositories-and-publish-a-content-view.adoc[leveloffset=+1]
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
include::modules/con_introduction-to-project-ansible-collection.adoc[]
4+
5+
include::modules/proc_installing-the-project-ansible-modules.adoc[leveloffset=+1]
6+
7+
include::modules/ref_getting-help-with-project-ansible-collection.adoc[leveloffset=+1]

guides/common/assembly_introduction-to-project-api.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ include::modules/con_introduction-to-project-api.adoc[]
55
include::modules/con_overview-of-the-project-api.adoc[leveloffset=+1]
66

77
include::modules/con_project-api-compared-to-hammer-cli.adoc[leveloffset=+1]
8+
9+
include::modules/ref_getting-help-with-project-api.adoc[leveloffset=+1]

guides/common/assembly_managing-project-with-ansible-collection.adoc

Lines changed: 0 additions & 14 deletions
This file was deleted.

guides/common/attributes-base.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// URLs
22
:BaseFilenameURL: index-{build}.html
33
:AdministeringDocURL: {BaseURL}Administering_Project/{BaseFilenameURL}#
4+
:AnsibleDocURL: {BaseURL}Foreman_Ansible_Collection/{BaseFilenameURL}#
45
:APIDocURL: {BaseURL}Project_API/{BaseFilenameURL}#
56
:IntegratingProvisioningInfrastructureServicesDocURL: {BaseURL}Integrating_Provisioning_Infrastructure_Services/{BaseFilenameURL}#
67
:ConfiguringLoadBalancerDocURL: {BaseURL}Configuring_Load_Balancer/{BaseFilenameURL}#

guides/common/attributes-satellite.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
// - lib/foreman_theme_satellite/documentation.rb in RedHatSatellite/foreman_theme_satellite
1515
// - downstream_filename_to_link.json in downstream
1616
:AdministeringDocURL: {BaseURL}administering_red_hat_satellite/index#
17+
:AnsibleDocURL: {BaseURL}using_the_satellite_ansible_collection/index#
1718
:APIDocURL: {BaseURL}using_the_satellite_rest_api/index#
1819
:ConfiguringDNSDHCPTFTPDocURL: {BaseURL}configuring_dns_dhcp_and_tftp_integration/index#
1920
:ConfiguringLoadBalancerDocURL: {BaseURL}configuring_capsules_with_a_load_balancer/index#

guides/common/attributes-titles.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Base for titles
22

33
:AdministeringDocTitle: Administering {ProjectName}
4+
:AnsibleDocTitle: Using the {Project} Ansible Collection
45
:APIDocTitle: Using the {Project} REST API
56
:AppCentricDeploymentDocTitle: Deploying hosts by using application centric approach
67
:IntegratingProvisioningInfrastructureServicesDocTitle: Integrating provisioning infrastructure services

guides/common/modules/con_automating-project-management-with-project-ansible-collection.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66
{Project} Ansible Collection is a set of Ansible modules that interact with the {Project} API.
77
You can use these modules to automate many aspects of {Project} administration.
88

9-
ifeval::["{context}" == "planning"]
109
.Additional resources
1110
* For more information about using Ansible to configure hosts, see {ManagingConfigurationsAnsibleDocURL}[{ManagingConfigurationsAnsibleDocTitle}].
1211
* For more information about automating {Project} using Ansible, see {ManagingConfigurationsAnsibleDocURL}automating-{project-context}-management-with-{project-context}-ansible-collection[Automating {Project} management with {Project} Ansible Collection] in _{AdministeringDocTitle}_.
13-
endif::[]
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
:_mod-docs-content-type: CONCEPT
2+
3+
[id="example-playbooks-based-on-modules-from-{project-context}-ansible-collection"]
4+
= Example playbooks based on modules from {Project} Ansible Collection
5+
6+
All playbooks based on modules from {Project} Ansible Collection must include parameters detailing how to connect to the {Project} API.
7+
The following examples use Ansible vault and module defaults group to provide these parameters, and they authenticate using a username and password.
8+
For more information, see xref:creating-a-playbook-with-modules-from-{project-context}-ansible-collection[].
9+
10+
.Additional resources
11+
* Use the `ansible-doc --list {ansible-namespace}` command to display the {Project} Ansible modules installed on your system.
12+
ifndef::orcharhino[]
13+
* See {ansible-galaxy}[{ansible-galaxy-name}] for a complete list of {Project} Ansible modules and other related information.
14+
endif::[]
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
:_mod-docs-content-type: CONCEPT
2+
3+
[id="introduction-to-{project-context}-ansible-collection"]
4+
= Introduction to {Project} Ansible Collection
5+
6+
{Project} Ansible Collection provides a set of Ansible modules for managing {Project}.
7+
Using the modules, you can automate many aspects of {Project} management.

0 commit comments

Comments
 (0)