Procedure 4.1. To Create an Organization:

1. Navigate to Administer → Organizations.
2. Click New Organization.
3. Insert the name of the new organization in the Name field.
4. Insert the label of the new organization in the Label field.
5. Insert a description of the new organization in the Description field.
6. Click Submit.
7. Select the hosts to assign to the new organization.
   • Click Assign All to assign all hosts with no organization to the new organization.
   • Click Manually Assign to manually select and assign the hosts with no organization.
   • Click Proceed to Edit to skip assigning hosts.
8. Specify the configuration details of the organization such as Capsules, subnets or compute resources. You can modify these settings later as described in Section 4.1.3, “Editing an Organization”.
9. Click Submit.

Procedure 4.2. To Create a New Organization Debug Certificate:

1. Navigate to Administer → Organizations.
2. Select an organization for which you want to generate a debug certificate.
3. Click Generate and Download. This generates a debug certificate. Save the certificate file in a secure location.

Procedure 4.3. To Edit an Organization:

1. Navigate to Administer → Organizations.
2. Click the name of the organization to be edited.
3. Select the resource to edit from the list on the left.
4. Click the name of the desired items to add them to the Selected Items list.
5. Click Submit.

Procedure 4.4. To Remove an Organization:

1. Navigate to Administer → Organizations.
2. Select Delete from the drop-down menu to the right of the name of the organization you want to remove.
3. An alert box appears:

   Delete Organization?

4. Click OK to delete the organization.

Procedure 4.5. To Create a Location:

1. Navigate to Administer → Locations.
2. Click New Location.
3. Insert the name of the new location in the Name field. If you want to create a nested location, select a Parent location from the drop-down menu. Optionally, specify a Description of the location. Click Submit.
4. Select the hosts to assign to the new location.
   • Click Assign All to assign all hosts with no location to the new location.
   • Click Manually Assign to manually select and assign the hosts with no location.
   • Click Proceed to Edit to skip assigning hosts.
5. Specify the configuration details of the location such as Capsules, subnets or compute resources. You can modify these settings later as described in Section 4.2.2, “Editing a Location”.
6. Click Submit.

Procedure 4.6. To Edit a Location:

1. Navigate to Administer → Locations.
2. Click the name of the location to be edited.
3. Select the resource to edit from the list on the left.
4. Click the name of the desired items to add them to the Selected Items list.
5. Click Submit.

Procedure 4.7. To Remove a Location:

1. Navigate to Administer → Locations.
2. Select Delete from the drop-down menu to the right of the name of the location you want to remove.
   An alert box appears:

   Delete Location?

3. Click OK.

Procedure 4.8. To Create a Life Cycle Environment:

1. Select an organization from the menu in the top left hand corner.
2. Click Content → Life Cycle Environments and then click New Environment Path.
3. Insert a name and a label (automatically fills in the Name field input) for the life cycle environment. The Description field is optional.
4. Click Save to create the environment.

Procedure 4.9. To Promote a Content View:

1. On the main menu, click Content → Content Views.
2. In the Name column, click the name of the content view that you want to promote.
3. On the Versions tab, identify the latest version, and click Promote.
4. Identify the promotion path where you want to promote the content view, select the appropriate life cycle environment, and click Promote Version.
5. After the promotion has completed, the Versions tab updates to display the new status of your content views.

Procedure 4.10. To Remove a Life Cycle Environment:

1. On the main menu, click Content → Life Cycle Environments.
2. Click the name of the life cycle environment that you want to remove, and then click Remove Environment.
3. In the confirmation dialog box, click Remove to remove the environment.

Procedure 6.3. To Create a Filter:

1. Navigate to Content → Content Views and select the Content View you want to filter.
2. Click Yum Content → Filters and click New Filter.
3. Specify the name of the new filter in the Name field and choose a content type from the Content Type drop-down menu. Choose whether the filter includes or excludes the selected content type by selecting the Type drop-down menu. Optionally, insert a description in the Description field.
4. Click Save to save your new filter.

Procedure 6.4. To Add Content to a Filter:

1. Navigate to Content → Content Views and select the Content View you want to filter.
2. Click Yum Content → Filters and click the name of the filter you want to edit. Depending on the type of filter selected, perform the following actions:
   1. If the filter is made for packages, specify a package name on the Packages subtab, and select a Detail value from the drop-down menu. Click Add to add the package to the filter.
   2. If the filter is made for package groups, click the Add subtab, and choose the desired package group. Click Add Package Group.
   3. If the filter is made for errata, click the Add subtab. Select the errata type (Security, Enhancement, or Bugfix), and specify a start date and end date. Click Add Errata.
   4. If the filter is made for errata - date and type, on the Erratum Date Range subtab, select the errata type (Security, Enhancement, or Bugfix) and specify a start date and end date. Click Save.
3. On the Affected Repositories subtab, choose whether the filter will affect all or a subset of repositories. If you choose a subset of repositories, select the desired repositories and click Update Repositories.
4. Click Publish New Version. Insert a comment if desired, then click Save.

Procedure 6.5. To Remove Content from a Filter:

1. Navigate to Content → Content Views and select the Content View you want to filter.
2. Click Yum Content → Filters and click the name of the filter you want to edit. Depending on the type of filter selected, perform the following actions:
   1. If the filter is made for packages, click the Packages subtab and select the Package Name check box next to the package to be removed. Click Remove Packages to remove the package from the filter.
   2. If the filter is made for package groups, click the List/Remove subtab and select the Name check box next to the package group to be removed. Click Remove Package Group to remove the package group from the filter.
   3. If the filter is made for errata, click the List/Remove subtab select the Errata ID check box next to the errata to be removed. Click Remove Errata to remove the errata from the filter.
   4. If the filter is made for errata - date and type, on the Erratum Date Range subtab, check the errata type (Security, Enhancement, or Bugfix). Specify the start date and end date. Click Save.
3. On the Affected Repositories subtab, choose whether the filter will affect all or a subset of repositories. If you choose a subset of repositories, select the desired repositories and click Update Repositories.
4. Click Publish New Version. Insert a comment if desired, and click Save.

Procedure 6.6. To Remove a Filter:

1. Navigate to Content → Content Views and select the Content View you want to filter.
2. Click Yum Content → Filters and select the check box next to the name of the package filter you want to remove.
3. Click Remove Filters.

Procedure 9.2. To Create a Policy:

1. In the Satellite web UI, navigate to Hosts → Policies, click New Compliance Policy and follow the wizard’s steps.
2. Enter a name for this policy, a description (optional), then click Next.
3. Select the SCAP Content and XCCDF Profile to be applied, then click Next.
4. Specify the scheduled time when the policy is to be applied, then click Next.
   Select Weekly, Monthly or Custom from the Period drop-down list.
   • If you select Weekly, also select the desired day of the week from the Weekday drop-down list.
   • If you select Monthly, also specify the desired day of the month in the Day of month field.
   • If you select Custom, enter a valid Cron expression in the Cron line field.
   The Custom option allows for greater flexibility in the policy's schedule than either the Weekly or Monthly options.
5. Select the location(s) to which the policy is to be applied, then click Next.
6. Select the organizations to which the policy is to be applied, then click Next.
7. Select the host group(s) to which the policy is to be applied, then click Next.
8. Click Submit.

Procedure 9.3.  To Bookmark a Search

1. Apply your search criteria.
2. From the Search list select Bookmark this search.
3. Complete the Name field.
   If you want the bookmark available to other users of this Satellite instance, select the Public check box.
4. Click Submit.

Procedure 10.3. To Create a Container:

1. Navigate to Containers → New Container. Alternatively, navigate to Containers → All Containers and click New container.
2. In the Preliminary stage of container creation, configure the following settings:
   • On the Compute resource tab, select the compute resource from the Deployed on drop-down menu. For more information on compute resources, see Section 13.3.4, “Compute Resources”.
   • On the Locations tab, select the locations where the new container will be available.
   • On the Organizations tab, select the organizations where the new container will be available.
   Click Next to proceed.
3. In the Image stage of container creation, import an image that will act as a base for your container. This can be a platform image, or a previously created layered image. Select from one of the following options:
   • Select the Katello tab to import the image from a life cycle environment. Specify the life cycle environment, content view, repository, tag, and Capsule Server.
   • Select the Docker hub tab to import the image from the Docker Hub registry. After you type the image name to the Search field, Satellite automatically searches the compute resource. Click the looking glass icon to search the Docker Hub. Select the image from the list of search results and pick a tag from the drop-down list.
   • Select the External registry tab to import the image from an existing registry. Select the registry from the drop-down menu, and search it by the image name. Satellite populates the Tag field with tags available for the selected image name. For more information, see Section 10.3, “Importing External Registries”.
   Click Next to proceed.
4. In the Configuration stage of container creation, set the following parameters:
   • Provide the container name.
   • Specify a command to run inside the container.
   • Specify an entrypoint, which is a command that is executed automatically as soon as the container starts. The default entrypoint is /bin/sh -c.
   • Assign CPUs to the container. For example, 0-2,16 represents CPUs 0, 1, 2, and 16.
   • Define the relative share of CPU time for the container.
   • Specify a memory limit for the container. For example, 512m limits the container memory usage to 512 MB.
   Click Next to proceed.
5. In the final stage of container creation named Environment, select if you want to allocate a pseudo-tty, attach STDIN, STDOUT, and STDERR to the container. Click Add environment variable to create a custom environment variable for the container.
6. Click Submit to create the container.

Procedure 10.4. To Investigate a Container:

1. Navigate to Containers → All Containers.
2. On the Containers page, every Docker compute resource has a dedicated tab. Each of these tabs contains the table of available containers together with selected parameters of each container. Select the tab of the compute resource you want to inspect.
3. To view the container metadata, click the name of the container you want to inspect. Satellite displays the table of container properties.
4. On the Processes tab, you can view processes that are currently running in the container. Click on the process name to view the metadata of the process.
5. If the container is running, you can view its standard output in the Logs tab. If you selected the allocate a pseudo-tty check box when creating a container, the console is interactive. Otherwise, it displays the initial standard output produced when the container started.

Procedure 10.5. To Start or Stop a Container:

1. Navigate to Containers → All Containers to view the list of available containers.
2. Click Power On next to the container you want to start. After starting the container, the button changes to Power Off, which allows for stopping the container. These actions are equivalent to the docker start and docker stop commands.

Procedure 10.6. To Commit a Container:

1. Navigate to Containers → All Containers to view the list of available containers.
2. Click the name of the container you want to commit.
3. Click Commit. Satellite prompts you to:
   • Specify a repository name. This can be a single name or combined with the user name, for example user/my-rhel-image.
   • Assign a tag to the image.
   • Provide your contact information.
   • Provide an informative comment about the image.
4. Click Submit.

Procedure 10.7. To Remove a Container:

1. Navigate to Containers → All Containers to view the list of available containers.
2. Click the name of the container you want to delete.
3. Click Delete.
4. In the alert box, click OK to remove the container.

Procedure 10.8. To Upload Images to a Repository:

1. Navigate to Content → Products.
2. Select the product that contains the repository you want to update. Navigate to the Repositories tab and select the docker repository you want to update.
3. Click Browse. Navigate to the location of the image you want to upload. Click Open.
4. Click Upload to upload the image to the repository.

Procedure 11.3. To Edit Auto-Attach on an Activation Key:

1. Click Content → Activation Keys.
2. Click the activation key name that you want to edit.
3. Click the Subscriptions tab.
4. Select the edit box next to Auto-Attach.
5. Select the check box to enable auto-attach.
6. Click Save.

Procedure 11.4. To Set the Service Level on an Activation Key:

1. Click Content → Activation Keys.
2. Click the activation key name you want to edit.
3. Click the Details tab.
4. Select the edit box next to Service Level.
5. Select the required service level from the drop-down list. The drop-down list only contains service levels available to the activation key.
6. Click Save.

Procedure 11.5. To Add a Subscription to an Activation Key:

1. Click Content → Activation Keys.
2. Click the name of the activation key you want to edit.
3. Click Subscriptions → Add.
4. From the list of available subscriptions, select the subscriptions you want to add and then click Add Selected.

Procedure 11.6. To Add Host Collections to an Activation Key:

1. Click Content → Activation Keys.
2. Click the activation key that you want to add a host collection to.
3. Click Host Collections and then click Add to display the list of available host collections.
4. Select the host collections you want to add, and then click Add Selected to add the host collections to the activation key.

Procedure 11.7. To Edit Product Content on an Activation Key:

1. Click Content → Activation Keys.
2. Click the activation key name that you want to edit.
3. Click the Product Content tab.
4. Click the edit box next to the required product.
5. Select either Yes (Default) or Override to No.
6. Click Save.

Procedure 11.8. To Remove Subscriptions from an Activation Key:

1. Click Content → Activation Keys.
2. A list of activation keys is displayed. Click the activation key you want to remove subscriptions from.
3. Click the Subscriptions subtab.
4. A list of subscriptions is displayed. Select the subscriptions to be removed.
5. Click Remove Selected to remove subscriptions from the activation key.

Procedure 11.9. To Remove Host Collections from the Activation Key:

1. Click Content → Activation Keys.
2. A list of activation keys is displayed. Click the activation key you want to remove host collections from.
3. Click the Host Collections subtab.
4. A list of host collections attached to the Activation Key is displayed. Select the check box of the host collections you want to remove.
5. Click Remove Selected to remove host collections from the activation key.

Procedure 13.2. To Create a Global Simple Parameter:

1. Click Configure → Global Parameters.
2. Click New Parameter.
3. Type a Name for the parameter's key.
4. Type a Value for the parameter.
5. Select if the value is hidden.
6. Click Submit.

Procedure 13.3. To configure smart parameters:

1. Click Configure → Puppet Classes.
2. Select a class from the list.
3. Click the Smart Variables tab. This displays a new screen. The left section contains a list of possible parameters the class supports. The right section contains the configuration options for the parameter selected. Click the Add Variable to add a new parameter. Otherwise, select a parameter from the left-hand list.
4. Type a name for the Parameter field.
5. Edit the Description text box to add any plain text notes.
6. Select the Parameter type of data to pass. This is most commonly a string, but other data types are supported.
7. Type a Default Value for the parameter.
8. Use the Optional Input Validator section to restrict the allowed values for the parameter. Choose a Validator type (either a list of comma separated values or a regular expression, regexp) and input the allows values or regular expression code in the Validator rule field.
9. The Override Value For Specific Hosts section at the bottom of the page provides options for overriding values based upon conditional arguments known as Matchers. Define the Order that the host values resolve, then click Add Matcher-Value to add your conditional argument.
   For example, if desired value of the parameter is test for any host with a fully qualified domain name of www.example.com, then specify the Match as fqdn=www.example.com and the Value as test.
10. Click Submit to save your changes.

Procedure 13.4. To Import Parameterized Classes:

1. Click Configure → Puppet Classes.
2. Click Import from Host Name to import parameterized classes from your Puppet Master.
3. The Puppet Classes page displays with the new classes listed.

Procedure 13.5. To Configure Parameterized Classes:

1. Click Configure → Puppet Classes.
2. Select a class from the list.
3. Click the Smart Class Parameter tab. This displays a new screen. The left section contains a list of possible parameters the class supports. The right section contains the configuration options for the parameter selected.
4. Select a parameter from the left-hand list.
5. Edit the Description text box to add any plain text notes.
6. Select Override to allow Satellite control over this variable. If the check box is not selected, Satellite does not pass this variable to Puppet.
7. Select the Parameter type of data to pass. This is most commonly a string, but other data types are supported.
8. Type a Default Value for the parameter.
9. The Override Value For Specific Hosts section at the bottom of the page provides options for overriding values based upon conditional arguments known as Matchers. Define the Order that the host values resolve, then click Add Matcher-Value to add your conditional argument.
   For example, if desired value of the parameter is test for any host with a fully qualified domain name of www.example.com, then specify the Match as fqdn=www.example.com and the Value as test.
10. Click Submit to save your changes.

Procedure 13.6. To Create a Domain:

1. Click Infrastructure → Domains.
2. Click New Domain. On the Domain tab, specify the following settings:
   1. Specify a Name for the Domain. This is the required DNS domain name.
   2. Type a Description for the Domain.
   3. Select a DNS-enabled Capsule server.
3. On the Parameters tab, specify domain parameters.
4. On the Locations tab, select locations for the domain.
5. On the Organizations tab, select organizations for the domain.

   Important

   Ensure that the Locations and Organizations are configured as they will help with future debugging.
6. Click Submit.

Procedure 13.8. To Create an Architecture:

1. Click Hosts → Architectures and then click New Architecture.
2. Specify a Name for the architecture.
3. Select any Operating Systems that include this architecture. If none are available, you can create and assign them under Hosts → Operating Systems.
4. Click Submit.

Procedure 13.9. To Add a Compute Resource:

1. Navigate to Infrastructure → Compute Resources.
2. Click New Compute Resource. On the Compute Resource tab, specify the following settings:
   1. Specify a Name and a Provider type for the Compute Resource. Optionally, insert a Description.
   2. Depending on the provider type chosen, the next few fields ask for authentication and datacenter details. Refer to the following table for more information about each provider type.

      Table 13.2. Provider Settings

      Type	Description
      RHEV	Suits Red Hat Enterprise Virtualization environments. Requires the URL of the Manager API, a valid Username and Password, and a Datacenter on the system to abstract compute resources. Click Load Datacenters to populate the drop-down menu. Optionally, you can specify a Quota ID and provide one or more certificate authorities in the X509 Certification Authorities field.
      Libvirt	Suits Libvirt-based environments. Requires the URL of the virtual machine. Select the Display type. Click Test Connection to test if the virtual machine is available. Select Console passwords to set a randomly generated password on the display connection.
      VMware	Suits VMware-based environments. Requires the hostname of the VCenter/Server, a valid VMware Username and Password, and a Datacenter to abstract compute resources. Click Load Datacenters to populate the drop-down menu. You can specify a certificate Fingerprint and select Console passwords to set a randomly generated password on the display connection.
      RHEL OpenStack Platform	Suits OpenStack-based environments. Requires the URL of the OpenStack server, a valid OpenStack Username and Password, and a Tenant to abstract compute resources. Click Load Tenants to populate the drop-down menu.
      Rackspace	Suits Rackspace public cloud accounts. Requires the URL of the Rackspace API, a valid Rackspace Username and API Key, and a Region to abstract compute resources. Click Test Connection to make sure your connection to the chosen region is valid.
      EC2	Suits Amazon EC2 public cloud accounts. Requires the Access Key and Secret Key available from any valid Amazon EC2 account. Requires a Region to act as a Datacenter for resource abstraction. Click Load Regions to populate the selection drop-down menu.
      Google	Suits Google Compute Engine public cloud accounts. Requires the Google Project ID, a valid Client Email and a Certificate path to the p12 file. You can also specify a Zone to abstract compute resources. Click Load zones to populate the drop-down menu.
      Docker	Suits container registries. Requires the URL of the internal or external compute resource. Optionally, specify a Username, Password, and a contact Email. Click Test Connection to test if the connection is available.

3. On the Locations tab, select desired locations to add them to the Selected Items list.
4. On the Organizations tab, select the desired organizations to add them to the Selected Items list.

   Important

   Ensure that the Locations and Organizations are configured as they will help with future debugging.
5. Click Submit.

Procedure 13.10. To Create a Hardware Model:

1. Click Hosts → Hardware Models.
2. Click New Model.
3. Specifa a Name for the Hardware Model.
4. For Sparc Solaris builds, insert the CPU Hardware model and Vendor class. Other architectures do not require values in these fields.
5. Type a description of the Hardware Model in the Information field.
6. Click Submit.

Procedure 13.11. To Add an Installation Medium:

1. Click Hosts → Installation Media.
2. Click New Medium. On the Medium tab, specify the following settings:
   1. Type a Name for the Installation Media. This setting is required.
   2. Type a Path to the Installation Medium. Options include either a URL or a valid NFS server. This setting is required.
   3. Select an Operating System Family to define the type of the Installation Medium.
3. On the Locations tab, select the desired locations to add them to the Selected Items list.
4. On the Organizations tab, select the desired organizations to add them to the Selected Items list.

   Important

   Ensure that the Locations and Organizations are configured as they will help with future debugging.
5. Click Submit.

Procedure 13.12. To Create a Partition Table:

1. Click Hosts → Partition Tables.
2. Click New Partition Table.
3. Type a Name for the partition table.
4. Specify the Layout of the partition table. The Layout field also accepts dynamic disk partitioning scripts.
5. Select the operating system from the OS Family drop-down list.
6. Click Submit.

Procedure 13.13. To Create a Provisioning Template:

1. Click Hosts → Provisioning Templates.
2. Click New Template. On the Provisioning Template tab, specify the following settings:
   1. Specify a Name for the template.
   2. Insert your template in the Template editor field. Alternatively, click Browse to upload the template. This replaces the content in the Template editor field with the content of your chosen file.
   3. Optionally, type a comment in the Audit Comment field. Satellite adds the comment to the template history to track changes. View the template history under the History tab.
3. On the Type tab, select Snippet to store the template code without defining it as particular script or template type, or select the type from the Type drop-down menu.
4. On the Association tab, select host groups, environments and operating systems to be associated with the template. Select the operating systems from the Applicable Operating Systems list. Click Add Combination and select a Hostgroup and Environment to limit the template's use. Note that associations are not available for templates of type snippet.
5. On the Association tab, you can view the history of existing templates. No history is available when creating a new template.
6. On the Locations tab, select locations for the template.
7. On the Organizations tab, select organizations for the template.

   Important

   Ensure that the Locations and Organizations are configured as they will help with future debugging.
8. Click Submit.

Procedure 13.14. Configure a gPXE Provisioning Template

1. Click Hosts → Provisioning templates.
2. Find the template Kickstart default PXELinux and select Clone.
3. Enter a name, for example, Kickstart default gPXELinux.
4. In the Template editor, search and replace @initrd with @host.url_for_boot(:initrd)
5. In the Template editor, search and replace @kernel with @host.url_for_boot(:kernel)
6. Select the Type tab. From the Type drop-down menu, select PXELinux.
7. On the Association tab, select host groups, environments and operating systems to be associated with the template. Select the operating systems from the Applicable Operating Systems list. Click Add Combination and select a Hostgroup and Environment to limit the template's use.
8. Click Submit.

Procedure 13.15. To Add an Operating System:

1. Click Hosts → Operating Systems.
2. Click New Operating system. On the Operating System tab, specify the following settings:
   1. Type the Name of the Operating System and its Major Version. These settings are required.
   2. Optionally, define the Minor Version, select the OS Family, and add a Description of the operating system.
   3. Select a Root password hash (MD5, SHA256, of SHA512).
   4. Select the Architectures from the list of available Architectures. If none are available, create and assign them under Hosts → Architectures as described in Section 13.3.3, “Architectures”.
3. On the Partition tables tab, select the applicable file system layouts from the list. For more information on creating partition tables, see Section 13.3.7, “Partition Tables”.
4. On the Installation Media tab, select the applicable installation media from the list. For more information on adding installation media, see Section 13.3.6, “Installation Media”.
5. On the Templates tab, you can assign provisioning templates when editing an existing operating system. This option is not available when creating a new operating system. For more information on creating provisioning templates, see Section 13.3.8, “Provisioning Templates”.
6. On the Parameters tab, you can add parameters for the operating system.
7. Click Submit.

Procedure 14.3. To Register Systems:

1. Open a terminal console and login as the root user on the command line.
2. Clear old system data in preparation for registering. This makes sure that your updated system data is uploaded correctly.

   # subscription-manager clean
   

3. Register the system using the Red Hat Subscription Manager (RHSM):

   # subscription-manager register --org your_org_name --activationkey your_activation_key

   Note

   Activation keys will allow you to add environments, provisioning templates and dictate what subscriptions are available and should be applied to the registering system.

   There are various options that may be added. For more information, use the command man subscription-manager.

Procedure 14.4. Verify the Satellite Tools Repository is Enabled

1. Open the Satellite web UI, navigate to Content → Red Hat Repositories and click on the RPMs tab.
2. Find and expand the Red Hat Enterprise Linux Server item.
3. Find and expand the Red Hat Satellite Tools 6.1 (for RHEL VERSION Server) (RPMs) item.
   If the Red Hat Satellite Tools 6.1 items are not visible, it may be because they are not included in the subscription manifest obtained from the Customer Portal. To correct that, log in to the Customer Portal, add these repositories, download the subscription manifest and import it into Satellite.
4. Ensure the Enabled check box beside the repository's name is selected. If not, select it.

Procedure 14.5. To Install Katello Agent:

1. On the host, open a terminal console and log in as the root user.
2. Verify that the satellite-tools repository is enabled, using the following command:

   # yum repolist enabled | grep -i satellite-tools

   If the satellite-tools is not enabled, enable it using the following command:

   # subscription-manager repos --enable satellite-tools

3. Install the katello-agent RPM package using the following command:

   # yum install katello-agent

Procedure 14.6. Verify the Satellite Tools Repository is Enabled

1. Open the Satellite web UI, navigate to Content → Red Hat Repositories and click on the RPMs tab.
2. Find and expand the Red Hat Enterprise Linux Server item.
3. Find and expand the Red Hat Satellite Tools 6.1 (for RHEL VERSION Server) (RPMs) item.
   If the Red Hat Satellite Tools 6.1 items are not visible, it may be because they are not included in the subscription manifest obtained from the Customer Portal. To correct that, log in to the Customer Portal, add these repositories, download the subscription manifest and import it into Satellite.
4. Ensure the Enabled check box beside the repository's name is selected. If not, select it.

Procedure 14.7. To Install and Enable the Puppet Agent:

1. On the host, open a terminal console and log in as the root user.
2. Verify that the satellite-tools repository is enabled, using the following command:

   # yum repolist enabled | grep -i satellite-tools

   If the satellite-tools is not enabled, enable it using the following command:

   # subscription-manager repos --enable satellite-tools

3. Install the Puppet agent RPM package using the following command:

   # yum install puppet
   

4. Configure the puppet agent to start at boot:
   • On Red Hat Enterprise Linux 6:

     # chkconfig puppet on

   • On Red Hat Enterprise Linux 7:

     # systemctl enable puppet

Procedure 14.8. Configuring the Puppet Agent

1. Configure the Puppet agent by changing the /etc/puppet/puppet.conf file:

   # vi /etc/puppet/puppet.conf
   

   [main]
       # The Puppet log directory.
       # The default value is '$vardir/log'.
       logdir = /var/log/puppet
   
       # Where Puppet PID files are kept.
       # The default value is '$vardir/run'.
       rundir = /var/run/puppet
   
       # Where SSL certificates are kept.
       # The default value is '$confdir/ssl'.
       ssldir = $vardir/ssl
   
   [agent]
       # The file in which puppetd stores a list of the classes
       # associated with the retrieved configuratiion.  Can be loaded in
       # the separate ``puppet`` executable using the ``--loadclasses``
       # option.
       # The default value is '$confdir/classes.txt'.
       classfile = $vardir/classes.txt
       pluginsync = true
       report = true
       ignoreschedules = true
       daemon = false
       ca_server = satellite.example.com
       server = satellite.example.com
       environment = KT_Example_Org_Library_RHEL6Server_3
   
       # Where puppetd caches the local configuration.  An
       # extension indicating the cache format is added automatically.
       # The default value is '$confdir/localconfig'.
       localconfig = $vardir/localconfig
   

   Important

   Set the environment parameter to the host's Puppet environment from the Satellite server. The Puppet environment label contains the organization label, lifecycle environment, content view name, and the content view ID. To see a list of Puppet environments in the Satellite 6 web UI, navigate to Configure → Environments.
2. Run the Puppet agent on the host:

   # puppet agent -t --server satellite.example.com

3. Sign the SSL certificate for the puppet client through the Satellite Server web interface:
   1. Log in to the Satellite Server through the web interface.
   2. Select Infrastructure → Capsules.
   3. Click Certificates to the right of the required host.
   4. Click Sign.
   5. Rerun the puppet agent command:

      # puppet agent -t --server satellite.example.com

Procedure 14.9. To Add a Physical Interface:

1. Navigate to Hosts → All hosts to view available hosts.
2. Click Edit next to the host you want to edit.
3. On the Network tab, click Add Interface.
4. Keep the Interface option selected in the Type menu.
5. Specify a MAC address of the additional interface. This setting is required.
6. Specify the device Identifier, for example eth0 or eth1.1. Identifier is used for bonded interfaces (in the Attached devices field, see Procedure 14.11, “To Add a Bonded Interface:”), VLANs and aliases (in the Attached to field, see Procedure 14.10, “To Add a Virtual Interface:”).
7. Specify the DNS name associated with the host's IP address. Satellite saves this name in the Capsule Server associated with the selected domain (the "DNS A" field) and the Capsule Server associated with the selected subnet (the "DNS PTR" field). A single host can therefore have several DNS entries.
8. Select a domain from the Domain drop-down menu. To create and manage domains, navigate to Infrastructure → Domains.
9. Select a subnet from the Subnet drop-down menu. To create and manage subnets, navigate to Infrastructure → Subnets.
10. Specify the interface IP address. Managed interfaces with assigned DHCP Capsule Server require this setting for creating a DHCP lease. DHCP-enabled managed interfaces provide an automatic suggestion of IP address.
11. Decide if the interface will be managed. If the Managed check box is selected, the interface configuration is pulled from the associated Capsule Server during provisioning, and DNS and DHCP entries are created. If using kickstart provisioning, a configuration file is automatically created for the interface.
12. Select the Virtual NIC check box to create a virtual interface. See Section 14.4.2, “Adding a Virtual Interface” for details.
13. Click OK to save the interface configuration, and then click Submit to apply the changes to the host.

Procedure 14.10. To Add a Virtual Interface:

1. Navigate to Hosts → All hosts to view available hosts.
2. Click Edit next to the host you want to edit.
3. On the Network tab, click Add Interface.
4. Keep the Interface option selected in the Type menu.
5. Specify the general interface settings. The applicable configuration options are the same as for the physical interfaces described in Section 14.4.1, “Adding a Physical Interface”. Specify MAC address for managed virtual interfaces so that the configuration files for provisioning are generated correctly. However, MAC address is not required for virtual interfaces that are not managed. If creating a VLAN, specify ID in the form of eth1.10 in the Identifier field. If creating an alias, use ID in the form of eth1:10.
6. Select the Virtual NIC check box. Additional configuration options specific to virtual interfaces are appended to the form:
   • Tag: You can specify tags per interface to provide a higher-level segmentation of the network. If left blank, managed interfaces inherit the tag form the VLAN ID of the associated subnet, given that this subnet has the VLAN ID specified. User-specified entries from this field are not applied on alias interfaces.
   • Attached to: Specify the identifier of the physical interface to which the virtual interface belongs, for example eth1. This setting is required.
7. Click OK to save the interface configuration. Then click Submit to apply the changes to the host.

Procedure 14.11. To Add a Bonded Interface:

1. Navigate to Hosts → All hosts to view available hosts.
2. Click Edit next to the host you want to edit.
3. On the Network tab, click Add Interface.
4. Select Bond from the Type menu. Additional type-specific configuration options are appended to the form.
5. Specify the general interface settings. The applicable configuration options are the same as for the physical interfaces described in Section 14.4.1, “Adding a Physical Interface”. Bonded interfaces use IDs in the form of bond0 in the Identifier field. It is sufficient if you specify a single MAC address in the MAC address field.
6. Specify the configuration options specific to bonded interfaces:
   • Mode: Select the bonding mode that defines a policy for fault tolerance and load balancing. See Table 14.1, “Bonding Modes Available in Red Hat Satellite” for a brief description of individual bonding modes.
   • Attached devices: Specify a comma separated list of identifiers of attached devices. These can be physical interfaces or VLANs.
   • Bond options: Specify a space separated list of configuration options, for example miimon=100. There are several configuration options you can specify for the bonded interface, see Red Hat Enterprise Linux 7 Networking Guide for details.
7. Click OK to save the interface configuration. Then click Submit to apply the changes to the host.

Procedure 14.12. To Enable BMC Power Management on an Existing Capsule:

1. Ensure the following lines exist in the /etc/foreman-proxy/settings.d/bmc.yml file. Create the file if necessary.

   :enabled: true
   :bmc_default_provider: your_bmc_provider

2. Restart the foreman-proxy service:

   # service foreman-proxy restart

3. Refresh the features for the Capsule.
   1. Log in to the Satellite web UI, and navigate to Infrastructure → Capsules.
   2. Identify the Capsule whose features you need to refresh. In the drop-down list on the right, click Refresh features. The list of features in the Features column should now include BMC.

Procedure 14.13. To Add a BMC Interface:

1. Navigate to Hosts → All hosts to view available hosts.
2. Click Edit next to the host you want to edit.
3. On the Network tab, click Add Interface.
4. Select BMC from the Type menu. Type-specific configuration options are appended to the form.
5. Specify the general interface settings. The applicable configuration options are the same as for the physical interfaces described in Section 14.4.1, “Adding a Physical Interface”.
6. Specify the configuration options specific to BMC interfaces:
   • Username, Password: Specify any authentication credentials required by BMC.
   • Provider: Specify the BMC provider.
7. Click OK to save the interface configuration, and then click Submit to apply the changes to the host.

Procedure 15.1. To Configure PXE-booting:

1. In the Satellite web UI, navigate to Hosts → Provisioning Templates.
2. Edit the PXELinux global default template. Add the following menu entry to the template:

   LABEL discovery
   MENU LABEL Foreman Discovery
   MENU DEFAULT
   KERNEL boot/fdi-image-rhel_7-vmlinuz
   APPEND initrd=boot/fdi-image-rhel_7-img rootflags=loop root=live:/fdi.iso rootfstype=auto ro rd.live.image acpi=force rd.luks=0 rd.md=0 rd.dm=0 rd.lvm=0 rd.bootif=0 rd.neednet=0 nomodeset proxy.url=https://SATELLITE_CAPSULE_URL:9090 proxy.type=proxy
   IPAPPEND 2

3. Set the new menu entry to be the default by modifying the ONTIMEOUT variable:

   ONTIMEOUT discovery

4. Click Build PXE Default at the top of the Provisioning Templates page. This instructs the TFTP proxy to rewrite the pxelinux.cfg/default file. Repeat this step every time a change is made to the default template to ensure that the changes are deployed on the TFTP Satellite Capsule.

Procedure 15.2. To Manually Provision a Discovered Host:

1. Navigate to Hosts → Discovered Hosts.
2. Select the host you want to provision and click Provision.
3. On the host's Edit page, complete the necessary details, and then click Save.

1. Shutdown the host.
2. Navigate to Hosts → Discovered Hosts.
3. In the Name column find the host you want to decommission and then select Delete from the corresponding Edit drop-down menu.

Procedure 15.3. To Create a Provisioning Rule:

1. Navigate to Configure → Discovery rules.
2. Click New Rule. Specify the following parameters of the provisioning rule:
   • Name is the name of the rule displayed in the list of rules. This name must not contain spaces or non-alphanumeric characters.
   • Search is the search statement used to match discovered hosts for the particular rule. You can use scoped search syntax to define it. See Section 15.3.4, “Scoped Search Syntax” for examples of using scoped search.
   • Host Group is the host group to be assigned to a matching host before starting the provisioning process. Make sure that the selected host group has all the required parameters set; required parameters are marked with an asterisk (*).
   • Hostname defines a pattern for assigning human-readable host names to the matching hosts. When left blank, the host name is assigned in the format "macMACADDRESS" by default. The same syntax used for provisioning templates is used in this instance. See Section 15.3.5, “Host Name Patterns” for more information and examples.
   • Hosts limit is the the maximum number of provisioned hosts per rule. If the limit is reached, the rule will not take effect until one or more hosts are deleted. Typical use cases are rules per server rack or row when it is necessary to change provisioning parameters such as host name or host group per entry. You can set this value to zero (0) to specify no limit.
   • Priority specifies the order of execution of rules. The value must be greater than or equal to zero. A lower value indicates a higher priority. If two rules have the same priority, the first rule encountered is applied.
   • Enabled provides the option to temporarily enable or disable rules.
3. Click Submit to save the rule.

Procedure 15.4. To Enable Automatic Provisioning:

1. Navigate to Administer → Settings → Discovered in the Satellite web UI.
2. Locate discovery_auto in the Name column, and set its value to true.
3. Click Save.

Procedure 16.3. To Add Packages to Host Collections:

1. Click Hosts → Host Collections.
2. Click the host collection where the package should be added.
3. On the Collection Actions tab, click Package Installation, Removal, and Updates.
4. In the field provided, specify the package or package group name. Then click:
   • Install ‐ if you want to install a new package
   • Update ‐ if you want to update an existing package in the host collection

Procedure 16.4. To Add Errata to a Host Collection:

1. Click Hosts → Host Collections.
2. Select the host collection where the errata should be added.
3. On the Collection Actions tab, click Errata Installation.
4. Select the errata you want to add to the host collection and click Install Selected.

Procedure 17.1. To Create a User:

1. Navigate to Administer → Users and then click New User.
2. Enter the required details on the User tab.
3. On the Locations tab, select the required locations for this user.
4. On the Organizations tab, select the required organizations for this user.
5. On the Roles tab, select the required roles for this user. Active roles are displayed in the right panel.
6. Click Submit to create the user.

Procedure 17.2. To Edit an Existing User:

1. Navigate to Administer → Users.
2. Click the user name of the user to be altered. General information about the user will appear on the right.
3. You can modify the user's username, first name, surname, email address, default location, default organization, language, and password in the User tab.
4. You can modify the user's assigned locations in the Locations tab.
5. You can modify the user's assigned organizations in the Organizations tab. If no organization is selected, the user can access all available organizations.
6. You can modify the user's assigned roles in the Roles tab.
7. Click Save to save your changes.

Procedure 17.3. To Assign a Role to a User:

1. Navigate to Administer → Users.
2. Click the user name of the user that you want to modify. General information about the user appears on the right.
3. Click the Roles tab to display the list of available role assignments.
4. Select role you want to assign to the user in the Roles list. The list contains the predefined roles, as well as any custom roles, see Table 17.1, “Predefined Roles Available in Red Hat Satellite”. Alternatively, select the Administrator check box to assign all available permissions to the selected user.
5. Click Save.

Procedure 17.4. To Configure Email Notifications:

1. Navigate to Administer → Users.
2. Click the user name of the user you want to edit.
3. On the Mail Preferences tab, select Mail enabled to enable updates.
4. Select the type of notifications the user will receive. The following notification types are available:
   • Puppet error state is a notification sent after a host reports an error related to Puppet. To enable these notifications, select Subscribe from the drop-down menu.
   • Puppet summary is a summary of Puppet reports. Choose the frequency of emails from the drop-down list that offers Daily, Weekly, or Monthly updates.
   • Satellite Host Advisory is a summary of applicable and installable errata for hosts managed by the user. Choose the frequency of emails from the drop-down list that offers Daily, Weekly, or Monthly updates.
   • Satellite Promote Errata is a notification sent only after a content view promotion. It contains a summary of errata applicable and installable to hosts registered to the promoted content view. This allows you to monitor what updates have been applied to which hosts. To enable these notifications, select Subscribe from the drop-down menu.
   • Satellite Sync Errata is a notification sent only after synchronizing a repository. It contains a summary of new errata introduced by the synchronization. To enable these notifications, select Subscribe from the drop-down menu.
5. Click Submit.

Procedure 17.5. To Remove a User:

1. On the main menu, click Administer → Users to open the Users page.
2. Click the Delete link to the right of the username you want to delete.
3. In the alert box, click OK to delete the user.

Procedure 17.7. To Configure an External User Group:

1. Navigate to Administer → User Groups. Click New User Group.
2. On the User group tab, specify the name of the new user group. Do not select any users as they will be added automatically when refreshing the external user group.
3. On the Roles tab, select the roles you want to assign to the user group. Alternatively, select the Administrator check box to assign all available permissions.
4. On the External groups tab, click Add external user group and select the authentication source:
   • If using an LDAP source, select its name from the Auth source drop-down menu.
   • If using IdM/IPA or AD, select EXTERNAL from the Auth source drop-down menu.
   Specify the exact name of the LDAP or external group in the Name field.
5. Click Submit.

Procedure 17.8. To Create a Role:

1. Navigate to Administer → Roles.
2. Click New Role.
3. Provide a Name for the role.
4. Click Submit to save your new role.

1. Navigate to Administer → Roles
2. Select Clone from the drop-down list to the right of the role to be copied.
3. Select the name for the new role and alter the permissions as needed.

Procedure 17.9. To Add Permissions to a Role:

1. Navigate to Administer → Roles.
2. Select Add Permission from the drop-down list to the right of the required role.
3. Select the Resource type from the drop-down list.

   Note

   The (Miscellaneous) group gathers permissions that are not associated with any resource group.
4. Click the permissions you want to select from the Permission list.
5. Select whether the permission is Unlimited.
6. To search for a particular role, use the Search field at the top of the list of roles. See Section 17.4, “Granular Permission Filtering” for the details of using filtering during these searches.
7. Click Next.
8. Click Submit to save changes.

Procedure 17.10. To View Permissions Associated with a Role:

1. Navigate to Administer → Roles.
2. Click Filters to the right of the required role to get to the Filters page.

Procedure 17.11. To Create a Complete Permission Table:

1. Ensure that the required packages are installed:

   # yum install ruby193-rubygem-foreman*

2. Start the Satellite console with the following command:

   # foreman-rake console

3. Insert the following code into the console:

   f = File.open('/tmp/table.html', 'w')
   
   result = Foreman::AccessControl.permissions.sort {|a,b| a.security_block <=> b.security_block}.collect do |p|
         actions = p.actions.collect { |a| "<li>#{a}</li>" }
         "<tr><td>#{p.name}</td><td><ul>#{actions.join('')}</ul></td><td>#{p.resource_type}</td></tr>"
   end.join("\n")
   
   f.write(result)

   The above syntax creates a table of permissions and saves it to the /tmp/table.html file.
4. Press Ctrl+D to exit the Satellite console. Insert the following text at the first line of /tmp/table.html:

   <table border="1"><tr><td>Permission name</td><td>Actions</td><td>Resource type</td></tr>

5. Append the following text at the end of /tmp/table.html:

   </table>

6. Open /tmp/table.html in a web browser to view the table.

Procedure 17.12. To Remove a Role:

1. Navigate to Administer → Roles.
2. Select Delete from the drop-down list to the right of the role to be deleted.
3. In an alert box that appears, click OK to delete the role.

Procedure 20.1. To Configure LDAP Authentication

1. Navigate to Administer → LDAP Authentication.
2. Click New authentication source.
3. On the LDAP server tab, enter the LDAP server's name, host name, port, and server type. The default port is 389, the default server type is POSIX (alternatively you can select FreeIPA or Active Directory depending on the type of authentication server). For TLS encrypted connections, select the LDAPS check box to enable encryption. The port should change to 636, which is the default for LDAPS.
4. On the Account tab, enter the following information:
   • Account username: an LDAP user who has read access to the LDAP server. User name is not required if the server allows anonymous reading, otherwise use the full path to the user's object. For example:

     uid=$login,cn=users,cn=accounts,dc=example,dc=com
     

   • Account password: the LDAP password for the user defined in the Account username field. This field can remain blank if the Account username is using the "$login" variable.
   • Base DN: the top level domain name of your LDAP directory. For example:

     dc=redhat,dc=com
     

   • Groups base DN: the top level domain name of your LDAP directory tree that contains groups.
   • LDAP filter: a filter to restrict your LDAP queries.
   • Automatically create accounts in Foreman: creates Satellite accounts automatically for LDAP users who log in for the first time in Satellite.
5. On the Attribute mappings tab, map LDAP attributes to Satellite attributes. You can map Login name, First name, Surname, Email address, and Photo attributes.
6. Click Submit.