Satellite 6 User Guide. ID Client Delivery

Transcription

1 ID Client Delivery pdf generated on July 7, 2017

2 Table of Contents 1 Concepts Terminology Description of Key Elements Life Cycle Management Content View Types of Hosts Types of Host Groups Operating System Activation Key Installation Object Hierarchy Parameter Hierarchy Configuration Parameters Users and Roles Installation Manual Installation Automated Installation Step by Step Environment Preparation Operating System and Templates Boot Process and Installation Managing Systems Managing Software Collection Membership Configuration Concepts Preparing Puppet Modules Parameters Updating Modules Host Group Task Reference Create Activation Key Create Subnet Create Hostgroup Create Host Install Host Create Content View Use Lifecycle Troubleshooting Enable Reinstallation of Hosts Enable Errata through Content Views Enable Build is not Available Host is not Registered after Installation Error 500 while Installing Host ID Client Delivery

3 5 Example Code Partitioning ID Client Delivery

4 1 Concepts 1.1 Terminology Activation Key Channel Content Host Content View Generic Image Hammer Hostcollection Hostgroup Lifecycle Location Manifest Organization Syncplan Tasks allows hosts to access certain repositories collection of repositories a view which gives more information about the host s software a view of repository content in a specific version (used in lifecycle) used for new installations of hosts powerful CLI tool for accessing the satellite control groups of hosts with actions, i.e update all erratas (freely selective) all similar hosts belong in one host group, a template for installation usually used for controlled staging like (dev - tst - qss - prd) subselection (works like a filter) used upstream per organization to attach subscriptions separating the satellite trough organizations scheduled syncronization of the channels satellite handles jobs with workers through tasks 1.2 Description of Key Elements Life Cycle Management Satellite 6 emphasises the aspects of life cycle management much more than Satellite 5 did. Satellite 6 bundles the content of software repositories and configuration settings to a content view. Changes like addition or removal of channels are documented by versioning. Systems can use a life cylce environment called Library, which provides the latest state of updates for a given software channel. The behaviour is very similar to the default practice in Satellite 5: whenever updates are available, they can be installed by either pulling from the client system or by pushing them from the Satellite GUI. Satellite 5 provided cloning of channels, which could be used to freeze channel contents and to provide a well defined and tested state of software versions. In Satellite 6 this concept is more elaborated and, if desired, allows for the definition of several consecutive states, like the often used steps of testing quality assurance production Content View A content view is a collection of sources for a managed system. Items belonging to a content view are software channels configuration packages The state of the collection is subject to versioning. To make changed packages visible to clients, a new version of the content view has to be published. Systems with the same content view assigned always get the same software version, independent of the current states of the software channels used by the view. Every organization has a Default Organization View which cannot be changed it is not visible in the list of created content views, it can only be assigned to hosts, host groups and activation ID Client Delivery

5 keys. This view always points to the latest content and is not subject to versioning. This behavior corresponds to the standard use case in Satellite 5, if no cloned channels were used. Keep in mind that versioned content views only provide updates which were available at the time the content view was published. To include the latest updates, you have to publish a new minor version Types of Hosts In Satellite 6, the term host is used in two different, but complementary definitions, called host and content host. Host is the term for basic definitions mainly used during system installation and provisioning, including: operating system and lifecycle environment disk partitioning network interface information provisioning parameters: system language, console keyboard layout activation keys (must be set as key value pair, no GUI available) Content Host is used in the context of package management. Typical management tasks are package installation errata management Types of Host Groups As a consequence of the two types of hosts, groups of hosts have changed too in comparison with Satellite 5. Host Group bundles hosts, therefore the settings of a host group apply during the installation process. All systems in a host group share the same installation parameters, but individual systems may have parameters assigned which override group parameters. Examples are initial lifecycle environment and content view subnet and domain operating system, partitioning and root password activation keys Host group membership is exclusive, a host may not be member of more than one group. Activation keys are important for further configuration steps, see below. Host Collection is a group construct for actions during the lifetime of systems, similar to the groups used in Satellite 5. Host collections consist of content hosts and allow to install software apply erratas ID Client Delivery

6 manage subscriptions assign lifecycle environments and content views Systems may be members of several host collections. The initial association with host collections is done by the use of activation keys. Examples for host collections are systems of same functionality (all web servers, all cluster nodes etc.) same lifecycle state (testing, production) same customer, if you manage systems in behalf of others Host collections are similar to system groups in Satellite 5. However the possibility to combine groups with boolean operations has gone, as has the System Set Manager, so you may have to create more host collections in Satellite 6 than Satellite 5 system groups Operating System An operating system object defines a basic set of parameters which are used to install a host. Every host or host group must have such an object assigned. Some of the elements of an operating system are obvious: the OS family (RHEL, Fedora etc.) OS version architecture (32 or 64 bit) Other elements we usually do not associate directly with the term operating system, they rather describe how the installation will be performed: disk partitioning installation medium scripts for controlling the setup from initial PXE to final provisioning: templates parameters to customize installation and configuration All of these configuration elements are preset in an operating system object, but can be overwritten in host groups or individual hosts. Except for the templates: such scripts can only be defined in the context of operating systems. However, the parameters evaluated in these scripts can be redefined in host groups and hosts. A customized OS definition is available: the operating system RedHat 7.3 ETH customized has some configurable parameters: console keyboard layout: keyboard defaults to sg-latin1 time zone: time-zone defaults to Europe/Zurich SSH access from Satellite: allow sat root access defaults to blank (off) ID Client Delivery

7 1.2.6 Activation Key Activation keys bundle configuration options related to software channel subscriptions, and association to host collections. They can be used as options for host and host group objects, or for registration on the Satellite for systems installed manually. Activation keys perform several important steps at the end of an installation: subscribing to the license management attaching software channels assigning to one or more host collections If used for manual registration, they also set lifecylce environments and content views. These options are ignored if the installation has been prepared on the satellite, the mandatory configuration options in hosts and host groups take precedence. Keep in mind that you can use several activation key for a host. This allows you to split configuration facets and reuse them for different host and host groups. Imagine a host collection UpdateAll which is associated to a activation key UpdateKey. The key has no other assignments: no subscriptions or product content (channels). If this key is assigned to each host definition, preferably by assigning the key to every host group, all of your systems will be member of a collection which allows you to initialize an update process on all systems you are responsible for. Other keys could be used to initiate updates on subsets of systems, assign basic software channels, or add optional channels Installation Object Hierarchy Up to here, we have a clear hierarchy: host groups contain hosts, and hosts have an operating system assigned. Host Group contains many Parameter Partition Table Host uses uses Parameter Partition Table Operating System Templates Partition Table Parameter Figure 1: Hierarchy of installation objects ID Client Delivery

8 1.2.8 Parameter Hierarchy If we look at the configuration parameters and where we can overwrite settings, the hierarchy is different. Host overrides Parameter Partition Table Operating System Host Group overrides Parameter Operating System Partition Table Operating System Templates Partition Table Parameter Figure 2: Hierarchy of parameter overrides The installation process is controlled by many variables which can be defined on different levels of the container hierarchy. The evaluation of the parameter values applied to a host differs from the container hierarchy: 1. operating systems define installations scripts, parameters and partition tables. 2. host groups use a selected operating system, and may override parameters and partitioning. 3. hosts may override operating system, parameters and partitioning inherited from host group or operating system definitions. There are further levels where parameters can be set, but not all are accessible for customers of the Satellite. Examples are global objects like locations, which can be configured by the service provider only Configuration Parameters System can be configured by two types of parameters: Simple parameters are configuration options evaluated in the installation and provisioning scripts. As a consequence, they have no effect after an installation has been completed. Puppet parameters See section 2.4 Parameters can be accessed and modified either in host or host group configuration screens directly, or by using Config Groups. ID Client Delivery

9 Users and Roles User accounts are created in the Satellite system, credentials are then taken from the central identity management system LDAPS. Users can be member of user groups, both single users and groups can be used as owner of a host. Satellite accounts have user roles assigned which allow for two levels of users: ETH User is the basic role. It allows for all the tasks necessary to prepare activation keys host objects, host groups and collections, install systems and manage erratas. ETH Admin adds permissions to maintain infrastructure objects like products and channels, subnets, or kickstart configurations. User accounts can be valid in more than one organization, but will have the same role level in every organization. More user roles are available for particular tasks, like managing containers or compute clusters. User management is not accessible to customers yet. Please contact rhn@id.ethz.ch for account requests. 1.3 Installation Similarly to the installation process with Satellite 5, you first need a boot medium. There are three types of installation with three different installation media: 1. Boot ISO without any automatisms 2. Customized boot ISO generated by Satellite 6 3. Generalized boot ISO, fully automatized Manual Installation This installation procedure is recommended only for users which have no account on the Satellite and therefore no access to the GUI. Installation is initiated by booting with a minimal boot ISO and a reference to the package repository on the Satellite, or a full OS DVD. System configuration like partitioning or software selection has to be done interactively in a GUI. After the installation, registration has to be done manually. Activation keys may be used to configure further software channels or add the system to host collections Automated Installation If a system has been fully registered as a host object, you can use a generic boot ISO. This boot disk does not contain any system specific information, it can be used for whatever system you intend to install. The Satellite recognizes the calling system regardless of architecture, OS version or system configuration. By assigning the host object to a host group, and by optionally overriding configuration parameters, further customization is possible. For the configuration process to be able to correctly configure the network, the MAC address, IP address and subnet information has to be defined in the host object. Additionally, the DHCP for your network must be configured to deliver a IP address. There is also a boot image for PXE available which has been derived from the general boot ISO. TODO offer ways to access. ID Client Delivery

10 2 Step by Step This chapter describes the steps necessary for setting up a single or a group of systems. This procedure is recommended whenever you plan to install more then one system. But even if you intend to install just one system: following these steps allows you to easily repeat the installation if something goes wrong or you just want to tweak some parameters and rerun the installation. 2.1 Environment Preparation Subnet Make sure the network is definded where the system will belong to. See section 3.2 for reference where to create a subnet. Host group Create a host group if not already done. As long as you don t use different systems to test new updates and run productive services, the Library lifecycle environment is the correct choice, as is the Default Organization View. See section 3.3 for reference where to create a host group. This example uses the most common entries for demonstration purposes. Partioning If you don t want to use the default partitioning scheme, you may 1. create your own partitioning definitions as objects and reuse them for different installations 2. add a specific partitioning scheme directly in a host definition An complex example of partitioning has been added in section 5.1. Lifecycle environment If you need a staged lifecylcle environment, prepare the environment as described in TODO. Content view If you don t have particular requirements for a staged livecycle environment, stick to the Default Organization View. This view will offer you the latest patches without the need to manually propagate a content view to a new version. Host collection While not mandatory, the use of host collections is recommended. See section for the functionality of host collections. Activation keys At least one activation key should be prepared. Whether you use one or more activation keys depends on your requirements. Your activation key(s) should provide at least one host collection where the system will be assigned to after the installation. Parameter Settings Basic variables and Puppet smart parameters are preset with default values. You have to adopt them if the defaults do not satisfy your needs, in the Host and host group objects. Take care that the environment and content view assigned to a activation key match the environment and content view used in host groups and hosts. The input field for activations keys in the host group configuration offers you matching keys, but you also can enter additional keys not matching anything. For example, this may be useful for if an additional keys only task is to put your host into a certain host collection. ID Client Delivery

11 The host group settings, activation keys tab contains an important check you should take care of. The link Reload data will perform a test of the activation keys entered above and determine if the key names are entered correctly and if they resolve to valid subscriptions. For a system to be registered as desired you should see one or more items in a bullet list. Each of them is a key recognized and used during subsequent content registration. Note that keys used just for assignment to a host collection do not show up in this list, but still will be used as expected Operating System and Templates Operating System is a low level object which bundles general settings used during installation like operating system, obviously partitioning configurable parameters used in scripts used during bootstrap and installation (templates) Most of the setting can be overwritten in objects which use an operating system as a building block; see section for a description of the parameter hierarchy. Templates is a term for used for scripts used during installation of a system. They are the equivalent to kickstart and snippet files used in Satellite 5. Important: while access to templates can be limited to particular organizations, their names are global. Always prefix own templates with your organization string to prevent name collisions, as in ID-BD-myCustomSnippet. If you need to customize templates, probably the script type of primary interest is the provinsioning template. It performs tasks like network configuration applying the partition table setting keyboard and timezone installing packages Scripts can be included with the snippet directive which reduces the modification to the main template. 2.2 Boot Process and Installation Enable system build For an installation, the Satellite must be ready to accept an installation request. This is done by activating Build in the host object. See section 3.5 for a guide through the interface. Get boot medium If everything is configured correctly, the click on Build should have revealed a menu where installation media are offered. If the MAC address of the system is known to the DHCP and the correct IP address can be assigned to the system, download the Generic Boot Image and make it accessible to your system to be installed. ID Client Delivery

12 If IP address and DNS name are not managed by a MAC address entry in the DNS, you must use the system specific boot disk which contains the information necessary for a correct network configuration. Boot system Boot your system either from boot medium or, in case of PXE, from network. The boot disk (mounted as boot medium or requested by PXE) loads an ipxe executable which either uses the information stored on the boot disk to configure the network interface, or in case of the generic boot disk, uses the DHCP service. Then ipxe HTTP request is issued to the Satellite with the MAC address as argument. This enables the Satellite to choose the environment configured for the client system. The installation process will now take place without the need for any further manual intervention. Supposed one of the activation keys is connected to a subscription, any erratas which are part of the content view in use are applied: Systems which belong to the Default Organization View will receive the latest updates. Systems assigned to a versioned content view will get exactly the updates defined in that content view. Finally, the Katello agent will be installed. This is the equivalent to the osad process used with Satellite 5: a daemon which communicates with the server, performs installation tasks and reports back which packages and erratas are installed. After a successful installation, the state of the host object changes back to its normal state. To perform another installation, you must put it into build mode again. As a consequence, the Satellite recognizes repeated installations of the same system, and the licensing subscription will be reused. 2.3 Managing Systems Managing Software The differences to the errata management provided by Satellite 5 are marginal. Erratas can be pushed for single content hosts or for several hosts by using host collections. Similarly, new software packages can be installed for a content host, or for a complete host collection Collection Membership Systems can be assigned to multiple host collections, primarily during the installation process, but also later. Here are some example how host collections may be used: House keeping Group systems of the same type in collections, i.e. web servers. If you want to install new software later, using collections makes sure all systems are affected. Patch job invocation a collection Update contains all systems you regularly want to update. If combined with versioned content views, each systems gets exactly the updates it is supposed to get. Life cycle management Add systems of the same stage (testing, production etc.) to corresponding collections. ID Client Delivery

13 2.4 Configuration Currently the only configuration management system supported directly in Satellite is Puppet. Ansible is announced, and of course are you free to use any system independently of Satellite. Some modules will be prepared and ready to use, but you can also use your own modules. The following chapters will discuss Puppet Concepts Puppet modules are imported into Satellite, where they are bundled and versioned. Hosts get a set of well defined modules applied, using different versions for different hosts is possible. Satellite can extract parameters from templates and present them in the web GUI for configuration. Despite the management of Puppet modules takes place in the Content menu, configurations are applied to systems in the Host section, not the Content Host section. If puppet modules are assigned to a host, the puppet agent will be installed automatically. Make sure the Red Hat Satellite 6 Tools RPMs repository is available for the host Preparing Puppet Modules A description of how to bring modules into Satellite can be found in the Red Hat documentation 1. The guide describes how to create a Puppet module, upload it into a product or pull it from a repository. There is a helper command pulp-puppet-module-builder which allows you to create a module repository directly from a git repository, see the guide for more information Parameters Go to Environments and on the environment you want to use click on Classes. Select a class, you get a list of all parameters defined for this class. Make sure on tab Puppet Class, the host groups you want to use this classe are assigned on tab Smart Class Parameter, Default behavior, the option Override is selected for every paramater you want to be able to customize in host groups or single hosts Updating Modules The update cycle consists of 1. Create a new module version 2. Update your module repository 3. Sync the repository to the Satellite 4. Publish a new version of the content view Don t forget to update the module version in metadata.json, or it will not be recognized as a change! 1 guide/ ID Client Delivery

14 2.4.5 Host Group As in general it is recommended to use Host Groups to assign Puppet parameters to hosts. Hosts will inherit parameter which have been configured to host groups. While basic configuration settings like timezone or console keyboard layout are well suited for host/hostgroup based configuration, more flexibility can be achieved with Config Groups. Set the input fields Content Source Puppet CA Puppet Master to the Satellite capsule used by your systems (usually the main Satellite). Don t use a puppet content view in the Content View field! You must use a content view which has software packages used for the installation, this will usually be Library Config Groups This function allows you to add functionality based on puppet modules to systems. You can add puppet modules (with or without class parameters) to a config group. After at least one config group has been created, the Puppet Classes tab of a host group or a single host will allow you to add config groups. 3 Task Reference The following chapters give you an overview over basic tasks in Satellite Create Activation Key 3.2 Create Subnet 3.3 Create Hostgroup 3.4 Create Host 3.5 Install Host 3.6 Create Contentview 3.7 Lifecycle ID Client Delivery

15 3.1 Create Activation Key Login to Content Activation Key New Activation Key Activation Keys Name Host Limit Environment Content View ORG-activation-key Unlimited hosts: Library Default Organization View Subscription Add Puppet Forge 1 0 out of... EPEL out of... Red Hat Enterprise Linux Academic Site Subscription out of... Product Content - Red Hat Enterprise Linux Server Red Hat Satellite Tools 6.2 (For RHEL 7 Server) (RPMs) Enabled? Override to Yes Red Hat Enterprise Linux 7 Server (Kickstart) Enabled? Override to Yes - Puppet Forge Puppet Forge Enabled? Override to Yes - Product XXX Channel XXX Enabled? Override to Yes Table 1: Create Activation Key ID Client Delivery

16 3.2 Create Subnet Login to Infrastructure Subnets New Subnet Subnet Name * Network address * Network mask * Gateway address mysubnet xxx.xxx.xxx x xxx.xxx.xxx.1 Primary DNS server IPAM Boot mode None Static Domains Domain ethz.ch Locations Locations Your Location Organizations Organization Your Organization Table 2: Create Subnet ID Client Delivery

17 3.3 Create Hostgroup Login to Configure Host groups New Host Group Host Group Name * Lifecycle Environment Content View myhostgroup Library Default Organization View Network Domain ethz.ch Operating System Architecture x86 64 Operating System RedHat 7.3 Media Selection Partition Table All Media Kickstart default Root Password * * * * * Locations Locations Your Location Organizations Organization Your Organization Table 3: Create Hostgroup ID Client Delivery

18 3.4 Create Host Login to Hosts All Hosts New Host Host Name * Organization * Location * Host Group Lifecycle Environment Content View id-host-01 Your Organization Your Location Webserver Library Default Organization View Interfaces MAC address 00:00:00:00:00:00 DNS name Domain Subnet IP address id-host-01 ethz.ch ID Subnet (xxx.xxx.xxx.0/24) xxx Table 4: Create Host ID Client Delivery

19 3.5 Install Host New Host Installation 1. Make sure you ve created the host in the webinterface. 2. Download generic image [ID portal]. 3. Boot new machine with generic ISO and let the installation run through. Reinstallation of Host 1. Login to Hosts All Hosts select your host Build 2. Insert generic boot image from [ID portal]. 3. Start automated installation. In case that s not possible: select your host Edit Manage 4. Repeat steps above. ID Client Delivery

20 3.6 Create Content View Create content views only if you want to manage package versions manually. If you intend to use the latest versions anyway, use the built in default organization view. Otherwise: Login to Content Content View + Create New View Name * Label * Rhel7 Web Rhel7 Web Select all repos which should to be included: Yum Content Repositories Add Name Description... EPEL Red Hat Enterprise Linux Server Add Repositories You may want to enable errata to be installed. Yum Content Filters + New Filter Name * Content Type * Inclusion Type * enable errata Errata - By Date and Type Include Define Start Date Save Publish New Version Table 5: Create Content View ID Client Delivery

21 3.7 Use Lifecycle Login to Content Lifecycle Environment + New Environment Path Name * Label * Description DEV DEV develop content Lifecycle Environment + Add New Environment Name * Label * Description TST TST test Repeat steps for QSS and PRD. Table 6: Use Lifecycle ID Client Delivery

22 4 Troubleshooting 4.1 Enable Reinstallation of Hosts For reinstallation of host, you need to enable build via the webinterface. Hostgroups are kind of templates for the reinstallation of new hosts and are not associated by default for content hosts. 4.2 Enable Errata through Content Views Add filter in content view where you can allow all errata to be installed. 4.3 Enable Build is not Available If your host was orginally build on Satellite 5, you need to do following: Host Edit Manage (top right) You can now allow building again. 4.4 Host is not Registered after Installation To have a complete self-installation you need to asign a hostgroup with an activation key to the host. 4.5 Error 500 while Installing Host If your error looks something like GET /unattended/provision?token=7d6a15c0-903a f-dadb88c2208a&static=yes you need to set a subnet in the interface section of your host. 5 Example Code 5.1 Partitioning clearpart --drives=hda,hdc zerombr # Raid 1 IDE config part raid.11 --size asprimary --ondrive=hda part raid.12 --size asprimary --ondrive=hda part raid.13 --size asprimary --ondrive=hda part raid.14 --size ondrive=hda part raid.15 --size grow --ondrive=hda part raid.21 --size asprimary --ondrive=hdc part raid.22 --size asprimary --ondrive=hdc part raid.23 --size asprimary --ondrive=hdc part raid.24 --size ondrive=hdc part raid.25 --size grow --ondrive=hdc # You can add --spares=x ID Client Delivery

23 raid / --fstype xfs --device root --level=raid1 raid.11 raid.21 raid /safe --fstype xfs --device safe --level=raid1 raid.12 raid.22 raid swap --fstype swap --device swap --level=raid1 raid.13 raid.23 raid /usr --fstype xfs --device usr --level=raid1 raid.14 raid.24 raid pv.01 --fstype xfs --device pv.01 --level=raid1 raid.15 raid.25 # LVM configuration so that we can resize /var and /usr/local later volgroup sysvg pv.01 logvol /var --vgname=sysvg --size= name=var logvol /var/freespace --vgname=sysvg --size= name=freespacetouse logvol /usr/local --vgname=sysvg --size=1 --grow --name=usrlocal This example is taken from the Red Hat Linux installation manual. ID Client Delivery