Address asciidoctor-dita-vale issues for host registration (#4409)

* Split multiple modules into web UI and CLI

* Minor fixes to address asciidoctor-dita-vale

* Add abstract role and create basic abstracts

---------

Co-authored-by: Maximilian Kolb <[email protected]>

Author: aneta-petrova

guides/common/assembly_building-cloud-images.adoc

@@ -8,9 +8,13 @@ include::modules/ref_supported-clients-in-registration.adoc[leveloffset=+1]
 
 include::modules/proc_configuring-a-host-for-registration.adoc[leveloffset=+1]
 
-include::modules/proc_registering-a-host.adoc[leveloffset=+1]
+include::modules/proc_registering-a-host-by-using-web-ui.adoc[leveloffset=+1]
 
-include::modules/proc_registering-a-host-using-ansible.adoc[leveloffset=+1]
+include::modules/proc_registering-a-host-by-using-cli.adoc[leveloffset=+1]
+
+include::modules/proc_registering-a-host-by-using-api.adoc[leveloffset=+1]
+
+include::modules/proc_registering-a-host-by-using-ansible.adoc[leveloffset=+1]
 
 include::modules/proc_installing-and-configuring-puppet-agent-manually.adoc[leveloffset=+1]
 

guides/common/assembly_registering-hosts.adoc

@@ -15,27 +15,43 @@ include::modules/ref_global-parameters-for-registration.adoc[leveloffset=+2]
 
 include::modules/proc_configuring-a-host-for-registration.adoc[leveloffset=+2]
 
-include::modules/proc_registering-a-host.adoc[leveloffset=+2]
+include::modules/proc_registering-a-host-by-using-web-ui.adoc[leveloffset=+2]
 
-include::modules/proc_registering-a-host-using-ansible.adoc[leveloffset=+2]
+include::modules/proc_registering-a-host-by-using-cli.adoc[leveloffset=+2]
+
+include::modules/proc_registering-a-host-by-using-api.adoc[leveloffset=+2]
+
+include::modules/proc_registering-a-host-by-using-ansible.adoc[leveloffset=+2]
 
 include::modules/proc_running-custom-code-during-host-registration.adoc[leveloffset=+2]
 
 include::modules/proc_customizing-the-registration-templates.adoc[leveloffset=+2]
 
 include::modules/con_invalidating-registration-tokens.adoc[leveloffset=+2]
 
-include::modules/proc_invalidating-your-own-jwts.adoc[leveloffset=+3]
+include::modules/proc_invalidating-your-own-jwts-by-using-web-ui.adoc[leveloffset=+3]
+
+include::modules/proc_invalidating-your-own-jwts-by-using-cli.adoc[leveloffset=+3]
+
+include::modules/proc_invalidating-your-own-jwts-by-using-api.adoc[leveloffset=+3]
 
-include::modules/proc_invalidating-jwts-of-other-users.adoc[leveloffset=+3]
+include::modules/proc_invalidating-jwts-of-other-users-by-using-web-ui.adoc[leveloffset=+3]
+
+include::modules/proc_invalidating-jwts-of-other-users-by-using-cli.adoc[leveloffset=+3]
+
+include::modules/proc_invalidating-jwts-of-other-users-by-using-api.adoc[leveloffset=+3]
 
 include::modules/proc_invalidating-jwts-of-all-users.adoc[leveloffset=+3]
 
 ifdef::satellite,orcharhino[]
 // Bootstrap script
 include::modules/proc_registering-hosts-by-using-the-bootstrap-script.adoc[leveloffset=+1]
 
-include::modules/proc_setting-permissions-for-the-bootstrap-script.adoc[leveloffset=+2]
+include::modules/proc_creating-a-puppet-environment-for-bootstrap-registration.adoc[leveloffset=+1]
+
+include::modules/proc_setting-permissions-for-the-bootstrap-script-by-using-web-ui.adoc[leveloffset=+2]
+
+include::modules/proc_setting-permissions-for-the-bootstrap-script-by-using-cli.adoc[leveloffset=+2]
 
 include::modules/ref_advanced-bootstrap-script-configuration.adoc[leveloffset=+2]
 

guides/common/modules/con_invalidating-registration-tokens.adoc

@@ -3,8 +3,11 @@
 [id="invalidating-registration-tokens"]
 = Invalidating registration tokens
 
+[role="_abstract"]
 When you generate a registration command in global host registration, {Project} also generates a unique JSON Web Token (JWT) that is used to authorize the registration call from a host to {ProjectServer}.
-This JWT is bound to the user that generated the registration command.
+If needed, you can invalidate a previously issued JWT.
+
+A JWT is bound to the user that generated the registration command.
 
 Users can configure a custom validity duration for the JWT.
 If the validity duration is too long or if the JWT has been compromised, the JWT poses a security concern.

guides/common/modules/con_registering-hosts-and-setting-up-host-integration.adoc

@@ -3,6 +3,7 @@
 [id="registering-hosts-and-setting-up-host-integration_{context}"]
 = Registering hosts and setting up host integration
 
+[role="_abstract"]
 You must register hosts that have not been provisioned through {Project} to be able to manage them with {Project}.
 You can register hosts through {ProjectServer} or {SmartProxyServer}.
 

guides/common/modules/con_registering-hosts-by-using-global-registration.adoc

@@ -3,6 +3,7 @@
 [id="Registering_Hosts_by_Using_Global_Registration_{context}"]
 = Registering hosts by using global registration
 
+[role="_abstract"]
 You can register a host to {Project} by generating a `curl` or `wget` command on {Project} and running this command on hosts.
 This method uses two provisioning templates: *Global Registration* template and *Linux host_init_config default* template.
 That gives you complete control over the host registration process.
@@ -17,7 +18,6 @@ For more information, see {AdministeringDocURL}limiting-host-resources[Limiting
 endif::[]
 
 ifndef::satellite,orcharhino[]
-.Additional resources
-* You can extend registration options by plugins.
+You can extend registration options by plugins.
 For more information, see https://github.com/theforeman/foreman/blob/develop/developer_docs/how_to_create_a_plugin.asciidoc[How to Create a Plugin] and https://github.com/theforeman/foreman/blob/develop/developer_docs/slot-and-fill.asciidoc[Slot and Fill].
 endif::[]

guides/common/modules/con_using-custom-ssl-certificate-for-hosts.adoc

@@ -3,5 +3,6 @@
 [id="using-custom-ssl-certificate-for-hosts_{context}"]
 = Using {customssl} certificate for hosts
 
+[role="_abstract"]
 You can use {customssl} certificate on your hosts to enable encrypted communications between {ProjectServer}, {SmartProxyServer}, and hosts.
 Before deploying it to your hosts, ensure that you have configured the {customssl} certificate to your {ProjectServer}.

guides/common/modules/proc_changing-the-method-the-bootstrap-script-uses-to-download-the-consumer-rpm.adoc

@@ -3,6 +3,7 @@
 [id="Changing_the_Method_the_Bootstrap_Script_Uses_to_Download_the_Consumer_RPM_{context}"]
 = Changing the method the bootstrap script uses to download the consumer RPM
 
+[role="_abstract"]
 By default, the bootstrap script uses HTTP to download the consumer RPM from `\http://{foreman-example-com}/pub/katello-ca-consumer-latest.noarch.rpm`.
 In some environments, you might want to allow HTTPS only between the host and {Project}.
 Use `--download-method` to change the download method from HTTP to HTTPS.

guides/common/modules/proc_configuring-a-host-for-registration.adoc

@@ -3,6 +3,7 @@
 [id="Configuring_a_Host_for_Registration_{context}"]
 = Configuring a host for registration
 
+[role="_abstract"]
 Configure your host for registration to {ProjectServer} or {SmartProxyServer}.
 You can use a configuration management tool to configure multiple hosts at once.
 

guides/common/modules/proc_creating-a-domain-for-a-host-during-registration.adoc

@@ -3,6 +3,7 @@
 [id="Creating_a_Domain_for_a_Host_During_Registration_{context}"]
 = Creating a domain for a host during registration
 
+[role="_abstract"]
 To create a host record, the DNS domain of a host needs to exist in {Project} prior to running the script.
 If the domain does not exist, add it using `--add-domain`.
 

guides/common/modules/proc_creating-a-puppet-environment-for-bootstrap-registration.adoc

@@ -0,0 +1,20 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="creating-a-puppet-environment-for-bootstrap-registration"]
+= Creating a Puppet environment for bootstrap registration
+
+[role="_abstract"]
+If a host group is associated with a Puppet environment created inside a `Production` environment, Puppet fails to retrieve the Puppet CA certificate while registering a host from that host group.
+You must create a suitable Puppet environment to be associated with a host group.
+
+.Procedure
+. Manually create a directory:
++
+[options="nowrap", subs="+quotes,attributes"]
+----
+# mkdir /etc/puppetlabs/code/environments/_example_environment_
+----
+. In the {ProjectWebUI}, navigate to *Configure* > *Puppet ENC* > *Environments*.
+. Click *Import environment from*.
+. Select your {SmartProxy}.
+. Choose the created directory and click *Update*.