Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ If you are using the default internal databases but want to start using external

To confirm whether your {ProjectServer} has internal or external databases, you can query the status of your databases:

For PostgreSQL, enter the following command:

[options="nowrap" subs="+quotes,attributes"]
----
# {foreman-maintain} service status --only postgresql
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ These can be physical interfaces or VLANs.

[id="cli-configuring-a-bonded-interface"]
.CLI procedure

* To create a host with a bonded interface, enter the following command:
* Create a host with a bonded interface:
+
[options="nowrap", subs="verbatim,quotes,attributes"]
----
Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/proc_creating-a-location.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You can return to this page at any time by navigating to *Administer* > *Locatio

[id="cli-creating-a-location"]
.CLI procedure
* Enter the following command to create a location:
* Create a location:
+
[subs="+quotes"]
----
Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/proc_creating-a-role.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this procedure to create a role.
. Click *Submit* to save your new role.

.CLI procedure
* To create a role, enter the following command:
* Create a role:
+
[options="nowrap", subs="+quotes,attributes"]
----
Expand Down
8 changes: 4 additions & 4 deletions guides/common/modules/proc_creating-an-activation-key.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ $ hammer activation-key create \
--content-view-environments "_Development_/_Stack_" \
--organization "_My_Organization_"
----
. Optional: Enter the following command to configure the activation key with system purpose attributes to set on hosts during registration.
. Optional: Configure the activation key with system purpose attributes to set on hosts during registration.
This helps determine which repositories are available on the host.
It also helps with reporting in the Subscriptions service of the Red Hat Hybrid Cloud Console.
+
Expand All @@ -59,9 +59,7 @@ $ hammer activation-key product-content \
--name "_My_Activation_Key_" \
--organization "_My_Organization_"
----
. Override the default auto-enable status for the {project-client-name} repository.
The default status is set to disabled.
To enable, enter the following command:
. Override the default auto-enable status for the {project-client-name} repository:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
Expand All @@ -71,3 +69,5 @@ $ hammer activation-key content-override \
--value 1 \
--organization "_My_Organization_"
----
+
The default status is set to disabled.
4 changes: 2 additions & 2 deletions guides/common/modules/proc_creating-an-organization.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You can return to this page at any time by navigating to *Administer* > *Organiz

[id="cli-creating-an-organization"]
.CLI procedure
. To create an organization, enter the following command:
. Create an organization:
+
[subs="+quotes"]
----
Expand All @@ -33,7 +33,7 @@ $ hammer organization create \
--description "_My_Organization_Description_"
----
. Optional: To edit an organization, enter the `hammer organization update` command.
For example, the following command assigns a compute resource to the organization:
For example, you can assign a compute resource to the organization:
+
[subs="+quotes"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You can also provide a compressed archive file containing extra code for the ima
* The `bin` directory is added to the `$PATH` variable; you can place binary files in this directory and use them in the `autostart` scripts.
* The `facts` directory is added to the `FACTERLIB` variable so that custom facts can be configured and sent to {Project}.
* The `lib` directory is added to the `LD_LIBRARY_PATH` variable and `lib/ruby` is added to the `RUBYLIB` variable, so that binary files in `/bin` can be executed correctly.
. After creating the directory structure, create a `.zip` file archive with the following command:
. After creating the directory structure, create a `.zip` file archive:
+
[options="nowrap" subs="+quotes,verbatim"]
----
Expand Down
4 changes: 2 additions & 2 deletions guides/common/modules/proc_installing-webhooks-plugin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Use the following procedure to install the webhooks plugin.
Then, you can configure {ProjectServer} to send webhook requests.

.Procedure
* Install the webhooks plugin by running the following command:
. On your {ProjectServer}, install the webhooks plugin:
+
[options="nowrap" subs="+quotes,attributes"]
----
# {foreman-installer} --enable-foreman-plugin-webhooks
----
* Optional: Install the webhooks CLI plugin:
. Optional: Install the webhooks CLI plugin:
+
[options="nowrap" subs="+quotes,attributes"]
----
Expand Down
4 changes: 2 additions & 2 deletions guides/common/modules/proc_performing-a-full-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,13 @@ Ensure no other tasks are scheduled for the same time as the backup.
====

.Procedure
* On {ProjectServer}, enter the following command:
* On {ProjectServer}, perform a full backup:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
# {foreman-maintain} backup offline _/var/{project-context}-backup_
----
* On {SmartProxyServer}, enter the following command:
* On {SmartProxyServer}, perform a full backup:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ For more information, see xref:Estimating_the_Size_of_a_Backup_{context}[].
endif::[]

.Procedure
* To perform an online backup, enter the following command:
* On your {ProjectServer}, perform an online backup:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,40 +15,44 @@ You can use both the {ProjectWebUI} and the Hammer CLI to remove lifecycle envir
. Select either *Optimized Sync* or *Complete Sync*.

.CLI procedure
. Select {SmartProxyServer} that you want from the list and take note of its *id*:
. Get a list of {SmartProxies}:
+
[options="nowrap", subs="verbatim,quotes,attributes"]
----
# {hammer-smart-proxy} list
----
. To verify {SmartProxyServer}'s details, enter the following command:
+
Note down the ID of your {SmartProxyServer}.
. Optional: Verify the defails of your {SmartProxyServer}:
+
[options="nowrap", subs="verbatim,quotes,attributes"]
----
# {hammer-smart-proxy} info \
--id __My_{smart-proxy-context-titlecase}_ID__
--id __My_{smart-proxy-context-titlecase}_Server_ID__
----
. Verify the list of lifecycle environments currently attached to {SmartProxyServer} and take note of the *Environment ID*:
. Optional: Verify the list of lifecycle environments currently attached to {SmartProxyServer}:
+
[options="nowrap", subs="verbatim,quotes,attributes"]
----
# {hammer-smart-proxy} content lifecycle-environments \
--id __My_{smart-proxy-context-titlecase}_ID__
--id __My_{smart-proxy-context-titlecase}_Server_ID__
----
+
Note down the Environment ID.
. Remove the lifecycle environment from {SmartProxyServer}:
+
[options="nowrap", subs="verbatim,quotes,attributes"]
----
# {hammer-smart-proxy} content remove-lifecycle-environment \
--id __My_{smart-proxy-context-titlecase}_ID__ \
--id __My_{smart-proxy-context-titlecase}_Server_ID__ \
--lifecycle-environment-id _My_Lifecycle_Environment_ID_
----
+
Repeat this step for every lifecycle environment that you want to remove from {SmartProxyServer}.
. Synchronize the content from {ProjectServer}'s environment to {SmartProxyServer}:
. Synchronize the content from {ProjectServer} to {SmartProxyServer}:
+
[options="nowrap", subs="verbatim,quotes,attributes"]
----
# {hammer-smart-proxy} content synchronize \
--id __My_{smart-proxy-context-titlecase}_ID__
--id __My_{smart-proxy-context-titlecase}_Server_ID__
----
2 changes: 1 addition & 1 deletion guides/common/modules/proc_salt-example.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Welcome to {{ grains['fqdn'] }} Powered by {{ salt['pillar.get']('vendor_name')
Access the `fqdn` Salt Grain from within this template and retrieve the `vendor_name` parameter from the Salt Pillar.
. Import the `motd` Salt State into {Project}.
For more information, see xref:Importing_Salt_States_{context}[].
. Verify that Salt has been given access to the `vendor_name` parameter by running either of the following commands on your Salt Master:
. On your Salt Master, verify that Salt has been given access to the `vendor_name` parameter:
+
[options="nowrap" subs="attributes"]
----
Expand Down
4 changes: 2 additions & 2 deletions guides/common/modules/proc_troubleshooting-dhcp-problems.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@

.Out of sync DHCP records
When an error occurs during DHCP orchestration, DHCP records in the {Project} database and the DHCP server might not match.
To fix this, you must add missing DHCP records from the {Project} database to the DHCP server and then remove unwanted records from the DHCP server as per the following steps:

Check failure on line 12 in guides/common/modules/proc_troubleshooting-dhcp-problems.adoc

View workflow job for this annotation

GitHub Actions / linter

[vale] reported by reviewdog 🐶 [RedHat.TermsErrors] Use 'according to', 'as', or 'as in' rather than 'as per'. Raw Output: {"message": "[RedHat.TermsErrors] Use 'according to', 'as', or 'as in' rather than 'as per'.", "location": {"path": "guides/common/modules/proc_troubleshooting-dhcp-problems.adoc", "range": {"start": {"line": 12, "column": 149}}}, "severity": "ERROR"}

.Procedure
. To preview the DHCP records that are going to be added to the DHCP server, enter the following command:
. Preview the DHCP records that are going to be added to the DHCP server:
+
[options="nowrap" subs="+quotes,attributes"]
----
Expand All @@ -26,7 +26,7 @@
----
. To keep DHCP records in {Project} and in the DHCP server synchronized, you can remove unwanted DHCP records from the DHCP server.
Note that {Project} assumes that all managed DHCP servers do not contain third-party records, therefore, this step might delete those unexpected records.
To preview what records are going to be removed from the DHCP server, enter the following command:
Preview what records are going to be removed from the DHCP server:
+
[options="nowrap" subs="+quotes,attributes"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,20 +59,17 @@ RAM: 256G
Number of CPU cores: 48+

.Procedure

. Optional: If you have configured the `custom-hiera.yaml` file on {ProjectServer}, back up the `/etc/foreman-installer/custom-hiera.yaml` file to `custom-hiera.original`.
You can use the backup file to restore the `/etc/foreman-installer/custom-hiera.yaml` file to its original state if it becomes corrupted:
+
----
# cp /etc/foreman-installer/custom-hiera.yaml \
/etc/foreman-installer/custom-hiera.original
----

. Optional: If you have configured the `custom-hiera.yaml` file on {ProjectServer}, review the definitions of the default tuning profile in `/usr/share/foreman-installer/config/foreman.hiera/tuning/common.yaml` and the tuning profile that you want to apply in `/usr/share/foreman-installer/config/foreman.hiera/tuning/sizes/`.
Compare the configuration entries against the entries in your `/etc/foreman-installer/custom-hiera.yaml` file and remove any duplicated configuration settings in your `/etc/foreman-installer/custom-hiera.yaml` file.

. Enter the `{foreman-installer}` command with the `--tuning` option for the profile that you want to apply.
For example, to apply the medium tuning profile settings, enter the following command:
For example, you can apply the medium tuning profile settings:
+
[options="nowrap" subs="attributes"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ logged every 60 sec: 61752 bytes or 84.80 Mbytes/day
----

.Procedure
* To view data storage statistics, enter the following command on your {ProjectServer}:
* On your {ProjectServer}, view data storage statistics:
+
[options="nowrap", subs="verbatim,quotes,attributes"]
----
Expand Down
Loading