Quick Start Guide

1. Register your Satellite Server, using your user name and password.

   # subscription-manager register
   Username:
   Password:
   The system has been registered with ID: 541084ff2-44cab-4eb1-9fa1-7683431bcf9a

1. To identify your Satellite subscription, enter the following command:

   # subscription-manager list --all --available

   The outputs displays something similar to the following:

   Subscription Name: Red Hat Satellite
   Provides:          Red Hat Satellite 6
                      Red Hat Enterprise Linux Server
                      Red Hat Satellite
                      Red Hat Enterprise Linux Load Balancer (for RHEL Server)
   SKU:               MCT0370
   Pool ID:           8a85f9874152663c0541943739717d11
   Available:         3
   Suggested:         1
   Service Level:     Premium
   Service Type:      L1-L3
   Multi-Entitlement: No
   Ends:              10/07/2014
   System Type:       Physical

2. Make a note of the Pool ID so that you can attach it to your Satellite host. Your Pool ID will be different than the example provided.

3. To attach your subscription to your Satellite Server, enter the following command, using your Pool ID:

   # subscription-manager attach --pool=8a85f9874152663c0541943739717d11

   The outputs displays something similar to the following:

   Successfully attached a subscription for: Red Hat Satellite

4. To verify that the subscriptions are successfully attached, enter the following command:

   # subscription-manager list --consumed

   The outputs displays something similar to the following:

   +-------------------------------------------+
      Consumed Subscriptions
   +-------------------------------------------+
   Subscription Name: Red Hat Satellite
   Provides:          Red Hat Satellite
                      Red Hat Enterprise Linux Server
                      Red Hat Software Collections (for RHEL Server)
                      Red Hat Satellite
                      Red Hat Satellite 6
                      Red Hat Software Collections (for RHEL Server)
                      Red Hat Satellite Capsule
                      Red Hat Enterprise Linux Load Balancer (for RHEL Server)
                      Red Hat Satellite with Embedded Oracle
                      Red Hat Satellite Capsule
                      Red Hat Enterprise Linux High Availability (for RHEL Server)
   SKU:               MCT0370
   Contract:          10293569
   Account:           5361051
   Serial:            1653856191250699363
   Pool ID:           8a85f9874152663c0541943739717d11
   Active:            True
   Quantity Used:     1
   Service Level:     Premium
   Service Type:      L1-L3
   Status Details:
   Starts:            10/08/2013
   Ends:              10/07/2014
   System Type:       Physical

1. Disable all existing repositories.

   # subscription-manager repos --disable "*"

2. Enable the Red Hat Satellite, Red Hat Enterprise Linux, and Red Hat Software Collections repositories.

   # subscription-manager repos --enable=rhel-7-server-rpms \
   --enable=rhel-server-rhscl-7-rpms \
   --enable=rhel-7-server-satellite-6.4-rpms \
   --enable=rhel-7-server-satellite-maintenance-6-rpms \
   --enable=rhel-7-server-ansible-2.6-rpms

3. Clear out any metadata.

   # yum clean all

4. Verify that the repositories have been enabled.

   # yum repolist enabled

1. Update all packages:

   # yum update

2. Install the Satellite Server package:

   # yum install satellite

3. Install Satellite Server and perform the initial configuration:

   # satellite-installer --scenario satellite \
   --foreman-admin-username admin \
   --foreman-admin-password redhat \
   --foreman-proxy-puppetca true \
   --foreman-proxy-tftp true \
   --enable-foreman-plugin-discovery

1. Open https://access.redhat.com/ in your browser and log in to your Red Hat account.
2. Navigate to Subscriptions in the upper-left corner of the Customer Portal.
3. Navigate to Subscription Allocations.
4. Click Create New subscription allocation
5. In the Name field, enter a name.
6. From the Type list, select the type and version that corresponds to your Satellite Server.
7. Click Create.

Uploading a Manifest Using the Web UI

1. Verify that you are in the correct organization.
2. Click Content > Red Hat Subscriptions.
3. Click Manage Manifest to open the Subscriptions page.
4. Click Choose file and select the manifest you created.
5. Click Upload to upload the manifest to Satellite Server.

Uploading a Manifest Using Hammer CLI

1. Upload a manifest to Satellite Server.

   # hammer subscription upload \
   --file ~/manifest_file.zip \
   --organization "Default_Organization"

For Web UI Users

1. Navigate to Infrastructure > Domains and click Create Domain.
2. In the DNS Domain field, enter the full DNS domain name.
3. In the Fullname field, enter the plain text name of the domain.
4. Click the Parameters tab.
5. Click Add Parameter and fill in the Name and Value fields.
6. Click the Locations tab, and add the location where the domain resides.
7. Click the Organizations tab, and add the organization that the domain belongs to.
8. Click Submit to save the changes.

Associating the Domain with the Default Organization Using the Web UI

1. On the Main Menu, click Infrastructure → Domains.
2. Select the domain in the Description column.
3. On the Locations tab, click Default_Location to add it to the Selected items list.
4. On the Organizations tab, click Default_Organization to add it to the Selected items list.
5. Click Submit.

Associating the Domain with the Default Organization Using Hammer ClI

1. Associate the domain to your organization.

   $ hammer organization add-domain --name "Default_Organization" --domain "domain_name.com"

2. Associate the domain to your location.

   $ hammer location add-domain --name "Default_Location" --domain "domain-name.com"

Configuring the Subnet Using the Web UI

1. On the Main Menu, click Infrastructure → Subnets.

2. Click New Subnet and enter the information specific to your environment.

   1. If you use DHCP, enter the following information:

      • Name: Provisioning_Net
      • Network address: 172.17.13.0
      • Network mask: 255.255.255.0
      • Gateway Address: 172.17.13.1
      • Primary DNS Server: 172.17.13.2
      • Secondary DNS Server: Leave blank
      • IPAM: None
      • Start of IP Range: 172.17.13.100
      • End of IP Range: 172.17.13.150
      • VLAN ID: Leave blank
      • Boot Mode: DHCP

   2. If you use static IP addresses, enter the following information:

      • Name: Provisioning_Net
      • Network address: 172.17.13.0
      • Network mask: 255.255.255.0
      • Gateway Address: 172.17.13.1
      • Primary DNS Server: 172.17.13.2
      • Secondary DNS Server: Leave blank
      • IPAM: None
      • Start of IP Range: 172.17.13.100
      • End of IP Range: 172.17.13.150
      • VLAN ID: Leave blank
      • Boot Mode: Static
3. Click Submit.
4. Click Provisioning_Net to edit the subnet.
5. On the Domains tab, select example.org.
6. On the Capsules tab, change the TFTP and Discovery Proxy capsule to reflect the host name of the Satellite Server.
7. On the Locations tab, select Default_Location under All items to associate the domain with the default location.
8. On the Organizations tab, select Default_Organization under All items to associate the domain with the default organization.

Configuring the Subnet Using Hammer CLI

1. Create a subnet.

   1. Create a subnet using DHCP.

      # hammer subnet create --name Provisioning_Net \
      --organization "Default_Organization" \
      --locations 'RDU' \
      --domain-ids 1 \
      --boot-mode DHCP \
      --network 172.17.13.0 \
      --mask 255.255.255.0 \
      --ipam None \
      --dns-primary 172.17.13.1 \
      --gateway 172.17.13.1 \
      --from 172.17.13.100 \
      --to 172.17.13.150 \
      --tftp-id 1

   2. Create a subnet using static IP addresses.

      # hammer subnet create --name Provisioning_Net \
      --organization "Default_Organization" \
      --locations 'RDU' \
      --domain-ids 1 \
      --boot-mode Static \
      --network 172.17.13.0 \
      --mask 255.255.255.0 \
      --ipam None \
      --dns-primary 172.17.13.1 \
      --gateway 172.17.13.1 \
      --from 172.17.13.100 \
      --to 172.17.13.150 \
      --tftp-id 1

      Note

      You cannot set the discovery proxy using Hammer CLI.

Enabling Red Hat Enterprise Linux 7 Server Repositories Using the Web UI

1. In the Satellite web UI, navigate to Content > Red Hat Repositories.
2. Use the Search field to enter the following repository name: Red Hat Enterprise Linux 7 Server (RPMs).
3. In the Available Repositories pane, click on Red Hat Enterprise Linux 7 Server (RPMs) to expand the repository set.
4. For the x86_64 7.5 entry, click the Enable icon to enable the repository.
5. Use the Search field to enter the following repository name: Red Hat Satellite Tools 6.4 (for RHEL 7 Server) (RPMs).
6. In the Available Repositories pane, click on Red Hat Satellite Tools 6.4 (for RHEL 7 Server) (RPMs) to expand the repository set.
7. For the x86_64 entry, click the Enable icon to enable the repository.
8. Use the Search field to enter the following repository name: Red Hat Enterprise Linux Server 7 (Kickstart).
9. In the Available Repositories pane, click on Red Hat Enterprise Linux 7 Server (Kickstart) to expand the repository set.
10. For the x86_64 7.5 entry, click the Enable icon to enable the repository.

Enabling Red Hat Enterprise Linux 7 Server Repositories Using Hammer CLI

1. Enable your Kickstart repository.

   # hammer repository-set enable --organization "Default_Organization" \
   --product 'Red Hat Enterprise Linux Server' \
   --basearch='x86_64' \
   --releasever='7Server' \
   --name 'Red Hat Enterprise Linux 7 Server (Kickstart)'

2. Enable your RPMs repository.

   # hammer repository-set enable --organization "Default_Organization" \
   --product 'Red Hat Enterprise Linux Server' \
   --basearch='x86_64' \
   --releasever='7Server' \
   --name 'Red Hat Enterprise Linux 7 Server (RPMs)'

3. Enable your Satellite Tools repository.

   # hammer repository-set enable --organization "Default_Organization" \
   --product 'Red Hat Enterprise Linux Server' \
   --basearch='x86_64' \
   --name 'Red Hat Satellite Tools {ProductVersion} (for RHEL 7 Server) (RPMs)'

Creating Custom Products Using the Web UI

1. Click Content → Products and then click New Product.
2. Enter a name for your custom Product.
3. Click Save.
4. After the screen refreshes, click Create Repository.
5. Enter Puppet Modules in the Name field.
6. In the Type field, Puppet. Leave the URL field blank.
7. Click Save.

1. Download the motd Puppet module from https://forge.puppetlabs.com/jeffmccune/motd. The file that you download will have a .tar.gz extension.
2. Click Content → Products and click Custom Products in the Name field.
3. On the Repositories tab, click Puppet Modules to modify the Puppet Modules repository.
4. In the Upload Package section, click Choose Files, and navigate to the motd module that you downloaded.
5. Click Upload.

Creating Custom Products and Enabling Repositories Using Hammer CLI

1. Create a custom Product.

   $ hammer product create --name "product_name" --organization "Default_Organization"

2. Create a new repository under the custom Product.

   $ hammer repository create --name "repo_name" \
   --organization "Default_Organization" \
   --product "product_name" \
   --content-type cont_type \
   --publish-via-http true \
   --url "repo_url"

   For the --content-type option, specify whether you want yum, puppet, or docker content. The command accepts only lower-case text.

3. Upload packages to the custom repository.

   $ hammer repository upload-content --product "product_name" \
   --organization "Default_Organization" \
   --id "repo_id" \
   --path path_to_dir

Synchronizing Content Using Red Hat Enterprise Linux 7 Server Using the Web UI

1. Click Content → Sync Status to display the list of available Products.
2. Navigate to Red Hat Enterprise Linux Server → 7Server → x86_64.

3. Select the following Products:

   • Red Hat Enterprise Linux 7 Server RPMs x86_64 6Server.
   • Red Hat Enterprise Linux 7 Server - Satellite Tools 6.4 RPMs x86_64.
4. Navigate to Red Hat Enterprise Linux Server → 7.5 → x86_64 and select Red Hat Enterprise Linux 7 Server Kickstart x86_64 7.5.

5. Click Synchronize Now.

   The synchronization could take several hours, depending on available bandwidth.

Synchronizing Content Using Hammer CLI

1. Synchronize your Kickstart repository.

   $ hammer repository synchronize --organization "Default_Organization" \
   --product 'Red Hat Enterprise Linux Server' \
   --name  'Red Hat Enterprise Linux 7 Server Kickstart x86_64 7.5' \
   --async

2. Synchronize your RPMs repository.

   $ hammer repository synchronize --organization "Default_Organization" \
   --product 'Red Hat Enterprise Linux Server' \
   --name 'Red Hat Enterprise Linux 7 Server RPMs x86_64 7Server' \
   --async

3. Synchronize your Satellite Tools repository.

   $ hammer repository synchronize --organization "Default_Organization" \
   --product 'Red Hat Enterprise Linux Server' \
   --name 'Red Hat Satellite Tools 6.4 for RHEL 7 Server RPMs x86_64' \
   --async

1. Click Content → Life Cycle Environments to open the Life Cycle Environment Paths page.

2. Click Add New Environment to display the New Environment page.

   The library is the origin of all content that you can use in your environments.

3. Enter a name in the Name Field.

   The label is automatically populated with the same name, but you can change it to suit your needs. You can also add a description of your environment.

4. Click Save.

Creating Life Cycle Environments Using Hammer CLI

1. Create the life cycle environment.

   $ hammer lifecycle-environment create --name Development \
   --prior Library \
   --organization “Default_Organization”

Creating Content Views Using the Web UI

1. Click Content → Content Views and then click Create New View.

2. Type RHEL6 x86_64 in the Name field.

   The label is automatically populated.

3. Clear the Composite View? check box and click Save.

Creating Content Views Using Hammer CLI

1. Create the Content View.

   $ hammer content-view create --organization "Default_Organization" \
   --name 'RHEL7_Base' \
   --label rhel7_base \
   --description 'Core Build for RHEL 7'

Adding Repositories Using Web UI

1. Navigate to Content > Content Views, and then select the Content View you want to edit.
2. In the Content View pane, click the Yum Content tab, and then select Repositories.

3. In the Add tab, select the following repositories from the Repository Selection list:

   • Red Hat Enterprise Linux 7 Server Kickstart x86_64 7.5
   • Red Hat Enterprise Linux 7 Server RPMs x86_64 7Server
   • Red Hat Satellite Tools 6.4 for RHEL 7 Server RPMs x86_64

4. Click Add Repositories.

   To see the list of repositories added to your Content View, click the List/Remove tab.

Adding Repositories Using Hammer CLI

1. Add the Kickstart repository.

   $ hammer content-view add-repository --organization "Default_Organization" \
   --name 'RHEL7_Base' \
   --product 'Red Hat Enterprise Linux Server' \
   --repository 'Red Hat Enterprise Linux 7 Server Kickstart x86_64 7.5'

2. Add the RPMs repository.

   $ hammer content-view add-repository --organization "Default_Organization" \
   --name 'RHEL7_Base' \
   --product 'Red Hat Enterprise Linux Server' \
   --repository 'Red Hat Enterprise Linux 7 Server RPMs x86_64 7Server'

3. Add the Satellite Tools repository.

   $ hammer content-view add-repository --organization "Default_Organization" \
   --name 'RHEL7_Base' \
   --product 'Red Hat Enterprise Linux Server' \
   --repository 'Red Hat Satellite Tools 6.4 for RHEL 7 Server RPMs x86_64'

Adding Puppet Modules Using the Web UI

1. Go to the Content Views page.
2. Click Content → Content Views.

3. On the Puppet Modules tab, click Add New Module to display a list of available Puppet Modules.

   You can use the Filter field to help locate the required module.

4. Click Select Version and select the 'motd' module.
5. Click Select Version next to the version of the module that you want to add.

Adding Puppet Modules Using Hammer CLI

1. Add a Puppet module.

   $ hammer content-view puppet-module add \
   --content-view cv_name \
   --name module_name

   ⁠

Publishing a Content View Using the Web UI

1. Click Content → Content Views.
2. Click the name of the Content View that you want to publish.

3. Click Publish New Version to display the Publish New Version page.

   This specifies the version and allows you to enter a comment to reflect any changes made to the Content View.

4. Click Save to publish the Content View to the library.

   You can monitor the publication progress on the screen that appears.

5. When the publishing process is complete, click Promote.

   The list of available promotion paths (Library → Dev → QA) displays.

6. Select the check box for the Dev environment, and then click Promote Version.

Publishing a Content View Using Hammer CLI

1. Publish your Content View.

   $ hammer content-view publish --organization "Default_Organization" \
   --name RHEL7_Base \
   --description 'Initial Publishing'

2. Promote your Content View.

   $ hammer content-view version promote \
   --organization "Default_Organization" \
   --content-view RHEL7_Base \
   --to-lifecycle-environment Development

Creating and Editing an Activation Key Using the Web UI

1. On the main menu, click Content → Activation Keys → New Activation Key.
2. In the Name field, enter a name.

3. If applicable, clear the Content Host Limit check box.

   You can use this field to control how many times a given activation key is used. For example, if you associate the key with a subscription that has a limited quantity, you can set the limit on the activation key to eliminate exceeding that quantity.

4. Select the check box for your environment.
5. In the Content View drop-down list, select the RHEL 7 x86_64 Content View, and then click Save.
6. On the Activation Keys page, click the Subscriptions tab, then click the Add tab to display the list of available subscriptions.
7. From the list of available subscriptions, select the subscriptions you want to add.
8. Click Add Selected.

Creating and Editing an Activation Key Using Hammer CLI

1. Create the activation key.

   $ hammer activation-key create --name ak-Reg_To_Dev_EL7 \
   --organization "Default_Organization" \
   --content-view RHEL7_Base \
   --lifecycle-environment Development

2. Add a subscription.

   $ hammer subscription list --organization “Default_Organization”
   $ hammer activation-key add-subscription \
   --name ak-Reg_To_Dev_EL7 \
   --subscription-id 8 \
   --organization "Default_Organization"

3. Set Product content to enable the repository.

   $ hammer activation-key content-override --name ak-Reg_To_Dev_EL7 \
   --organization "Default_Organization" \
   --content-label rhel-7-server-satellite-tools-6.4-rpms \
   --value 1

Creating a Provisioning Template Using the Web UI

1. On the main menu, click Hosts → Provisioning Templates.

2. In the Name column, select Kickstart Default iPXE or PXELinux in the list of provisioning templates.

   This displays the configuration tabs where you can customize the template.

3. On the Association tab, select the appropriate operating system and click Submit.

4. In the Name column, select the appropriate provisioning template.

   If you use PXE-less discovery, you should select the Discover Red Hat kexec provisioning template.

5. On the Association tab, select the appropriate operating system and click Submit.

6. On the main menu, click Hosts → Operating Systems and select the appropriate operating system.

   This displays the configuration tabs where you can customize the operating system.

7. On the Partition Table tab, select Kickstart Default.
8. On the Installation Media tab, ensure Default_Organization/Library/Red_Hat_6_Server_Kickstart_x86_64_6Server is visible and selected.
9. On the Templates tab, select Katello Kickstart Default from the provision drop-down list.
10. Select Discovery Red Hat kexec from the kexec drop-down list and click Submit.

Creating a Provisioning Template Using Hammer CLI

1. Create a provisioning template.

   $ hammer template create --name template_name --file path_to_template_file

   If you use PXE-less discovery, you should use the kexec template type.

2. Add the operating system.

   $ hammer template add-operatingsystem id

Creating Host Groups Using the Web UI

1. On the main menu, click Configure → Host Groups, and then click New Host Group.

2. On the Host Group tab, input the following values:

   • Name: RHEL6Server-x86_64
   • Lifecycle Environment: Default_Organization/DEV
   • Content View: RHEL_6_x86_64
   • Content Source: The FQDN of your Capsule (in this case the Satellite Server)
   • Puppet CA: The FQDN of your Satellite
   • Puppet Master: The FQDN of your Satellite
3. On the Puppet Classes tab, select the motd puppet module from the list of available classes.

4. On the Network tab, select the following values:

   • Domain: example.org
   • Subnet: Provisioning_Net
   • Realm: For the purposes of this example, leave this field blank. If you have configured realm management, for example IPA, select the appropriate realm here.

5. On the Operating System tab, select the following values:

   • Architecture: x86_64
   • Operating system: RHEL Server 6.5
   • Media: Default_Organization/Library Red Hat Server 6.5 x86_64. In this example, this is automatically populated. If this field is not automatically populated, it means the Organization and Location associations are not correctly configured.
   • Partition table: Kickstart default
   • Root password: changeme
6. On the Locations tab, select Default_location.
7. On the Organizations tab, select Default_Organization.
8. On the Activation Keys tab, select the appropriate key.
9. Click Submit.

Creating Host Groups Using Hammer CLI

1. Create the host group.

   $ hammer hostgroup create --name "hostgroup_name" \
   --environment "environment_name" \
   --architecture "architecture_name" \
   --domain domain_name \
   --subnet subnet_name \
   --puppet-proxy proxy_name \
   --puppet-ca-proxy ca-proxy_name \
   --operatingsystem "os_name" \
   --partition-table "table_name" \
   --medium "medium_name" \
   --organization-ids org_ID1,org_ID2... \
   --location-ids loc_ID1,loc_ID2...

2. Add an activation key.

   $ hammer hostgroup set-parameter --hostgroup "hostgroup_name" \
   --name "kt_activation_keys" \
   --value key_name