Datasets:

mtpti5iD
/

redhat-docs_dataset

Dataset card Data Studio Files Files and versions Community

Split (2)

train · 44.6k rows

Subsets and Splits

No saved queries yet

Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.

title stringlengths 4 168	content stringlengths 7 1.74M	commands sequencelengths 1 5.62k ⌀	url stringlengths 79 342
Using Octavia for Load Balancing-as-a-Service	Using Octavia for Load Balancing-as-a-Service Red Hat OpenStack Platform 17.0 Octavia administration and how to use octavia to load balance network traffic across the data plane. OpenStack Documentation Team [email protected]	null	https://docs.redhat.com/en/documentation/red_hat_openstack_platform/17.0/html/using_octavia_for_load_balancing-as-a-service/index
3.10. ns	3.10. ns The ns subsystem provides a way to group processes into separate namespaces . Within a particular namespace, processes can interact with each other but are isolated from processes running in other namespaces. These separate namespaces are sometimes referred to as containers when used for operating-system-level virtualization.	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/resource_management_guide/sec-ns
30.5. Modifying sudo Commands and Command Groups	30.5. Modifying sudo Commands and Command Groups Modifying sudo Commands and Command Groups in the Web UI Under the Policy tab, click Sudo Sudo Commands or Sudo Sudo Command Groups . Click the name of the command or command group to display its configuration page. Change the settings as required. On some configuration pages, the Save button is available at the top of the page. On these pages, you must click the button to confirm the changes. Modifying sudo Commands and Command Groups from the Command Line To modify a command or command group, use the following commands: ipa sudocmd-mod ipa sudocmdgroup-mod Add command-line options to the above-mentioned commands to update the sudo command or command group attributes. For example, to add a new description for the /usr/bin/less command: For more information about these commands and the options they accept, run them with the --help option added.	[ "ipa sudocmd-mod /usr/bin/less --desc=\"For reading log files\" ------------------------------------- Modified Sudo Command \"/usr/bin/less\" ------------------------------------- Sudo Command: /usr/bin/less Description: For reading log files Sudo Command Groups: files" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/linux_domain_identity_authentication_and_policy_guide/modify-sudo-cmd-cmdgroup
4.9. Emerson Network Power Switch (SNMP interface)	4.9. Emerson Network Power Switch (SNMP interface) Table 4.10, "Emerson Network Power Switch (SNMP interface) (Red Hat Enterprise Linux 6.7 and later)" lists the fence device parameters used by fence_emerson , the fence agent for Emerson over SNMP. Table 4.10. Emerson Network Power Switch (SNMP interface) (Red Hat Enterprise Linux 6.7 and later) luci Field cluster.conf Attribute Description Name name A name for the Emerson Network Power Switch device connected to the cluster. IP Address or Hostname ipaddr The IP address or host name assigned to the device. UDP/TCP Port (optional) udpport UDP/TCP port to use for connections with the device; the default value is 161. Login login The login name used to access the device. Password passwd The password used to authenticate the connection to the device. Password Script (optional) passwd_script The script that supplies a password for access to the fence device. Using this supersedes the Password parameter. SNMP Version snmp_version The SNMP version to use (1, 2c, 3); the default value is 1. SNMP Community community The SNMP community string. SNMP Security Level snmp_sec_level The SNMP security level (noAuthNoPriv, authNoPriv, authPriv). SNMP Authentication Protocol snmp_auth_prot The SNMP authentication protocol (MD5, SHA). SNMP Privacy Protocol snmp_priv_prot The SNMP privacy protocol (DES, AES). SNMP privacy protocol password snmp_priv_passwd The SNMP Privacy Protocol Password. SNMP Privacy Protocol Script snmp_priv_passwd_script The script that supplies a password for SNMP privacy protocol. Using this supersedes the SNMP privacy protocol password parameter. Power Wait (seconds) power_wait Number of seconds to wait after issuing a power off or power on command. Power Timeout (seconds) power_timeout Number of seconds to continue testing for a status change after issuing a power off or power on command. The default value is 20. Shell Timeout (seconds) shell_timeout Number of seconds to wait for a command prompt after issuing a command. The default value is 3. Login Timeout (seconds) login_timeout Number of seconds to wait for a command prompt after login. The default value is 5. Times to Retry Power On Operation retry_on Number of attempts to retry a power on operation. The default value is 1. Port (Outlet) Number port Physical plug number or name of virtual machine. Delay (optional) delay The number of seconds to wait before fencing is started. The default value is 0.	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/fence_configuration_guide/s1-software-fence-emerson-ca
Chapter 1. About hardware accelerators	Chapter 1. About hardware accelerators Specialized hardware accelerators play a key role in the emerging generative artificial intelligence and machine learning (AI/ML) industry. Specifically, hardware accelerators are essential to the training and serving of large language and other foundational models that power this new technology. Data scientists, data engineers, ML engineers, and developers can take advantage of the specialized hardware acceleration for data-intensive transformations and model development and serving. Much of that ecosystem is open source, with a number of contributing partners and open source foundations. Red Hat OpenShift Container Platform provides support for cards and peripheral hardware that add processing units that comprise hardware accelerators: Graphical processing units (GPUs) Neural processing units (NPUs) Application-specific integrated circuits (ASICs) Data processing units (DPUs) Specialized hardware accelerators provide a rich set of benefits for AI/ML development: One platform for all A collaborative environment for developers, data engineers, data scientists, and DevOps Extended capabilities with Operators Operators allow for bringing AI/ML capabilities to OpenShift Container Platform Hybrid-cloud support On-premise support for model development, delivery, and deployment Support for AI/ML workloads Model testing, iteration, integration, promotion, and serving into production as services Red Hat provides an optimized platform to enable these specialized hardware accelerators in Red Hat Enterprise Linux (RHEL) and OpenShift Container Platform platforms at the Linux (kernel and userspace) and Kubernetes layers. To do this, Red Hat combines the proven capabilities of Red Hat OpenShift AI and Red Hat OpenShift Container Platform in a single enterprise-ready AI application platform. Hardware Operators use the operating framework of a Kubernetes cluster to enable the required accelerator resources. You can also deploy the provided device plugin manually or as a daemon set. This plugin registers the GPU in the cluster. Certain specialized hardware accelerators are designed to work within disconnected environments where a secure environment must be maintained for development and testing. 1.1. Hardware accelerators Red Hat OpenShift Container Platform enables the following hardware accelerators: NVIDIA GPU AMD Instinct(R) GPU Intel(R) Gaudi(R) Additional resources Introduction to Red Hat OpenShift AI NVIDIA GPU Operator on Red Hat OpenShift Container Platform AMD Instinct Accelerators Intel Gaudi Al Accelerators	null	https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/hardware_accelerators/about-hardware-accelerators
Managing Red Hat Certified and Ansible Galaxy collections in automation hub	Managing Red Hat Certified and Ansible Galaxy collections in automation hub Red Hat Ansible Automation Platform 2.3 Configure automation hub to deliver curated Red Hat Certified and Ansible Galaxy collections to your users. Red Hat Customer Content Services	null	https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.3/html/managing_red_hat_certified_and_ansible_galaxy_collections_in_automation_hub/index
Chapter 2. Browsing with the API	Chapter 2. Browsing with the API REST APIs give access to resources (data entities) through URI paths. Procedure Go to the automation controller REST API in a web browser at: https://<server name>/api/controller/v2 Click the "v2" link to "current versions" or "available versions" . Automation controller supports version 2 of the API. Perform a GET with just the /api/ endpoint to get the current_version , which is the recommended version. Click the icon on the navigation menu, for documentation on the access methods for that particular API endpoint and what data is returned when using those methods. Use the PUT and POST verbs on the specific API pages by formatting JSON in the various text fields. You can also view changed settings from factory defaults at /api/v2/settings/changed/ endpoint. It reflects changes you made in the API browser, not changed settings that come from static settings files.	null	https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/automation_controller_api_overview/controller-api-browsing-api
5.341. upstart	5.341. upstart 5.341.1. RHBA-2012:0863 - upstart bug fix and enhancement update An updated upstart package that fixes two bug and adds two enhancements is now available for Red Hat Enterprise Linux 6. The upstart package contains an event-based replacement for the /sbin/init daemon that starts tasks and services during boot, stops them during shut down, and supervises them while the system is running. Bug Fixes BZ# 771736 Previously, the PACKAGE_BUGREPORT variable pointed to a Ubuntu mailing list. The mailing list was therefore presented in multiple manual pages, which was unwanted. With this update, the value of the PACKAGE_BUGREPORT variable has been modified to "https://launchpad.net/upstart/+bugs", and users are now directed to that website rather than to the Ubuntu mailing list. BZ# 798551 versions of upstart did not mount the proc and sys file systems. This was ensured by initscripts, which could, under certain circumstances, lead to race condition problems. With this update, upstart is used to mount the proc and sys file systems before launching anything else. Enhancements BZ# 663594 Files with the ".conf" suffix located in the /etc/init/ directory are not considered as configuration files. As a consequence, such files are not protected during a package update and can be overwritten by new files. This update adds support for "override" files that contain user-specified settings. Now, it is possible to alter parameters provided by the aforementioned ".conf" files by creating a corresponding file with the ".override" suffix. BZ# 735427 Previously, the initctl scripts returned error messages that did not tell users how to run the particular command correctly to get the required output. This update adds a new stanza, "usage", that can be used to provide users with detailed information on how to run the particular command correctly if the input has been incorrect. All users of upstart are advised to upgrade to this updated package, which fixes these bugs and adds these enhancements.	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/6.3_technical_notes/upstart
Chapter 2. Setting up Maven locally	Chapter 2. Setting up Maven locally Typical Fuse application development uses Maven to build and manage projects. The following topics describe how to set up Maven locally: Section 2.1, "Preparing to set up Maven" Section 2.2, "Adding Red Hat repositories to Maven" Section 2.3, "Using local Maven repositories" Section 2.4, "Setting Maven mirror using environmental variables or system properties" Section 2.5, "About Maven artifacts and coordinates" 2.1. Preparing to set up Maven Maven is a free, open source, build tool from Apache. Typically, you use Maven to build Fuse applications. Procedure Download the latest version of Maven from the Maven download page . Ensure that your system is connected to the Internet. While building a project, the default behavior is that Maven searches external repositories and downloads the required artifacts. Maven looks for repositories that are accessible over the Internet. You can change this behavior so that Maven searches only repositories that are on a local network. That is, Maven can run in an offline mode. In offline mode, Maven looks for artifacts in its local repository. See Section 2.3, "Using local Maven repositories" . 2.2. Adding Red Hat repositories to Maven To access artifacts that are in Red Hat Maven repositories, you need to add those repositories to Maven's settings.xml file. Maven looks for the settings.xml file in the .m2 directory of the user's home directory. If there is not a user specified settings.xml file, Maven uses the system-level settings.xml file at M2_HOME/conf/settings.xml . Prerequisite You know the location of the settings.xml file in which you want to add the Red Hat repositories. Procedure In the settings.xml file, add repository elements for the Red Hat repositories as shown in this example: <?xml version="1.0"?> <settings> <profiles> <profile> <id>extra-repos</id> <activation> <activeByDefault>true</activeByDefault> </activation> <repositories> <repository> <id>redhat-ga-repository</id> <url>https://maven.repository.redhat.com/ga</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </repository> <repository> <id>redhat-ea-repository</id> <url>https://maven.repository.redhat.com/earlyaccess/all</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </repository> <repository> <id>jboss-public</id> <name>JBoss Public Repository Group</name> <url>https://repository.jboss.org/nexus/content/groups/public/</url> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>redhat-ga-repository</id> <url>https://maven.repository.redhat.com/ga</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </pluginRepository> <pluginRepository> <id>redhat-ea-repository</id> <url>https://maven.repository.redhat.com/earlyaccess/all</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </pluginRepository> <pluginRepository> <id>jboss-public</id> <name>JBoss Public Repository Group</name> <url>https://repository.jboss.org/nexus/content/groups/public</url> </pluginRepository> </pluginRepositories> </profile> </profiles> <activeProfiles> <activeProfile>extra-repos</activeProfile> </activeProfiles> </settings> 2.3. Using local Maven repositories If you are running a container without an Internet connection, and you need to deploy an application that has dependencies that are not available offline, you can use the Maven dependency plug-in to download the application's dependencies into a Maven offline repository. You can then distribute this customized Maven offline repository to machines that do not have an Internet connection. Procedure In the project directory that contains the pom.xml file, download a repository for a Maven project by running a command such as the following: In this example, Maven dependencies and plug-ins that are required to build the project are downloaded to the /tmp/my-project directory. Distribute this customized Maven offline repository internally to any machines that do not have an Internet connection. 2.4. Setting Maven mirror using environmental variables or system properties When running the applications you need access to the artifacts that are in the Red Hat Maven repositories. These repositories are added to Maven's settings.xml file. Maven checks the following locations for settings.xml file: looks for the specified url if not found looks for USD{user.home}/.m2/settings.xml if not found looks for USD{maven.home}/conf/settings.xml if not found looks for USD{M2_HOME}/conf/settings.xml if no location is found, empty org.apache.maven.settings.Settings instance is created. 2.4.1. About Maven mirror Maven uses a set of remote repositories to access the artifacts, which are currently not available in local repository. The list of repositories almost always contains Maven Central repository, but for Red Hat Fuse, it also contains Maven Red Hat repositories. In some cases where it is not possible or allowed to access different remote repositories, you can use a mechanism of Maven mirrors. A mirror replaces a particular repository URL with a different one, so all HTTP traffic when remote artifacts are being searched for can be directed to a single URL. 2.4.2. Adding Maven mirror to settings.xml To set the Maven mirror, add the following section to Maven's settings.xml : No mirror is used if the above section is not found in the settings.xml file. To specify a global mirror without providing the XML configuration, you can use either system property or environmental variables. 2.4.3. Setting Maven mirror using environmental variable or system property To set the Maven mirror using either environmental variable or system property, you can add: Environmental variable called MAVEN_MIRROR_URL to bin/setenv file System property called mavenMirrorUrl to etc/system.properties file 2.4.4. Using Maven options to specify Maven mirror url To use an alternate Maven mirror url, other than the one specified by environmental variables or system property, use the following maven options when running the application: -DmavenMirrorUrl=mirrorId::mirrorUrl for example, -DmavenMirrorUrl=my-mirror::http://mirror.net/repository -DmavenMirrorUrl=mirrorUrl for example, -DmavenMirrorUrl=http://mirror.net/repository . In this example, the <id> of the <mirror> is just a mirror. 2.5. About Maven artifacts and coordinates In the Maven build system, the basic building block is an artifact . After a build, the output of an artifact is typically an archive, such as a JAR or WAR file. A key aspect of Maven is the ability to locate artifacts and manage the dependencies between them. A Maven coordinate is a set of values that identifies the location of a particular artifact. A basic coordinate has three values in the following form: groupId:artifactId:version Sometimes Maven augments a basic coordinate with a packaging value or with both a packaging value and a classifier value. A Maven coordinate can have any one of the following forms: Here are descriptions of the values: groupdId Defines a scope for the name of the artifact. You would typically use all or part of a package name as a group ID. For example, org.fusesource.example . artifactId Defines the artifact name relative to the group ID. version Specifies the artifact's version. A version number can have up to four parts: n.n.n.n , where the last part of the version number can contain non-numeric characters. For example, the last part of 1.0-SNAPSHOT is the alphanumeric substring, 0-SNAPSHOT . packaging Defines the packaged entity that is produced when you build the project. For OSGi projects, the packaging is bundle . The default value is jar . classifier Enables you to distinguish between artifacts that were built from the same POM, but have different content. Elements in an artifact's POM file define the artifact's group ID, artifact ID, packaging, and version, as shown here: <project ... > ... <groupId>org.fusesource.example</groupId> <artifactId>bundle-demo</artifactId> <packaging>bundle</packaging> <version>1.0-SNAPSHOT</version> ... </project> To define a dependency on the preceding artifact, you would add the following dependency element to a POM file: <project ... > ... <dependencies> <dependency> <groupId>org.fusesource.example</groupId> <artifactId>bundle-demo</artifactId> <version>1.0-SNAPSHOT</version> </dependency> </dependencies> ... </project> Note It is not necessary to specify the bundle package type in the preceding dependency, because a bundle is just a particular kind of JAR file and jar is the default Maven package type. If you do need to specify the packaging type explicitly in a dependency, however, you can use the type element.	[ "<?xml version=\"1.0\"?> <settings> <profiles> <profile> <id>extra-repos</id> <activation> <activeByDefault>true</activeByDefault> </activation> <repositories> <repository> <id>redhat-ga-repository</id> <url>https://maven.repository.redhat.com/ga</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </repository> <repository> <id>redhat-ea-repository</id> <url>https://maven.repository.redhat.com/earlyaccess/all</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </repository> <repository> <id>jboss-public</id> <name>JBoss Public Repository Group</name> <url>https://repository.jboss.org/nexus/content/groups/public/</url> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>redhat-ga-repository</id> <url>https://maven.repository.redhat.com/ga</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </pluginRepository> <pluginRepository> <id>redhat-ea-repository</id> <url>https://maven.repository.redhat.com/earlyaccess/all</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </pluginRepository> <pluginRepository> <id>jboss-public</id> <name>JBoss Public Repository Group</name> <url>https://repository.jboss.org/nexus/content/groups/public</url> </pluginRepository> </pluginRepositories> </profile> </profiles> <activeProfiles> <activeProfile>extra-repos</activeProfile> </activeProfiles> </settings>", "mvn org.apache.maven.plugins:maven-dependency-plugin:3.1.0:go-offline -Dmaven.repo.local=/tmp/my-project", "<mirror> <id>all</id> <mirrorOf>*</mirrorOf> <url>http://host:port/path</url> </mirror>", "groupId:artifactId:version groupId:artifactId:packaging:version groupId:artifactId:packaging:classifier:version", "<project ... > <groupId>org.fusesource.example</groupId> <artifactId>bundle-demo</artifactId> <packaging>bundle</packaging> <version>1.0-SNAPSHOT</version> </project>", "<project ... > <dependencies> <dependency> <groupId>org.fusesource.example</groupId> <artifactId>bundle-demo</artifactId> <version>1.0-SNAPSHOT</version> </dependency> </dependencies> </project>" ]	https://docs.redhat.com/en/documentation/red_hat_fuse/7.13/html/getting_started_with_fuse_on_apache_karaf/set-up-maven-locally
Providing feedback on Red Hat build of OpenJDK documentation	Providing feedback on Red Hat build of OpenJDK documentation To report an error or to improve our documentation, log in to your Red Hat Jira account and submit an issue. If you do not have a Red Hat Jira account, then you will be prompted to create an account. Procedure Click the following link to create a ticket . Enter a brief description of the issue in the Summary . Provide a detailed description of the issue or enhancement in the Description . Include a URL to where the issue occurs in the documentation. Clicking Create creates and routes the issue to the appropriate documentation team.	null	https://docs.redhat.com/en/documentation/red_hat_build_of_openjdk/8/html/eclipse_temurin_8.0.422_release_notes/providing-direct-documentation-feedback_openjdk
Chapter 5. Override Ceph behavior	Chapter 5. Override Ceph behavior As a storage administrator, you need to understand how to use overrides for the Red Hat Ceph Storage cluster to change Ceph options during runtime. 5.1. Setting and unsetting Ceph override options You can set and unset Ceph options to override Ceph's default behavior. Prerequisites A running Red Hat Ceph Storage cluster. Root-level access to the node. Procedure To override Ceph's default behavior, use the ceph osd set command and the behavior you wish to override: Syntax Once you set the behavior, ceph health will reflect the override(s) that you have set for the cluster. Example To cease overriding Ceph's default behavior, use the ceph osd unset command and the override you wish to cease. Syntax Example Flag Description noin Prevents OSDs from being treated as in the cluster. noout Prevents OSDs from being treated as out of the cluster. noup Prevents OSDs from being treated as up and running. nodown Prevents OSDs from being treated as down . full Makes a cluster appear to have reached its full_ratio , and thereby prevents write operations. pause Ceph will stop processing read and write operations, but will not affect OSD in , out , up or down statuses. nobackfill Ceph will prevent new backfill operations. norebalance Ceph will prevent new rebalancing operations. norecover Ceph will prevent new recovery operations. noscrub Ceph will prevent new scrubbing operations. nodeep-scrub Ceph will prevent new deep scrubbing operations. notieragent Ceph will disable the process that is looking for cold/dirty objects to flush and evict. 5.2. Ceph override use cases noin : Commonly used with noout to address flapping OSDs. noout : If the mon osd report timeout is exceeded and an OSD has not reported to the monitor, the OSD will get marked out . If this happens erroneously, you can set noout to prevent the OSD(s) from getting marked out while you troubleshoot the issue. noup : Commonly used with nodown to address flapping OSDs. nodown : Networking issues may interrupt Ceph 'heartbeat' processes, and an OSD may be up but still get marked down. You can set nodown to prevent OSDs from getting marked down while troubleshooting the issue. full : If a cluster is reaching its full_ratio , you can pre-emptively set the cluster to full and expand capacity. Note Setting the cluster to full will prevent write operations. pause : If you need to troubleshoot a running Ceph cluster without clients reading and writing data, you can set the cluster to pause to prevent client operations. nobackfill : If you need to take an OSD or node down temporarily, for example, upgrading daemons, you can set nobackfill so that Ceph will not backfill while the OSDs is down . norecover : If you need to replace an OSD disk and don't want the PGs to recover to another OSD while you are hotswapping disks, you can set norecover to prevent the other OSDs from copying a new set of PGs to other OSDs. noscrub and nodeep-scrubb : If you want to prevent scrubbing for example, to reduce overhead during high loads, recovery, backfilling, and rebalancing you can set noscrub and/or nodeep-scrub to prevent the cluster from scrubbing OSDs. notieragent : If you want to stop the tier agent process from finding cold objects to flush to the backing storage tier, you may set notieragent .	[ "ceph osd set FLAG", "ceph osd set noout", "ceph osd unset FLAG", "ceph osd unset noout" ]	https://docs.redhat.com/en/documentation/red_hat_ceph_storage/6/html/administration_guide/override-ceph-behavior
Chapter 5. Scaling a user-provisioned cluster with the Bare Metal Operator	Chapter 5. Scaling a user-provisioned cluster with the Bare Metal Operator After deploying a user-provisioned infrastructure cluster, you can use the Bare Metal Operator (BMO) and other metal 3 components to scale bare-metal hosts in the cluster. This approach helps you to scale a user-provisioned cluster in a more automated way. 5.1. About scaling a user-provisioned cluster with the Bare Metal Operator You can scale user-provisioned infrastructure clusters by using the Bare Metal Operator (BMO) and other metal 3 components. User-provisioned infrastructure installations do not feature the Machine API Operator. The Machine API Operator typically manages the lifecycle of bare-metal nodes in a cluster. However, it is possible to use the BMO and other metal 3 components to scale nodes in user-provisioned clusters without requiring the Machine API Operator. 5.1.1. Prerequisites for scaling a user-provisioned cluster You installed a user-provisioned infrastructure cluster on bare metal. You have baseboard management controller (BMC) access to the hosts. 5.1.2. Limitations for scaling a user-provisioned cluster You cannot use a provisioning network to scale user-provisioned infrastructure clusters by using the Bare Metal Operator (BMO). Consequentially, you can only use bare-metal host drivers that support virtual media networking booting, for example redfish-virtualmedia and idrac-virtualmedia . You cannot scale MachineSet objects in user-provisioned infrastructure clusters by using the BMO. 5.2. Configuring a provisioning resource to scale user-provisioned clusters Create a Provisioning custom resource (CR) to enable Metal platform components on a user-provisioned infrastructure cluster. Prerequisites You installed a user-provisioned infrastructure cluster on bare metal. Procedure Create a Provisioning CR. Save the following YAML in the provisioning.yaml file: apiVersion: metal3.io/v1alpha1 kind: Provisioning metadata: name: provisioning-configuration spec: provisioningNetwork: "Disabled" watchAllNamespaces: false Note OpenShift Container Platform 4.14 does not support enabling a provisioning network when you scale a user-provisioned cluster by using the Bare Metal Operator. Create the Provisioning CR by running the following command: USD oc create -f provisioning.yaml Example output provisioning.metal3.io/provisioning-configuration created Verification Verify that the provisioning service is running by running the following command: USD oc get pods -n openshift-machine-api Example output NAME READY STATUS RESTARTS AGE cluster-autoscaler-operator-678c476f4c-jjdn5 2/2 Running 0 5d21h cluster-baremetal-operator-6866f7b976-gmvgh 2/2 Running 0 5d21h control-plane-machine-set-operator-7d8566696c-bh4jz 1/1 Running 0 5d21h ironic-proxy-64bdw 1/1 Running 0 5d21h ironic-proxy-rbggf 1/1 Running 0 5d21h ironic-proxy-vj54c 1/1 Running 0 5d21h machine-api-controllers-544d6849d5-tgj9l 7/7 Running 1 (5d21h ago) 5d21h machine-api-operator-5c4ff4b86d-6fjmq 2/2 Running 0 5d21h metal3-6d98f84cc8-zn2mx 5/5 Running 0 5d21h metal3-image-customization-59d745768d-bhrp7 1/1 Running 0 5d21h 5.3. Provisioning new hosts in a user-provisioned cluster by using the BMO You can use the Bare Metal Operator (BMO) to provision bare-metal hosts in a user-provisioned cluster by creating a BareMetalHost custom resource (CR). Note Provisioning bare-metal hosts to the cluster by using the BMO sets the spec.externallyProvisioned specification in the BareMetalHost custom resource to false by default. Do not set the spec.externallyProvisioned specification to true , because this setting results in unexpected behavior. Prerequisites You created a user-provisioned bare-metal cluster. You have baseboard management controller (BMC) access to the hosts. You deployed a provisioning service in the cluster by creating a Provisioning CR. Procedure Create a configuration file for the bare-metal node. Depending if you use either a static configuration or a DHCP server, choose one of the following example bmh.yaml files and configure it to your needs by replacing values in the YAML to match your environment: To deploy with a static configuration, create the following bmh.yaml file: --- apiVersion: v1 kind: Secret metadata: name: openshift-worker-<num>-network-config-secret 1 namespace: openshift-machine-api type: Opaque stringData: nmstate: \| 2 interfaces: 3 - name: <nic1_name> 4 type: ethernet state: up ipv4: address: - ip: <ip_address> 5 prefix-length: 24 enabled: true dns-resolver: config: server: - <dns_ip_address> 6 routes: config: - destination: 0.0.0.0/0 -hop-address: <next_hop_ip_address> 7 -hop-interface: <next_hop_nic1_name> 8 --- apiVersion: v1 kind: Secret metadata: name: openshift-worker-<num>-bmc-secret namespace: openshift-machine-api type: Opaque data: username: <base64_of_uid> 9 password: <base64_of_pwd> --- apiVersion: metal3.io/v1alpha1 kind: BareMetalHost metadata: name: openshift-worker-<num> namespace: openshift-machine-api spec: online: true bootMACAddress: <nic1_mac_address> 10 bmc: address: <protocol>://<bmc_url> 11 credentialsName: openshift-worker-<num>-bmc-secret disableCertificateVerification: false customDeploy: method: install_coreos userData: name: worker-user-data-managed namespace: openshift-machine-api rootDeviceHints: deviceName: <root_device_hint> 12 preprovisioningNetworkDataName: openshift-worker-<num>-network-config-secret 1 Replace all instances of <num> with a unique compute node number for the bare-metal nodes in the name , credentialsName , and preprovisioningNetworkDataName fields. 2 Add the NMState YAML syntax to configure the host interfaces. To configure the network interface for a newly created node, specify the name of the secret that has the network configuration. Follow the nmstate syntax to define the network configuration for your node. See "Preparing the bare-metal node" for details on configuring NMState syntax. 3 Optional: If you have configured the network interface with nmstate , and you want to disable an interface, set state: up with the IP addresses set to enabled: false . 4 Replace <nic1_name> with the name of the bare-metal node's first network interface controller (NIC). 5 Replace <ip_address> with the IP address of the bare-metal node's NIC. 6 Replace <dns_ip_address> with the IP address of the bare-metal node's DNS resolver. 7 Replace <next_hop_ip_address> with the IP address of the bare-metal node's external gateway. 8 Replace <next_hop_nic1_name> with the name of the bare-metal node's external gateway. 9 Replace <base64_of_uid> and <base64_of_pwd> with the base64 string of the user name and password. 10 Replace <nic1_mac_address> with the MAC address of the bare-metal node's first NIC. See the "BMC addressing" section for additional BMC configuration options. 11 Replace <protocol> with the BMC protocol, such as IPMI, Redfish, or others. Replace <bmc_url> with the URL of the bare-metal node's baseboard management controller. 12 Optional: Replace <root_device_hint> with a device path when specifying a root device hint. See "Root device hints" for additional details. When configuring the network interface with a static configuration by using nmstate , set state: up with the IP addresses set to enabled: false : --- apiVersion: v1 kind: Secret metadata: name: openshift-worker-<num>-network-config-secret namespace: openshift-machine-api # ... interfaces: - name: <nic_name> type: ethernet state: up ipv4: enabled: false ipv6: enabled: false # ... To deploy with a DHCP configuration, create the following bmh.yaml file: --- apiVersion: v1 kind: Secret metadata: name: openshift-worker-<num>-bmc-secret 1 namespace: openshift-machine-api type: Opaque data: username: <base64_of_uid> 2 password: <base64_of_pwd> --- apiVersion: metal3.io/v1alpha1 kind: BareMetalHost metadata: name: openshift-worker-<num> namespace: openshift-machine-api spec: online: true bootMACAddress: <nic1_mac_address> 3 bmc: address: <protocol>://<bmc_url> 4 credentialsName: openshift-worker-<num>-bmc disableCertificateVerification: false customDeploy: method: install_coreos userData: name: worker-user-data-managed namespace: openshift-machine-api rootDeviceHints: deviceName: <root_device_hint> 5 1 Replace <num> with a unique compute node number for the bare-metal nodes in the name and credentialsName fields. 2 Replace <base64_of_uid> and <base64_of_pwd> with the base64 string of the user name and password. 3 Replace <nic1_mac_address> with the MAC address of the bare-metal node's first NIC. See the "BMC addressing" section for additional BMC configuration options. 4 Replace <protocol> with the BMC protocol, such as IPMI, Redfish, or others. Replace <bmc_url> with the URL of the bare-metal node's baseboard management controller. 5 Optional: Replace <root_device_hint> with a device path when specifying a root device hint. See "Root device hints" for additional details. Important If the MAC address of an existing bare-metal node matches the MAC address of the bare-metal host that you are attempting to provision, then the installation will fail. If the host enrollment, inspection, cleaning, or other steps fail, the Bare Metal Operator retries the installation continuously. See "Diagnosing a duplicate MAC address when provisioning a new host in the cluster" for additional details. Create the bare-metal node by running the following command: USD oc create -f bmh.yaml Example output secret/openshift-worker-<num>-network-config-secret created secret/openshift-worker-<num>-bmc-secret created baremetalhost.metal3.io/openshift-worker-<num> created Inspect the bare-metal node by running the following command: USD oc -n openshift-machine-api get bmh openshift-worker-<num> where: <num> Specifies the compute node number. Example output NAME STATE CONSUMER ONLINE ERROR openshift-worker-<num> provisioned true Approve all certificate signing requests (CSRs). Get the list of pending CSRs by running the following command: USD oc get csr Example output NAME AGE SIGNERNAME REQUESTOR REQUESTEDDURATION CONDITION csr-gfm9f 33s kubernetes.io/kube-apiserver-client-kubelet system:serviceaccount:openshift-machine-config-o perator:node-bootstrapper <none> Pending Approve the CSR by running the following command: USD oc adm certificate approve <csr_name> Example output certificatesigningrequest.certificates.k8s.io/<csr_name> approved Verification Verify that the node is ready by running the following command: USD oc get nodes Example output NAME STATUS ROLES AGE VERSION app1 Ready worker 47s v1.24.0+dc5a2fd controller1 Ready master,worker 2d22h v1.24.0+dc5a2fd Additional resources Preparing the bare-metal node Root device hints Diagnosing a duplicate MAC address when provisioning a new host in the cluster 5.4. Optional: Managing existing hosts in a user-provisioned cluster by using the BMO Optionally, you can use the Bare Metal Operator (BMO) to manage existing bare-metal controller hosts in a user-provisioned cluster by creating a BareMetalHost object for the existing host. It is not a requirement to manage existing user-provisioned hosts; however, you can enroll them as externally-provisioned hosts for inventory purposes. Important To manage existing hosts by using the BMO, you must set the spec.externallyProvisioned specification in the BareMetalHost custom resource to true to prevent the BMO from re-provisioning the host. Prerequisites You created a user-provisioned bare-metal cluster. You have baseboard management controller (BMC) access to the hosts. You deployed a provisioning service in the cluster by creating a Provisioning CR. Procedure Create the Secret CR and the BareMetalHost CR. Save the following YAML in the controller.yaml file: --- apiVersion: v1 kind: Secret metadata: name: controller1-bmc namespace: openshift-machine-api type: Opaque data: username: <base64_of_uid> password: <base64_of_pwd> --- apiVersion: metal3.io/v1alpha1 kind: BareMetalHost metadata: name: controller1 namespace: openshift-machine-api spec: bmc: address: <protocol>://<bmc_url> 1 credentialsName: "controller1-bmc" bootMACAddress: <nic1_mac_address> customDeploy: method: install_coreos externallyProvisioned: true 2 online: true userData: name: controller-user-data-managed namespace: openshift-machine-api 1 You can only use bare-metal host drivers that support virtual media networking booting, for example redfish-virtualmedia and idrac-virtualmedia . 2 You must set the value to true to prevent the BMO from re-provisioning the bare-metal controller host. Create the bare-metal host object by running the following command: USD oc create -f controller.yaml Example output secret/controller1-bmc created baremetalhost.metal3.io/controller1 created Verification Verify that the BMO created the bare-metal host object by running the following command: USD oc get bmh -A Example output NAMESPACE NAME STATE CONSUMER ONLINE ERROR AGE openshift-machine-api controller1 externally provisioned true 13s 5.5. Removing hosts from a user-provisioned cluster by using the BMO You can use the Bare Metal Operator (BMO) to remove bare-metal hosts from a user-provisioned cluster. Prerequisites You created a user-provisioned bare-metal cluster. You have baseboard management controller (BMC) access to the hosts. You deployed a provisioning service in the cluster by creating a Provisioning CR. Procedure Cordon and drain the node by running the following command: USD oc adm drain app1 --force --ignore-daemonsets=true Example output node/app1 cordoned WARNING: ignoring DaemonSet-managed Pods: openshift-cluster-node-tuning-operator/tuned-tvthg, openshift-dns/dns- default-9q6rz, openshift-dns/node-resolver-zvt42, openshift-image-registry/node-ca-mzxth, openshift-ingress-cana ry/ingress-canary-qq5lf, openshift-machine-config-operator/machine-config-daemon-v79dm, openshift-monitoring/nod e-exporter-2vn59, openshift-multus/multus-additional-cni-plugins-wssvj, openshift-multus/multus-fn8tg, openshift -multus/network-metrics-daemon-5qv55, openshift-network-diagnostics/network-check-target-jqxn2, openshift-ovn-ku bernetes/ovnkube-node-rsvqg evicting pod openshift-operator-lifecycle-manager/collect-profiles-27766965-258vp evicting pod openshift-operator-lifecycle-manager/collect-profiles-27766950-kg5mk evicting pod openshift-operator-lifecycle-manager/collect-profiles-27766935-stf4s pod/collect-profiles-27766965-258vp evicted pod/collect-profiles-27766950-kg5mk evicted pod/collect-profiles-27766935-stf4s evicted node/app1 drained Delete the customDeploy specification from the BareMetalHost CR. Edit the BareMetalHost CR for the host by running the following command: USD oc edit bmh -n openshift-machine-api <host_name> Delete the lines spec.customDeploy and spec.customDeploy.method : ... customDeploy: method: install_coreos Verify that the provisioning state of the host changes to deprovisioning by running the following command: USD oc get bmh -A Example output NAMESPACE NAME STATE CONSUMER ONLINE ERROR AGE openshift-machine-api controller1 externally provisioned true 58m openshift-machine-api worker1 deprovisioning true 57m Delete the host by running the following command when the BareMetalHost state changes to available : USD oc delete bmh -n openshift-machine-api <bmh_name> Note You can run this step without having to edit the BareMetalHost CR. It might take some time for the BareMetalHost state to change from deprovisioning to available . Delete the node by running the following command: USD oc delete node <node_name> Verification Verify that you deleted the node by running the following command: USD oc get nodes Example output NAME STATUS ROLES AGE VERSION controller1 Ready master,worker 2d23h v1.24.0+dc5a2fd	[ "apiVersion: metal3.io/v1alpha1 kind: Provisioning metadata: name: provisioning-configuration spec: provisioningNetwork: \"Disabled\" watchAllNamespaces: false", "oc create -f provisioning.yaml", "provisioning.metal3.io/provisioning-configuration created", "oc get pods -n openshift-machine-api", "NAME READY STATUS RESTARTS AGE cluster-autoscaler-operator-678c476f4c-jjdn5 2/2 Running 0 5d21h cluster-baremetal-operator-6866f7b976-gmvgh 2/2 Running 0 5d21h control-plane-machine-set-operator-7d8566696c-bh4jz 1/1 Running 0 5d21h ironic-proxy-64bdw 1/1 Running 0 5d21h ironic-proxy-rbggf 1/1 Running 0 5d21h ironic-proxy-vj54c 1/1 Running 0 5d21h machine-api-controllers-544d6849d5-tgj9l 7/7 Running 1 (5d21h ago) 5d21h machine-api-operator-5c4ff4b86d-6fjmq 2/2 Running 0 5d21h metal3-6d98f84cc8-zn2mx 5/5 Running 0 5d21h metal3-image-customization-59d745768d-bhrp7 1/1 Running 0 5d21h", "--- apiVersion: v1 kind: Secret metadata: name: openshift-worker-<num>-network-config-secret 1 namespace: openshift-machine-api type: Opaque stringData: nmstate: \| 2 interfaces: 3 - name: <nic1_name> 4 type: ethernet state: up ipv4: address: - ip: <ip_address> 5 prefix-length: 24 enabled: true dns-resolver: config: server: - <dns_ip_address> 6 routes: config: - destination: 0.0.0.0/0 next-hop-address: <next_hop_ip_address> 7 next-hop-interface: <next_hop_nic1_name> 8 --- apiVersion: v1 kind: Secret metadata: name: openshift-worker-<num>-bmc-secret namespace: openshift-machine-api type: Opaque data: username: <base64_of_uid> 9 password: <base64_of_pwd> --- apiVersion: metal3.io/v1alpha1 kind: BareMetalHost metadata: name: openshift-worker-<num> namespace: openshift-machine-api spec: online: true bootMACAddress: <nic1_mac_address> 10 bmc: address: <protocol>://<bmc_url> 11 credentialsName: openshift-worker-<num>-bmc-secret disableCertificateVerification: false customDeploy: method: install_coreos userData: name: worker-user-data-managed namespace: openshift-machine-api rootDeviceHints: deviceName: <root_device_hint> 12 preprovisioningNetworkDataName: openshift-worker-<num>-network-config-secret", "--- apiVersion: v1 kind: Secret metadata: name: openshift-worker-<num>-network-config-secret namespace: openshift-machine-api # interfaces: - name: <nic_name> type: ethernet state: up ipv4: enabled: false ipv6: enabled: false", "--- apiVersion: v1 kind: Secret metadata: name: openshift-worker-<num>-bmc-secret 1 namespace: openshift-machine-api type: Opaque data: username: <base64_of_uid> 2 password: <base64_of_pwd> --- apiVersion: metal3.io/v1alpha1 kind: BareMetalHost metadata: name: openshift-worker-<num> namespace: openshift-machine-api spec: online: true bootMACAddress: <nic1_mac_address> 3 bmc: address: <protocol>://<bmc_url> 4 credentialsName: openshift-worker-<num>-bmc disableCertificateVerification: false customDeploy: method: install_coreos userData: name: worker-user-data-managed namespace: openshift-machine-api rootDeviceHints: deviceName: <root_device_hint> 5", "oc create -f bmh.yaml", "secret/openshift-worker-<num>-network-config-secret created secret/openshift-worker-<num>-bmc-secret created baremetalhost.metal3.io/openshift-worker-<num> created", "oc -n openshift-machine-api get bmh openshift-worker-<num>", "NAME STATE CONSUMER ONLINE ERROR openshift-worker-<num> provisioned true", "oc get csr", "NAME AGE SIGNERNAME REQUESTOR REQUESTEDDURATION CONDITION csr-gfm9f 33s kubernetes.io/kube-apiserver-client-kubelet system:serviceaccount:openshift-machine-config-o perator:node-bootstrapper <none> Pending", "oc adm certificate approve <csr_name>", "certificatesigningrequest.certificates.k8s.io/<csr_name> approved", "oc get nodes", "NAME STATUS ROLES AGE VERSION app1 Ready worker 47s v1.24.0+dc5a2fd controller1 Ready master,worker 2d22h v1.24.0+dc5a2fd", "--- apiVersion: v1 kind: Secret metadata: name: controller1-bmc namespace: openshift-machine-api type: Opaque data: username: <base64_of_uid> password: <base64_of_pwd> --- apiVersion: metal3.io/v1alpha1 kind: BareMetalHost metadata: name: controller1 namespace: openshift-machine-api spec: bmc: address: <protocol>://<bmc_url> 1 credentialsName: \"controller1-bmc\" bootMACAddress: <nic1_mac_address> customDeploy: method: install_coreos externallyProvisioned: true 2 online: true userData: name: controller-user-data-managed namespace: openshift-machine-api", "oc create -f controller.yaml", "secret/controller1-bmc created baremetalhost.metal3.io/controller1 created", "oc get bmh -A", "NAMESPACE NAME STATE CONSUMER ONLINE ERROR AGE openshift-machine-api controller1 externally provisioned true 13s", "oc adm drain app1 --force --ignore-daemonsets=true", "node/app1 cordoned WARNING: ignoring DaemonSet-managed Pods: openshift-cluster-node-tuning-operator/tuned-tvthg, openshift-dns/dns- default-9q6rz, openshift-dns/node-resolver-zvt42, openshift-image-registry/node-ca-mzxth, openshift-ingress-cana ry/ingress-canary-qq5lf, openshift-machine-config-operator/machine-config-daemon-v79dm, openshift-monitoring/nod e-exporter-2vn59, openshift-multus/multus-additional-cni-plugins-wssvj, openshift-multus/multus-fn8tg, openshift -multus/network-metrics-daemon-5qv55, openshift-network-diagnostics/network-check-target-jqxn2, openshift-ovn-ku bernetes/ovnkube-node-rsvqg evicting pod openshift-operator-lifecycle-manager/collect-profiles-27766965-258vp evicting pod openshift-operator-lifecycle-manager/collect-profiles-27766950-kg5mk evicting pod openshift-operator-lifecycle-manager/collect-profiles-27766935-stf4s pod/collect-profiles-27766965-258vp evicted pod/collect-profiles-27766950-kg5mk evicted pod/collect-profiles-27766935-stf4s evicted node/app1 drained", "oc edit bmh -n openshift-machine-api <host_name>", "customDeploy: method: install_coreos", "oc get bmh -A", "NAMESPACE NAME STATE CONSUMER ONLINE ERROR AGE openshift-machine-api controller1 externally provisioned true 58m openshift-machine-api worker1 deprovisioning true 57m", "oc delete bmh -n openshift-machine-api <bmh_name>", "oc delete node <node_name>", "oc get nodes", "NAME STATUS ROLES AGE VERSION controller1 Ready master,worker 2d23h v1.24.0+dc5a2fd" ]	https://docs.redhat.com/en/documentation/openshift_container_platform/4.14/html/installing_on_bare_metal/scaling-a-user-provisioned-cluster-with-the-bare-metal-operator
Chapter 1. Workflow for converting a virtualization cluster to a hyperconverged cluster	Chapter 1. Workflow for converting a virtualization cluster to a hyperconverged cluster Verify that your virtualization hosts use Red Hat Virtualization 4.4 or higher, and meet Red Hat Hyperconverged Infrastructure for Virtualization Support Requirements . Subscribe to software repositories . Convert virtualization hosts to hyperconverged hosts . Create Red Hat Gluster Storage volumes using storage on the converted host .	null	https://docs.redhat.com/en/documentation/red_hat_hyperconverged_infrastructure_for_virtualization/1.8/html/converting_a_virtualization_cluster_to_a_hyperconverged_cluster/workflow-convert-rhv-rhhi
2.9.2. Performance Tuning With GFS2	2.9.2. Performance Tuning With GFS2 It is usually possible to alter the way in which a troublesome application stores its data in order to gain a considerable performance advantage. A typical example of a troublesome application is an email server. These are often laid out with a spool directory containing files for each user ( mbox ), or with a directory for each user containing a file for each message ( maildir ). When requests arrive over IMAP, the ideal arrangement is to give each user an affinity to a particular node. That way their requests to view and delete email messages will tend to be served from the cache on that one node. Obviously if that node fails, then the session can be restarted on a different node. When mail arrives by means of SMTP, then again the individual nodes can be set up so as to pass a certain user's mail to a particular node by default. If the default node is not up, then the message can be saved directly into the user's mail spool by the receiving node. Again this design is intended to keep particular sets of files cached on just one node in the normal case, but to allow direct access in the case of node failure. This setup allows the best use of GFS2's page cache and also makes failures transparent to the application, whether imap or smtp . Backup is often another tricky area. Again, if it is possible it is greatly preferable to back up the working set of each node directly from the node which is caching that particular set of inodes. If you have a backup script which runs at a regular point in time, and that seems to coincide with a spike in the response time of an application running on GFS2, then there is a good chance that the cluster may not be making the most efficient use of the page cache. Obviously, if you are in the (enviable) position of being able to stop the application in order to perform a backup, then this will not be a problem. On the other hand, if a backup is run from just one node, then after it has completed a large portion of the file system will be cached on that node, with a performance penalty for subsequent accesses from other nodes. This can be mitigated to a certain extent by dropping the VFS page cache on the backup node after the backup has completed with following command: However this is not as good a solution as taking care to ensure the working set on each node is either shared, mostly read only across the cluster, or accessed largely from a single node.	[ "echo -n 3 >/proc/sys/vm/drop_caches" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/global_file_system_2/gfs2_performance_tuning
Chapter 4. Overview of image configuration	Chapter 4. Overview of image configuration The Image Configuration tests, also known as cloud/configuration , confirm that the image is configured in accordance with Red Hat standards so that customers have a uniform and consistent experience across multiple cloud providers and images in an integrated environment. The cloud/configuration test includes the following subtests: 4.1. Default system logging Confirms the default system logging service (syslog) is configured to store the logs in the /var/log/ directory of the image to allow quick issue resolution when needed. Success criteria Basic system logging is stored in /var/log/ directory on the image. 4.2. Network configuration test Network configuration confirms that the default firewall service (iptables) is running, port 22 is open with SSHD running, ports 80 and 443 are open or closed, and that all other ports are closed. This ensures that the image is protected from unauthorized access by default, with a known access configuration. This also ensures that customers have SSH access to the image and are able to quickly deploy HTTP applications without additional configuration. The image may have other ports open if they are necessary for proper operation of the cloud infrastructure but such ports must be documented. This test displays status (Pass) at runtime only if ports 22, 80 (optional), 443 (optional) are open on the image. If other ports are open, this test requests a description of the open ports for review at Red Hat to confirm success or failure. Note As part of the certification process, the Red Hat Certification application by default runs on port 8009. The Red Hat Certification application may also run on another open port during certification testing but it is recommended to open this port only during the testing and not as default in the configuration of an image. Success criteria Depending on the RHEL version, ensure that the following services are enabled and running: RHEL version Services RHEL 9 firewalld or nftables RHEL 8.3 and later firewalld or nftables RHEL 8 to 8.2 firewalld and nftables or firewalld and iptables sshd is enabled and running on port 22 and is accessible Any other ports open are required for proper operation of the cloud infrastructure and are documented Red Hat Certification application is running on port 8009 (or another port as configured) All other ports are closed Note The httpd service is allowed but not required to be running on port 80 and/or port 443. 4.3. Default OS runlevel Confirms that the current system runlevel is 3, 4, or 5. This subtest ensures that the image is operating in the desired mode/state with all the required system services (for example networking) running. Success criteria The current runlevel is 3, 4, or 5. Additional resources For more information about runlevels, see: RHEL 9 : Working with systemd targets . RHEL 8 : Working with systemd targets . 4.4. System services The system services confirms the root user can start and stop services on the system. This ensures that your customers who have system administration privileges can access/work with applications and services on the system and perform all the tasks which require administrative access in a seamless manner. The system services also ensures that there is no gap between the configured and actual state of the installed system services. Success criteria The root user can start and stop system services provided by the Red Hat product. For all the installed system services, actual status should match to their configured status. For instance if the service is enabled then it should be in running state. Additional resources For more information about gaining the required privileges, see: RHEL 9 : Managing sudo access . RHEL 8 : Managing sudo access . 4.5. Subscription services Confirms that the required Red Hat subscriptions are configured, available and working on the image and that the update mechanism is Red Hat Satellite or RHUI. This ensures that customers are able to obtain access to the packages and updates they need to support their applications through standard Red Hat package update or delivery mechanisms. Success criteria The image is configured and able to download, install, and upgrade a package from Red Hat Satellite or the RHUI subscription management services.	null	https://docs.redhat.com/en/documentation/red_hat_certified_cloud_and_service_provider_certification/2025/html/red_hat_certified_cloud_and_service_provider_certification_policy_guide/assembly-image-configuration_cloud-image-pol-supportability-tests
Chapter 15. Bean	Chapter 15. Bean Only producer is supported The Bean component binds beans to Camel message exchanges. 15.1. Dependencies When using bean with Red Hat build of Camel Spring Boot make sure to use the following Maven dependency to have support for auto configuration: <dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-bean-starter</artifactId> </dependency> 15.2. URI format Where beanID can be any string which is used to look up the bean in the Registry 15.3. Configuring Options Camel components are configured on two levels: Component level Endpoint level 15.3.1. Component Level Options The component level is the highest level. The configurations you define at this level are inherited by all the endpoints. For example, a component can have security settings, credentials for authentication, urls for network connection, and so on. Since components typically have pre-configured defaults for the most common cases, you may need to only configure a few component options, or maybe none at all. You can configure components with Component DSL in a configuration file (application.properties\|yaml), or directly with Java code. 15.3.2. Endpoint Level Options At the Endpoint level you have many options, which you can use to configure what you want the endpoint to do. The options are categorized according to whether the endpoint is used as a consumer (from) or as a producer (to) or used for both. You can configure endpoints directly in the endpoint URI as path and query parameters. You can also use Endpoint DSL and DataFormat DSL as type safe ways of configuring endpoints and data formats in Java. When configuring options, use Property Placeholders for urls, port numbers, sensitive information, and other settings. Placeholders allows you to externalize the configuration from your code, giving you more flexible and reusable code. 15.4. Component Options The Bean component supports 4 options, which are listed below. Name Description Default Type cache (producer) Deprecated Use singleton option instead. true Boolean lazyStartProducer (producer) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false boolean scope (producer) Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple times while processing the request. The bean does not have to be thread-safe as the instance is only called from the same request. When using delegate scope, then the bean will be looked up or created per call. However in case of lookup then this is delegated to the bean registry such as Spring or CDI (if in use), which depends on their configuration can act as either singleton or prototype scope. so when using prototype then this depends on the delegated registry. Enum values: Singleton Request Prototype Singleton BeanScope autowiredEnabled (advanced) Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. true boolean 15.5. Endpoint Options The Bean endpoint is configured using URI syntax: with the following path and query parameters: 15.5.1. Path Parameters (1 parameters) Name Description Default Type beanName (common) Required Sets the name of the bean to invoke. String 15.5.2. Query Parameters (5 parameters) Name Description Default Type cache (common) Deprecated Use scope option instead. Boolean method (common) Sets the name of the method to invoke on the bean. String scope (common) Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple times while processing the request. The bean does not have to be thread-safe as the instance is only called from the same request. When using prototype scope, then the bean will be looked up or created per call. However in case of lookup then this is delegated to the bean registry such as Spring or CDI (if in use), which depends on their configuration can act as either singleton or prototype scope. so when using prototype then this depends on the delegated registry. Enum values: Singleton Request Prototype Singleton BeanScope lazyStartProducer (producer) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false boolean parameters (advanced) Used for configuring additional properties on the bean. Map 15.6. Examples The object instance that is used to consume messages must be explicitly registered with the Registry. For example, if you are using Spring you must define the bean in the Spring configuration XML file. You can also register beans manually via Camel's Registry with the bind method. Once an endpoint has been registered, you can build Camel routes that use it to process exchanges. A bean: endpoint cannot be defined as the input to the route; i.e. you cannot consume from it, you can only route from some inbound message Endpoint to the bean endpoint as output. So consider using a direct: or queue: endpoint as the input. You can use the createProxy() methods on ProxyHelper to create a proxy that will generate exchanges and send them to any endpoint: And the same route using XML DSL: <route> <from uri="direct:hello"/> <to uri="bean:bye"/> </route> 15.7. Bean as endpoint Camel also supports invoking Bean as an Endpoint. What happens is that when the exchange is routed to the myBean Camel will use the Bean Binding to invoke the bean. The source for the bean is just a plain POJO. Camel will use Bean Binding to invoke the sayHello method, by converting the Exchange's In body to the String type and storing the output of the method on the Exchange Out body. 15.8. Java DSL bean syntax Java DSL comes with syntactic sugar for the component. Instead of specifying the bean explicitly as the endpoint (i.e. to("bean:beanName") ) you can use the following syntax: // Send message to the bean endpoint // and invoke method resolved using Bean Binding. from("direct:start").bean("beanName"); // Send message to the bean endpoint // and invoke given method. from("direct:start").bean("beanName", "methodName"); Instead of passing name of the reference to the bean (so that Camel will lookup for it in the registry), you can specify the bean itself: // Send message to the given bean instance. from("direct:start").bean(new ExampleBean()); // Explicit selection of bean method to be invoked. from("direct:start").bean(new ExampleBean(), "methodName"); // Camel will create the instance of bean and cache it for you. from("direct:start").bean(ExampleBean.class); 15.9. Bean Binding How bean methods to be invoked are chosen (if they are not specified explicitly through the method parameter) and how parameter values are constructed from the Message are all defined by the Bean Binding mechanism which is used throughout all of the various Bean Integration mechanisms in Camel. 15.10. Spring Boot Auto-Configuration The component supports 13 options, which are listed below. Name Description Default Type camel.component.bean.autowired-enabled Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. true Boolean camel.component.bean.enabled Whether to enable auto configuration of the bean component. This is enabled by default. Boolean camel.component.bean.lazy-start-producer Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false Boolean camel.component.bean.scope Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple times while processing the request. The bean does not have to be thread-safe as the instance is only called from the same request. When using delegate scope, then the bean will be looked up or created per call. However in case of lookup then this is delegated to the bean registry such as Spring or CDI (if in use), which depends on their configuration can act as either singleton or prototype scope. so when using prototype then this depends on the delegated registry. BeanScope camel.component.class.autowired-enabled Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. true Boolean camel.component.class.enabled Whether to enable auto configuration of the class component. This is enabled by default. Boolean camel.component.class.lazy-start-producer Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false Boolean camel.component.class.scope Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple times while processing the request. The bean does not have to be thread-safe as the instance is only called from the same request. When using delegate scope, then the bean will be looked up or created per call. However in case of lookup then this is delegated to the bean registry such as Spring or CDI (if in use), which depends on their configuration can act as either singleton or prototype scope. so when using prototype then this depends on the delegated registry. BeanScope camel.language.bean.enabled Whether to enable auto configuration of the bean language. This is enabled by default. Boolean camel.language.bean.scope Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple times while processing the request. The bean does not have to be thread-safe as the instance is only called from the same request. When using prototype scope, then the bean will be looked up or created per call. However in case of lookup then this is delegated to the bean registry such as Spring or CDI (if in use), which depends on their configuration can act as either singleton or prototype scope. So when using prototype scope then this depends on the bean registry implementation. Singleton String camel.language.bean.trim Whether to trim the value to remove leading and trailing whitespaces and line breaks. true Boolean camel.component.bean.cache Deprecated Use singleton option instead. true Boolean camel.component.class.cache Deprecated Use singleton option instead. true Boolean	[ "<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-bean-starter</artifactId> </dependency>", "bean:beanName[?options]", "bean:beanName", "<route> <from uri=\"direct:hello\"/> <to uri=\"bean:bye\"/> </route>", "// Send message to the bean endpoint // and invoke method resolved using Bean Binding. from(\"direct:start\").bean(\"beanName\"); // Send message to the bean endpoint // and invoke given method. from(\"direct:start\").bean(\"beanName\", \"methodName\");", "// Send message to the given bean instance. from(\"direct:start\").bean(new ExampleBean()); // Explicit selection of bean method to be invoked. from(\"direct:start\").bean(new ExampleBean(), \"methodName\"); // Camel will create the instance of bean and cache it for you. from(\"direct:start\").bean(ExampleBean.class);" ]	https://docs.redhat.com/en/documentation/red_hat_build_of_apache_camel/4.4/html/red_hat_build_of_apache_camel_for_spring_boot_reference/csb-camel-bean-component-starter
Chapter 1. Preparing your environment for installation	Chapter 1. Preparing your environment for installation 1.1. System requirements The following requirements apply to the networked base operating system: x86_64 architecture The latest version of Red Hat Enterprise Linux 8 4-core 2.0 GHz CPU at a minimum A minimum of 12 GB RAM is required for Capsule Server to function. In addition, a minimum of 4 GB RAM of swap space is also recommended. Capsule running with less RAM than the minimum value might not operate correctly. A unique host name, which can contain lower-case letters, numbers, dots (.) and hyphens (-) A current Red Hat Satellite subscription Administrative user (root) access Full forward and reverse DNS resolution using a fully-qualified domain name Satellite only supports UTF-8 encoding. If your territory is USA and your language is English, set en_US.utf-8 as the system-wide locale settings. For more information about configuring system locale in Red Hat Enterprise Linux, see Configuring System Locale guide . Your Satellite must have the Red Hat Satellite Infrastructure Subscription manifest in your Customer Portal. Satellite must have satellite-capsule-6.x repository enabled and synced. To create, manage, and export a Red Hat Subscription Manifest in the Customer Portal, see Creating and managing manifests for a connected Satellite Server in Subscription Central . Satellite Server and Capsule Server do not support shortnames in the hostnames. When using custom certificates, the Common Name (CN) of the custom certificate must be a fully qualified domain name (FQDN) instead of a shortname. This does not apply to the clients of a Satellite. Before you install Capsule Server, ensure that your environment meets the requirements for installation. Warning The version of Capsule must match with the version of Satellite installed. It should not be different. For example, the Capsule version 6.15 cannot be registered with the Satellite version 6.14. Capsule Server must be installed on a freshly provisioned system that serves no other function except to run Capsule Server. The freshly provisioned system must not have the following users provided by external identity providers to avoid conflicts with the local users that Capsule Server creates: apache foreman-proxy postgres pulp puppet redis For more information on scaling your Capsule Servers, see Capsule Server scalability considerations . Certified hypervisors Capsule Server is fully supported on both physical systems and virtual machines that run on hypervisors that are supported to run Red Hat Enterprise Linux. For more information about certified hypervisors, see Certified Guest Operating Systems in Red Hat OpenStack Platform, Red Hat Virtualization, Red Hat OpenShift Virtualization and Red Hat Enterprise Linux with KVM . SELinux mode SELinux must be enabled, either in enforcing or permissive mode. Installation with disabled SELinux is not supported. FIPS mode You can install Capsule on a Red Hat Enterprise Linux system that is operating in FIPS mode. You cannot enable FIPS mode after the installation of Capsule. For more information, see Switching RHEL to FIPS mode in Red Hat Enterprise Linux 8 Security hardening . Note Satellite supports DEFAULT and FIPS crypto-policies. The FUTURE crypto-policy is not supported for Satellite and Capsule installations. The FUTURE policy is a stricter forward-looking security level intended for testing a possible future policy. For more information, see Using system-wide cryptographic policies in the Red Hat Enterprise Linux guide. 1.2. Storage requirements The following table details storage requirements for specific directories. These values are based on expected use case scenarios and can vary according to individual environments. The runtime size was measured with Red Hat Enterprise Linux 6, 7, and 8 repositories synchronized. Table 1.1. Storage requirements for Capsule Server installation Directory Installation Size Runtime Size /var/lib/pulp 1 MB 300 GB /var/lib/pgsql 100 MB 20 GB /usr 3 GB Not Applicable /opt/puppetlabs 500 MB Not Applicable The size of the PostgreSQL database on your Capsule Server can grow significantly with an increasing number of lifecycle environments, content views, or repositories that are synchronized from your Satellite Server. In the largest Satellite environments, the size of /var/lib/pgsql on Capsule Server can grow to double or triple the size of /var/lib/pgsql on your Satellite Server. 1.3. Storage guidelines Consider the following guidelines when installing Capsule Server to increase efficiency. If you mount the /tmp directory as a separate file system, you must use the exec mount option in the /etc/fstab file. If /tmp is already mounted with the noexec option, you must change the option to exec and re-mount the file system. This is a requirement for the puppetserver service to work. Because most Capsule Server data is stored in the /var directory, mounting /var on LVM storage can help the system to scale. Use high-bandwidth, low-latency storage for the /var/lib/pulp/ directories. As Red Hat Satellite has many operations that are I/O intensive, using high latency, low-bandwidth storage causes performance degradation. Ensure your installation has a speed in the range 60 - 80 Megabytes per second. You can use the storage-benchmark script to get this data. For more information on using the storage-benchmark script, see Impact of Disk Speed on Satellite Operations . File system guidelines Do not use the GFS2 file system as the input-output latency is too high. Log file storage Log files are written to /var/log/messages/, /var/log/httpd/ , and /var/lib/foreman-proxy/openscap/content/ . You can manage the size of these files using logrotate . For more information, see How to use logrotate utility to rotate log files . The exact amount of storage you require for log messages depends on your installation and setup. SELinux considerations for NFS mount When the /var/lib/pulp directory is mounted using an NFS share, SELinux blocks the synchronization process. To avoid this, specify the SELinux context of the /var/lib/pulp directory in the file system table by adding the following lines to /etc/fstab : If NFS share is already mounted, remount it using the above configuration and enter the following command: Duplicated packages Packages that are duplicated in different repositories are only stored once on the disk. Additional repositories containing duplicate packages require less additional storage. The bulk of storage resides in the /var/lib/pulp/ directory. These end points are not manually configurable. Ensure that storage is available on the /var file system to prevent storage problems. Symbolic links You cannot use symbolic links for /var/lib/pulp/ . Synchronized RHEL ISO If you plan to synchronize RHEL content ISOs to Satellite, note that all minor versions of Red Hat Enterprise Linux also synchronize. You must plan to have adequate storage on your Satellite to manage this. 1.4. Supported operating systems You can install the operating system from a disc, local ISO image, kickstart, or any other method that Red Hat supports. Red Hat Capsule Server is supported on the latest version of Red Hat Enterprise Linux 8 that is available at the time when Capsule Server is installed. versions of Red Hat Enterprise Linux including EUS or z-stream are not supported. The following operating systems are supported by the installer, have packages, and are tested for deploying Satellite: Table 1.2. Operating systems supported by satellite-installer Operating System Architecture Notes Red Hat Enterprise Linux 8 x86_64 only Red Hat advises against using an existing system because the Satellite installer will affect the configuration of several components. Red Hat Capsule Server requires a Red Hat Enterprise Linux installation with the @Base package group with no other package-set modifications, and without third-party configurations or software not directly necessary for the direct operation of the server. This restriction includes hardening and other non-Red Hat security software. If you require such software in your infrastructure, install and verify a complete working Capsule Server first, then create a backup of the system before adding any non-Red Hat software. Do not register Capsule Server to the Red Hat Content Delivery Network (CDN). Red Hat does not support using the system for anything other than running Capsule Server. 1.5. Port and firewall requirements For the components of Satellite architecture to communicate, ensure that the required network ports are open and free on the base operating system. You must also ensure that the required network ports are open on any network-based firewalls. The installation of a Capsule Server fails if the ports between Satellite Server and Capsule Server are not open before installation starts. Use this information to configure any network-based firewalls. Note that some cloud solutions must be specifically configured to allow communications between machines because they isolate machines similarly to network-based firewalls. If you use an application-based firewall, ensure that the application-based firewall permits all applications that are listed in the tables and known to your firewall. If possible, disable the application checking and allow open port communication based on the protocol. Integrated Capsule Satellite Server has an integrated Capsule and any host that is directly connected to Satellite Server is a Client of Satellite in the context of this section. This includes the base operating system on which Capsule Server is running. Clients of Capsule Hosts which are clients of Capsules, other than Satellite's integrated Capsule, do not need access to Satellite Server. For more information on Satellite Topology, see Capsule Networking in Overview, concepts, and deployment considerations . Required ports can change based on your configuration. The following tables indicate the destination port and the direction of network traffic: Table 1.3. Capsule incoming traffic Destination Port Protocol Service Source Required For Description 53 TCP and UDP DNS DNS Servers and clients Name resolution DNS (optional) 67 UDP DHCP Client Dynamic IP DHCP (optional) 69 UDP TFTP Client TFTP Server (optional) 443, 80 TCP HTTPS, HTTP Client Content Retrieval Content 443, 80 TCP HTTPS, HTTP Client Content Host Registration Capsule CA RPM installation 443 TCP HTTPS Red Hat Satellite Content Mirroring Management 443 TCP HTTPS Red Hat Satellite Capsule API Smart Proxy functionality 443 TCP HTTPS Client Content Host registration Initiation Uploading facts Sending installed packages and traces 1883 TCP MQTT Client Pull based REX (optional) Content hosts for REX job notification (optional) 8000 TCP HTTP Client Provisioning templates Template retrieval for client installers, iPXE or UEFI HTTP Boot 8000 TCP HTTP Client PXE Boot Installation 8140 TCP HTTPS Client Puppet agent Client updates (optional) 8443 TCP HTTPS Client Content Host registration Deprecated and only needed for Client hosts deployed before upgrades 9090 TCP HTTPS Red Hat Satellite Capsule API Capsule functionality 9090 TCP HTTPS Client Register Endpoint Client registration with an external Capsule Server 9090 TCP HTTPS Client OpenSCAP Configure Client (if the OpenSCAP plugin is installed) 9090 TCP HTTPS Discovered Node Discovery Host discovery and provisioning (if the discovery plugin is installed) Any host that is directly connected to Satellite Server is a client in this context because it is a client of the integrated Capsule. This includes the base operating system on which a Capsule Server is running. A DHCP Capsule performs ICMP ping and TCP echo connection attempts to hosts in subnets with DHCP IPAM set to find out if an IP address considered for use is free. This behavior can be turned off using satellite-installer --foreman-proxy-dhcp-ping-free-ip=false . Table 1.4. Capsule outgoing traffic Destination Port Protocol Service Destination Required For Description ICMP ping Client DHCP Free IP checking (optional) 7 TCP echo Client DHCP Free IP checking (optional) 22 TCP SSH Target host Remote execution Run jobs 53 TCP and UDP DNS DNS Servers on the Internet DNS Server Resolve DNS records (optional) 53 TCP and UDP DNS DNS Server Capsule DNS Validation of DNS conflicts (optional) 68 UDP DHCP Client Dynamic IP DHCP (optional) 443 TCP HTTPS Satellite Capsule Capsule Configuration management Template retrieval OpenSCAP Remote Execution result upload 443 TCP HTTPS Red Hat Portal SOS report Assisting support cases (optional) 443 TCP HTTPS Satellite Content Sync 443 TCP HTTPS Satellite Client communication Forward requests from Client to Satellite 443 TCP HTTPS Infoblox DHCP Server DHCP management When using Infoblox for DHCP, management of the DHCP leases (optional) 623 Client Power management BMC On/Off/Cycle/Status 7911 TCP DHCP, OMAPI DHCP Server DHCP The DHCP target is configured using --foreman-proxy-dhcp-server and defaults to localhost ISC and remote_isc use a configurable port that defaults to 7911 and uses OMAPI 8443 TCP HTTPS Client Discovery Capsule sends reboot command to the discovered host (optional) Note ICMP to Port 7 UDP and TCP must not be rejected, but can be dropped. The DHCP Capsule sends an ECHO REQUEST to the Client network to verify that an IP address is free. A response prevents IP addresses from being allocated. 1.6. Enabling connections from Satellite Server and clients to a Capsule Server On the base operating system on which you want to install Capsule, you must enable incoming connections from Satellite Server and clients to Capsule Server and make these rules persistent across reboots. Procedure Open the ports for clients on Capsule Server: Allow access to services on Capsule Server: Make the changes persistent: Verification Enter the following command: For more information, see Using and Configuring firewalld in Red Hat Enterprise Linux 8 Securing networks .	[ "nfs.example.com:/nfsshare /var/lib/pulp nfs context=\"system_u:object_r:var_lib_t:s0\" 1 2", "restorecon -R /var/lib/pulp", "firewall-cmd --add-port=\"8000/tcp\" --add-port=\"9090/tcp\"", "firewall-cmd --add-service=dns --add-service=dhcp --add-service=tftp --add-service=http --add-service=https --add-service=puppetmaster", "firewall-cmd --runtime-to-permanent", "firewall-cmd --list-all" ]	https://docs.redhat.com/en/documentation/red_hat_satellite/6.15/html/installing_capsule_server/preparing-environment-for-capsule-installation
Chapter 2. Backing up the undercloud and the control plane nodes by using the Relax-and-Recover tool	Chapter 2. Backing up the undercloud and the control plane nodes by using the Relax-and-Recover tool You must back up your undercloud node and your control plane nodes when you upgrade or update your Red Hat Openstack Platform (RHOSP). You can backup your undercloud node and your control plane nodes using the Relax-and-Recover (ReaR) tool. To back up and restore your undercloud and your control plane nodes using the ReaR tool, you must complete the following procedures: Backing up the undercloud node Backing up the control plane nodes Restoring the undercloud and control plane nodes 2.1. Backing up the undercloud node by using the Relax-and-Recover tool To back up the undercloud node, you configure the backup node, install the Relax-and-Recover tool on the undercloud node, and then create the backup image. You can create backups as a part of your regular environment maintenance. In addition, you must back up the undercloud node before performing updates or upgrades. You can use the backups to restore the undercloud node to its state if an error occurs during an update or upgrade. 2.1.1. Supported backup formats and protocols The undercloud and backup and restore process uses the open-source tool Relax-and-Recover (ReaR) to create and restore bootable backup images. ReaR is written in Bash and supports multiple image formats and multiple transport protocols. The following list shows the backup formats and protocols that Red Hat OpenStack Platform supports when you use ReaR to back up and restore the undercloud and control plane. Bootable media formats ISO File transport protocols SFTP NFS 2.1.2. Configuring the backup storage location Before you create a backup of the control plane nodes, configure the backup storage location in the bar-vars.yaml environment file. This file stores the key-value parameters that you want to pass to the backup execution. Procedure Log in to the undercloud as the stack user. Source the stackrc file: Create the bar-vars.yaml file: touch /home/stack/bar-vars.yaml In the bar-vars.yaml file, configure the backup storage location: If you use an NFS server, add the following parameters and set the values of the IP address of your NFS server and backup storage folder: tripleo_backup_and_restore_server: <ip_address> tripleo_backup_and_restore_shared_storage_folder: <backup_dir> Replace <ip_address> and <backup_dir> with the values that apply to your environment. By default, the tripleo_backup_and_restore_server parameter value is 192.168.24.1 . If you use an SFTP server, add the tripleo_backup_and_restore_output_url parameter and set the values of the URL and credentials of the SFTP server: tripleo_backup_and_restore_output_url: sftp://<user>:<password>@<backup_node>/ tripleo_backup_and_restore_backup_url: iso:///backup/ Replace <user> , <password> , and <backup_node> with the backup node URL and credentials. 2.1.3. Optional: Configuring backup encryption You can encrypt backups as an additional security measure to protect sensitive data. Procedure In the bar-vars.yaml file, add the following parameters: tripleo_backup_and_restore_crypt_backup_enabled: true tripleo_backup_and_restore_crypt_backup_password: <password> Replace <password> with the password you want to use to encrypt the backup. 2.1.4. Installing and configuring an NFS server on the backup node You can install and configure a new NFS server to store the backup file. To install and configure an NFS server on the backup node, create an inventory file, create an SSH key, and run the openstack undercloud backup command with the NFS server options. Important If you previously installed and configured an NFS or SFTP server, you do not need to complete this procedure. You enter the server information when you set up ReaR on the node that you want to back up. By default, the Relax and Recover (ReaR) IP address parameter for the NFS server is 192.168.24.1 . You must add the parameter tripleo_backup_and_restore_server to set the IP address value that matches your environment. Procedure On the undercloud node, source the undercloud credentials: On the undercloud node, create an inventory file for the backup node: (undercloud) [stack@undercloud ~]USD cat <<'EOF'> ~/nfs-inventory.yaml [BackupNode] <backup_node> ansible_host=<ip_address> ansible_user=<user> EOF Replace <backup_node> , <ip_address> , and <user> with the values that apply to your environment. Copy the public SSH key from the undercloud node to the backup node. (undercloud) [stack@undercloud ~]USD ssh-copy-id -i ~/.ssh/id_rsa.pub <backup_node> Replace <backup_node> with the path and name of the backup node. Configure the NFS server on the backup node: (undercloud) [stack@undercloud ~]USD openstack undercloud backup --setup-nfs --extra-vars /home/stack/bar-vars.yaml --inventory /home/stack/nfs-inventory.yaml 2.1.5. Installing ReaR on the undercloud node Before you create a backup of the undercloud node, install and configure Relax and Recover (ReaR) on the undercloud. Prerequisites You have an NFS or SFTP server installed and configured on the backup node. For more information about creating a new NFS server, see Section 2.1.4, "Installing and configuring an NFS server on the backup node" . Procedure On the undercloud node, source the undercloud credentials: [stack@undercloud-0 ~]USD source stackrc If you have not done so before, extract the static ansible inventory file from the location in which it was saved during installation: (undercloud) [stack@undercloud ~]USD cp ~/overcloud-deploy/<stack>/tripleo-ansible-inventory.yaml ~/tripleo-inventory.yaml Replace <stack> with the name of your stack. By default, the name of the stack is overcloud . Install ReaR on the undercloud node: (undercloud) [stack@undercloud ~]USD openstack undercloud backup --setup-rear --extra-vars /home/stack/bar-vars.yaml --inventory /home/stack/tripleo-inventory.yaml If your system uses the UEFI boot loader, perform the following steps on the undercloud node: Install the following tools: USD sudo dnf install dosfstools efibootmgr Enable UEFI backup in the ReaR configuration file located in /etc/rear/local.conf by replacing the USING_UEFI_BOOTLOADER parameter value 0 with the value 1 and adding UEFI_BOOTLOADER=/boot/efi/EFI/redhat/shimx64.efi . 2.1.6. Optional: Creating a standalone database backup of the undercloud nodes You can include standalone undercloud database backups in your routine backup schedule to provide additional data security. A full backup of an undercloud node includes a database backup of the undercloud node. But if a full undercloud restoration fails, you might lose access to the database portion of the full undercloud backup. In this case, you can recover the database from a standalone undercloud database backup. You can create a standalone undercloud database backup in conjunction with the ReaR tool and the Snapshot and Revert tool. However, it is recommended that you back up the entire undercloud. For more information about creating a backup of the undercloud node, see Creating a backup of the undercloud node . Procedure Create a database backup of the undercloud nodes: openstack undercloud backup --db-only The db backup file is stored in /home/stack with the name openstack-backup-mysql-<timestamp>.sql . Additional resources Section 2.1.8, "Creating a backup of the undercloud node" Section 2.3.4, "Restoring the undercloud node database manually" 2.1.7. Configuring Open vSwitch (OVS) interfaces for backup If you use an Open vSwitch (OVS) bridge in your environment, you must manually configure the OVS interfaces before you create a backup of the undercloud or control plane nodes. The restoration process uses this information to restore the network interfaces. Procedure In the /etc/rear/local.conf file, add the NETWORKING_PREPARATION_COMMANDS parameter in the following format: Replace <command_1> and <command_2> with commands that configure the network interfaces. For example, you can add the ip link add br-ctlplane type bridge command to create the control plane bridge or add the ip link set eth0 up command to change the state of eth0 to up. You can add more commands to the parameter based on your network configuration. For example, if your undercloud has the following configuration: The NETWORKING_PREPARATION_COMMANDS parameter is formatted as follows: 2.1.8. Creating a backup of the undercloud node To create a backup of the undercloud node, use the openstack undercloud backup command. You can then use the backup to restore the undercloud node to its state in case the node becomes corrupted or inaccessible. The backup of the undercloud node includes the backup of the database that runs on the undercloud node. Note It is recommended that you create a backup of the undercloud node by using the following procedure. However, if you completed Creating a standalone database backup of the undercloud nodes , you can skip this procedure. Prerequisites You have an NFS or SFTP server installed and configured on the backup node. For more information about creating a new NFS server, see Section 2.1.4, "Installing and configuring an NFS server on the backup node" . You have installed ReaR on the undercloud node. For more information, see Section 2.1.5, "Installing ReaR on the undercloud node" . If you use an OVS bridge for your network interfaces, you have configured the OVS interfaces. For more information, see Section 2.1.7, "Configuring Open vSwitch (OVS) interfaces for backup" . Procedure Log in to the undercloud as the stack user. Retrieve the MySQL root password: [stack@undercloud ~]USD PASSWORD=USD(sudo /bin/hiera -c /etc/puppet/hiera.yaml mysql::server::root_password) Create a database backup of the undercloud node: [stack@undercloud ~]USD sudo podman exec mysql bash -c "mysqldump -uroot -pUSDPASSWORD --opt --all-databases" \| sudo tee /root/undercloud-all-databases.sql On the undercloud node, source the undercloud credentials: [stack@undercloud-0 ~]USD source stackrc Create a backup of the undercloud node: (undercloud) [stack@undercloud ~]USD openstack undercloud backup --inventory /home/stack/tripleo-inventory.yaml 2.1.9. Scheduling undercloud node backups with cron You can schedule backups of the undercloud nodes with ReaR by using the Ansible backup-and-restore role. You can view the logs in the /var/log/rear-cron directory. Prerequisites You have an NFS or SFTP server installed and configured on the backup node. For more information about creating a new NFS server, see Section 2.1.4, "Installing and configuring an NFS server on the backup node" . You have installed ReaR on the undercloud and control plane nodes. For more information, see Section 2.2.3, "Installing ReaR on the control plane nodes" . You have sufficient available disk space at your backup location to store the backup. Procedure To schedule a backup of your control plane nodes, run the following command. The default schedule is Sundays at midnight: openstack undercloud backup --cron Optional: Customize the scheduled backup according to your deployment: To change the default backup schedule, pass a different cron schedule on the tripleo_backup_and_restore_cron parameter: openstack undercloud backup --cron --extra-vars '{"tripleo_backup_and_restore_cron": "0 0 * * 0"}' To define additional parameters that are added to the backup command when cron runs the scheduled backup, pass the tripleo_backup_and_restore_cron_extra parameter to the backup command, as shown in the following example: openstack undercloud backup --cron --extra-vars '{"tripleo_backup_and_restore_cron_extra":"--extra-vars bar-vars.yaml --inventory /home/stack/tripleo-inventory.yaml"}' To change the default user that executes the backup, pass the tripleo_backup_and_restore_cron_user parameter to the backup command, as shown in the following example: openstack undercloud backup --cron --extra-vars '{"tripleo_backup_and_restore_cron_user": "root"} 2.2. Backing up the control plane nodes by using the Relax-and-Recover tool To back up the control plane nodes, you configure the backup node, install the Relax-and-Recover tool on the control plane nodes, and create the backup image. You can create backups as a part of your regular environment maintenance. In addition, you must back up the control plane nodes before performing updates or upgrades. You can use the backups to restore the control plane nodes to their state if an error occurs during an update or upgrade. The backup process causes the failover of services that are managed by pacemaker. For this reason, you must run it during planned maintenance and expect some transactions to be lost. 2.2.1. Supported backup formats and protocols The undercloud and backup and restore process uses the open-source tool Relax-and-Recover (ReaR) to create and restore bootable backup images. ReaR is written in Bash and supports multiple image formats and multiple transport protocols. The following list shows the backup formats and protocols that Red Hat OpenStack Platform supports when you use ReaR to back up and restore the undercloud and control plane. Bootable media formats ISO File transport protocols SFTP NFS 2.2.2. Installing and configuring an NFS server on the backup node You can install and configure a new NFS server to store the backup file. To install and configure an NFS server on the backup node, create an inventory file, create an SSH key, and run the openstack undercloud backup command with the NFS server options. Important If you previously installed and configured an NFS or SFTP server, you do not need to complete this procedure. You enter the server information when you set up ReaR on the node that you want to back up. By default, the Relax and Recover (ReaR) IP address parameter for the NFS server is 192.168.24.1 . You must add the parameter tripleo_backup_and_restore_server to set the IP address value that matches your environment. Procedure On the undercloud node, source the undercloud credentials: On the undercloud node, create an inventory file for the backup node: (undercloud) [stack@undercloud ~]USD cat <<'EOF'> ~/nfs-inventory.yaml [BackupNode] <backup_node> ansible_host=<ip_address> ansible_user=<user> EOF Replace <backup_node> , <ip_address> , and <user> with the values that apply to your environment. Copy the public SSH key from the undercloud node to the backup node. (undercloud) [stack@undercloud ~]USD ssh-copy-id -i ~/.ssh/id_rsa.pub <backup_node> Replace <backup_node> with the path and name of the backup node. Configure the NFS server on the backup node: (undercloud) [stack@undercloud ~]USD openstack undercloud backup --setup-nfs --extra-vars /home/stack/bar-vars.yaml --inventory /home/stack/nfs-inventory.yaml 2.2.3. Installing ReaR on the control plane nodes Before you create a backup of the control plane nodes, install and configure Relax and Recover (ReaR) on each of the control plane nodes. Important Due to a known issue, the ReaR backup of overcloud nodes continues even if a Controller node is down. Ensure that all your Controller nodes are running before you run the ReaR backup. A fix is planned for a later Red Hat OpenStack Platform (RHOSP) release. For more information, see BZ#2077335 - Back up of the overcloud ctlplane keeps going even if one controller is unreachable . Prerequisites You have an NFS or SFTP server installed and configured on the backup node. For more information about creating a new NFS server, see Section 2.2.2, "Installing and configuring an NFS server on the backup node" . Procedure On the undercloud node, source the undercloud credentials: [stack@undercloud-0 ~]USD source stackrc If you have not done so before, extract the static ansible inventory file from the location in which it was saved during installation: (undercloud) [stack@undercloud ~]USD cp ~/overcloud-deploy/<stack>/tripleo-ansible-inventory.yaml ~/tripleo-inventory.yaml Replace <stack> with the name of your stack. By default, the name of the stack is overcloud . In the bar-vars.yaml file, configure the backup storage location: If you installed and configured your own NFS server, add the tripleo_backup_and_restore_server parameter and set the value to the IP address of your NFS server: tripleo_backup_and_restore_server: <ip_address> tripleo_backup_and_restore_shared_storage_folder: <backup_dir> Replace <ip_address> and <backup_dir> with the values that apply to your environment. By default, the tripleo_backup_and_restore_server parameter value is 192.168.24.1 .* If you use an SFTP server, add the tripleo_backup_and_restore_output_url parameter and set the values of the URL and credentials of the SFTP server: tripleo_backup_and_restore_output_url: sftp://<user>:<password>@<backup_node>/ tripleo_backup_and_restore_backup_url: iso:///backup/ Replace <user> , <password> , and <backup_node> with the backup node URL and credentials. Install ReaR on the control plane nodes: (undercloud) [stack@undercloud ~]USD openstack overcloud backup --setup-rear --extra-vars /home/stack/bar-vars.yaml --inventory /home/stack/tripleo-inventory.yaml If your system uses the UEFI boot loader, perform the following steps on the control plane nodes: Install the following tools: USD sudo dnf install dosfstools efibootmgr Enable UEFI backup in the ReaR configuration file located in /etc/rear/local.conf by replacing the USING_UEFI_BOOTLOADER parameter value 0 with the value 1 and adding UEFI_BOOTLOADER=/boot/efi/EFI/redhat/shimx64.efi . 2.2.4. Configuring Open vSwitch (OVS) interfaces for backup If you use an Open vSwitch (OVS) bridge in your environment, you must manually configure the OVS interfaces before you create a backup of the undercloud or control plane nodes. The restoration process uses this information to restore the network interfaces. Procedure In the /etc/rear/local.conf file, add the NETWORKING_PREPARATION_COMMANDS parameter in the following format: Replace <command_1> and <command_2> with commands that configure the network interfaces. For example, you can add the ip link add br-ctlplane type bridge command to create the control plane bridge or add the ip link set eth0 up command to change the state of eth0 to up. You can add more commands to the parameter based on your network configuration. For example, if your undercloud has the following configuration: The NETWORKING_PREPARATION_COMMANDS parameter is formatted as follows: 2.2.5. Creating a backup of the control plane nodes To create a backup of the control plane nodes, use the openstack overcloud backup command. You can then use the backup to restore the control plane nodes to their state in case the nodes become corrupted or inaccessible. The backup of the control plane nodes includes the backup of the database that runs on the control plane nodes. Prerequisites You have an NFS or SFTP server installed and configured on the backup node. For more information about creating a new NFS server, see Section 2.2.2, "Installing and configuring an NFS server on the backup node" . You have installed ReaR on the control plane nodes. For more information, see Section 2.2.3, "Installing ReaR on the control plane nodes" . If you use an OVS bridge for your network interfaces, you have configured the OVS interfaces. For more information, see Section 2.2.4, "Configuring Open vSwitch (OVS) interfaces for backup" . Procedure Locate the config-drive partition on each control plane node: On each control plane node, back up the config-drive partition of each node as the root user: [root@controller-x ~]# dd if=<config_drive_partition> of=/mnt/config-drive Replace <config_drive_partition> with the name of the config-drive partition that you located in step 1. On the undercloud node, source the undercloud credentials: [stack@undercloud-0 ~]USD source stackrc Create a backup of the control plane nodes: (undercloud) [stack@undercloud ~]USD openstack overcloud backup --inventory /home/stack/tripleo-inventory.yaml The backup process runs sequentially on each control plane node without disrupting the service to your environment. 2.2.6. Scheduling control plane node backups with cron You can schedule backups of the control plane nodes with ReaR by using the Ansible backup-and-restore role. You can view the logs in the /var/log/rear-cron directory. Prerequisites You have an NFS or SFTP server installed and configured on the backup node. For more information about creating a new NFS server, see Section 2.1.4, "Installing and configuring an NFS server on the backup node" . You have installed ReaR on the undercloud and control plane nodes. For more information, see Section 2.2.3, "Installing ReaR on the control plane nodes" . You have sufficient available disk space at your backup location to store the backup. Procedure To schedule a backup of your control plane nodes, run the following command. The default schedule is Sundays at midnight: openstack overcloud backup --cron Optional: Customize the scheduled backup according to your deployment: To change the default backup schedule, pass a different cron schedule on the tripleo_backup_and_restore_cron parameter: openstack overcloud backup --cron --extra-vars '{"tripleo_backup_and_restore_cron": "0 0 * * 0"}' To define additional parameters that are added to the backup command when cron runs the scheduled backup, pass the tripleo_backup_and_restore_cron_extra parameter to the backup command, as shown in the following example: openstack overcloud backup --cron --extra-vars '{"tripleo_backup_and_restore_cron_extra":"--extra-vars bar-vars.yaml --inventory /home/stack/tripleo-inventory.yaml"}' To change the default user that executes the backup, pass the tripleo_backup_and_restore_cron_user parameter to the backup command, as shown in the following example: openstack overcloud backup --cron --extra-vars '{"tripleo_backup_and_restore_cron_user": "root"} 2.3. Restoring the undercloud node and control plane nodes by using the Relax-and-Recover tool If your undercloud or control plane nodes become corrupted or if an error occurs during an update or upgrade, you can restore the undercloud or overcloud control plane nodes from a backup to their state. If the restore process fails to automatically restore the Galera cluster or nodes with colocated Ceph monitors, you can restore these components manually. 2.3.1. Restoring the undercloud node You can restore the undercloud node to its state using the backup ISO image that you created using ReaR. You can find the backup ISO images on the backup node. Burn the bootable ISO image to a DVD or download it to the undercloud node through Integrated Lights-Out (iLO) remote access. Prerequisites You have created a backup of the undercloud node. For more information, see Section 2.1.8, "Creating a backup of the undercloud node" . You have access to the backup node. If you use an OVS bridge for your network interfaces, you have access to the network configuration information that you set in the NETWORKING_PREPARATION_COMMANDS parameter. For more information, see see Section 2.1.7, "Configuring Open vSwitch (OVS) interfaces for backup" . If you configured backup encryption, you must decrypt the backup before you begin the restoration process. Run the following decrypt step in the system where the backup file is located: USD dd if=backup.tar.gz \| /usr/bin/openssl des3 -d -k "<encryption key>" \| tar -C <backup_location> -xzvf - '.conf' Replace <encryption key> with your encryption key. Replace <backup_location> with the folder in which you want to save the backup.tar.gz file, for example, /ctl_plane_backups/undercloud-0/ . Procedure Power off the undercloud node. Ensure that the undercloud node is powered off completely before you proceed. Boot the undercloud node with the backup ISO image. When the Relax-and-Recover boot menu displays, select Recover <undercloud_node> . Replace <undercloud_node> with the name of your undercloud node. Note If your system uses UEFI, select the Relax-and-Recover (no Secure Boot) option. Log in as the root user and restore the node: The following message displays: Welcome to Relax-and-Recover. Run "rear recover" to restore your system! RESCUE <undercloud_node>:~ # rear recover When the undercloud node restoration process completes, the console displays the following message: Finished recovering your system Exiting rear recover Running exit tasks Power off the node: RESCUE <undercloud_node>:~ # poweroff On boot up, the node resumes its state. 2.3.2. Restoring the control plane nodes If an error occurs during an update or upgrade, you can restore the control plane nodes to their state using the backup ISO image that you have created using ReaR. To restore the control plane, you must restore all control plane nodes to ensure state consistency. You can find the backup ISO images on the backup node. Burn the bootable ISO image to a DVD or download it to the undercloud node through Integrated Lights-Out (iLO) remote access. Note Red Hat supports backups of Red Hat OpenStack Platform with native SDNs, such as Open vSwitch (OVS) and the default Open Virtual Network (OVN). For information about third-party SDNs, refer to the third-party SDN documentation. Prerequisites You have created a backup of the control plane nodes. For more information, see Section 2.2.5, "Creating a backup of the control plane nodes" . You have access to the backup node. If you use an OVS bridge for your network interfaces, you have access to the network configuration information that you set in the NETWORKING_PREPARATION_COMMANDS parameter. For more information, see see Section 2.2.4, "Configuring Open vSwitch (OVS) interfaces for backup" . Procedure Power off each control plane node. Ensure that the control plane nodes are powered off completely before you proceed. Boot each control plane node with the corresponding backup ISO image. When the Relax-and-Recover boot menu displays, on each control plane node, select Recover <control_plane_node> . Replace <control_plane_node> with the name of the corresponding control plane node. Note If your system uses UEFI, select the Relax-and-Recover (no Secure Boot) option. On each control plane node, log in as the root user and restore the node: The following message displays: When the control plane node restoration process completes, the console displays the following message: When the command line console is available, restore the config-drive partition of each control plane node: # once completed, restore the config-drive partition (which is ISO9660) RESCUE <control_plane_node>:~ USD dd if=/mnt/local/mnt/config-drive of=<config_drive_partition> Power off the node: Set the boot sequence to the normal boot device. On boot up, the node resumes its state. To ensure that the services are running correctly, check the status of pacemaker. Log in to a Controller node as the root user and enter the following command: To view the status of the overcloud, use the OpenStack Integration Test Suite (tempest). For more information, see Validating your OpenStack cloud with the Integration Test Suite (tempest) . Troubleshooting Clear resource alarms that are displayed by pcs status by running the following command: Clear STONITH fencing action errors that are displayed by pcs status by running the following commands: 2.3.3. Restoring the Galera cluster manually If the Galera cluster does not restore as part of the restoration procedure, you must restore Galera manually. Note In this procedure, you must perform some steps on one Controller node. Ensure that you perform these steps on the same Controller node as you go through the procedure. Procedure On Controller-0 , retrieve the Galera cluster virtual IP: USD sudo hiera -c /etc/puppet/hiera.yaml mysql_vip Disable the database connections through the virtual IP on all Controller nodes: USD sudo iptables -I INPUT -p tcp --destination-port 3306 -d USDMYSQL_VIP=<galera_cluster_vip> -j DROP Replace <galera_cluster_vip> with the IP address you retrieved in step 1. On Controller-0 , retrieve the MySQL root password: USD sudo hiera -c /etc/puppet/hiera.yaml mysql::server::root_password On Controller-0 , set the Galera resource to unmanaged mode: USD sudo pcs resource unmanage galera-bundle Stop the MySQL containers on all Controller nodes: USD sudo podman container stop USD(sudo podman container ls --all --format "{{.Names}}" --filter=name=galera-bundle) Move the current directory on all Controller nodes: USD sudo mv /var/lib/mysql /var/lib/mysql-save Create the new directory /var/lib/mysq on all Controller nodes: USD sudo mkdir /var/lib/mysql USD sudo chown 42434:42434 /var/lib/mysql USD sudo chcon -t container_file_t /var/lib/mysql USD sudo chmod 0755 /var/lib/mysql USD sudo chcon -r object_r /var/lib/mysql USD sudo chcon -u system_u /var/lib/mysql Start the MySQL containers on all Controller nodes: USD sudo podman container start USD(sudo podman container ls --all --format "{{ .Names }}" --filter=name=galera-bundle) Create the MySQL database on all Controller nodes: USD sudo podman exec -i USD(sudo podman container ls --all --format "{{ .Names }}" \ --filter=name=galera-bundle) bash -c "mysql_install_db --datadir=/var/lib/mysql --user=mysql --log_error=/var/log/mysql/mysql_init.log" Start the database on all Controller nodes: USD sudo podman exec USD(sudo podman container ls --all --format "{{ .Names }}" \ --filter=name=galera-bundle) bash -c "mysqld_safe --skip-networking --wsrep-on=OFF --log-error=/var/log/mysql/mysql_safe.log" & Move the .my.cnf Galera configuration file on all Controller nodes: USD sudo podman exec USD(sudo podman container ls --all --format "{{ .Names }}" \ --filter=name=galera-bundle) bash -c "mv /root/.my.cnf /root/.my.cnf.bck" Reset the Galera root password on all Controller nodes: USD sudo podman exec USD(sudo podman container ls --all --format "{{ .Names }}" \ --filter=name=galera-bundle) bash -c "mysql -uroot -e'use mysql;set password for root@localhost = password(\"USDROOTPASSWORD\");flush privileges;'" Restore the .my.cnf Galera configuration file inside the Galera container on all Controller nodes: USD sudo podman exec USD(sudo podman container ls --all --format "{{ .Names }}" \ --filter=name=galera-bundle) bash -c "mv /root/.my.cnf.bck /root/.my.cnf" On Controller-0 , copy the backup database files to /var/lib/MySQL : USD sudo cp openstack-backup-mysql.sql /var/lib/mysql USD sudo cp openstack-backup-mysql-grants.sql /var/lib/mysql Note The path to these files is /home/tripleo-admin/. On Controller-0 , restore the MySQL database: USD sudo podman exec USD(sudo podman container ls --all --format "{{ .Names }}" \ --filter=name=galera-bundle) bash -c "mysql -u root -pUSDROOT_PASSWORD < \"/var/lib/mysql/USDBACKUP_FILE\" " USD sudo podman exec USD(sudo podman container ls --all --format "{{ .Names }}" \ --filter=name=galera-bundle) bash -c "mysql -u root -pUSDROOT_PASSWORD < \"/var/lib/mysql/USDBACKUP_GRANT_FILE\" " Shut down the databases on all Controller nodes: USD sudo podman exec USD(sudo podman container ls --all --format "{{ .Names }}" \ --filter=name=galera-bundle) bash -c "mysqladmin shutdown" On Controller-0 , start the bootstrap node: USD sudo podman exec USD(sudo podman container ls --all --format "{{ .Names }}" --filter=name=galera-bundle) \ /usr/bin/mysqld_safe --pid-file=/var/run/mysql/mysqld.pid --socket=/var/lib/mysql/mysql.sock --datadir=/var/lib/mysql \ --log-error=/var/log/mysql/mysql_cluster.log --user=mysql --open-files-limit=16384 \ --wsrep-cluster-address=gcomm:// & Verification: On Controller-0, check the status of the cluster: USD sudo podman exec USD(sudo podman container ls --all --format "{{ .Names }}" \ --filter=name=galera-bundle) bash -c "clustercheck" Ensure that the following message is displayed: "Galera cluster node is synced", otherwise you must recreate the node. On Controller-0 , retrieve the cluster address from the configuration: USD sudo podman exec USD(sudo podman container ls --all --format "{{ .Names }}" \ --filter=name=galera-bundle) bash -c "grep wsrep_cluster_address /etc/my.cnf.d/galera.cnf" \| awk '{print USD3}' On each of the remaining Controller nodes, start the database and validate the cluster: Start the database: USD sudo podman exec USD(sudo podman container ls --all --format "{{ .Names }}" \ --filter=name=galera-bundle) /usr/bin/mysqld_safe --pid-file=/var/run/mysql/mysqld.pid --socket=/var/lib/mysql/mysql.sock \ --datadir=/var/lib/mysql --log-error=/var/log/mysql/mysql_cluster.log --user=mysql --open-files-limit=16384 \ --wsrep-cluster-address=USDCLUSTER_ADDRESS & Check the status of the MYSQL cluster: USD sudo podman exec USD(sudo podman container ls --all --format "{{ .Names }}" \ --filter=name=galera-bundle) bash -c "clustercheck" Ensure that the following message is displayed: "Galera cluster node is synced", otherwise you must recreate the node. Stop the MySQL container on all Controller nodes: USD sudo podman exec USD(sudo podman container ls --all --format "{{ .Names }}" --filter=name=galera-bundle) \ /usr/bin/mysqladmin -u root shutdown On all Controller nodes, remove the following firewall rule to allow database connections through the virtual IP address: USD sudo iptables -D INPUT -p tcp --destination-port 3306 -d <galera_cluster_vip> -j DROP Replace <galera_cluster_vip> with the IP address you retrieved in step 1. Restart the MySQL container on all Controller nodes: USD sudo podman container restart USD(sudo podman container ls --all --format "{{ .Names }}" --filter=name=galera-bundle) Restart the clustercheck container on all Controller nodes: USD sudo podman container restart USD(sudo podman container ls --all --format "{{ .Names }}" --filter=name=clustercheck) On Controller-0 , set the Galera resource to managed mode: USD sudo pcs resource manage galera-bundle Verification To ensure that services are running correctly, check the status of pacemaker: USD sudo pcs status To view the status of the overcloud, use the OpenStack Integration Test Suite (tempest). For more information, see Validating your OpenStack cloud with the Integration Test Suite (tempest) . If you suspect an issue with a particular node, check the state of the cluster with clustercheck : USD sudo podman exec clustercheck /usr/bin/clustercheck 2.3.4. Restoring the undercloud node database manually If the undercloud database does not restore as part of the undercloud restore process, you can restore the database manually. You can only restore the database if you previously created a standalone database backup. Prerequisites You have created a standalone backup of the undercloud database. For more information, see Section 2.1.6, "Optional: Creating a standalone database backup of the undercloud nodes" . Procedure Log in to the director undercloud node as the root user. Stop all tripleo services: [root@director ~]# systemctl stop tripleo_ Ensure that no containers are running on the server by entering the following command: [root@director ~]# podman ps If any containers are running, enter the following command to stop the containers: Create a backup of the current /var/lib/mysql directory and then delete the directory: [root@director ~]# cp -a /var/lib/mysql /var/lib/mysql_bck [root@director ~]# rm -rf /var/lib/mysql Recreate the database directory and set the SELinux attributes for the new directory: [root@director ~]# mkdir /var/lib/mysql [root@director ~]# chown 42434:42434 /var/lib/mysql [root@director ~]# chmod 0755 /var/lib/mysql [root@director ~]# chcon -t container_file_t /var/lib/mysql [root@director ~]# chcon -r object_r /var/lib/mysql [root@director ~]# chcon -u system_u /var/lib/mysql Create a local tag for the mariadb image. Replace <image_id> and <undercloud.ctlplane.example.com> with the values applicable in your environment: [root@director ~]# podman images \| grep mariadb <undercloud.ctlplane.example.com>:8787/rh-osbs/rhosp16-openstack-mariadb 16.2_20210322.1 <image_id> 3 weeks ago 718 MB [root@director ~]# podman tag <image_id> mariadb [root@director ~]# podman images \| grep maria localhost/mariadb latest <image_id> 3 weeks ago 718 MB <undercloud.ctlplane.example.com>:8787/rh-osbs/rhosp16-openstack-mariadb 16.2_20210322.1 <image_id> 3 weeks ago 718 MB Initialize the /var/lib/mysql directory with the container: [root@director ~]# podman run --net=host -v /var/lib/mysql:/var/lib/mysql localhost/mariadb mysql_install_db --datadir=/var/lib/mysql --user=mysql Note You can ignore the following error messages, which are generated because the directories do not exist in the container image used in RHOSP. Copy the database backup file that you want to import to the database: [root@director ~]# cp /root/undercloud-all-databases.sql /var/lib/mysql Start the database service to import the data: [root@director ~]# podman run --net=host -dt -v /var/lib/mysql:/var/lib/mysql localhost/mariadb /usr/libexec/mysqld Import the data and configure the max_allowed_packet parameter: Log in to the container and configure it: [root@director ~]# podman exec -it <container_id> /bin/bash ()[mysql@5a4e429c6f40 /]USD mysql -u root -e "set global max_allowed_packet = 1073741824;" ()[mysql@5a4e429c6f40 /]USD mysql -u root < /var/lib/mysql/undercloud-all-databases.sql ()[mysql@5a4e429c6f40 /]USD mysql -u root -e 'flush privileges' ()[mysql@5a4e429c6f40 /]USD exit exit Stop the container: [root@director ~]# podman stop <container_id> Check that no containers are running: [root@director ~]# podman ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES [root@director ~]# Restart all tripleo services: [root@director ~]# systemctl start multi-user.target	[ "source ~/stackrc", "touch /home/stack/bar-vars.yaml", "tripleo_backup_and_restore_server: <ip_address> tripleo_backup_and_restore_shared_storage_folder: <backup_dir>", "tripleo_backup_and_restore_output_url: sftp://<user>:<password>@<backup_node>/ tripleo_backup_and_restore_backup_url: iso:///backup/", "tripleo_backup_and_restore_crypt_backup_enabled: true tripleo_backup_and_restore_crypt_backup_password: <password>", "[stack@undercloud-0 ~]USD source stackrc (undercloud) [stack@undercloud ~]USD", "(undercloud) [stack@undercloud ~]USD cat <<'EOF'> ~/nfs-inventory.yaml [BackupNode] <backup_node> ansible_host=<ip_address> ansible_user=<user> EOF", "(undercloud) [stack@undercloud ~]USD ssh-copy-id -i ~/.ssh/id_rsa.pub <backup_node>", "(undercloud) [stack@undercloud ~]USD openstack undercloud backup --setup-nfs --extra-vars /home/stack/bar-vars.yaml --inventory /home/stack/nfs-inventory.yaml", "[stack@undercloud-0 ~]USD source stackrc", "(undercloud) [stack@undercloud ~]USD cp ~/overcloud-deploy/<stack>/tripleo-ansible-inventory.yaml ~/tripleo-inventory.yaml", "(undercloud) [stack@undercloud ~]USD openstack undercloud backup --setup-rear --extra-vars /home/stack/bar-vars.yaml --inventory /home/stack/tripleo-inventory.yaml", "sudo dnf install dosfstools efibootmgr", "openstack undercloud backup --db-only", "NETWORKING_PREPARATION_COMMANDS=('<command_1>' '<command_2>' ...')", "ip -4 addr ls br-ctlplane 8: br-ctlplane: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UNKNOWN group default qlen 1000 inet 172.16.9.1/24 brd 172.16.9.255 scope global br-ctlplane valid_lft forever preferred_lft forever sudo ovs-vsctl show Bridge br-ctlplane Controller \"tcp:127.0.0.1:6633\" is_connected: true fail_mode: secure datapath_type: system Port eth0 Interface eth0 Port br-ctlplane Interface br-ctlplane type: internal Port phy-br-ctlplane Interface phy-br-ctlplane type: patch options: {peer=int-br-ctlplane}", "NETWORKING_PREPARATION_COMMANDS=('ip link add br-ctlplane type bridge' 'ip link set br-ctlplane up' 'ip link set eth0 up' 'ip link set eth0 master br-ctlplane' 'ip addr add 172.16.9.1/24 dev br-ctlplane')", "[stack@undercloud ~]USD PASSWORD=USD(sudo /bin/hiera -c /etc/puppet/hiera.yaml mysql::server::root_password)", "[stack@undercloud ~]USD sudo podman exec mysql bash -c \"mysqldump -uroot -pUSDPASSWORD --opt --all-databases\" \| sudo tee /root/undercloud-all-databases.sql", "[stack@undercloud-0 ~]USD source stackrc", "(undercloud) [stack@undercloud ~]USD openstack undercloud backup --inventory /home/stack/tripleo-inventory.yaml", "openstack undercloud backup --cron", "openstack undercloud backup --cron --extra-vars '{\"tripleo_backup_and_restore_cron\": \"0 0 * * 0\"}'", "openstack undercloud backup --cron --extra-vars '{\"tripleo_backup_and_restore_cron_extra\":\"--extra-vars bar-vars.yaml --inventory /home/stack/tripleo-inventory.yaml\"}'", "openstack undercloud backup --cron --extra-vars '{\"tripleo_backup_and_restore_cron_user\": \"root\"}", "[stack@undercloud-0 ~]USD source stackrc (undercloud) [stack@undercloud ~]USD", "(undercloud) [stack@undercloud ~]USD cat <<'EOF'> ~/nfs-inventory.yaml [BackupNode] <backup_node> ansible_host=<ip_address> ansible_user=<user> EOF", "(undercloud) [stack@undercloud ~]USD ssh-copy-id -i ~/.ssh/id_rsa.pub <backup_node>", "(undercloud) [stack@undercloud ~]USD openstack undercloud backup --setup-nfs --extra-vars /home/stack/bar-vars.yaml --inventory /home/stack/nfs-inventory.yaml", "[stack@undercloud-0 ~]USD source stackrc", "(undercloud) [stack@undercloud ~]USD cp ~/overcloud-deploy/<stack>/tripleo-ansible-inventory.yaml ~/tripleo-inventory.yaml", "tripleo_backup_and_restore_server: <ip_address> tripleo_backup_and_restore_shared_storage_folder: <backup_dir>", "tripleo_backup_and_restore_output_url: sftp://<user>:<password>@<backup_node>/ tripleo_backup_and_restore_backup_url: iso:///backup/", "(undercloud) [stack@undercloud ~]USD openstack overcloud backup --setup-rear --extra-vars /home/stack/bar-vars.yaml --inventory /home/stack/tripleo-inventory.yaml", "sudo dnf install dosfstools efibootmgr", "NETWORKING_PREPARATION_COMMANDS=('<command_1>' '<command_2>' ...')", "ip -4 addr ls br-ctlplane 8: br-ctlplane: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UNKNOWN group default qlen 1000 inet 172.16.9.1/24 brd 172.16.9.255 scope global br-ctlplane valid_lft forever preferred_lft forever sudo ovs-vsctl show Bridge br-ctlplane Controller \"tcp:127.0.0.1:6633\" is_connected: true fail_mode: secure datapath_type: system Port eth0 Interface eth0 Port br-ctlplane Interface br-ctlplane type: internal Port phy-br-ctlplane Interface phy-br-ctlplane type: patch options: {peer=int-br-ctlplane}", "NETWORKING_PREPARATION_COMMANDS=('ip link add br-ctlplane type bridge' 'ip link set br-ctlplane up' 'ip link set eth0 up' 'ip link set eth0 master br-ctlplane' 'ip addr add 172.16.9.1/24 dev br-ctlplane')", "[stack@undercloud-0 ~]USD blkid -t LABEL=\"config-2\" -odevice", "dd if=<config_drive_partition> of=/mnt/config-drive", "[stack@undercloud-0 ~]USD source stackrc", "(undercloud) [stack@undercloud ~]USD openstack overcloud backup --inventory /home/stack/tripleo-inventory.yaml", "openstack overcloud backup --cron", "openstack overcloud backup --cron --extra-vars '{\"tripleo_backup_and_restore_cron\": \"0 0 * * 0\"}'", "openstack overcloud backup --cron --extra-vars '{\"tripleo_backup_and_restore_cron_extra\":\"--extra-vars bar-vars.yaml --inventory /home/stack/tripleo-inventory.yaml\"}'", "openstack overcloud backup --cron --extra-vars '{\"tripleo_backup_and_restore_cron_user\": \"root\"}", "dd if=backup.tar.gz \| /usr/bin/openssl des3 -d -k \"<encryption key>\" \| tar -C <backup_location> -xzvf - '.conf'", "Welcome to Relax-and-Recover. Run \"rear recover\" to restore your system! RESCUE <undercloud_node>:~ # rear recover", "Finished recovering your system Exiting rear recover Running exit tasks", "RESCUE <undercloud_node>:~ # poweroff", "Welcome to Relax-and-Recover. Run \"rear recover\" to restore your system! RESCUE <control_plane_node>:~ # rear recover", "Finished recovering your system Exiting rear recover Running exit tasks", "once completed, restore the config-drive partition (which is ISO9660) RESCUE <control_plane_node>:~ USD dd if=/mnt/local/mnt/config-drive of=<config_drive_partition>", "RESCUE <control_plane_node>:~ # poweroff", "pcs status", "pcs resource clean", "pcs resource clean pcs stonith history cleanup", "sudo hiera -c /etc/puppet/hiera.yaml mysql_vip", "sudo iptables -I INPUT -p tcp --destination-port 3306 -d USDMYSQL_VIP=<galera_cluster_vip> -j DROP", "sudo hiera -c /etc/puppet/hiera.yaml mysql::server::root_password", "sudo pcs resource unmanage galera-bundle", "sudo podman container stop USD(sudo podman container ls --all --format \"{{.Names}}\" --filter=name=galera-bundle)", "sudo mv /var/lib/mysql /var/lib/mysql-save", "sudo mkdir /var/lib/mysql sudo chown 42434:42434 /var/lib/mysql sudo chcon -t container_file_t /var/lib/mysql sudo chmod 0755 /var/lib/mysql sudo chcon -r object_r /var/lib/mysql sudo chcon -u system_u /var/lib/mysql", "sudo podman container start USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle)", "sudo podman exec -i USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle) bash -c \"mysql_install_db --datadir=/var/lib/mysql --user=mysql --log_error=/var/log/mysql/mysql_init.log\"", "sudo podman exec USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle) bash -c \"mysqld_safe --skip-networking --wsrep-on=OFF --log-error=/var/log/mysql/mysql_safe.log\" &", "sudo podman exec USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle) bash -c \"mv /root/.my.cnf /root/.my.cnf.bck\"", "sudo podman exec USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle) bash -c \"mysql -uroot -e'use mysql;set password for root@localhost = password(\\\"USDROOTPASSWORD\\\");flush privileges;'\"", "sudo podman exec USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle) bash -c \"mv /root/.my.cnf.bck /root/.my.cnf\"", "sudo cp openstack-backup-mysql.sql /var/lib/mysql sudo cp openstack-backup-mysql-grants.sql /var/lib/mysql", "sudo podman exec USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle) bash -c \"mysql -u root -pUSDROOT_PASSWORD < \\\"/var/lib/mysql/USDBACKUP_FILE\\\" \" sudo podman exec USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle) bash -c \"mysql -u root -pUSDROOT_PASSWORD < \\\"/var/lib/mysql/USDBACKUP_GRANT_FILE\\\" \"", "sudo podman exec USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle) bash -c \"mysqladmin shutdown\"", "sudo podman exec USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle) /usr/bin/mysqld_safe --pid-file=/var/run/mysql/mysqld.pid --socket=/var/lib/mysql/mysql.sock --datadir=/var/lib/mysql --log-error=/var/log/mysql/mysql_cluster.log --user=mysql --open-files-limit=16384 --wsrep-cluster-address=gcomm:// &", "sudo podman exec USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle) bash -c \"clustercheck\"", "sudo podman exec USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle) bash -c \"grep wsrep_cluster_address /etc/my.cnf.d/galera.cnf\" \| awk '{print USD3}'", "sudo podman exec USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle) /usr/bin/mysqld_safe --pid-file=/var/run/mysql/mysqld.pid --socket=/var/lib/mysql/mysql.sock --datadir=/var/lib/mysql --log-error=/var/log/mysql/mysql_cluster.log --user=mysql --open-files-limit=16384 --wsrep-cluster-address=USDCLUSTER_ADDRESS &", "sudo podman exec USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle) bash -c \"clustercheck\"", "sudo podman exec USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle) /usr/bin/mysqladmin -u root shutdown", "sudo iptables -D INPUT -p tcp --destination-port 3306 -d <galera_cluster_vip> -j DROP", "sudo podman container restart USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=galera-bundle)", "sudo podman container restart USD(sudo podman container ls --all --format \"{{ .Names }}\" --filter=name=clustercheck)", "sudo pcs resource manage galera-bundle", "sudo pcs status", "sudo podman exec clustercheck /usr/bin/clustercheck", "systemctl stop tripleo_", "podman ps", "podman stop <container_name>", "cp -a /var/lib/mysql /var/lib/mysql_bck rm -rf /var/lib/mysql", "mkdir /var/lib/mysql chown 42434:42434 /var/lib/mysql chmod 0755 /var/lib/mysql chcon -t container_file_t /var/lib/mysql chcon -r object_r /var/lib/mysql chcon -u system_u /var/lib/mysql", "podman images \| grep mariadb <undercloud.ctlplane.example.com>:8787/rh-osbs/rhosp16-openstack-mariadb 16.2_20210322.1 <image_id> 3 weeks ago 718 MB", "podman tag <image_id> mariadb", "podman images \| grep maria localhost/mariadb latest <image_id> 3 weeks ago 718 MB <undercloud.ctlplane.example.com>:8787/rh-osbs/rhosp16-openstack-mariadb 16.2_20210322.1 <image_id> 3 weeks ago 718 MB", "podman run --net=host -v /var/lib/mysql:/var/lib/mysql localhost/mariadb mysql_install_db --datadir=/var/lib/mysql --user=mysql", "chown: cannot access '/usr/lib64/mariadb/plugin/auth_pam_tool_dir/auth_pam_tool': No such file or directory Couldn't set an owner to '/usr/lib64/mariadb/plugin/auth_pam_tool_dir/auth_pam_tool'. It must be root, the PAM authentication plugin doesn't work otherwise.", "cp /root/undercloud-all-databases.sql /var/lib/mysql", "podman run --net=host -dt -v /var/lib/mysql:/var/lib/mysql localhost/mariadb /usr/libexec/mysqld", "podman exec -it <container_id> /bin/bash ()[mysql@5a4e429c6f40 /]USD mysql -u root -e \"set global max_allowed_packet = 1073741824;\" ()[mysql@5a4e429c6f40 /]USD mysql -u root < /var/lib/mysql/undercloud-all-databases.sql ()[mysql@5a4e429c6f40 /]USD mysql -u root -e 'flush privileges' ()[mysql@5a4e429c6f40 /]USD exit exit", "podman stop <container_id>", "podman ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES", "systemctl start multi-user.target" ]	https://docs.redhat.com/en/documentation/red_hat_openstack_platform/17.1/html/backing_up_and_restoring_the_undercloud_and_control_plane_nodes/assembly_backing-up-the-undercloud-and-the-control-plane-nodes-using-the-relax-and-recover-tool_br-undercloud-ctlplane
Chapter 5. The sepolicy Suite	Chapter 5. The sepolicy Suite The sepolicy utility provides a suite of features to query the installed SELinux policy. These features are either new or were previously provided by separate utilities, such as sepolgen or setrans . The suite allows you to generate transition reports, man pages, or even new policy modules, thus giving users easier access and better understanding of the SELinux policy. The policycoreutils-devel package provides sepolicy . Enter the following command as the root user to install sepolicy : The sepolicy suite provides the following features that are invoked as command-line parameters: Table 5.1. The sepolicy Features Feature Description booleans Query the SELinux Policy to see description of Booleans communicate Query the SELinux policy to see if domains can communicate with each other generate Generate an SELinux policy module template gui Graphical User Interface for SELinux Policy interface List SELinux Policy interfaces manpage Generate SELinux man pages network Query SELinux policy network information transition Query SELinux policy and generate a process transition report 5.1. The sepolicy Python Bindings In versions of Red Hat Enterprise Linux, the setools package included the sesearch and seinfo utilities. The sesearch utility is used for searching rules in a SELinux policy while the seinfo utility allows you to query various other components in the policy. In Red Hat Enterprise Linux 7, Python bindings for sesearch and seinfo have been added so that you can use the functionality of these utilities through the sepolicy suite. See the example below:	[ "~]# yum install policycoreutils-devel", "> python >>> import sepolicy >>> sepolicy.info(sepolicy.ATTRIBUTE) Returns a dictionary of all information about SELinux Attributes >>>sepolicy.search([sepolicy.ALLOW]) Returns a dictionary of all allow rules in the policy." ]	https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/selinux_users_and_administrators_guide/chap-security-enhanced_linux-the_sepolicy_suite
Chapter 7. Installing a cluster on OpenStack in a restricted network	Chapter 7. Installing a cluster on OpenStack in a restricted network In OpenShift Container Platform 4.14, you can install a cluster on Red Hat OpenStack Platform (RHOSP) in a restricted network by creating an internal mirror of the installation release content. 7.1. Prerequisites You reviewed details about the OpenShift Container Platform installation and update processes. You read the documentation on selecting a cluster installation method and preparing it for users . You verified that OpenShift Container Platform 4.14 is compatible with your RHOSP version by using the Supported platforms for OpenShift clusters section. You can also compare platform support across different versions by viewing the OpenShift Container Platform on RHOSP support matrix . You created a registry on your mirror host and obtained the imageContentSources data for your version of OpenShift Container Platform. Important Because the installation media is on the mirror host, you can use that computer to complete all installation steps. You understand performance and scalability practices for cluster scaling, control plane sizing, and etcd. For more information, see Recommended practices for scaling the cluster . You have the metadata service enabled in RHOSP. 7.2. About installations in restricted networks In OpenShift Container Platform 4.14, you can perform an installation that does not require an active connection to the internet to obtain software components. Restricted network installations can be completed using installer-provisioned infrastructure or user-provisioned infrastructure, depending on the cloud platform to which you are installing the cluster. If you choose to perform a restricted network installation on a cloud platform, you still require access to its cloud APIs. Some cloud functions, like Amazon Web Service's Route 53 DNS and IAM services, require internet access. Depending on your network, you might require less internet access for an installation on bare metal hardware, Nutanix, or on VMware vSphere. To complete a restricted network installation, you must create a registry that mirrors the contents of the OpenShift image registry and contains the installation media. You can create this registry on a mirror host, which can access both the internet and your closed network, or by using other methods that meet your restrictions. 7.2.1. Additional limits Clusters in restricted networks have the following additional limitations and restrictions: The ClusterVersion status includes an Unable to retrieve available updates error. By default, you cannot use the contents of the Developer Catalog because you cannot access the required image stream tags. 7.3. Resource guidelines for installing OpenShift Container Platform on RHOSP To support an OpenShift Container Platform installation, your Red Hat OpenStack Platform (RHOSP) quota must meet the following requirements: Table 7.1. Recommended resources for a default OpenShift Container Platform cluster on RHOSP Resource Value Floating IP addresses 3 Ports 15 Routers 1 Subnets 1 RAM 88 GB vCPUs 22 Volume storage 275 GB Instances 7 Security groups 3 Security group rules 60 Server groups 2 - plus 1 for each additional availability zone in each machine pool A cluster might function with fewer than recommended resources, but its performance is not guaranteed. Important If RHOSP object storage (Swift) is available and operated by a user account with the swiftoperator role, it is used as the default backend for the OpenShift Container Platform image registry. In this case, the volume storage requirement is 175 GB. Swift space requirements vary depending on the size of the image registry. Note By default, your security group and security group rule quotas might be low. If you encounter problems, run openstack quota set --secgroups 3 --secgroup-rules 60 <project> as an administrator to increase them. An OpenShift Container Platform deployment comprises control plane machines, compute machines, and a bootstrap machine. 7.3.1. Control plane machines By default, the OpenShift Container Platform installation process creates three control plane machines. Each machine requires: An instance from the RHOSP quota A port from the RHOSP quota A flavor with at least 16 GB memory and 4 vCPUs At least 100 GB storage space from the RHOSP quota 7.3.2. Compute machines By default, the OpenShift Container Platform installation process creates three compute machines. Each machine requires: An instance from the RHOSP quota A port from the RHOSP quota A flavor with at least 8 GB memory and 2 vCPUs At least 100 GB storage space from the RHOSP quota Tip Compute machines host the applications that you run on OpenShift Container Platform; aim to run as many as you can. 7.3.3. Bootstrap machine During installation, a bootstrap machine is temporarily provisioned to stand up the control plane. After the production control plane is ready, the bootstrap machine is deprovisioned. The bootstrap machine requires: An instance from the RHOSP quota A port from the RHOSP quota A flavor with at least 16 GB memory and 4 vCPUs At least 100 GB storage space from the RHOSP quota 7.4. Internet access for OpenShift Container Platform In OpenShift Container Platform 4.14, you require access to the internet to obtain the images that are necessary to install your cluster. You must have internet access to: Access OpenShift Cluster Manager to download the installation program and perform subscription management. If the cluster has internet access and you do not disable Telemetry, that service automatically entitles your cluster. Access Quay.io to obtain the packages that are required to install your cluster. Obtain the packages that are required to perform cluster updates. 7.5. Enabling Swift on RHOSP Swift is operated by a user account with the swiftoperator role. Add the role to an account before you run the installation program. Important If the Red Hat OpenStack Platform (RHOSP) object storage service , commonly known as Swift, is available, OpenShift Container Platform uses it as the image registry storage. If it is unavailable, the installation program relies on the RHOSP block storage service, commonly known as Cinder. If Swift is present and you want to use it, you must enable access to it. If it is not present, or if you do not want to use it, skip this section. Important RHOSP 17 sets the rgw_max_attr_size parameter of Ceph RGW to 256 characters. This setting causes issues with uploading container images to the OpenShift Container Platform registry. You must set the value of rgw_max_attr_size to at least 1024 characters. Before installation, check if your RHOSP deployment is affected by this problem. If it is, reconfigure Ceph RGW. Prerequisites You have a RHOSP administrator account on the target environment. The Swift service is installed. On Ceph RGW , the account in url option is enabled. Procedure To enable Swift on RHOSP: As an administrator in the RHOSP CLI, add the swiftoperator role to the account that will access Swift: USD openstack role add --user <user> --project <project> swiftoperator Your RHOSP deployment can now use Swift for the image registry. 7.6. Defining parameters for the installation program The OpenShift Container Platform installation program relies on a file that is called clouds.yaml . The file describes Red Hat OpenStack Platform (RHOSP) configuration parameters, including the project name, log in information, and authorization service URLs. Procedure Create the clouds.yaml file: If your RHOSP distribution includes the Horizon web UI, generate a clouds.yaml file in it. Important Remember to add a password to the auth field. You can also keep secrets in a separate file from clouds.yaml . If your RHOSP distribution does not include the Horizon web UI, or you do not want to use Horizon, create the file yourself. For detailed information about clouds.yaml , see Config files in the RHOSP documentation. clouds: shiftstack: auth: auth_url: http://10.10.14.42:5000/v3 project_name: shiftstack username: <username> password: <password> user_domain_name: Default project_domain_name: Default dev-env: region_name: RegionOne auth: username: <username> password: <password> project_name: 'devonly' auth_url: 'https://10.10.14.22:5001/v2.0' If your RHOSP installation uses self-signed certificate authority (CA) certificates for endpoint authentication: Copy the certificate authority file to your machine. Add the cacerts key to the clouds.yaml file. The value must be an absolute, non-root-accessible path to the CA certificate: clouds: shiftstack: ... cacert: "/etc/pki/ca-trust/source/anchors/ca.crt.pem" Tip After you run the installer with a custom CA certificate, you can update the certificate by editing the value of the ca-cert.pem key in the cloud-provider-config keymap. On a command line, run: USD oc edit configmap -n openshift-config cloud-provider-config Place the clouds.yaml file in one of the following locations: The value of the OS_CLIENT_CONFIG_FILE environment variable The current directory A Unix-specific user configuration directory, for example ~/.config/openstack/clouds.yaml A Unix-specific site configuration directory, for example /etc/openstack/clouds.yaml The installation program searches for clouds.yaml in that order. 7.7. Setting OpenStack Cloud Controller Manager options Optionally, you can edit the OpenStack Cloud Controller Manager (CCM) configuration for your cluster. This configuration controls how OpenShift Container Platform interacts with Red Hat OpenStack Platform (RHOSP). For a complete list of configuration parameters, see the "OpenStack Cloud Controller Manager reference guide" page in the "Installing on OpenStack" documentation. Procedure If you have not already generated manifest files for your cluster, generate them by running the following command: USD openshift-install --dir <destination_directory> create manifests In a text editor, open the cloud-provider configuration manifest file. For example: USD vi openshift/manifests/cloud-provider-config.yaml Modify the options according to the CCM reference guide. Configuring Octavia for load balancing is a common case for clusters that do not use Kuryr. For example: #... [LoadBalancer] lb-provider = "amphora" 1 floating-network-id="d3deb660-4190-40a3-91f1-37326fe6ec4a" 2 create-monitor = True 3 monitor-delay = 10s 4 monitor-timeout = 10s 5 monitor-max-retries = 1 6 #... 1 This property sets the Octavia provider that your load balancer uses. It accepts "ovn" or "amphora" as values. If you choose to use OVN, you must also set lb-method to SOURCE_IP_PORT . 2 This property is required if you want to use multiple external networks with your cluster. The cloud provider creates floating IP addresses on the network that is specified here. 3 This property controls whether the cloud provider creates health monitors for Octavia load balancers. Set the value to True to create health monitors. As of RHOSP 16.2, this feature is only available for the Amphora provider. 4 This property sets the frequency with which endpoints are monitored. The value must be in the time.ParseDuration() format. This property is required if the value of the create-monitor property is True . 5 This property sets the time that monitoring requests are open before timing out. The value must be in the time.ParseDuration() format. This property is required if the value of the create-monitor property is True . 6 This property defines how many successful monitoring requests are required before a load balancer is marked as online. The value must be an integer. This property is required if the value of the create-monitor property is True . Important Prior to saving your changes, verify that the file is structured correctly. Clusters might fail if properties are not placed in the appropriate section. Important You must set the value of the create-monitor property to True if you use services that have the value of the .spec.externalTrafficPolicy property set to Local . The OVN Octavia provider in RHOSP 16.2 does not support health monitors. Therefore, services that have ETP parameter values set to Local might not respond when the lb-provider value is set to "ovn" . Important For installations that use Kuryr, Kuryr handles relevant services. There is no need to configure Octavia load balancing in the cloud provider. Save the changes to the file and proceed with installation. Tip You can update your cloud provider configuration after you run the installer. On a command line, run: USD oc edit configmap -n openshift-config cloud-provider-config After you save your changes, your cluster will take some time to reconfigure itself. The process is complete if none of your nodes have a SchedulingDisabled status. 7.8. Creating the RHCOS image for restricted network installations Download the Red Hat Enterprise Linux CoreOS (RHCOS) image to install OpenShift Container Platform on a restricted network Red Hat OpenStack Platform (RHOSP) environment. Prerequisites Obtain the OpenShift Container Platform installation program. For a restricted network installation, the program is on your mirror registry host. Procedure Log in to the Red Hat Customer Portal's Product Downloads page . Under Version , select the most recent release of OpenShift Container Platform 4.14 for RHEL 8. Important The RHCOS images might not change with every release of OpenShift Container Platform. You must download images with the highest version that is less than or equal to the OpenShift Container Platform version that you install. Use the image versions that match your OpenShift Container Platform version if they are available. Download the Red Hat Enterprise Linux CoreOS (RHCOS) - OpenStack Image (QCOW) image. Decompress the image. Note You must decompress the image before the cluster can use it. The name of the downloaded file might not contain a compression extension, like .gz or .tgz . To find out if or how the file is compressed, in a command line, enter: Upload the image that you decompressed to a location that is accessible from the bastion server, like Glance. For example: Important Depending on your RHOSP environment, you might be able to upload the image in either .raw or .qcow2 formats . If you use Ceph, you must use the .raw format. Warning If the installation program finds multiple images with the same name, it chooses one of them at random. To avoid this behavior, create unique names for resources in RHOSP. The image is now available for a restricted installation. Note the image name or location for use in OpenShift Container Platform deployment. 7.9. Creating the installation configuration file You can customize the OpenShift Container Platform cluster you install on Red Hat OpenStack Platform (RHOSP). Prerequisites You have the OpenShift Container Platform installation program and the pull secret for your cluster. For a restricted network installation, these files are on your mirror host. You have the imageContentSources values that were generated during mirror registry creation. You have obtained the contents of the certificate for your mirror registry. You have retrieved a Red Hat Enterprise Linux CoreOS (RHCOS) image and uploaded it to an accessible location. Procedure Create the install-config.yaml file. Change to the directory that contains the installation program and run the following command: USD ./openshift-install create install-config --dir <installation_directory> 1 1 For <installation_directory> , specify the directory name to store the files that the installation program creates. When specifying the directory: Verify that the directory has the execute permission. This permission is required to run Terraform binaries under the installation directory. Use an empty directory. Some installation assets, such as bootstrap X.509 certificates, have short expiration intervals, therefore you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier OpenShift Container Platform version. Note Always delete the ~/.powervs directory to avoid reusing a stale configuration. Run the following command: USD rm -rf ~/.powervs At the prompts, provide the configuration details for your cloud: Optional: Select an SSH key to use to access your cluster machines. Note For production OpenShift Container Platform clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your ssh-agent process uses. Select openstack as the platform to target. Specify the Red Hat OpenStack Platform (RHOSP) external network name to use for installing the cluster. Specify the floating IP address to use for external access to the OpenShift API. Specify a RHOSP flavor with at least 16 GB RAM to use for control plane nodes and 8 GB RAM for compute nodes. Select the base domain to deploy the cluster to. All DNS records will be sub-domains of this base and will also include the cluster name. Enter a name for your cluster. The name must be 14 or fewer characters long. In the install-config.yaml file, set the value of platform.openstack.clusterOSImage to the image location or name. For example: platform: openstack: clusterOSImage: http://mirror.example.com/images/rhcos-43.81.201912131630.0-openstack.x86_64.qcow2.gz?sha256=ffebbd68e8a1f2a245ca19522c16c86f67f9ac8e4e0c1f0a812b068b16f7265d Edit the install-config.yaml file to give the additional information that is required for an installation in a restricted network. Update the pullSecret value to contain the authentication information for your registry: pullSecret: '{"auths":{"<mirror_host_name>:5000": {"auth": "<credentials>","email": "[email protected]"}}}' For <mirror_host_name> , specify the registry domain name that you specified in the certificate for your mirror registry, and for <credentials> , specify the base64-encoded user name and password for your mirror registry. Add the additionalTrustBundle parameter and value. additionalTrustBundle: \| -----BEGIN CERTIFICATE----- ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ -----END CERTIFICATE----- The value must be the contents of the certificate file that you used for your mirror registry. The certificate file can be an existing, trusted certificate authority, or the self-signed certificate that you generated for the mirror registry. Add the image content resources, which resemble the following YAML excerpt: imageContentSources: - mirrors: - <mirror_host_name>:5000/<repo_name>/release source: quay.io/openshift-release-dev/ocp-release - mirrors: - <mirror_host_name>:5000/<repo_name>/release source: registry.redhat.io/ocp/release For these values, use the imageContentSources that you recorded during mirror registry creation. Optional: Set the publishing strategy to Internal : publish: Internal By setting this option, you create an internal Ingress Controller and a private load balancer. Make any other modifications to the install-config.yaml file that you require. You can find more information about the available parameters in the Installation configuration parameters section. Back up the install-config.yaml file so that you can use it to install multiple clusters. Important The install-config.yaml file is consumed during the installation process. If you want to reuse the file, you must back it up now. Additional resources Installation configuration parameters for OpenStack 7.9.1. Configuring the cluster-wide proxy during installation Production environments can deny direct access to the internet and instead have an HTTP or HTTPS proxy available. You can configure a new OpenShift Container Platform cluster to use a proxy by configuring the proxy settings in the install-config.yaml file. Note Kuryr installations default to HTTP proxies. Prerequisites For Kuryr installations on restricted networks that use the Proxy object, the proxy must be able to reply to the router that the cluster uses. To add a static route for the proxy configuration, from a command line as the root user, enter: USD ip route add <cluster_network_cidr> via <installer_subnet_gateway> The restricted subnet must have a gateway that is defined and available to be linked to the Router resource that Kuryr creates. Prerequisites You have an existing install-config.yaml file. You reviewed the sites that your cluster requires access to and determined whether any of them need to bypass the proxy. By default, all cluster egress traffic is proxied, including calls to hosting cloud provider APIs. You added sites to the Proxy object's spec.noProxy field to bypass the proxy if necessary. Note The Proxy object status.noProxy field is populated with the values of the networking.machineNetwork[].cidr , networking.clusterNetwork[].cidr , and networking.serviceNetwork[] fields from your installation configuration. For installations on Amazon Web Services (AWS), Google Cloud Platform (GCP), Microsoft Azure, and Red Hat OpenStack Platform (RHOSP), the Proxy object status.noProxy field is also populated with the instance metadata endpoint ( 169.254.169.254 ). Procedure Edit your install-config.yaml file and add the proxy settings. For example: apiVersion: v1 baseDomain: my.domain.com proxy: httpProxy: http://<username>:<pswd>@<ip>:<port> 1 httpsProxy: https://<username>:<pswd>@<ip>:<port> 2 noProxy: example.com 3 additionalTrustBundle: \| 4 -----BEGIN CERTIFICATE----- <MY_TRUSTED_CA_CERT> -----END CERTIFICATE----- additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> 5 1 A proxy URL to use for creating HTTP connections outside the cluster. The URL scheme must be http . 2 A proxy URL to use for creating HTTPS connections outside the cluster. 3 A comma-separated list of destination domain names, IP addresses, or other network CIDRs to exclude from proxying. Preface a domain with . to match subdomains only. For example, .y.com matches x.y.com , but not y.com . Use * to bypass the proxy for all destinations. 4 If provided, the installation program generates a config map that is named user-ca-bundle in the openshift-config namespace that contains one or more additional CA certificates that are required for proxying HTTPS connections. The Cluster Network Operator then creates a trusted-ca-bundle config map that merges these contents with the Red Hat Enterprise Linux CoreOS (RHCOS) trust bundle, and this config map is referenced in the trustedCA field of the Proxy object. The additionalTrustBundle field is required unless the proxy's identity certificate is signed by an authority from the RHCOS trust bundle. 5 Optional: The policy to determine the configuration of the Proxy object to reference the user-ca-bundle config map in the trustedCA field. The allowed values are Proxyonly and Always . Use Proxyonly to reference the user-ca-bundle config map only when http/https proxy is configured. Use Always to always reference the user-ca-bundle config map. The default value is Proxyonly . Note The installation program does not support the proxy readinessEndpoints field. Note If the installer times out, restart and then complete the deployment by using the wait-for command of the installer. For example: USD ./openshift-install wait-for install-complete --log-level debug Save the file and reference it when installing OpenShift Container Platform. The installation program creates a cluster-wide proxy that is named cluster that uses the proxy settings in the provided install-config.yaml file. If no proxy settings are provided, a cluster Proxy object is still created, but it will have a nil spec . Note Only the Proxy object named cluster is supported, and no additional proxies can be created. 7.9.2. Sample customized install-config.yaml file for restricted OpenStack installations This sample install-config.yaml demonstrates all of the possible Red Hat OpenStack Platform (RHOSP) customization options. Important This sample file is provided for reference only. You must obtain your install-config.yaml file by using the installation program. apiVersion: v1 baseDomain: example.com controlPlane: name: master platform: {} replicas: 3 compute: - name: worker platform: openstack: type: ml.large replicas: 3 metadata: name: example networking: clusterNetwork: - cidr: 10.128.0.0/14 hostPrefix: 23 machineNetwork: - cidr: 10.0.0.0/16 serviceNetwork: - 172.30.0.0/16 networkType: OVNKubernetes platform: openstack: region: region1 cloud: mycloud externalNetwork: external computeFlavor: m1.xlarge apiFloatingIP: 128.0.0.1 fips: false pullSecret: '{"auths": ...}' sshKey: ssh-ed25519 AAAA... additionalTrustBundle: \| -----BEGIN CERTIFICATE----- ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ -----END CERTIFICATE----- imageContentSources: - mirrors: - <mirror_registry>/<repo_name>/release source: quay.io/openshift-release-dev/ocp-release - mirrors: - <mirror_registry>/<repo_name>/release source: quay.io/openshift-release-dev/ocp-v4.0-art-dev 7.10. Generating a key pair for cluster node SSH access During an OpenShift Container Platform installation, you can provide an SSH public key to the installation program. The key is passed to the Red Hat Enterprise Linux CoreOS (RHCOS) nodes through their Ignition config files and is used to authenticate SSH access to the nodes. The key is added to the ~/.ssh/authorized_keys list for the core user on each node, which enables password-less authentication. After the key is passed to the nodes, you can use the key pair to SSH in to the RHCOS nodes as the user core . To access the nodes through SSH, the private key identity must be managed by SSH for your local user. If you want to SSH in to your cluster nodes to perform installation debugging or disaster recovery, you must provide the SSH public key during the installation process. The ./openshift-install gather command also requires the SSH public key to be in place on the cluster nodes. Important Do not skip this procedure in production environments, where disaster recovery and debugging is required. Note You must use a local key, not one that you configured with platform-specific approaches such as AWS key pairs . Procedure If you do not have an existing SSH key pair on your local machine to use for authentication onto your cluster nodes, create one. For example, on a computer that uses a Linux operating system, run the following command: USD ssh-keygen -t ed25519 -N '' -f <path>/<file_name> 1 1 Specify the path and file name, such as ~/.ssh/id_ed25519 , of the new SSH key. If you have an existing key pair, ensure your public key is in the your ~/.ssh directory. Note If you plan to install an OpenShift Container Platform cluster that uses the RHEL cryptographic libraries that have been submitted to NIST for FIPS 140-2/140-3 Validation on only the x86_64 , ppc64le , and s390x architectures, do not create a key that uses the ed25519 algorithm. Instead, create a key that uses the rsa or ecdsa algorithm. View the public SSH key: USD cat <path>/<file_name>.pub For example, run the following to view the ~/.ssh/id_ed25519.pub public key: USD cat ~/.ssh/id_ed25519.pub Add the SSH private key identity to the SSH agent for your local user, if it has not already been added. SSH agent management of the key is required for password-less SSH authentication onto your cluster nodes, or if you want to use the ./openshift-install gather command. Note On some distributions, default SSH private key identities such as ~/.ssh/id_rsa and ~/.ssh/id_dsa are managed automatically. If the ssh-agent process is not already running for your local user, start it as a background task: USD eval "USD(ssh-agent -s)" Example output Agent pid 31874 Note If your cluster is in FIPS mode, only use FIPS-compliant algorithms to generate the SSH key. The key must be either RSA or ECDSA. Add your SSH private key to the ssh-agent : USD ssh-add <path>/<file_name> 1 1 Specify the path and file name for your SSH private key, such as ~/.ssh/id_ed25519 Example output Identity added: /home/<you>/<path>/<file_name> (<computer_name>) steps When you install OpenShift Container Platform, provide the SSH public key to the installation program. 7.11. Enabling access to the environment At deployment, all OpenShift Container Platform machines are created in a Red Hat OpenStack Platform (RHOSP)-tenant network. Therefore, they are not accessible directly in most RHOSP deployments. You can configure OpenShift Container Platform API and application access by using floating IP addresses (FIPs) during installation. You can also complete an installation without configuring FIPs, but the installer will not configure a way to reach the API or applications externally. 7.11.1. Enabling access with floating IP addresses Create floating IP (FIP) addresses for external access to the OpenShift Container Platform API and cluster applications. Procedure Using the Red Hat OpenStack Platform (RHOSP) CLI, create the API FIP: USD openstack floating ip create --description "API <cluster_name>.<base_domain>" <external_network> Using the Red Hat OpenStack Platform (RHOSP) CLI, create the apps, or Ingress, FIP: USD openstack floating ip create --description "Ingress <cluster_name>.<base_domain>" <external_network> Add records that follow these patterns to your DNS server for the API and Ingress FIPs: api.<cluster_name>.<base_domain>. IN A <API_FIP> .apps.<cluster_name>.<base_domain>. IN A <apps_FIP> Note If you do not control the DNS server, you can access the cluster by adding the cluster domain names such as the following to your /etc/hosts file: <api_floating_ip> api.<cluster_name>.<base_domain> <application_floating_ip> grafana-openshift-monitoring.apps.<cluster_name>.<base_domain> <application_floating_ip> prometheus-k8s-openshift-monitoring.apps.<cluster_name>.<base_domain> <application_floating_ip> oauth-openshift.apps.<cluster_name>.<base_domain> <application_floating_ip> console-openshift-console.apps.<cluster_name>.<base_domain> application_floating_ip integrated-oauth-server-openshift-authentication.apps.<cluster_name>.<base_domain> The cluster domain names in the /etc/hosts file grant access to the web console and the monitoring interface of your cluster locally. You can also use the kubectl or oc . You can access the user applications by using the additional entries pointing to the <application_floating_ip>. This action makes the API and applications accessible to only you, which is not suitable for production deployment, but does allow installation for development and testing. Add the FIPs to the install-config.yaml file as the values of the following parameters: platform.openstack.ingressFloatingIP platform.openstack.apiFloatingIP If you use these values, you must also enter an external network as the value of the platform.openstack.externalNetwork parameter in the install-config.yaml file. Tip You can make OpenShift Container Platform resources available outside of the cluster by assigning a floating IP address and updating your firewall configuration. 7.11.2. Completing installation without floating IP addresses You can install OpenShift Container Platform on Red Hat OpenStack Platform (RHOSP) without providing floating IP addresses. In the install-config.yaml file, do not define the following parameters: platform.openstack.ingressFloatingIP platform.openstack.apiFloatingIP If you cannot provide an external network, you can also leave platform.openstack.externalNetwork blank. If you do not provide a value for platform.openstack.externalNetwork , a router is not created for you, and, without additional action, the installer will fail to retrieve an image from Glance. You must configure external connectivity on your own. If you run the installer from a system that cannot reach the cluster API due to a lack of floating IP addresses or name resolution, installation fails. To prevent installation failure in these cases, you can use a proxy network or run the installer from a system that is on the same network as your machines. Note You can enable name resolution by creating DNS records for the API and Ingress ports. For example: api.<cluster_name>.<base_domain>. IN A <api_port_IP> .apps.<cluster_name>.<base_domain>. IN A <ingress_port_IP> If you do not control the DNS server, you can add the record to your /etc/hosts file. This action makes the API accessible to only you, which is not suitable for production deployment but does allow installation for development and testing. 7.12. Deploying the cluster You can install OpenShift Container Platform on a compatible cloud platform. Important You can run the create cluster command of the installation program only once, during initial installation. Prerequisites You have the OpenShift Container Platform installation program and the pull secret for your cluster. You have verified that the cloud provider account on your host has the correct permissions to deploy the cluster. An account with incorrect permissions causes the installation process to fail with an error message that displays the missing permissions. Procedure Change to the directory that contains the installation program and initialize the cluster deployment: USD ./openshift-install create cluster --dir <installation_directory> \ 1 --log-level=info 2 1 For <installation_directory> , specify the location of your customized ./install-config.yaml file. 2 To view different installation details, specify warn , debug , or error instead of info . Verification When the cluster deployment completes successfully: The terminal displays directions for accessing your cluster, including a link to the web console and credentials for the kubeadmin user. Credential information also outputs to <installation_directory>/.openshift_install.log . Important Do not delete the installation program or the files that the installation program creates. Both are required to delete the cluster. Example output ... INFO Install complete! INFO To access the cluster as the system:admin user when using 'oc', run 'export KUBECONFIG=/home/myuser/install_dir/auth/kubeconfig' INFO Access the OpenShift web-console here: https://console-openshift-console.apps.mycluster.example.com INFO Login to the console with user: "kubeadmin", and password: "password" INFO Time elapsed: 36m22s Important The Ignition config files that the installation program generates contain certificates that expire after 24 hours, which are then renewed at that time. If the cluster is shut down before renewing the certificates and the cluster is later restarted after the 24 hours have elapsed, the cluster automatically recovers the expired certificates. The exception is that you must manually approve the pending node-bootstrapper certificate signing requests (CSRs) to recover kubelet certificates. See the documentation for Recovering from expired control plane certificates for more information. It is recommended that you use Ignition config files within 12 hours after they are generated because the 24-hour certificate rotates from 16 to 22 hours after the cluster is installed. By using the Ignition config files within 12 hours, you can avoid installation failure if the certificate update runs during installation. 7.13. Verifying cluster status You can verify your OpenShift Container Platform cluster's status during or after installation. Procedure In the cluster environment, export the administrator's kubeconfig file: USD export KUBECONFIG=<installation_directory>/auth/kubeconfig 1 1 For <installation_directory> , specify the path to the directory that you stored the installation files in. The kubeconfig file contains information about the cluster that is used by the CLI to connect a client to the correct cluster and API server. View the control plane and compute machines created after a deployment: USD oc get nodes View your cluster's version: USD oc get clusterversion View your Operators' status: USD oc get clusteroperator View all running pods in the cluster: USD oc get pods -A 7.14. Logging in to the cluster by using the CLI You can log in to your cluster as a default system user by exporting the cluster kubeconfig file. The kubeconfig file contains information about the cluster that is used by the CLI to connect a client to the correct cluster and API server. The file is specific to a cluster and is created during OpenShift Container Platform installation. Prerequisites You deployed an OpenShift Container Platform cluster. You installed the oc CLI. Procedure Export the kubeadmin credentials: USD export KUBECONFIG=<installation_directory>/auth/kubeconfig 1 1 For <installation_directory> , specify the path to the directory that you stored the installation files in. Verify you can run oc commands successfully using the exported configuration: USD oc whoami Example output system:admin Additional resources See Accessing the web console for more details about accessing and understanding the OpenShift Container Platform web console. 7.15. Disabling the default OperatorHub catalog sources Operator catalogs that source content provided by Red Hat and community projects are configured for OperatorHub by default during an OpenShift Container Platform installation. In a restricted network environment, you must disable the default catalogs as a cluster administrator. Procedure Disable the sources for the default catalogs by adding disableAllDefaultSources: true to the OperatorHub object: USD oc patch OperatorHub cluster --type json \ -p '[{"op": "add", "path": "/spec/disableAllDefaultSources", "value": true}]' Tip Alternatively, you can use the web console to manage catalog sources. From the Administration Cluster Settings Configuration OperatorHub page, click the Sources tab, where you can create, update, delete, disable, and enable individual sources. 7.16. Telemetry access for OpenShift Container Platform In OpenShift Container Platform 4.14, the Telemetry service, which runs by default to provide metrics about cluster health and the success of updates, requires internet access. If your cluster is connected to the internet, Telemetry runs automatically, and your cluster is registered to OpenShift Cluster Manager . After you confirm that your OpenShift Cluster Manager inventory is correct, either maintained automatically by Telemetry or manually by using OpenShift Cluster Manager, use subscription watch to track your OpenShift Container Platform subscriptions at the account or multi-cluster level. Additional resources See About remote health monitoring for more information about the Telemetry service 7.17. steps Customize your cluster . If the mirror registry that you used to install your cluster has a trusted CA, add it to the cluster by configuring additional trust stores . If necessary, you can opt out of remote health reporting . If necessary, see Registering your disconnected cluster Configure image streams for the Cluster Samples Operator and the must-gather tool. Learn how to use Operator Lifecycle Manager (OLM) on restricted networks . If you did not configure RHOSP to accept application traffic over floating IP addresses, configure RHOSP access with floating IP addresses .	[ "openstack role add --user <user> --project <project> swiftoperator", "clouds: shiftstack: auth: auth_url: http://10.10.14.42:5000/v3 project_name: shiftstack username: <username> password: <password> user_domain_name: Default project_domain_name: Default dev-env: region_name: RegionOne auth: username: <username> password: <password> project_name: 'devonly' auth_url: 'https://10.10.14.22:5001/v2.0'", "clouds: shiftstack: cacert: \"/etc/pki/ca-trust/source/anchors/ca.crt.pem\"", "oc edit configmap -n openshift-config cloud-provider-config", "openshift-install --dir <destination_directory> create manifests", "vi openshift/manifests/cloud-provider-config.yaml", "# [LoadBalancer] lb-provider = \"amphora\" 1 floating-network-id=\"d3deb660-4190-40a3-91f1-37326fe6ec4a\" 2 create-monitor = True 3 monitor-delay = 10s 4 monitor-timeout = 10s 5 monitor-max-retries = 1 6 #", "oc edit configmap -n openshift-config cloud-provider-config", "file <name_of_downloaded_file>", "openstack image create --file rhcos-44.81.202003110027-0-openstack.x86_64.qcow2 --disk-format qcow2 rhcos-USD{RHCOS_VERSION}", "./openshift-install create install-config --dir <installation_directory> 1", "rm -rf ~/.powervs", "platform: openstack: clusterOSImage: http://mirror.example.com/images/rhcos-43.81.201912131630.0-openstack.x86_64.qcow2.gz?sha256=ffebbd68e8a1f2a245ca19522c16c86f67f9ac8e4e0c1f0a812b068b16f7265d", "pullSecret: '{\"auths\":{\"<mirror_host_name>:5000\": {\"auth\": \"<credentials>\",\"email\": \"[email protected]\"}}}'", "additionalTrustBundle: \| -----BEGIN CERTIFICATE----- ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ -----END CERTIFICATE-----", "imageContentSources: - mirrors: - <mirror_host_name>:5000/<repo_name>/release source: quay.io/openshift-release-dev/ocp-release - mirrors: - <mirror_host_name>:5000/<repo_name>/release source: registry.redhat.io/ocp/release", "publish: Internal", "ip route add <cluster_network_cidr> via <installer_subnet_gateway>", "apiVersion: v1 baseDomain: my.domain.com proxy: httpProxy: http://<username>:<pswd>@<ip>:<port> 1 httpsProxy: https://<username>:<pswd>@<ip>:<port> 2 noProxy: example.com 3 additionalTrustBundle: \| 4 -----BEGIN CERTIFICATE----- <MY_TRUSTED_CA_CERT> -----END CERTIFICATE----- additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> 5", "./openshift-install wait-for install-complete --log-level debug", "apiVersion: v1 baseDomain: example.com controlPlane: name: master platform: {} replicas: 3 compute: - name: worker platform: openstack: type: ml.large replicas: 3 metadata: name: example networking: clusterNetwork: - cidr: 10.128.0.0/14 hostPrefix: 23 machineNetwork: - cidr: 10.0.0.0/16 serviceNetwork: - 172.30.0.0/16 networkType: OVNKubernetes platform: openstack: region: region1 cloud: mycloud externalNetwork: external computeFlavor: m1.xlarge apiFloatingIP: 128.0.0.1 fips: false pullSecret: '{\"auths\": ...}' sshKey: ssh-ed25519 AAAA additionalTrustBundle: \| -----BEGIN CERTIFICATE----- ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ -----END CERTIFICATE----- imageContentSources: - mirrors: - <mirror_registry>/<repo_name>/release source: quay.io/openshift-release-dev/ocp-release - mirrors: - <mirror_registry>/<repo_name>/release source: quay.io/openshift-release-dev/ocp-v4.0-art-dev", "ssh-keygen -t ed25519 -N '' -f <path>/<file_name> 1", "cat <path>/<file_name>.pub", "cat ~/.ssh/id_ed25519.pub", "eval \"USD(ssh-agent -s)\"", "Agent pid 31874", "ssh-add <path>/<file_name> 1", "Identity added: /home/<you>/<path>/<file_name> (<computer_name>)", "openstack floating ip create --description \"API <cluster_name>.<base_domain>\" <external_network>", "openstack floating ip create --description \"Ingress <cluster_name>.<base_domain>\" <external_network>", "api.<cluster_name>.<base_domain>. IN A <API_FIP> .apps.<cluster_name>.<base_domain>. IN A <apps_FIP>", "api.<cluster_name>.<base_domain>. IN A <api_port_IP> .apps.<cluster_name>.<base_domain>. IN A <ingress_port_IP>", "./openshift-install create cluster --dir <installation_directory> \\ 1 --log-level=info 2", "INFO Install complete! INFO To access the cluster as the system:admin user when using 'oc', run 'export KUBECONFIG=/home/myuser/install_dir/auth/kubeconfig' INFO Access the OpenShift web-console here: https://console-openshift-console.apps.mycluster.example.com INFO Login to the console with user: \"kubeadmin\", and password: \"password\" INFO Time elapsed: 36m22s", "export KUBECONFIG=<installation_directory>/auth/kubeconfig 1", "oc get nodes", "oc get clusterversion", "oc get clusteroperator", "oc get pods -A", "export KUBECONFIG=<installation_directory>/auth/kubeconfig 1", "oc whoami", "system:admin", "oc patch OperatorHub cluster --type json -p '[{\"op\": \"add\", \"path\": \"/spec/disableAllDefaultSources\", \"value\": true}]'" ]	https://docs.redhat.com/en/documentation/openshift_container_platform_installation/4.14/html/installing_on_openstack/installing-openstack-installer-restricted
10.2. About Host Entry Configuration Properties	10.2. About Host Entry Configuration Properties A host entry can contain information about the host that is outside its system configuration, such as its physical location, its MAC address, and keys and certificates. This information can be set when the host entry is created if it is created manually; otherwise, most of that information needs to be added to the host entry after the host is enrolled in the domain. Table 10.1. Host Configuration Properties UI Field Command-Line Option Description Description --desc= description A description of the host. Locality --locality= locality The geographic location of the host. Location --location= location The physical location of the host, such as its data center rack. Platform --platform= string The host hardware or architecture. Operating system --os= string The operating system and version for the host. MAC address --macaddress= address The MAC address for the host. This is a multi-valued attribute. The MAC address is used by the NIS plug-in to create a NIS ethers map for the host. SSH public keys --sshpubkey= string The full SSH public key for the host. This is a multi-valued attribute, so multiple keys can be set. Principal name (not editable) --principalname= principal The Kerberos principal name for the host. This defaults to the hostname during the client installation, unless a different principal is explicitly set in the -p . This can be changed using the command-line tools, but cannot be changed in the UI. Set One-Time Password --password= string Sets a password for the host which can be used in bulk enrollment. - --random Generates a random password to be used in bulk enrollment. - --certificate= string A certificate blob for the host. - --updatedns An attribute switch which sets whether the host can dynamically update its DNS entries if its IP address changes.	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/identity_management_guide/host-attr
Chapter 4. Planning your DNS services and host names	Chapter 4. Planning your DNS services and host names Identity Management (IdM) provides different types of DNS configurations in the IdM server. The following sections describe them and provide advice on how to determine which is the best for your use case. 4.1. DNS services available in an IdM server You can install an Identity Management (IdM) server with or without integrated DNS. Table 4.1. Comparing IdM with integrated DNS and without integrated DNS With integrated DNS Without integrated DNS Overview: IdM runs its own DNS service for the IdM domain. IdM uses DNS services provided by an external DNS server. Limitations: The integrated DNS server provided by IdM only supports features related to IdM deployment and maintenance. It does not support some of the advanced features of a general-purpose DNS server. Specific limitations are as follows: IdM DNS nameserver must be authoritative for its zones. The supported record types are A, AAAA, A6, AFSDB, CERT, CNAME, DLV, DNAME, DS, KX, LOC, MX, NAPTR, NS, PTR, SRV, SSHFP, TLSA, TXT, and URI. Split DNS, also known as split-view, split-horizon, split-brain DNS, is not supported. There are known issues if the DNS nameserver restarts in a multi-core environment. For example, if log rotation causes a nameserver to restart, the nameserver might crash. If you must use a multi-core setup, allow systemd to restart the nameserver after a failure occurs. DNS is not integrated with native IdM tools. For example, IdM does not update the DNS records automatically after a change in the topology. Works best for: Basic usage within the IdM deployment. When the IdM server manages DNS, DNS is tightly integrated with native IdM tools, which enables automating some of the DNS record management tasks. Environments where advanced DNS features beyond the scope of the IdM DNS are needed. Environments with a well-established DNS infrastructure where you want to keep using an external DNS server. Even if an Identity Management server is used as a primary DNS server, other external DNS servers can still be used as secondary servers. For example, if your environment is already using another DNS server, such as a DNS server integrated with Active Directory (AD), you can delegate only the IdM primary domain to the DNS integrated with IdM. It is not necessary to migrate DNS zones to the IdM DNS. Note If you need to issue certificates for IdM clients with an IP address in the Subject Alternative Name (SAN) extension, you must use the IdM integrated DNS service. 4.2. Guidelines for planning the DNS domain name and Kerberos realm name When installing the first Identity Management (IdM) server, the installation prompts for a primary DNS name of the IdM domain and Kerberos realm name. These guidelines can help you set the names correctly. Warning You will not be able to change the IdM primary domain name and Kerberos realm name after the server is already installed. Do not expect to be able to move from a testing environment to a production environment by changing the names, for example from lab.example.com to production.example.com . A separate DNS domain for service records Ensure that the primary DNS domain used for IdM is not shared with any other system. This helps avoid conflicts on the DNS level. Proper DNS domain name delegation Ensure you have valid delegation in the public DNS tree for the DNS domain. Do not use a domain name that is not delegated to you, not even on a private network. Multi-label DNS domain Do not use single-label domain names, for example .company . The IdM domain must be composed of one or more subdomains and a top level domain, for example example.com or company.example.com . A unique Kerberos realm name Ensure the realm name is not in conflict with any other existing Kerberos realm name, such as a name used by Active Directory (AD). Kerberos realm name as an upper-case version of the primary DNS name Consider setting the realm name to an upper-case ( EXAMPLE.COM ) version of the primary DNS domain name ( example.com ). Warning If you do not set the Kerberos realm name to be the upper-case version of the primary DNS name, you will not be able to use AD trusts. Additional notes on planning the DNS domain name and Kerberos realm name One IdM deployment always represents one Kerberos realm. You can join IdM clients from multiple distinct DNS domains ( example.com , example.net , example.org ) to a single Kerberos realm ( EXAMPLE.COM ). IdM clients do not need to be in the primary DNS domain. For example, if the IdM domain is idm.example.com , the clients can be in the clients.example.com domain, but clear mapping must be configured between the DNS domain and the Kerberos realm. Note The standard method to create the mapping is using the _kerberos TXT DNS records. The IdM integrated DNS adds these records automatically. Planning DNS forwarding If you want to use only one forwarder for your entire IdM deployment, configure a global forwarder . If your company is spread over multiple sites in geographically distant regions, global forwarders might be impractical. Configure per-server forwarders . If your company has an internal DNS network that is not resolvable from the public internet, configure a forward zone and zone forwarders so that the hosts in the IdM domain can resolve hosts from this other internal DNS network.	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/8/html/planning_identity_management/planning-your-dns-services-and-host-names-planning-identity-management
Providing feedback on JBoss EAP documentation	Providing feedback on JBoss EAP documentation To report an error or to improve our documentation, log in to your Red Hat Jira account and submit an issue. If you do not have a Red Hat Jira account, then you will be prompted to create an account. Procedure Click the following link to create a ticket . Please include the Document URL , the section number and describe the issue . Enter a brief description of the issue in the Summary . Provide a detailed description of the issue or enhancement in the Description . Include a URL to where the issue occurs in the documentation. Clicking Submit creates and routes the issue to the appropriate documentation team.	null	https://docs.redhat.com/en/documentation/red_hat_jboss_enterprise_application_platform/7.4/html/developing_jakarta_enterprise_beans_applications/proc_providing-feedback-on-red-hat-documentation_jakarta-enterprise-beans
5.6. Online Data Relocation	5.6. Online Data Relocation You can move data while the system is in use with the pvmove command. The pvmove command breaks up the data to be moved into sections and creates a temporary mirror to move each section. For more information on the operation of the pvmove command, see the pvmove (8) man page. Note In order to perform a pvmove operation in a cluster, you should ensure that the cmirror package is installed and the cmirrord service is running. The following command moves all allocated space off the physical volume /dev/sdc1 to other free physical volumes in the volume group: The following command moves just the extents of the logical volume MyLV . Since the pvmove command can take a long time to execute, you may want to run the command in the background to avoid display of progress updates in the foreground. The following command moves all extents allocated to the physical volume /dev/sdc1 over to /dev/sdf1 in the background. The following command reports the progress of the move as a percentage at five second intervals.	[ "pvmove /dev/sdc1", "pvmove -n MyLV /dev/sdc1", "pvmove -b /dev/sdc1 /dev/sdf1", "pvmove -i5 /dev/sdd1" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/logical_volume_manager_administration/online_relocation
Chapter 3. Eclipse Temurin features	Chapter 3. Eclipse Temurin features Eclipse Temurin does not contain structural changes from the upstream distribution of OpenJDK. For the list of changes and security fixes that the latest OpenJDK 11 release of Eclipse Temurin includes, see OpenJDK 11.0.25 Released . Important Full support for Eclipse Temurin 11 ends on 31 October 2024. For more information, see Eclipse Temurin 11 - End of full support . New features and enhancements Eclipse Temurin 11.0.25 includes the following new features and enhancements. TLS_ECDH_* cipher suites are disabled by default The TLS Elliptic-curve Diffie-Hellman (TLS_ECDH) cipher suites do not preserve forward secrecy and they are rarely used. OpenJDK 11.0.25 disables the TLS_ECDH cipher suites by adding the ECDH option to the jdk.tls.disabledAlgorithms security property in the java.security configuration file. If you attempt to use the TLS_ECDH cipher suites, OpenJDK now throws an SSLHandshakeException error. If you want to continue using the TLS_ECDH cipher suites, you can remove ECDH from the jdk.tls.disabledAlgorithms security property either by modifying the java.security configuration file or by using the java.security.properties system property. Note Continued use of the TLS_ECDH cipher suites is at your own risk. ECDH cipher suites that use RC4 were disabled in an earlier release. This change does not affect the TLS_ECDHE cipher suites, which remain enabled by default. See JDK-8279164 (JDK Bug System) . Distrust of TLS server certificates issued after 11 November 2024 and anchored by Entrust root CAs In accordance with similar plans that Google and Mozilla recently announced, OpenJDK 11.0.25 distrusts TLS certificates that are issued after 11 November 2024 and anchored by Entrust root certificate authorities (CAs). This change in behavior includes any certificates that are branded as AffirmTrust, which are managed by Entrust. OpenJDK will continue to trust certificates that are issued on or before 11 November 2024 until these certificates expire. If a server's certificate chain is anchored by an affected certificate, any attempts to negotiate a TLS session now fail with an exception to indicate that the trust anchor is not trusted. For example: You can check whether this change affects a certificate in a JDK keystore by using the following keytool command: keytool -v -list -alias <your_server_alias> -keystore <your_keystore_filename> If this change affects any certificate in the chain, update this certificate or contact the organization that is responsible for managing the certificate. If you want to continue using TLS server certificates that are anchored by Entrust root certificates, you can remove ENTRUST_TLS from the jdk.security.caDistrustPolicies security property either by modifying the java.security configuration file or by using the java.security.properties system property. Note Continued use of the distrusted TLS server certificates is at your own risk. These restrictions apply to the following Entrust root certificates that OpenJDK includes: Certificate 1 Alias name: entrustevca [jdk] Distinguished name: CN=Entrust Root Certification Authority, OU=(c) 2006 Entrust, Inc., OU=www.entrust.net/CPS is incorporated by reference, O=Entrust, Inc., C=US SHA256: 73:C1:76:43:4F:1B:C6:D5:AD:F4:5B:0E:76:E7:27:28:7C:8D:E5:76:16:C1:E6:E6:14:1A:2B:2C:BC:7D:8E:4C Certificate 2 Alias name: entrustrootcaec1 [jdk] Distinguished name: CN=Entrust Root Certification Authority - EC1, OU=(c) 2012 Entrust, Inc. - for authorized use only, OU=See www.entrust.net/legal-terms, O=Entrust, Inc., C=US SHA256: 02:ED:0E:B2:8C:14:DA:45:16:5C:56:67:91:70:0D:64:51:D7:FB:56:F0:B2:AB:1D:3B:8E:B0:70:E5:6E:DF:F5 Certificate 3 Alias name: entrustrootcag2 [jdk] Distinguished name: CN=Entrust Root Certification Authority - G2, OU=(c) 2009 Entrust, Inc. - for authorized use only, OU=See www.entrust.net/legal-terms, O=Entrust, Inc., C=US SHA256: 43:DF:57:74:B0:3E:7F:EF:5F:E4:0D:93:1A:7B:ED:F1:BB:2E:6B:42:73:8C:4E:6D:38:41:10:3D:3A:A7:F3:39 Certificate 4 Alias name: entrustrootcag4 [jdk] Distinguished name: CN=Entrust Root Certification Authority - G4, OU=(c) 2015 Entrust, Inc. - for authorized use only, OU=See www.entrust.net/legal-termsO=Entrust, Inc., C=US SHA256: DB:35:17:D1:F6:73:2A:2D:5A:B9:7C:53:3E:C7:07:79:EE:32:70:A6:2F:B4:AC:42:38:37:24:60:E6:F0:1E:88 Certificate 5 Alias name: entrust2048ca [jdk] Distinguished name: CN=Entrust.net Certification Authority (2048), OU=(c) 1999 Entrust.net Limited, OU=www.entrust.net/CPS_2048 incorp. by ref. (limits liab.), O=Entrust.net SHA256: 6D:C4:71:72:E0:1C:BC:B0:BF:62:58:0D:89:5F:E2:B8:AC:9A:D4:F8:73:80:1E:0C:10:B9:C8:37:D2:1E:B1:77 Certificate 6 Alias name: affirmtrustcommercialca [jdk] Distinguished name: CN=AffirmTrust Commercial, O=AffirmTrust, C=US SHA256: 03:76:AB:1D:54:C5:F9:80:3C:E4:B2:E2:01:A0:EE:7E:EF:7B:57:B6:36:E8:A9:3C:9B:8D:48:60:C9:6F:5F:A7 Certificate 7 Alias name: affirmtrustnetworkingca [jdk] Distinguished name: CN=AffirmTrust Networking, O=AffirmTrust, C=US SHA256: 0A:81:EC:5A:92:97:77:F1:45:90:4A:F3:8D:5D:50:9F:66:B5:E2:C5:8F:CD:B5:31:05:8B:0E:17:F3:F0B4:1B Certificate 8 Alias name: affirmtrustpremiumca [jdk] Distinguished name: CN=AffirmTrust Premium, O=AffirmTrust, C=US SHA256: 70:A7:3F:7F:37:6B:60:07:42:48:90:45:34:B1:14:82:D5:BF:0E:69:8E:CC:49:8D:F5:25:77:EB:F2:E9:3B:9A Certificate 9 Alias name: affirmtrustpremiumeccca [jdk] Distinguished name: CN=AffirmTrust Premium ECCO=AffirmTrust, C=US SHA256: BD:71:FD:F6:DA:97:E4:CF:62:D1:64:7A:DD:25:81:B0:7D:79:AD:F8:39:7E:B4:EC:BA:9C:5E:84:88:82:14:23 See JDK-8337664 (JDK Bug System) and JDK-8341059 (JDK Bug System) . Reduced verbose locale output in -XshowSettings launcher option In earlier releases, the -XshowSettings launcher option printed a long list of available locales, which obscured other settings. In OpenJDK 11.0.25, the -XshowSettings launcher option no longer prints the list of available locales by default. If you want to view all settings that relate to the available locales, you can use the -XshowSettings:locale option. See JDK-8310201 (JDK Bug System) . SSL.com root certificates added In OpenJDK 11.0.25, the cacerts truststore includes two SSL.com TLS root certificates: Certificate 1 Name: SSL.com Alias name: ssltlsrootecc2022 Distinguished name: CN=SSL.com TLS ECC Root CA 2022, O=SSL Corporation, C=US Certificate 2 Name: SSL.com Alias name: ssltlsrootrsa2022 Distinguished name: CN=SSL.com TLS RSA Root CA 2022, O=SSL Corporation, C=US See JDK-8341057 (JDK Bug System) . Relaxation of Java Abstract Window Toolkit (AWT) Robot specification OpenJDK 11.0.25 is based on the latest maintenance release of the Java 11 specification. This release relaxes the specification of the following three methods in the java.awt.Robot class: mouseMove(int,int) getPixelColor(int,int) createScreenCapture(Rectangle) This relaxation of the specification allows these methods to fail when the desktop environment does not permit moving the mouse pointer or capturing screen content. See JDK-8307779 (JDK Bug System) . Changes to com.sun.jndi.ldap.object.trustSerialData system property The JDK implementation of the LDAP provider no longer supports the deserialization of Java objects by default. In OpenJDK 11.0.25, the com.sun.jndi.ldap.object.trustSerialData system property is set to false by default. This release also increases the scope of the com.sun.jndi.ldap.object.trustSerialData property to cover the reconstruction of RMI remote objects from the javaRemoteLocation LDAP attribute. These changes mean that transparent deserialization of Java objects now requires an explicit opt-in. From OpenJDK 11.0.25 onward, if you want to allow applications to reconstruct Java objects and RMI stubs from LDAP attributes, you must explicitly set the com.sun.jndi.ldap.object.trustSerialData property to true . See JDK-8290367 (JDK Bug System) and JDK bug system reference ID: JDK-8332643. HTTP client enhancements OpenJDK 11.0.25 limits the maximum header field size that the HTTP client accepts within the JDK for all supported versions of the HTTP protocol. The header field size is computed as the sum of the size of the uncompressed header name, the size of the uncompressed header value, and an overhead of 32 bytes for each field section line. If a peer sends a field section that exceeds this limit, a java.net.ProtocolException is raised. OpenJDK 11.0.25 introduces a jdk.http.maxHeaderSize system property that you can use to change the maximum header field size (in bytes). Alternatively, you can disable the maximum header field size by setting the jdk.http.maxHeaderSize property to zero or a negative value. The jdk.http.maxHeaderSize property is set to 393,216 bytes (that is, 384KB) by default. JDK bug system reference ID: JDK-8328286 ClassLoadingMXBean and MemoryMXBean APIs have isVerbose() methods consistent with their setVerbose() methods The setVerbose(boolean enabled) method for the ClassLoadingMXBean API displays the following behavior: If enabled is true , the setVerbose method sets class+load* logging on standard output (stdout) at the Info level. If enabled is false , the setVerbose method disables class+load* logging on stdout. In earlier releases, the isVerbose() method for the ClassLoadingMXBean API checked if class+load logging was enabled at the Info level on any type of log output, not just stdout. In this situation, if you enabled logging to a file by using the java -Xlog option, the isVerbose() method returned true even if setVerbose(false) was called, which resulted in counterintuitive behavior. The isVerbose() method for the MemoryMXBean API also displayed similar counterintuitive behavior. From OpenJDK 11.0.25 onward, the ClassLoadingMXBean.isVerbose() and MemoryMXBean.isVerbose() methods display the following behavior: ClassLoadingMXBean::isVerbose() returns true only if class+load* logging is enabled at the Info level (or higher) specifically on standard output (stdout). MemoryMXBean::isVerbose() returns true only if garbage collector logging is enabled at the Info level (or higher) on stdout. See JDK-8338139 (JDK Bug System) . Revised on 2024-10-30 10:44:14 UTC	[ "TLS server certificate issued after 2024-11-11 and anchored by a distrusted legacy Entrust root CA: CN=Entrust.net CertificationAuthority (2048), OU=(c) 1999 Entrust.net Limited,OU=www.entrust.net/CPS_2048 incorp. by ref. (limits liab.),O=Entrust.net" ]	https://docs.redhat.com/en/documentation/red_hat_build_of_openjdk/11/html/release_notes_for_eclipse_temurin_11.0.25/openjdk-temurin-features-11-0-23_openjdk
Chapter 5. Upgrading a geo-replication deployment of Red Hat Quay on OpenShift Container Platform	Chapter 5. Upgrading a geo-replication deployment of Red Hat Quay on OpenShift Container Platform Use the following procedure to upgrade your geo-replicated Red Hat Quay on OpenShift Container Platform deployment. Important When upgrading geo-replicated Red Hat Quay on OpenShift Container Platform deployment to the y-stream release (for example, Red Hat Quay 3.7 Red Hat Quay 3.8), you must stop operations before upgrading. There is intermittent downtime down upgrading from one y-stream release to the . It is highly recommended to back up your Red Hat Quay on OpenShift Container Platform deployment before upgrading. Procedure This procedure assumes that you are running the Red Hat Quay registry on three or more systems. For this procedure, we will assume three systems named System A, System B, and System C . System A will serve as the primary system in which the Red Hat Quay Operator is deployed. On System B and System C, scale down your Red Hat Quay registry. This is done by disabling auto scaling and overriding the replica county for Red Hat Quay, mirror workers, and Clair if it is managed. Use the following quayregistry.yaml file as a reference: apiVersion: quay.redhat.com/v1 kind: QuayRegistry metadata: name: registry namespace: ns spec: components: ... - kind: horizontalpodautoscaler managed: false 1 - kind: quay managed: true overrides: 2 replicas: 0 - kind: clair managed: true overrides: replicas: 0 - kind: mirror managed: true overrides: replicas: 0 ... 1 Disable auto scaling of Quay , Clair and Mirroring workers 2 Set the replica count to 0 for components accessing the database and objectstorage Note You must keep the Red Hat Quay registry running on System A. Do not update the quayregistry.yaml file on System A. Wait for the registry-quay-app , registry-quay-mirror , and registry-clair-app pods to disappear. Enter the following command to check their status: oc get pods -n <quay-namespace> Example output quay-operator.v3.7.1-6f9d859bd-p5ftc 1/1 Running 0 12m quayregistry-clair-postgres-7487f5bd86-xnxpr 1/1 Running 1 (12m ago) 12m quayregistry-quay-app-upgrade-xq2v6 0/1 Completed 0 12m quayregistry-quay-redis-84f888776f-hhgms 1/1 Running 0 12m On System A, initiate a Red Hat Quay upgrade to the latest y-stream version. This is a manual process. For more information about upgrading installed Operators, see Upgrading installed Operators . For more information about Red Hat Quay upgrade paths, see Upgrading the Red Hat Quay Operator . After the new Red Hat Quay registry is installed, the necessary upgrades on the cluster are automatically completed. Afterwards, new Red Hat Quay pods are started with the latest y-stream version. Additionally, new Quay pods are scheduled and started. Confirm that the update has properly worked by navigating to the Red Hat Quay UI: In the OpenShift console, navigate to Operators Installed Operators , and click the Registry Endpoint link. Important Do not execute the following step until the Red Hat Quay UI is available. Do not upgrade the Red Hat Quay registry on System B and on System C until the UI is available on System A. Confirm that the update has properly worked on System A, initiate the Red Hat Quay upgrade on System B and on System C. The Operator upgrade results in an upgraded Red Hat Quay installation, and the pods are restarted. Note Because the database schema is correct for the new y-stream installation, the new pods on System B and on System C should quickly start. After updating, revert the changes made in step 1 of this procedure by removing overrides for the components. For example: apiVersion: quay.redhat.com/v1 kind: QuayRegistry metadata: name: registry namespace: ns spec: components: ... - kind: horizontalpodautoscaler managed: true 1 - kind: quay managed: true - kind: clair managed: true - kind: mirror managed: true ... 1 If the horizontalpodautoscaler resource was set to true before the upgrade procedure, or if you want Red Hat Quay to scale in case of a resource shortage, set it to true .	[ "apiVersion: quay.redhat.com/v1 kind: QuayRegistry metadata: name: registry namespace: ns spec: components: ... - kind: horizontalpodautoscaler managed: false 1 - kind: quay managed: true overrides: 2 replicas: 0 - kind: clair managed: true overrides: replicas: 0 - kind: mirror managed: true overrides: replicas: 0 ...", "get pods -n <quay-namespace>", "quay-operator.v3.7.1-6f9d859bd-p5ftc 1/1 Running 0 12m quayregistry-clair-postgres-7487f5bd86-xnxpr 1/1 Running 1 (12m ago) 12m quayregistry-quay-app-upgrade-xq2v6 0/1 Completed 0 12m quayregistry-quay-redis-84f888776f-hhgms 1/1 Running 0 12m", "apiVersion: quay.redhat.com/v1 kind: QuayRegistry metadata: name: registry namespace: ns spec: components: ... - kind: horizontalpodautoscaler managed: true 1 - kind: quay managed: true - kind: clair managed: true - kind: mirror managed: true ..." ]	https://docs.redhat.com/en/documentation/red_hat_quay/3/html/upgrade_red_hat_quay/upgrading-geo-repl-quay-operator
2.8. Active Directory Authentication Using Kerberos (GSSAPI)	2.8. Active Directory Authentication Using Kerberos (GSSAPI) When using Red Hat JBoss Data Grid with Microsoft Active Directory, data security can be enabled via Kerberos authentication. To configure Kerberos authentication for Microsoft Active Directory, use the following procedure. Procedure 2.6. Configure Kerberos Authentication for Active Directory (Library Mode) Configure JBoss EAP server to authenticate itself to Kerberos. This can be done by configuring a dedicated security domain, for example: The security domain for authentication must be configured correctly for JBoss EAP, an application must have a valid Kerberos ticket. To initiate the Kerberos ticket, you must reference another security domain using . This points to the standard Kerberos login module described in Step 3. The security domain authentication configuration described in the step points to the following standard Kerberos login module: Report a bug	[ "<security-domain name=\"ldap-service\" cache-type=\"default\"> <authentication> <login-module code=\"Kerberos\" flag=\"required\"> <module-option name=\"storeKey\" value=\"true\"/> <module-option name=\"useKeyTab\" value=\"true\"/> <module-option name=\"refreshKrb5Config\" value=\"true\"/> <module-option name=\"principal\" value=\"ldap/[email protected]\"/> <module-option name=\"keyTab\" value=\"USD{basedir}/keytab/ldap.keytab\"/> <module-option name=\"doNotPrompt\" value=\"true\"/> </login-module> </authentication> </security-domain>", "<module-option name=\"usernamePasswordDomain\" value=\"krb-admin\"/>", "<security-domain name=\"ispn-admin\" cache-type=\"default\"> <authentication> <login-module code=\"SPNEGO\" flag=\"requisite\"> <module-option name=\"password-stacking\" value=\"useFirstPass\"/> <module-option name=\"serverSecurityDomain\" value=\"ldap-service\"/> <module-option name=\"usernamePasswordDomain\" value=\"krb-admin\"/> </login-module> <login-module code=\"AdvancedAdLdap\" flag=\"required\"> <module-option name=\"password-stacking\" value=\"useFirstPass\"/> <module-option name=\"bindAuthentication\" value=\"GSSAPI\"/> <module-option name=\"jaasSecurityDomain\" value=\"ldap-service\"/> <module-option name=\"java.naming.provider.url\" value=\"ldap://localhost:389\"/> <module-option name=\"baseCtxDN\" value=\"ou=People,dc=infinispan,dc=org\"/> <module-option name=\"baseFilter\" value=\"(krb5PrincipalName={0})\"/> <module-option name=\"rolesCtxDN\" value=\"ou=Roles,dc=infinispan,dc=org\"/> <module-option name=\"roleFilter\" value=\"(member={1})\"/> <module-option name=\"roleAttributeID\" value=\"cn\"/> </login-module> </authentication> </security-domain>", "<security-domain name=\"krb-admin\" cache-type=\"default\"> <authentication> <login-module code=\"Kerberos\" flag=\"required\"> <module-option name=\"useKeyTab\" value=\"true\"/> <module-option name=\"principal\" value=\"[email protected]\"/> <module-option name=\"keyTab\" value=\"USD{basedir}/keytab/admin.keytab\"/> </login-module> </authentication> </security-domain>" ]	https://docs.redhat.com/en/documentation/red_hat_data_grid/6.6/html/security_guide/active_directory_authentication_using_kerberos_gssapi
C.9. DistributionManager	C.9. DistributionManager org.infinispan.distribution.DistributionManagerImpl The DistributionManager component handles the distribution of content across a cluster. Note The DistrubutionManager component is only available in clustered mode. Table C.16. Operations Name Description Signature isAffectedByRehash Determines whether a given key is affected by an ongoing rehash. boolean isAffectedByRehash(Object p0) isLocatedLocally Indicates whether a given key is local to this instance of the cache. Only works with String keys. boolean isLocatedLocally(String p0) locateKey Locates an object in a cluster. Only works with String keys. List locateKey(String p0) 23149%2C+Administration+and+Configuration+Guide-6.628-06-2017+13%3A51%3A02JBoss+Data+Grid+6Documentation6.6.1 Report a bug	null	https://docs.redhat.com/en/documentation/red_hat_data_grid/6.6/html/administration_and_configuration_guide/distributionmanager
21.14. virt-sparsify: Reclaiming Empty Disk Space	21.14. virt-sparsify: Reclaiming Empty Disk Space The virt-sparsify command-line tool can be used to make a virtual machine disk (or any disk image) sparse. This is also known as thin-provisioning. Free disk space on the disk image is converted to free space on the host. The virt-sparsify command can work with most filesystems, such as ext2, ext3, ext4, btrfs, NTFS. It also works with LVM physical volumes. virt-sparsify can operate on any disk image, not just virtual machine disk images. Warning Using virt-sparsify on live virtual machines, or concurrently with other disk editing tools can cause disk corruption. The virtual machine must be shut down before using this command. In addition, disk images should not be edited concurrently. The command can also be used to convert between some disk formats. For example, virt-sparsify can convert a raw disk image to a thin-provisioned qcow2 image. Note If a virtual machine has multiple disks and uses volume management, virt-sparsify will work, but it will not be very effective. If the input is raw , then the default output is raw sparse . The size of the output image must be checked using a tool that understands sparseness. Note that the ls command shows the image size to be 100M. However, the du command correctly shows the image size to be 3.6M. Important limitations The following is a list of important limitations: The virtual machine must be shutdown before using virt-sparsify . In a worst case scenario, virt-sparsify may require up to twice the virtual size of the source disk image. One for the temporary copy and one for the destination image. If you use the --in-place option, large amounts of temporary space are not needed. virt-sparsify cannot be used to resize disk images. To resize disk images, use virt-resize . For information about virt-resize , see Section 21.8, "virt-resize: Resizing Guest Virtual Machines Offline" . virt-sparsify does not work with encrypted disks, because encrypted disks cannot be sparsified. virt-sparsify cannot sparsify the space between partitions. This space is often used for critical items like bootloaders, so it is not really unused space. In copy mode, qcow2 internal snapshots are not copied to the destination image. Examples To install virt-sparsify , run one of the following commands: # yum install /usr/bin/virt-sparsify or # yum install libguestfs-tools-c To sparsify a disk: # virt-sparsify /dev/sda1 /dev/device Copies the contents of /dev/sda1 to /dev/device , making the output sparse. If /dev/device already exists, it is overwritten. The format of /dev/sda1 is detected and used as the format for /dev/device . To convert between formats: # virt-sparsify disk .raw --convert qcow2 disk .qcow2 Tries to zero and sparsify free space on every filesystem it can find within the source disk image. To prevent free space from being overwritten with zeros on certain filesystems: # virt-sparsify --ignore /dev/device /dev/sda1 /dev/device Creates sparsified disk images from all filesystems in the disk image, without overwriting free space on the filesystems with zeros. To make a disk image sparse without creating a temporary copy: # virt-sparsify --in-place disk .img Makes the specified disk image sparse, overwriting the image file. virt-sparsify options The following command options are available to use with virt-sparsify : Table 21.4. virt-sparsify options Command Description Example --help Displays a brief help entry about a particular command or about the virt-sparsify utility. For additional help, see the virt-sparsify man page. virt-sparsify --help --check-tmpdir ignore \| continue \| warn \| fail Estimates if tmpdir has enough space to complete the operation. The specified option determines the behavior if there is not enough space to complete the operation. ignore : The issue is ignored and the operation continues. continue : Reports an error and the operation continues. warn : Reports an error and waits for the user to press Enter. fail : Reports an error and aborts the operation. This option cannot be used with the ‐‐in-place option. virt-sparsify --check-tmpdir ignore /dev/sda1 /dev/device virt-sparsify --check-tmpdir continue /dev/sda1 /dev/device virt-sparsify --check-tmpdir warn /dev/sda1 /dev/device virt-sparsify --check-tmpdir fail /dev/sda1 /dev/device --compress Compresses the output file. This only works if the output format is qcow2. This option cannot be used with the ‐‐in-place option. virt-sparsify --compress /dev/sda1 /dev/device --convert Creates the sparse image using a specified format. If no format is specified, the input format is used. The following output formats are supported and known to work: raw, qcow, vdi You can use any format supported by the QEMU emulator. It is recommended that you use the --convert option. This way, virt-sparsify does not need to guess the input format. This option cannot be used with the ‐‐in-place option. virt-sparsify --convert raw /dev/sda1 /dev/device virt-sparsify --convert qcow2 /dev/sda1 /dev/device virt-sparsify --convert other_format indisk outdisk --format Specifies the format of the input disk image. If not specified, the format is detected from the image. When working with untrusted raw-format guest disk images, ensure to specify the format. virt-sparsify --format raw /dev/sda1 /dev/device virt-sparsify --format qcow2 /dev/sda1 /dev/device --ignore Ignores the specified file system or volume group. When a filesystem is specified and the --in-place option is not specified, free space on the filesystem is not zeroed. However, existing blocks of zeroes are sparsified. When the ‐‐in-place option is specified, the filesystem is completely ignored. When a volume group is specified, the volume group is ignored. The volume group name should be used without the /dev/ prefix. For example, ‐‐ignore vg_foo The --ignore option can be included in the command multiple times. virt-sparsify --ignore filesystem1 /dev/sda1 /dev/device virt-sparsify --ignore volume_group /dev/sda1 /dev/device --in-place Makes an image sparse in-place, instead of making a temporary copy. Although in-place sparsification is more efficient than copying sparsification, it cannot recover quite as much disk space as copying sparsification. In-place sparsification works using discard (also known as trim or unmap) support. To use in-place sparsification, specify a disk image that will be sparsified in-place. When specifying in-place sparsification, the following options cannot be used: --convert and --compress , because they require wholesale disk format changes. --check-tmpdir , because large amounts of temporary space are not required. virt-sparsify --in-place disk.img -x Enables tracing of libguestfs API calls. virt-sparsify -x filesystem1 /dev/sda1 /dev/device For more information, including additional options, see libguestfs.org .	[ "ls -lh test1.img -rw-rw-r--. 1 rjones rjones 100M Aug 8 08:08 test1.img du -sh test1.img 3.6M test1.img" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/virtualization_deployment_and_administration_guide/virt-sparsify
Chapter 3. Diagnosing performance issues	Chapter 3. Diagnosing performance issues 3.1. Enabling garbage collection logging Examining garbage collection logs can be useful when attempting to troubleshoot Java performance issues, especially those related to memory usage. Other than some additional disk I/O activity for writing the log files, enabling garbage collection logging does not significantly affect server performance. Garbage collection logging is already enabled by default for a standalone JBoss EAP server running on OpenJDK or Oracle JDK. For a JBoss EAP managed domain, garbage collection logging can be enabled for the host controller, process controller, or individual JBoss EAP servers. Get the correct JVM options for enabling garbage collection logging for your JDK. Replace the path in the options below to where you want the log to be created. Note The Red Hat Customer Portal has a JVM Options Configuration Tool that can help you generate optimal JVM settings. For OpenJDK 11 or Oracle JDK 11: For versions 9 or later of OpenJDK, Oracle JDK, or any JDK that supports JEP 271: Additional resources For more information about JEP 271, see JEP 271: Unified GC Logging on the OpenJDK web page. 3.2. Java heap dumps A Java heap dump is a snapshot of a JVM heap created at a certain point in time. Creating and analyzing heap dumps can be useful for diagnosing and troubleshooting issues with Java applications. Depending on which JDK you are using, there are different ways of creating and analyzing a Java heap dump for a JBoss EAP process. This section covers common methods for Oracle JDK and OpenJDK. 3.2.1. Creating a heap dump using OpenJDK and Oracle JDK 3.2.1.1. Create an on-demand heap dump You can use the jcmd command to create an on-demand heap dump for JBoss EAP running on OpenJDK or Oracle JDK. Procedure Determine the process ID of the JVM that you want to create a heap dump from. Create the heap dump with the following command: This creates a heap dump file in the HPROF format, usually located in EAP_HOME or EAP_HOME /bin . Alternatively, you can specify a file path to another directory. 3.2.1.2. Create a heap dump automatically on OutOfMemoryError You can use the -XX:+HeapDumpOnOutOfMemoryError JVM option to automatically create a heap dump when an OutOfMemoryError exception is thrown. This creates a heap dump file in the HPROF format, usually located in EAP_HOME or EAP_HOME /bin . Alternatively, you can set a custom path for the heap dump using -XX:HeapDumpPath= /path/ . If you specify a file name using -XX:HeapDumpPath , for example, -XX:HeapDumpPath= /path/filename.hprof , the heap dumps will overwrite each other. 3.2.2. Analyzing a heap dump 3.2.2.1. Heap dump analysis tools There are many tools that can analyze heap dump files and help identify issues. Red Hat Support recommends using the Eclipse Memory Analyzer tool (MAT) , which can analyze heap dumps formatted in either HPROF or PHD formats. Additional resources For information on using Eclipse MAT, see the Eclipse MAT documentation . 3.2.2.2. Heap dump analysis tips Sometimes the cause of the heap performance issues are obvious, but other times you may need an understanding of your application's code and the specific circumstances that cause issues like an OutOfMemoryError . This can help to identify whether an issue is a memory leak, or if the heap is just not large enough. Some suggestions for identifying memory usage issues include: If a single object is not found to be consuming too much memory, try grouping by class to see if many small objects are consuming a lot of memory. Check if the biggest usage of memory is a thread. A good indicator of this is if the OutOfMemoryError -triggered heap dump is much smaller than the specified Xmx maximum heap size. A technique to make memory leaks more detectable is to temporarily double the normal maximum heap size. When an OutOfMemoryError occurs, the size of the objects related to the memory leak will be about half the size of the heap. When the source of a memory issue is identified, you can view the paths from garbage collection roots to see what is keeping the objects alive. 3.3. Java Flight Recorder 3.3.1. About Java Flight Recorder The Oracle JDK Mission Control user guide describes Java Flight Recorder (JFR) as a "profiling and event collection framework". Developers can use JFR with JDK Mission Control (JMC) to collect data about Java Virtual Machines (JVMs) and other Java applications. Developers can use this data to identify and fix performance issues. JFR has been carefully designed so that it requires a low level of overhead (consumption of resources). This means that JFR profiling can run continuously in certain production environments with minimal impact. Developers can use JFR and JMC to quickly analyze runtime information after an incident. Note JFR is available from Java OpenJDK 8u262 or later as part of the Java Diagnostic Command Tool. Additional resources For more information about JFR, see section Flight Recorder in the Oracle JDK Mission Control user guide . 3.3.2. Java Flight Recorder profiling configurations Developers can modify the profiling configurations to customize their instance of Java Flight Recorder (JFR). Two different profiling configurations are available with JFR: default : provides a sparse sampling of information; low profiling detail profile : provides a more comprehensive sampling of information; medium profiling detail Developers can modify either configuration files to enable additional event metrics sampling. 3.3.3. Enable Java Flight Recorder profile capture Developers can use Java Flight Recorder (JFR) to profile a JBoss EAP installation on bare metal or using Red Hat OpenShift Container Platform. To learn about using JFR with OpenShift, see Introduction to Cryostat: JDK Flight Recorder for containers . 3.3.3.1. Enable Java Flight Recorder profiling on bare metal Developers can start a Java Flight Recorder (JFR) profile using the command line or the Java Management Extensions (JMX) with the Java Mission Control (JMC) desktop application. 3.3.3.2. Configure Java Flight Recorder profiling for JBoss EAP using Java Virtual Machine configuration flags You can use configuration flags to configure Java Flight Recorder (JFR) profiling with JBoss EAP on Java Virtual Machines (JVMs). Example JVM configuration The StartFlightRecording=delay configuration flag allows you to set the amount of time JFR waits after the JVM boots before starting a profiling session. In the preceding example, StartFlightRecording=delay is set to 15 seconds, which means profiling will start after a 15 second delay. The duration configuration flag allows you to set the length of time for each profiling session. In the preceding example, duration is set to 60 seconds. The name configuration flag allows you to set the in memory profile name. In this example, the in memory profile name is set to jboss-eap-profile . The filename configuration flag allows you to set the filename and path where you would like the file to be saved. In this example, filename is set to C:\TEMP\jboss-eap-profile.jfr . The settings configuration flag allows you to select a profiling configuration. In this example, settings is set to default . Note that the file extension for the profiling configuration is excluded. After the profiling session is complete, a file will be created at the file path defined by the filename option. 3.3.3.3. Profiling using Java command tool for a running JBoss EAP Java Virtual Machine You can use the Java Flight Recorder (JFR) JFR.start command to configure a running JBoss EAP Java Virtual Machine (JVM) for profiling using the Java command tool, jcmd . Procedure Use one of the following commands: For a Linux operating system: For example: JFR.start command for Linux example Once a JFR profiling session starts, you will receive the following confirmation message: For a Windows operating system: For example: JFR.start command for Windows example Once a JFR profiling session starts, you will receive the following confirmation message: The duration option allows you to set the length of time for each profiling session. In the preceding example commands, duration is set to 60 seconds. The filename option allows you to set the filename and path where you would like the file to be saved. In the preceding example commands, filename is set to /tmp/jboss-eap-profile.jfr in the Linux example, and C:\TEMP\jboss-eap-profile.jfr in the Windows example. 3.3.3.4. Connect a local Java Virtual Machine using Java Mission Control You can use Java Mission Control (JMC) to connect a local Java Virtual Machine (JVM) running on the same server as your instance of JMC. Prerequisites Java Mission Control with JBoss EAP libraries is configured. See How to connect Java Mission Control with EAP remotely? for instructions. JBoss EAP is configured for remote monitoring connections, and a user is created in the ApplicationRealm for monitoring. Procedure Open Java Mission Control. In the JVM Browser pane, select the JVM to profile. Expand the dropdown menu for the JVM to reveal the Flight Recorder item. Right click Flight Recorder to open the sub-menu, select Start Flight Recording... . Figure 3.1. JVM Browser in JMC In the Start Flight Recording window configure options for profiling. Figure 3.2. JVM profiling settings Click for detailed low level settings. Figure 3.3. JVM profiling advanced settings Click Finish to start profiling. 3.3.3.5. Connect a remote Java Virtual Machine using Java Mission Control You can use Java Mission Control (JMC) to connect to a remote Java Virtual Machine (JVM) profile. Prerequisites Configure Java Mission Control with JBoss EAP libraries. See How to connect Java Mission Control with EAP remotely? for instructions. Configure JBoss EAP for remote monitoring connections, with a user created in the ApplicationRealm for monitoring. Procedure Open Java Mission Control. In the File menu, select Connect . In the Connect window, select Create a new connection , then click . Figure 3.4. Connect window in JMC In the JVM Connection window, complete the details for your remote JBoss EAP JVM to be profiled. Figure 3.5. JVM connection details in JMC In the Host field, add your hostname or an IP address. In the Port field, add your port number. In the User field, add the user that you created in the ApplicationRealm . In the Password field, add your password created in the ApplicationRealm . Optional To store credentials in a settings file, click the checkbox to Store credentials in settings file . Click Custom JMX Service URL to override the default setting. Figure 3.6. JMX Service URL for JVM connection Change the JMX service URL to define the JBoss remoting protocol. Click Test connection to verify your settings. Click Finish to save your settings. A JMXRMI Preferences not set warning message will appear. Figure 3.7. JMXRMI preferences warning message Click OK to accept the connection attempt. In the JVM Browser pane, select the JVM to profile. Expand the dropdown menu for the JVM to reveal the Flight Recorder item. Right click Flight Recorder to open the sub-menu, then select Start Flight Recording... . Figure 3.8. Connect a remote JVM using JMC profile menu In the Start Flight Recording window configure options for profiling. Figure 3.9. JVM profiling settings Click for detailed low level settings. Figure 3.10. JVM profiling advanced settings Click Finish to start profiling. 3.4. Identifying high CPU utilization by Java threads Note For customers using JBoss EAP on Red Hat Enterprise Linux or Solaris, the JVMPeg lab tool on the Red Hat Customer Portal helps collect and analyze Java thread information to identify high CPU utilization. Follow the instructions for using the JVMPeg lab tool instead of using the following procedure. For OpenJDK and Oracle JDK environments, Java thread diagnostic information is available using the jstack utility. Identify the process ID of the Java process that is utilizing a high percentage of the CPU. It can also be useful to obtain per-thread CPU data on high-usage processes. This can be done using the top -H command on Red Hat Enterprise Linux systems. Using the jstack utility, create a stack dump of the Java process. For example, on Linux and Solaris: You might need to create multiple dumps at intervals to see any changes or trends over a period of time. Analyze the stack dumps. You can use a tool such as the Thread Dump Analyzer (TDA) . 3.5. Runtime statistics for managed executor services and managed scheduled executor services You can monitor the performance of managed executor services and managed scheduled executor services by viewing the runtime statistics generated with the management CLI attributes. You can view the runtime statistics for a standalone server or for an individual server mapped to a host. Important The domain.xml configuration does not include a resource for the runtime statistic management CLI attributes, so you cannot use the management CLI attributes to view the runtime statistics for a managed domain. Table 3.1. Displays management CLI attributes for monitoring the performance of managed executor services and of managed scheduled executor services. Attribute Description active-thread-count The approximate number of threads that are actively executing tasks. completed-task-count The approximate total number of tasks that have completed execution. hung-thread-count The number of executor threads that are hung. max-thread-count The largest number of executor threads. current-queue-size The current size of the executor's task queue. task-count The approximate total number of tasks that have been submitted for execution. thread-count The current number of executor threads. Example of viewing the runtime statistics for a managed executor service running on a standalone server. Example of the runtime statistics for a managed scheduled executor service running on a standalone server. Example of viewing the runtime statistics for a managed executor service running on a server mapped to a host. Example of the runtime statistics for a managed scheduled executor service running on a server mapped to a host.	[ "-verbose:gc -Xloggc: <path_to_directory> /gc.log -XX:+PrintGCDetails -XX:+PrintGCDateStamps -XX:+UseGCLogFileRotation -XX:NumberOfGCLogFiles=5 -XX:GCLogFileSize=3M -XX:-TraceClassUnloading", "-Xlog:gc*:file= <path_to_directory> /gc.log:time,uptimemillis:filecount=5,filesize=3M", "jcmd JAVA_PID GC.heap_dump -all=true FILENAME .hprof", "-XX:StartFlightRecording=delay=15s,duration=60s,name=jboss-eap-profile, filename=C:\\TEMP\\jboss-eap-profile.jfr,settings=default", "jcmd <PID> JFR.start duration= TIME filename= path/to/YOUR_PROFILE_NAME .jfr", "jcmd <PID> JFR.start duration=60s filename=/tmp/jboss-eap-profile.jfr", "jcmd <PID> JFR.start duration=60s filename=/tmp/jboss-eap-profile.jfr <PID>: Started recording 1. The result will be written to: /tmp/jboss-eap-profile.jfr", "> jcmd.exe <PID> JFR.start duration= TIME filename= path/to/YOUR_PROFILE_NAME .jfr", "> jcmd.exe <PID> JFR.start duration=60s filename=C:\\TEMP\\jboss-eap-profile.jfr", "> jcmd.exe <PID> JFR.start duration=60s filename=C:\\TEMP\\jboss-eap-profile.jfr <PID>: Started recording 1. The result will be written to: C:\\TEMP\\jboss-eap-profile.jfr", "service:jmx:remote+http://<host>:9990", "jstack -l JAVA_PROCESS_ID > high-cpu-tdump.out", "[standalone@localhost:9990 /] /subsystem=ee/managed-executor-service=default:read-resource(include-runtime=true,recursive=true)", "[standalone@localhost:9990 /] /subsystem=ee/managed-scheduled-executor-service=default:read-resource(include-runtime=true,recursive=true)", "[domain@localhost:9990 /] /host= <host_name> /server= <server_name> /subsystem=ee/managed-executor-service=default:read-resource(include-runtime=true,recursive=true)", "[domain@localhost:9990 /] /host= <host_name> /server= <server_name> /subsystem=ee/managed-scheduled-executor-service=default:read-resource(include-runtime=true,recursive=true)" ]	https://docs.redhat.com/en/documentation/red_hat_jboss_enterprise_application_platform/8.0/html/performance_tuning_for_red_hat_jboss_enterprise_application_platform/assembly-diagnosing-performance-issues_performance-tuning-guide
Chapter 5. Configuring Satellite Server with external services	Chapter 5. Configuring Satellite Server with external services If you do not want to configure the DNS, DHCP, and TFTP services on Satellite Server, use this section to configure your Satellite Server to work with external DNS, DHCP, and TFTP services. 5.1. Configuring Satellite Server with external DNS You can configure Satellite Server with external DNS. Satellite Server uses the nsupdate utility to update DNS records on the remote server. To make any changes persistent, you must enter the satellite-installer command with the options appropriate for your environment. Prerequisites You must have a configured external DNS server. This guide assumes you have an existing installation. Procedure Copy the /etc/rndc.key file from the external DNS server to Satellite Server: Configure the ownership, permissions, and SELinux context: To test the nsupdate utility, add a host remotely: Enter the satellite-installer command to make the following persistent changes to the /etc/foreman-proxy/settings.d/dns.yml file: In the Satellite web UI, navigate to Infrastructure > Capsules . Locate the Satellite Server and select Refresh from the list in the Actions column. Associate the DNS service with the appropriate subnets and domain. 5.2. Configuring Satellite Server with external DHCP To configure Satellite Server with external DHCP, you must complete the following procedures: Section 5.2.1, "Configuring an external DHCP server to use with Satellite Server" Section 5.2.2, "Configuring Satellite Server with an external DHCP server" 5.2.1. Configuring an external DHCP server to use with Satellite Server To configure an external DHCP server running Red Hat Enterprise Linux to use with Satellite Server, you must install the ISC DHCP Service and Berkeley Internet Name Domain (BIND) utilities packages. You must also share the DHCP configuration and lease files with Satellite Server. The example in this procedure uses the distributed Network File System (NFS) protocol to share the DHCP configuration and lease files. Note If you use dnsmasq as an external DHCP server, enable the dhcp-no-override setting. This is required because Satellite creates configuration files on the TFTP server under the grub2/ subdirectory. If the dhcp-no-override setting is disabled, hosts fetch the bootloader and its configuration from the root directory, which might cause an error. Procedure On your Red Hat Enterprise Linux host, install the ISC DHCP Service and Berkeley Internet Name Domain (BIND) utilities packages: Generate a security token: Edit the dhcpd configuration file for all subnets and add the key generated by tsig-keygen . The following is an example: Note that the option routers value is the IP address of your Satellite Server or Capsule Server that you want to use with an external DHCP service. On Satellite Server, define each subnet. Do not set DHCP Capsule for the defined Subnet yet. To prevent conflicts, set up the lease and reservation ranges separately. For example, if the lease range is 192.168.38.10 to 192.168.38.100, in the Satellite web UI define the reservation range as 192.168.38.101 to 192.168.38.250. Configure the firewall for external access to the DHCP server: Make the changes persistent: On Satellite Server, determine the UID and GID of the foreman user: On the DHCP server, create the foreman user and group with the same IDs as determined in a step: To ensure that the configuration files are accessible, restore the read and execute flags: Enable and start the DHCP service: Export the DHCP configuration and lease files using NFS: Create directories for the DHCP configuration and lease files that you want to export using NFS: To create mount points for the created directories, add the following line to the /etc/fstab file: Mount the file systems in /etc/fstab : Ensure the following lines are present in /etc/exports : Note that the IP address that you enter is the Satellite or Capsule IP address that you want to use with an external DHCP service. Reload the NFS server: Configure the firewall for DHCP omapi port 7911: Optional: Configure the firewall for external access to NFS. Clients are configured using NFSv3. Make the changes persistent: 5.2.2. Configuring Satellite Server with an external DHCP server You can configure Satellite Server with an external DHCP server. Prerequisites Ensure that you have configured an external DHCP server and that you have shared the DHCP configuration and lease files with Satellite Server. For more information, see Section 5.2.1, "Configuring an external DHCP server to use with Satellite Server" . Procedure Install the nfs-utils package: Create the DHCP directories for NFS: Change the file owner: Verify communication with the NFS server and the Remote Procedure Call (RPC) communication paths: Add the following lines to the /etc/fstab file: Mount the file systems on /etc/fstab : To verify that the foreman-proxy user can access the files that are shared over the network, display the DHCP configuration and lease files: Enter the satellite-installer command to make the following persistent changes to the /etc/foreman-proxy/settings.d/dhcp.yml file: Associate the DHCP service with the appropriate subnets and domain. 5.3. Using Infoblox as DHCP and DNS providers You can use Satellite Server to connect to your Infoblox application to create and manage DHCP and DNS records, and to reserve IP addresses. The supported Infoblox version is NIOS 8.0 or higher. 5.3.1. Infoblox limitations All DHCP and DNS records can be managed only in a single Network or DNS view. After you install the Infoblox modules on Satellite Server and set up the view using the satellite-installer command, you cannot edit the view. Satellite Server communicates with a single Infoblox node by using the standard HTTPS web API. If you want to configure clustering and High Availability, make the configurations in Infoblox. Hosting PXE-related files by using the TFTP functionality of Infoblox is not supported. You must use Satellite Server as a TFTP server for PXE provisioning. For more information, see Configuring networking in Provisioning hosts . Satellite IPAM feature cannot be integrated with Infoblox. 5.3.2. Infoblox prerequisites You must have Infoblox account credentials to manage DHCP and DNS entries in Satellite. Ensure that you have Infoblox administration roles with the names: DHCP Admin and DNS Admin . The administration roles must have permissions or belong to an admin group that permits the accounts to perform tasks through the Infoblox API. 5.3.3. Installing the Infoblox CA certificate You must install Infoblox HTTPS CA certificate on the base system of Satellite Server. Procedure Download the certificate from the Infoblox web UI or you use the following OpenSSL commands to download the certificate: The infoblox.example.com entry must match the host name for the Infoblox application in the X509 certificate. Verification Test the CA certificate by using a curl query: Example positive response: 5.3.4. Installing the DHCP Infoblox module Install the DHCP Infoblox module on Satellite Server. Note that you cannot manage records in separate views. You can also install DHCP and DNS Infoblox modules simultaneously by combining this procedure and Section 5.3.5, "Installing the DNS Infoblox module" . DHCP Infoblox record type considerations If you want to use the DHCP and DNS Infoblox modules together, configure the DHCP Infoblox module with the fixedaddress record type only. The host record type causes DNS conflicts and is not supported. If you configure the DHCP Infoblox module with the host record type, you have to unset both DNS Capsule and Reverse DNS Capsule options on your Infoblox-managed subnets, because Infoblox does DNS management by itself. Using the host record type leads to creating conflicts and being unable to rename hosts in Satellite. Procedure On Satellite Server, enter the following command: Optional: In the Satellite web UI, navigate to Infrastructure > Capsules , select the Capsule with the DHCP Infoblox module, and ensure that the dhcp feature is listed. In the Satellite web UI, navigate to Infrastructure > Subnets . For all subnets managed through Infoblox, ensure that the IP address management ( IPAM ) method of the subnet is set to DHCP . 5.3.5. Installing the DNS Infoblox module Install the DNS Infoblox module on Satellite Server. You can also install DHCP and DNS Infoblox modules simultaneously by combining this procedure and Section 5.3.4, "Installing the DHCP Infoblox module" . Procedure On Satellite Server, enter the following command to configure the Infoblox module: Optionally, you can change the value of the --foreman-proxy-plugin-dns-infoblox-dns-view option to specify an Infoblox DNS view other than the default view. Optional: In the Satellite web UI, navigate to Infrastructure > Capsules , select the Capsule with the Infoblox DNS module, and ensure that the dns feature is listed. In the Satellite web UI, navigate to Infrastructure > Domains . For all domains managed through Infoblox, ensure that the DNS Proxy is set for those domains. In the Satellite web UI, navigate to Infrastructure > Subnets . For all subnets managed through Infoblox, ensure that the DNS Capsule and Reverse DNS Capsule are set for those subnets. 5.4. Configuring Satellite Server with external TFTP You can configure Satellite Server with external TFTP services. Procedure Create the TFTP directory for NFS: In the /etc/fstab file, add the following line: Mount the file systems in /etc/fstab : Enter the satellite-installer command to make the following persistent changes to the /etc/foreman-proxy/settings.d/tftp.yml file: If the TFTP service is running on a different server than the DHCP service, update the tftp_servername setting with the FQDN or IP address of the server that the TFTP service is running on: In the Satellite web UI, navigate to Infrastructure > Capsules . Locate the Satellite Server and select Refresh from the list in the Actions column. Associate the TFTP service with the appropriate subnets and domain. 5.5. Configuring Satellite Server with external IdM DNS When Satellite Server adds a DNS record for a host, it first determines which Capsule is providing DNS for that domain. It then communicates with the Capsule that is configured to provide DNS service for your deployment and adds the record. The hosts are not involved in this process. Therefore, you must install and configure the IdM client on the Satellite or Capsule that is currently configured to provide a DNS service for the domain you want to manage by using the IdM server. Satellite Server can be configured to use a Red Hat Identity Management (IdM) server to provide DNS service. For more information about Red Hat Identity Management, see the Red Hat Enterprise Linux 7 Linux Domain Identity, Authentication, and Policy Guide . To configure Satellite Server to use a Red Hat Identity Management (IdM) server to provide DNS service, use one of the following procedures: Section 5.5.1, "Configuring dynamic DNS update with GSS-TSIG authentication" Section 5.5.2, "Configuring dynamic DNS update with TSIG authentication" To revert to internal DNS service, use the following procedure: Section 5.5.3, "Reverting to internal DNS service" Note You are not required to use Satellite Server to manage DNS. When you are using the realm enrollment feature of Satellite, where provisioned hosts are enrolled automatically to IdM, the ipa-client-install script creates DNS records for the client. Configuring Satellite Server with external IdM DNS and realm enrollment are mutually exclusive. For more information about configuring realm enrollment, see Section 5.6, "Configuring Satellite to manage the lifecycle of a host registered to a Identity Management realm" . 5.5.1. Configuring dynamic DNS update with GSS-TSIG authentication You can configure the IdM server to use the generic security service algorithm for secret key transaction (GSS-TSIG) technology defined in RFC3645 . To configure the IdM server to use the GSS-TSIG technology, you must install the IdM client on the Satellite Server base operating system. Prerequisites You must ensure the IdM server is deployed and the host-based firewall is configured correctly. For more information, see Port requirements for IdM in Red Hat Enterprise Linux 9 Installing Identity Management or Port requirements for IdM in Red Hat Enterprise Linux 8 Installing Identity Management . You must contact the IdM server administrator to ensure that you obtain an account on the IdM server with permissions to create zones on the IdM server. You should create a backup of the answer file. You can use the backup to restore the answer file to its original state if it becomes corrupted. For more information, see Configuring Satellite Server . Procedure To configure dynamic DNS update with GSS-TSIG authentication, complete the following steps: Creating a Kerberos principal on the IdM server Obtain a Kerberos ticket for the account obtained from the IdM administrator: Create a new Kerberos principal for Satellite Server to use to authenticate on the IdM server: Installing and configuring the idM client On the base operating system of either the Satellite or Capsule that is managing the DNS service for your deployment, install the ipa-client package: Configure the IdM client by running the installation script and following the on-screen prompts: Obtain a Kerberos ticket: Remove any preexisting keytab : Obtain the keytab for this system: Note When adding a keytab to a standby system with the same host name as the original system in service, add the r option to prevent generating new credentials and rendering the credentials on the original system invalid. For the dns.keytab file, set the group and owner to foreman-proxy : Optional: To verify that the keytab file is valid, enter the following command: Configuring DNS zones in the IdM web UI Create and configure the zone that you want to manage: Navigate to Network Services > DNS > DNS Zones . Select Add and enter the zone name. For example, example.com . Click Add and Edit . Click the Settings tab and in the BIND update policy box, add the following to the semi-colon separated list: Set Dynamic update to True . Enable Allow PTR sync . Click Save to save the changes. Create and configure the reverse zone: Navigate to Network Services > DNS > DNS Zones . Click Add . Select Reverse zone IP network and add the network address in CIDR format to enable reverse lookups. Click Add and Edit . Click the Settings tab and in the BIND update policy box, add the following to the semi-colon separated list: Set Dynamic update to True . Click Save to save the changes. Configuring the Satellite or Capsule Server that manages the DNS service for the domain Configure your Satellite Server or Capsule Server to connect to your DNS service: For each affected Capsule, update the configuration of that Capsule in the Satellite web UI: In the Satellite web UI, navigate to Infrastructure > Capsules , locate the Satellite Server, and from the list in the Actions column, select Refresh . Configure the domain: In the Satellite web UI, navigate to Infrastructure > Domains and select the domain name. In the Domain tab, ensure DNS Capsule is set to the Capsule where the subnet is connected. Configure the subnet: In the Satellite web UI, navigate to Infrastructure > Subnets and select the subnet name. In the Subnet tab, set IPAM to None . In the Domains tab, select the domain that you want to manage using the IdM server. In the Capsules tab, ensure Reverse DNS Capsule is set to the Capsule where the subnet is connected. Click Submit to save the changes. 5.5.2. Configuring dynamic DNS update with TSIG authentication You can configure an IdM server to use the secret key transaction authentication for DNS (TSIG) technology that uses the rndc.key key file for authentication. The TSIG protocol is defined in RFC2845 . Prerequisites You must ensure the IdM server is deployed and the host-based firewall is configured correctly. For more information, see Port Requirements in the Red Hat Enterprise Linux 7 Linux Domain Identity, Authentication, and Policy Guide . You must obtain root user access on the IdM server. You must confirm whether Satellite Server or Capsule Server is configured to provide DNS service for your deployment. You must configure DNS, DHCP and TFTP services on the base operating system of either the Satellite or Capsule that is managing the DNS service for your deployment. You must create a backup of the answer file. You can use the backup to restore the answer file to its original state if it becomes corrupted. For more information, see Configuring Satellite Server . Procedure To configure dynamic DNS update with TSIG authentication, complete the following steps: Enabling external updates to the DNS zone in the IdM server On the IdM Server, add the following to the top of the /etc/named.conf file: ######################################################################## include "/etc/rndc.key"; controls { inet _IdM_Server_IP_Address_ port 953 allow { _Satellite_IP_Address_; } keys { "rndc-key"; }; }; ######################################################################## Reload the named service to make the changes take effect: In the IdM web UI, navigate to Network Services > DNS > DNS Zones and click the name of the zone. In the Settings tab, apply the following changes: Add the following in the BIND update policy box: grant "rndc-key" zonesub ANY; Set Dynamic update to True . Click Update to save the changes. Copy the /etc/rndc.key file from the IdM server to the base operating system of your Satellite Server. Enter the following command: To set the correct ownership, permissions, and SELinux context for the rndc.key file, enter the following command: Assign the foreman-proxy user to the named group manually. Normally, satellite-installer ensures that the foreman-proxy user belongs to the named UNIX group, however, in this scenario Satellite does not manage users and groups, therefore you need to assign the foreman-proxy user to the named group manually. On Satellite Server, enter the following satellite-installer command to configure Satellite to use the external DNS server: Testing external updates to the DNS zone in the IdM server Ensure that the key in the /etc/rndc.key file on Satellite Server is the same key file that is used on the IdM server: key "rndc-key" { algorithm hmac-md5; secret " secret-key =="; }; On Satellite Server, create a test DNS entry for a host. For example, host test.example.com with an A record of 192.168.25.20 on the IdM server at 192.168.25.1 . On Satellite Server, test the DNS entry: Example output: Server: 192.168.25.1 Address: 192.168.25.1#53 Name: test.example.com Address: 192.168.25.20 To view the entry in the IdM web UI, navigate to Network Services > DNS > DNS Zones . Click the name of the zone and search for the host by name. If resolved successfully, remove the test DNS entry: Confirm that the DNS entry was removed: The above nslookup command fails and returns the SERVFAIL error message if the record was successfully deleted. 5.5.3. Reverting to internal DNS service You can revert to using Satellite Server and Capsule Server as your DNS providers. You can use a backup of the answer file that was created before configuring external DNS, or you can create a backup of the answer file. For more information about answer files, see Configuring Satellite Server . Procedure On the Satellite or Capsule Server that you want to configure to manage DNS service for the domain, complete the following steps: Configuring Satellite or Capsule as a DNS server If you have created a backup of the answer file before configuring external DNS, restore the answer file and then enter the satellite-installer command: If you do not have a suitable backup of the answer file, create a backup of the answer file now. To configure Satellite or Capsule as DNS server without using an answer file, enter the following satellite-installer command on Satellite or Capsule: For more information, see Configuring DNS, DHCP, and TFTP on Capsule Server . After you run the satellite-installer command to make any changes to your Capsule configuration, you must update the configuration of each affected Capsule in the Satellite web UI. Updating the configuration in the Satellite web UI In the Satellite web UI, navigate to Infrastructure > Capsules . For each Capsule that you want to update, from the Actions list, select Refresh . Configure the domain: In the Satellite web UI, navigate to Infrastructure > Domains and click the domain name that you want to configure. In the Domain tab, set DNS Capsule to the Capsule where the subnet is connected. Configure the subnet: In the Satellite web UI, navigate to Infrastructure > Subnets and select the subnet name. In the Subnet tab, set IPAM to DHCP or Internal DB . In the Domains tab, select the domain that you want to manage using Satellite or Capsule. In the Capsules tab, set Reverse DNS Capsule to the Capsule where the subnet is connected. Click Submit to save the changes. 5.6. Configuring Satellite to manage the lifecycle of a host registered to a Identity Management realm As well as providing access to Satellite Server, hosts provisioned with Satellite can also be integrated with Identity Management realms. Red Hat Satellite has a realm feature that automatically manages the lifecycle of any system registered to a realm or domain provider. Use this section to configure Satellite Server or Capsule Server for Identity Management realm support, then add hosts to the Identity Management realm group. Prerequisites Satellite Server that is registered to the Content Delivery Network or an external Capsule Server that is registered to Satellite Server. A deployed realm or domain provider such as Identity Management. To install and configure Identity Management packages on Satellite Server or Capsule Server: To use Identity Management for provisioned hosts, complete the following steps to install and configure Identity Management packages on Satellite Server or Capsule Server: Install the ipa-client package on Satellite Server or Capsule Server: Configure the server as a Identity Management client: Create a realm proxy user, realm-capsule , and the relevant roles in Identity Management: Note the principal name that returns and your Identity Management server configuration details because you require them for the following procedure. To configure Satellite Server or Capsule Server for Identity Management realm support: Complete the following procedure on Satellite and every Capsule that you want to use: Copy the /root/freeipa.keytab file to any Capsule Server that you want to include in the same principal and realm: Move the /root/freeipa.keytab file to the /etc/foreman-proxy directory and set the ownership settings to the foreman-proxy user: Enter the following command on all Capsules that you want to include in the realm. If you use the integrated Capsule on Satellite, enter this command on Satellite Server: You can also use these options when you first configure the Satellite Server. Ensure that the most updated versions of the ca-certificates package is installed and trust the Identity Management Certificate Authority: Optional: If you configure Identity Management on an existing Satellite Server or Capsule Server, complete the following steps to ensure that the configuration changes take effect: Restart the foreman-proxy service: In the Satellite web UI, navigate to Infrastructure > Capsules . Locate the Capsule you have configured for Identity Management and from the list in the Actions column, select Refresh . To create a realm for the Identity Management-enabled Capsule After you configure your integrated or external Capsule with Identity Management, you must create a realm and add the Identity Management-configured Capsule to the realm. Procedure In the Satellite web UI, navigate to Infrastructure > Realms and click Create Realm . In the Name field, enter a name for the realm. From the Realm Type list, select the type of realm. From the Realm Capsule list, select Capsule Server where you have configured Identity Management. Click the Locations tab and from the Locations list, select the location where you want to add the new realm. Click the Organizations tab and from the Organizations list, select the organization where you want to add the new realm. Click Submit . Updating host groups with realm information You must update any host groups that you want to use with the new realm information. In the Satellite web UI, navigate to Configure > Host Groups , select the host group that you want to update, and click the Network tab. From the Realm list, select the realm you create as part of this procedure, and then click Submit . Adding hosts to a Identity Management host group Identity Management supports the ability to set up automatic membership rules based on a system's attributes. Red Hat Satellite's realm feature provides administrators with the ability to map the Red Hat Satellite host groups to the Identity Management parameter userclass which allow administrators to configure automembership. When nested host groups are used, they are sent to the Identity Management server as they are displayed in the Red Hat Satellite User Interface. For example, "Parent/Child/Child". Satellite Server or Capsule Server sends updates to the Identity Management server, however automembership rules are only applied at initial registration. To add hosts to a Identity Management host group: On the Identity Management server, create a host group: Create an automembership rule: Where you can use the following options: automember-add flags the group as an automember group. --type=hostgroup identifies that the target group is a host group, not a user group. automember_rule adds the name you want to identify the automember rule by. Define an automembership condition based on the userclass attribute: Where you can use the following options: automember-add-condition adds regular expression conditions to identify group members. --key=userclass specifies the key attribute as userclass . --type=hostgroup identifies that the target group is a host group, not a user group. --inclusive-regex= ^webserver identifies matching values with a regular expression pattern. hostgroup_name - identifies the target host group's name. When a system is added to Satellite Server's hostgroup_name host group, it is added automatically to the Identity Management server's " hostgroup_name " host group. Identity Management host groups allow for Host-Based Access Controls (HBAC), sudo policies and other Identity Management functions.	[ "scp root@ dns.example.com :/etc/rndc.key /etc/foreman-proxy/rndc.key", "restorecon -v /etc/foreman-proxy/rndc.key chown -v root:foreman-proxy /etc/foreman-proxy/rndc.key chmod -v 640 /etc/foreman-proxy/rndc.key", "echo -e \"server DNS_IP_Address \\n update add aaa.example.com 3600 IN A Host_IP_Address \\n send\\n\" \| nsupdate -k /etc/foreman-proxy/rndc.key nslookup aaa.example.com DNS_IP_Address echo -e \"server DNS_IP_Address \\n update delete aaa.example.com 3600 IN A Host_IP_Address \\n send\\n\" \| nsupdate -k /etc/foreman-proxy/rndc.key", "satellite-installer --foreman-proxy-dns=true --foreman-proxy-dns-managed=false --foreman-proxy-dns-provider=nsupdate --foreman-proxy-dns-server=\" DNS_IP_Address \" --foreman-proxy-keyfile=/etc/foreman-proxy/rndc.key", "dnf install dhcp-server bind-utils", "tsig-keygen -a hmac-md5 omapi_key", "cat /etc/dhcp/dhcpd.conf default-lease-time 604800; max-lease-time 2592000; log-facility local7; subnet 192.168.38.0 netmask 255.255.255.0 { range 192.168.38.10 192.168.38.100 ; option routers 192.168.38.1 ; option subnet-mask 255.255.255.0 ; option domain-search \" virtual.lan \"; option domain-name \" virtual.lan \"; option domain-name-servers 8.8.8.8 ; } omapi-port 7911; key omapi_key { algorithm hmac-md5; secret \" My_Secret \"; }; omapi-key omapi_key;", "firewall-cmd --add-service dhcp", "firewall-cmd --runtime-to-permanent", "id -u foreman 993 id -g foreman 990", "groupadd -g 990 foreman useradd -u 993 -g 990 -s /sbin/nologin foreman", "chmod o+rx /etc/dhcp/ chmod o+r /etc/dhcp/dhcpd.conf chattr +i /etc/dhcp/ /etc/dhcp/dhcpd.conf", "systemctl enable --now dhcpd", "dnf install nfs-utils systemctl enable --now nfs-server", "mkdir -p /exports/var/lib/dhcpd /exports/etc/dhcp", "/var/lib/dhcpd /exports/var/lib/dhcpd none bind,auto 0 0 /etc/dhcp /exports/etc/dhcp none bind,auto 0 0", "mount -a", "/exports 192.168.38.1 (rw,async,no_root_squash,fsid=0,no_subtree_check) /exports/etc/dhcp 192.168.38.1 (ro,async,no_root_squash,no_subtree_check,nohide) /exports/var/lib/dhcpd 192.168.38.1 (ro,async,no_root_squash,no_subtree_check,nohide)", "exportfs -rva", "firewall-cmd --add-port=7911/tcp", "firewall-cmd --add-service mountd --add-service nfs --add-service rpc-bind --zone public", "firewall-cmd --runtime-to-permanent", "satellite-maintain packages install nfs-utils", "mkdir -p /mnt/nfs/etc/dhcp /mnt/nfs/var/lib/dhcpd", "chown -R foreman-proxy /mnt/nfs", "showmount -e DHCP_Server_FQDN rpcinfo -p DHCP_Server_FQDN", "DHCP_Server_FQDN :/exports/etc/dhcp /mnt/nfs/etc/dhcp nfs ro,vers=3,auto,nosharecache,context=\"system_u:object_r:dhcp_etc_t:s0\" 0 0 DHCP_Server_FQDN :/exports/var/lib/dhcpd /mnt/nfs/var/lib/dhcpd nfs ro,vers=3,auto,nosharecache,context=\"system_u:object_r:dhcpd_state_t:s0\" 0 0", "mount -a", "su foreman-proxy -s /bin/bash cat /mnt/nfs/etc/dhcp/dhcpd.conf cat /mnt/nfs/var/lib/dhcpd/dhcpd.leases exit", "satellite-installer --enable-foreman-proxy-plugin-dhcp-remote-isc --foreman-proxy-dhcp-provider=remote_isc --foreman-proxy-dhcp-server= My_DHCP_Server_FQDN --foreman-proxy-dhcp=true --foreman-proxy-plugin-dhcp-remote-isc-dhcp-config /mnt/nfs/etc/dhcp/dhcpd.conf --foreman-proxy-plugin-dhcp-remote-isc-dhcp-leases /mnt/nfs/var/lib/dhcpd/dhcpd.leases --foreman-proxy-plugin-dhcp-remote-isc-key-name=omapi_key --foreman-proxy-plugin-dhcp-remote-isc-key-secret= My_Secret --foreman-proxy-plugin-dhcp-remote-isc-omapi-port=7911", "update-ca-trust enable openssl s_client -showcerts -connect infoblox.example.com :443 </dev/null \| openssl x509 -text >/etc/pki/ca-trust/source/anchors/infoblox.crt update-ca-trust extract", "curl -u admin:password https:// infoblox.example.com /wapi/v2.0/network", "[ { \"_ref\": \"network/ZG5zLm5ldHdvcmskMTkyLjE2OC4yMDIuMC8yNC8w: infoblox.example.com /24/default\", \"network\": \"192.168.202.0/24\", \"network_view\": \"default\" } ]", "satellite-installer --enable-foreman-proxy-plugin-dhcp-infoblox --foreman-proxy-dhcp true --foreman-proxy-dhcp-provider infoblox --foreman-proxy-dhcp-server infoblox.example.com --foreman-proxy-plugin-dhcp-infoblox-username admin --foreman-proxy-plugin-dhcp-infoblox-password infoblox --foreman-proxy-plugin-dhcp-infoblox-record-type fixedaddress --foreman-proxy-plugin-dhcp-infoblox-dns-view default --foreman-proxy-plugin-dhcp-infoblox-network-view default", "satellite-installer --enable-foreman-proxy-plugin-dns-infoblox --foreman-proxy-dns true --foreman-proxy-dns-provider infoblox --foreman-proxy-plugin-dns-infoblox-dns-server infoblox.example.com --foreman-proxy-plugin-dns-infoblox-username admin --foreman-proxy-plugin-dns-infoblox-password infoblox --foreman-proxy-plugin-dns-infoblox-dns-view default", "mkdir -p /mnt/nfs/var/lib/tftpboot", "TFTP_Server_IP_Address :/exports/var/lib/tftpboot /mnt/nfs/var/lib/tftpboot nfs rw,vers=3,auto,nosharecache,context=\"system_u:object_r:tftpdir_rw_t:s0\" 0 0", "mount -a", "satellite-installer --foreman-proxy-tftp-root /mnt/nfs/var/lib/tftpboot --foreman-proxy-tftp=true", "satellite-installer --foreman-proxy-tftp-servername= TFTP_Server_FQDN", "kinit idm_user", "ipa service-add capsule/satellite.example.com", "satellite-maintain packages install ipa-client", "ipa-client-install", "kinit admin", "rm /etc/foreman-proxy/dns.keytab", "ipa-getkeytab -p capsule/ [email protected] -s idm1.example.com -k /etc/foreman-proxy/dns.keytab", "chown foreman-proxy:foreman-proxy /etc/foreman-proxy/dns.keytab", "kinit -kt /etc/foreman-proxy/dns.keytab capsule/ [email protected]", "grant capsule\\047 [email protected] wildcard * ANY;", "grant capsule\\047 [email protected] wildcard * ANY;", "satellite-installer --foreman-proxy-dns-managed=false --foreman-proxy-dns-provider=nsupdate_gss --foreman-proxy-dns-server=\" idm1.example.com \" --foreman-proxy-dns-tsig-keytab=/etc/foreman-proxy/dns.keytab --foreman-proxy-dns-tsig-principal=\"capsule/ [email protected] \" --foreman-proxy-dns=true", "######################################################################## include \"/etc/rndc.key\"; controls { inet _IdM_Server_IP_Address_ port 953 allow { _Satellite_IP_Address_; } keys { \"rndc-key\"; }; }; ########################################################################", "systemctl reload named", "grant \"rndc-key\" zonesub ANY;", "scp /etc/rndc.key root@ satellite.example.com :/etc/rndc.key", "restorecon -v /etc/rndc.key chown -v root:named /etc/rndc.key chmod -v 640 /etc/rndc.key", "usermod -a -G named foreman-proxy", "satellite-installer --foreman-proxy-dns-managed=false --foreman-proxy-dns-provider=nsupdate --foreman-proxy-dns-server=\" IdM_Server_IP_Address \" --foreman-proxy-dns-ttl=86400 --foreman-proxy-dns=true --foreman-proxy-keyfile=/etc/rndc.key", "key \"rndc-key\" { algorithm hmac-md5; secret \" secret-key ==\"; };", "echo -e \"server 192.168.25.1\\n update add test.example.com 3600 IN A 192.168.25.20\\n send\\n\" \| nsupdate -k /etc/rndc.key", "nslookup test.example.com 192.168.25.1", "Server: 192.168.25.1 Address: 192.168.25.1#53 Name: test.example.com Address: 192.168.25.20", "echo -e \"server 192.168.25.1\\n update delete test.example.com 3600 IN A 192.168.25.20\\n send\\n\" \| nsupdate -k /etc/rndc.key", "nslookup test.example.com 192.168.25.1", "satellite-installer", "satellite-installer --foreman-proxy-dns-managed=true --foreman-proxy-dns-provider=nsupdate --foreman-proxy-dns-server=\"127.0.0.1\" --foreman-proxy-dns=true", "satellite-maintain packages install ipa-client", "ipa-client-install", "foreman-prepare-realm admin realm-capsule", "scp /root/freeipa.keytab root@ capsule.example.com :/etc/foreman-proxy/freeipa.keytab", "mv /root/freeipa.keytab /etc/foreman-proxy chown foreman-proxy:foreman-proxy /etc/foreman-proxy/freeipa.keytab", "satellite-installer --foreman-proxy-realm true --foreman-proxy-realm-keytab /etc/foreman-proxy/freeipa.keytab --foreman-proxy-realm-principal [email protected] --foreman-proxy-realm-provider freeipa", "cp /etc/ipa/ca.crt /etc/pki/ca-trust/source/anchors/ipa.crt update-ca-trust enable update-ca-trust", "systemctl restart foreman-proxy", "ipa hostgroup-add hostgroup_name --desc= hostgroup_description", "ipa automember-add --type=hostgroup hostgroup_name automember_rule", "ipa automember-add-condition --key=userclass --type=hostgroup --inclusive-regex= ^webserver hostgroup_name ---------------------------------- Added condition(s) to \" hostgroup_name \" ---------------------------------- Automember Rule: automember_rule Inclusive Regex: userclass= ^webserver ---------------------------- Number of conditions added 1 ----------------------------" ]	https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html/installing_satellite_server_in_a_connected_network_environment/configuring-external-services
Chapter 2. Optimizing systemd to shorten the boot time	Chapter 2. Optimizing systemd to shorten the boot time As a system administrator, you can optimize performance of your system and shorten the boot time. You can review the services that systemd starts during boot and evaluate their necessity. Disabling certain services to start at boot can improve the boot time of your system. 2.1. Examining system boot performance To examine system boot performance, you can use the systemd-analyze command. By using certain options, you can tune systemd to shorten the boot time. Prerequisites Optional: Before you examine systemd to tune the boot time, list all enabled services: Procedure Choose the information you want to analyze: Analyze the information about the time that the last successful boot took: Analyze the unit initialization time of each systemd unit: The output lists the units in descending order according to the time they took to initialize during the last successful boot. Identify critical units that took the longest time to initialize at the last successful boot: The output highlights the units that critically slow down the boot with the red color. Figure 2.1. The output of the systemd-analyze critical-chain command Additional resources systemd-analyze (1) man page 2.2. A guide to selecting services that can be safely disabled You can shorten the boot time of your system by disabling certain services that are enabled on boot by default. List enabled services: Disable a service: Certain services must stay enabled so that your operating system is safe and functions in the way you need. Refer to the following table as a guide to selecting the services that you can safely disable. The table lists all services enabled by default on a minimal installation of Red Hat Enterprise Linux. Table 2.1. Services enabled by default on a minimal installation of RHEL Service name Can it be disabled? More information auditd.service yes Disable auditd.service only if you do not need audit messages from the kernel. Be aware that if you disable auditd.service , the /var/log/audit/audit.log file is not produced. Consequently, you are not able to retroactively review some commonly-reviewed actions or events, such as user logins, service starts or password changes. Also note that auditd has two parts: a kernel part, and a service itself. By using the systemctl disable auditd command, you only disable the service, but not the kernel part. To disable system auditing in its entirety, set audit=0 on kernel command line. [email protected] no This service runs only when it is really needed, so it does not need to be disabled. crond.service yes Be aware that no items from crontab will run if you disable crond.service. dbus-org.fedoraproject.FirewallD1.service yes A symlink to firewalld.service dbus-org.freedesktop.NetworkManager.service yes A symlink to NetworkManager.service dbus-org.freedesktop.nm-dispatcher.service yes A symlink to NetworkManager-dispatcher.service firewalld.service yes Disable firewalld.service only if you do not need firewall. [email protected] no This service runs only when it is really needed, so it does not need to be disabled. import-state.service yes Disable import-state.service only if you do not need to boot from a network storage. irqbalance.service yes Disable irqbalance.service only if you have just one CPU. Do not disable irqbalance.service on systems with multiple CPUs. kdump.service yes Disable kdump.service only if you do not need reports from kernel crashes. loadmodules.service yes This service is not started unless the /etc/rc.modules or /etc/sysconfig/modules directory exists, which means that it is not started on a minimal RHEL installation. lvm2-monitor.service yes Disable lvm2-monitor.service only if you do not use Logical Volume Manager (LVM). microcode.service no Do not be disable the service because it provides updates of the microcode software in CPU. NetworkManager-dispatcher.service yes Disable NetworkManager-dispatcher.service only if you do not need notifications on network configuration changes (for example in static networks). NetworkManager-wait-online.service yes Disable NetworkManager-wait-online.service only if you do not need working network connection available right after the boot. If the service is enabled, the system does not finish the boot before the network connection is working. This may prolong the boot time significantly. NetworkManager.service yes Disable NetworkManager.service only if you do not need connection to a network. nis-domainname.service yes Disable nis-domainname.service only if you do not use Network Information Service (NIS). rhsmcertd.service no rngd.service yes Disable rngd.service only if you do not need much entropy on your system, or you do not have any sort of hardware generator. Note that the service is necessary in environments that require a lot of good entropy, such as systems used for generation of X.509 certificates (for example the FreeIPA server). rsyslog.service yes Disable rsyslog.service only if you do not need persistent logs, or you set systemd-journald to persistent mode. selinux-autorelabel-mark.service yes Disable selinux-autorelabel-mark.service only if you do not use SELinux. sshd.service yes Disable sshd.service only if you do not need remote logins by OpenSSH server. sssd.service yes Disable sssd.service only if there are no users who log in the system over the network (for example by using LDAP or Kerberos). Red Hat recommends to disable all sssd-* units if you disable sssd.service . syslog.service yes An alias for rsyslog.service tuned.service yes Disable tuned.service only if you do need to use performance tuning. lvm2-lvmpolld.socket yes Disable lvm2-lvmpolld.socket only if you do not use Logical Volume Manager (LVM). dnf-makecache.timer yes Disable dnf-makecache.timer only if you do not need your package metadata to be updated automatically. unbound-anchor.timer yes Disable unbound-anchor.timer only if you do not need daily update of the root trust anchor for DNS Security Extensions (DNSSEC). This root trust anchor is used by Unbound resolver and resolver library for DNSSEC validation. To find more information about a service, use one of the following commands: The systemctl cat command provides the content of the respective /usr/lib/systemd/system/ <service> service file, as well as all applicable overrides. The applicable overrides include unit file overrides from the /etc/systemd/system/ <service> file or drop-in files from a corresponding unit.type.d directory. Additional resources The systemd.unit(5) man page The systemd help command that shows the man page of a particular service 2.3. Additional resources systemctl (1) man page systemd (1) man page systemd-delta (1) man page systemd.directives (7) man page systemd.unit (5) man page systemd.service (5) man page systemd.target (5) man page systemd.kill (5) man page systemd Home Page	[ "systemctl list-unit-files --state=enabled", "systemd-analyze", "systemd-analyze blame", "systemd-analyze critical-chain", "systemctl list-unit-files --state=enabled", "systemctl disable <service_name>", "systemctl cat <service_name>", "systemctl help <service_name>" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/using_systemd_unit_files_to_customize_and_optimize_your_system/optimizing-systemd-to-shorten-the-boot-time_working-with-systemd
7.26. clustermon	7.26. clustermon 7.26.1. RHBA-2015:1413 - clustermon bug fix update Updated clustermon packages that fix one bug are now available for Red Hat Enterprise Linux 6. The clustermon packages are used for remote cluster management. The modclusterd service provides an abstraction of cluster status used by the Conga architecture and by the Simple Network Management (SNMP) and Common Information Model (CIM) modules of clustermon. Bug Fix BZ# 1111249 , BZ# 1114622 The internal ricci API has been extended with an ability to temporarily stop a clustered resource, which was used to resolve the BZ#1111249 enhancement request in the luci packages, documented in the RHBA-2015:20054 erratum. Users of clustermon are advised to upgrade to these updated packages, which fix this bug.	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/6.7_technical_notes/package-clustermon
Chapter 1. Storage overview	Chapter 1. Storage overview MicroShift supports multiple types of storage, both for on-premise and cloud providers. You can manage container storage for persistent and non-persistent data in a Red Hat build of MicroShift cluster. 1.1. Storage types MicroShift storage is broadly classified into two categories, namely ephemeral storage and persistent storage. 1.1.1. Ephemeral storage Pods and containers are ephemeral or transient in nature and designed for stateless applications. Ephemeral storage allows administrators and developers to better manage the local storage for some of their operations. To read details about ephemeral storage, click Understanding ephemeral storage . 1.1.2. Persistent storage Stateful applications deployed in containers require persistent storage. MicroShift uses a pre-provisioned storage framework called persistent volumes (PV) to allow cluster administrators to provision persistent storage. The data inside these volumes can exist beyond the lifecycle of an individual pod. Developers can use persistent volume claims (PVCs) to request storage requirements. For persistent storage details, read Understanding persistent storage . 1.1.3. Dynamic storage provisioning Using dynamic provisioning allows you to create storage volumes on-demand, eliminating the need for pre-provisioned storage. For more information about how dynamic provisioning works in Red Hat build of MicroShift, read Dynamic provisioning .	null	https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/4.18/html/storage/storage-overview-microshift
3.3. NFS Share Setup	3.3. NFS Share Setup The following procedure configures the NFS share for the NFS daemon failover. You need to perform this procedure on only one node in the cluster. Create the /nfsshare directory. Mount the ext4 file system that you created in Section 3.2, "Configuring an LVM Volume with an ext4 File System" on the /nfsshare directory. Create an exports directory tree on the /nfsshare directory. Place files in the exports directory for the NFS clients to access. For this example, we are creating test files named clientdatafile1 and clientdatafile2 . Unmount the ext4 file system and deactivate the LVM volume group.	[ "mkdir /nfsshare", "mount /dev/my_vg/my_lv /nfsshare", "mkdir -p /nfsshare/exports mkdir -p /nfsshare/exports/export1 mkdir -p /nfsshare/exports/export2", "touch /nfsshare/exports/export1/clientdatafile1 touch /nfsshare/exports/export2/clientdatafile2", "umount /dev/my_vg/my_lv vgchange -an my_vg" ]	https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/high_availability_add-on_administration/s1-nfssharesetup-haaa
Chapter 227. Mock Component	Chapter 227. Mock Component Available as of Camel version 1.0 Testing of distributed and asynchronous processing is notoriously difficult. The Mock , Test and DataSet endpoints work great with the Camel Testing Framework to simplify your unit and integration testing using Enterprise Integration Patterns and Camel's large range of Components together with the powerful Bean Integration. The Mock component provides a powerful declarative testing mechanism, which is similar to jMock in that it allows declarative expectations to be created on any Mock endpoint before a test begins. Then the test is run, which typically fires messages to one or more endpoints, and finally the expectations can be asserted in a test case to ensure the system worked as expected. This allows you to test various things like: The correct number of messages are received on each endpoint, The correct payloads are received, in the right order, Messages arrive on an endpoint in order, using some Expression to create an order testing function, Messages arrive match some kind of Predicate such as that specific headers have certain values, or that parts of the messages match some predicate, such as by evaluating an XPath or XQuery Expression. Note There is also the Test endpoint which is a Mock endpoint, but which uses a second endpoint to provide the list of expected message bodies and automatically sets up the Mock endpoint assertions. In other words, it's a Mock endpoint that automatically sets up its assertions from some sample messages in a File or database , for example. Caution Mock endpoints keep received Exchanges in memory indefinitely. Remember that Mock is designed for testing. When you add Mock endpoints to a route, each Exchange sent to the endpoint will be stored (to allow for later validation) in memory until explicitly reset or the JVM is restarted. If you are sending high volume and/or large messages, this may cause excessive memory use. If your goal is to test deployable routes inline, consider using NotifyBuilder or AdviceWith in your tests instead of adding Mock endpoints to routes directly. From Camel 2.10 onwards there are two new options retainFirst , and retainLast that can be used to limit the number of messages the Mock endpoints keep in memory. 227.1. URI format Where someName can be any string that uniquely identifies the endpoint. You can append query options to the URI in the following format, ?option=value&option=value&... 227.2. Options The Mock component has no options. The Mock endpoint is configured using URI syntax: with the following path and query parameters: 227.2.1. Path Parameters (1 parameters): Name Description Default Type name Required Name of mock endpoint String 227.2.2. Query Parameters (10 parameters): Name Description Default Type assertPeriod (producer) Sets a grace period after which the mock endpoint will re-assert to ensure the preliminary assertion is still valid. This is used for example to assert that exactly a number of messages arrives. For example if expectedMessageCount(int) was set to 5, then the assertion is satisfied when 5 or more message arrives. To ensure that exactly 5 messages arrives, then you would need to wait a little period to ensure no further message arrives. This is what you can use this setAssertPeriod(long) method for. By default this period is disabled. 0 long expectedCount (producer) Specifies the expected number of message exchanges that should be received by this endpoint. Beware: If you want to expect that 0 messages, then take extra care, as 0 matches when the tests starts, so you need to set a assert period time to let the test run for a while to make sure there are still no messages arrived; for that use setAssertPeriod(long). An alternative is to use NotifyBuilder, and use the notifier to know when Camel is done routing some messages, before you call the assertIsSatisfied() method on the mocks. This allows you to not use a fixed assert period, to speedup testing times. If you want to assert that exactly n'th message arrives to this mock endpoint, then see also the setAssertPeriod(long) method for further details. -1 int reportGroup (producer) A number that is used to turn on throughput logging based on groups of the size. int resultMinimumWaitTime (producer) Sets the minimum expected amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied 0 long resultWaitTime (producer) Sets the maximum amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied 0 long retainFirst (producer) Specifies to only retain the first n'th number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the first 10 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object... ) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received. -1 int retainLast (producer) Specifies to only retain the last n'th number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the last 20 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object... ) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received. -1 int sleepForEmptyTest (producer) Allows a sleep to be specified to wait to check that this endpoint really is empty when expectedMessageCount(int) is called with zero 0 long copyOnExchange (producer) Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true. true boolean synchronous (advanced) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). false boolean 227.3. Simple Example Here's a simple example of Mock endpoint in use. First, the endpoint is resolved on the context. Then we set an expectation, and then, after the test has run, we assert that our expectations have been met: MockEndpoint resultEndpoint = context.resolveEndpoint("mock:foo", MockEndpoint.class); // set expectations resultEndpoint.expectedMessageCount(2); // send some messages // now lets assert that the mock:foo endpoint received 2 messages resultEndpoint.assertIsSatisfied(); You typically always call the assertIsSatisfied() method to test that the expectations were met after running a test. Camel will by default wait 10 seconds when the assertIsSatisfied() is invoked. This can be configured by setting the setResultWaitTime(millis) method. 227.4. Using assertPeriod Available as of Camel 2.7 When the assertion is satisfied then Camel will stop waiting and continue from the assertIsSatisfied method. That means if a new message arrives on the mock endpoint, just a bit later, that arrival will not affect the outcome of the assertion. Suppose you do want to test that no new messages arrives after a period thereafter, then you can do that by setting the setAssertPeriod method, for example: MockEndpoint resultEndpoint = context.resolveEndpoint("mock:foo", MockEndpoint.class); resultEndpoint.setAssertPeriod(5000); resultEndpoint.expectedMessageCount(2); // send some messages // now lets assert that the mock:foo endpoint received 2 messages resultEndpoint.assertIsSatisfied(); 227.5. Setting expectations You can see from the Javadoc of MockEndpoint the various helper methods you can use to set expectations. The main methods are as follows: Method Description expectedMessageCount(int) To define the expected message count on the endpoint. expectedMinimumMessageCount(int) To define the minimum number of expected messages on the endpoint. expectedBodiesReceived(... ) To define the expected bodies that should be received (in order). expectedHeaderReceived(... ) To define the expected header that should be received expectsAscending(Expression) To add an expectation that messages are received in order, using the given Expression to compare messages. expectsDescending(Expression) To add an expectation that messages are received in order, using the given Expression to compare messages. expectsNoDuplicates(Expression) To add an expectation that no duplicate messages are received; using an Expression to calculate a unique identifier for each message. This could be something like the JMSMessageID if using JMS, or some unique reference number within the message. Here's another example: resultEndpoint.expectedBodiesReceived("firstMessageBody", "secondMessageBody", "thirdMessageBody"); 227.6. Adding expectations to specific messages In addition, you can use the message(int messageIndex) method to add assertions about a specific message that is received. For example, to add expectations of the headers or body of the first message (using zero-based indexing like java.util.List ), you can use the following code: resultEndpoint.message(0).header("foo").isEqualTo("bar"); There are some examples of the Mock endpoint in use in the camel-core processor tests . 227.7. Mocking existing endpoints Available as of Camel 2.7 Camel now allows you to automatically mock existing endpoints in your Camel routes. Note How it works The endpoints are still in action. What happens differently is that a Mock endpoint is injected and receives the message first and then delegates the message to the target endpoint. You can view this as a kind of intercept and delegate or endpoint listener. Suppose you have the given route below: Route @Override protected RouteBuilder createRouteBuilder() throws Exception { return new RouteBuilder() { @Override public void configure() throws Exception { from("direct:start").to("direct:foo").to("log:foo").to("mock:result"); from("direct:foo").transform(constant("Bye World")); } }; } You can then use the adviceWith feature in Camel to mock all the endpoints in a given route from your unit test, as shown below: adviceWith mocking all endpoints public void testAdvisedMockEndpoints() throws Exception { // advice the first route using the inlined AdviceWith route builder // which has extended capabilities than the regular route builder context.getRouteDefinitions().get(0).adviceWith(context, new AdviceWithRouteBuilder() { @Override public void configure() throws Exception { // mock all endpoints mockEndpoints(); } }); getMockEndpoint("mock:direct:start").expectedBodiesReceived("Hello World"); getMockEndpoint("mock:direct:foo").expectedBodiesReceived("Hello World"); getMockEndpoint("mock:log:foo").expectedBodiesReceived("Bye World"); getMockEndpoint("mock:result").expectedBodiesReceived("Bye World"); template.sendBody("direct:start", "Hello World"); assertMockEndpointsSatisfied(); // additional test to ensure correct endpoints in registry assertNotNull(context.hasEndpoint("direct:start")); assertNotNull(context.hasEndpoint("direct:foo")); assertNotNull(context.hasEndpoint("log:foo")); assertNotNull(context.hasEndpoint("mock:result")); // all the endpoints was mocked assertNotNull(context.hasEndpoint("mock:direct:start")); assertNotNull(context.hasEndpoint("mock:direct:foo")); assertNotNull(context.hasEndpoint("mock:log:foo")); } Notice that the mock endpoints is given the URI mock:<endpoint> , for example mock:direct:foo . Camel logs at INFO level the endpoints being mocked: Note Mocked endpoints are without parameters Endpoints which are mocked will have their parameters stripped off. For example the endpoint log:foo?showAll=true will be mocked to the following endpoint mock:log:foo . Notice the parameters have been removed. Its also possible to only mock certain endpoints using a pattern. For example to mock all log endpoints you do as shown: adviceWith mocking only log endpoints using a pattern public void testAdvisedMockEndpointsWithPattern() throws Exception { // advice the first route using the inlined AdviceWith route builder // which has extended capabilities than the regular route builder context.getRouteDefinitions().get(0).adviceWith(context, new AdviceWithRouteBuilder() { @Override public void configure() throws Exception { // mock only log endpoints mockEndpoints("log"); } }); // now we can refer to log:foo as a mock and set our expectations getMockEndpoint("mock:log:foo").expectedBodiesReceived("Bye World"); getMockEndpoint("mock:result").expectedBodiesReceived("Bye World"); template.sendBody("direct:start", "Hello World"); assertMockEndpointsSatisfied(); // additional test to ensure correct endpoints in registry assertNotNull(context.hasEndpoint("direct:start")); assertNotNull(context.hasEndpoint("direct:foo")); assertNotNull(context.hasEndpoint("log:foo")); assertNotNull(context.hasEndpoint("mock:result")); // only the log:foo endpoint was mocked assertNotNull(context.hasEndpoint("mock:log:foo")); assertNull(context.hasEndpoint("mock:direct:start")); assertNull(context.hasEndpoint("mock:direct:foo")); } The pattern supported can be a wildcard or a regular expression. See more details about this at Intercept as its the same matching function used by Camel. Note Mind that mocking endpoints causes the messages to be copied when they arrive on the mock. That means Camel will use more memory. This may not be suitable when you send in a lot of messages. 227.8. Mocking existing endpoints using the camel-test component Instead of using the adviceWith to instruct Camel to mock endpoints, you can easily enable this behavior when using the camel-test Test Kit. The same route can be tested as follows. Notice that we return "" from the isMockEndpoints method, which tells Camel to mock all endpoints. If you only want to mock all log endpoints you can return "log" instead. isMockEndpoints using camel-test kit public class IsMockEndpointsJUnit4Test extends CamelTestSupport { @Override public String isMockEndpoints() { // override this method and return the pattern for which endpoints to mock. // use to indicate all return ""; } @Test public void testMockAllEndpoints() throws Exception { // notice we have automatic mocked all endpoints and the name of the endpoints is "mock:uri" getMockEndpoint("mock:direct:start").expectedBodiesReceived("Hello World"); getMockEndpoint("mock:direct:foo").expectedBodiesReceived("Hello World"); getMockEndpoint("mock:log:foo").expectedBodiesReceived("Bye World"); getMockEndpoint("mock:result").expectedBodiesReceived("Bye World"); template.sendBody("direct:start", "Hello World"); assertMockEndpointsSatisfied(); // additional test to ensure correct endpoints in registry assertNotNull(context.hasEndpoint("direct:start")); assertNotNull(context.hasEndpoint("direct:foo")); assertNotNull(context.hasEndpoint("log:foo")); assertNotNull(context.hasEndpoint("mock:result")); // all the endpoints was mocked assertNotNull(context.hasEndpoint("mock:direct:start")); assertNotNull(context.hasEndpoint("mock:direct:foo")); assertNotNull(context.hasEndpoint("mock:log:foo")); } @Override protected RouteBuilder createRouteBuilder() throws Exception { return new RouteBuilder() { @Override public void configure() throws Exception { from("direct:start").to("direct:foo").to("log:foo").to("mock:result"); from("direct:foo").transform(constant("Bye World")); } }; } } 227.9. Mocking existing endpoints with XML DSL If you do not use the camel-test component for unit testing (as shown above) you can use a different approach when using XML files for routes. The solution is to create a new XML file used by the unit test and then include the intended XML file which has the route you want to test. Suppose we have the route in the camel-route.xml file: camel-route.xml 1 <!-- this camel route is in the camel-route.xml file --> <camelContext xmlns="http://camel.apache.org/schema/spring"> <route> <from uri="direct:start"/> <to uri="direct:foo"/> <to uri="log:foo"/> <to uri="mock:result"/> </route> <route> <from uri="direct:foo"/> <transform> <constant>Bye World</constant> </transform> </route> </camelContext> Then we create a new XML file as follows, where we include the camel-route.xml file and define a spring bean with the class org.apache.camel.impl.InterceptSendToMockEndpointStrategy which tells Camel to mock all endpoints: test-camel-route.xml <!-- the Camel route is defined in another XML file --> <import resource="camel-route.xml"/> <!-- bean which enables mocking all endpoints --> <bean id="mockAllEndpoints" class="org.apache.camel.component.mock.InterceptSendToMockEndpointStrategy"/> Then in your unit test you load the new XML file ( test-camel-route.xml ) instead of camel-route.xml . To only mock all Log endpoints you can define the pattern in the constructor for the bean: <bean id="mockAllEndpoints" class="org.apache.camel.impl.InterceptSendToMockEndpointStrategy"> <constructor-arg index="0" value="log"/> </bean> 227.10. Mocking endpoints and skip sending to original endpoint Available as of Camel 2.10 Sometimes you want to easily mock and skip sending to a certain endpoints. So the message is detoured and send to the mock endpoint only. From Camel 2.10 onwards you can now use the mockEndpointsAndSkip method using AdviceWith or the Test Kit . The example below will skip sending to the two endpoints "direct:foo" , and "direct:bar" . adviceWith mock and skip sending to endpoints public void testAdvisedMockEndpointsWithSkip() throws Exception { // advice the first route using the inlined AdviceWith route builder // which has extended capabilities than the regular route builder context.getRouteDefinitions().get(0).adviceWith(context, new AdviceWithRouteBuilder() { @Override public void configure() throws Exception { // mock sending to direct:foo and direct:bar and skip send to it mockEndpointsAndSkip("direct:foo", "direct:bar"); } }); getMockEndpoint("mock:result").expectedBodiesReceived("Hello World"); getMockEndpoint("mock:direct:foo").expectedMessageCount(1); getMockEndpoint("mock:direct:bar").expectedMessageCount(1); template.sendBody("direct:start", "Hello World"); assertMockEndpointsSatisfied(); // the message was not send to the direct:foo route and thus not sent to the seda endpoint SedaEndpoint seda = context.getEndpoint("seda:foo", SedaEndpoint.class); assertEquals(0, seda.getCurrentQueueSize()); } The same example using the Test Kit isMockEndpointsAndSkip using camel-test kit public class IsMockEndpointsAndSkipJUnit4Test extends CamelTestSupport { @Override public String isMockEndpointsAndSkip() { // override this method and return the pattern for which endpoints to mock, // and skip sending to the original endpoint. return "direct:foo"; } @Test public void testMockEndpointAndSkip() throws Exception { // notice we have automatic mocked the direct:foo endpoints and the name of the endpoints is "mock:uri" getMockEndpoint("mock:result").expectedBodiesReceived("Hello World"); getMockEndpoint("mock:direct:foo").expectedMessageCount(1); template.sendBody("direct:start", "Hello World"); assertMockEndpointsSatisfied(); // the message was not send to the direct:foo route and thus not sent to the seda endpoint SedaEndpoint seda = context.getEndpoint("seda:foo", SedaEndpoint.class); assertEquals(0, seda.getCurrentQueueSize()); } @Override protected RouteBuilder createRouteBuilder() throws Exception { return new RouteBuilder() { @Override public void configure() throws Exception { from("direct:start").to("direct:foo").to("mock:result"); from("direct:foo").transform(constant("Bye World")).to("seda:foo"); } }; } } 227.11. Limiting the number of messages to keep Available as of Camel 2.10 The Mock endpoints will by default keep a copy of every Exchange that it received. So if you test with a lot of messages, then it will consume memory. From Camel 2.10 onwards we have introduced two options retainFirst and retainLast that can be used to specify to only keep N'th of the first and/or last Exchanges. For example in the code below, we only want to retain a copy of the first 5 and last 5 Exchanges the mock receives. MockEndpoint mock = getMockEndpoint("mock:data"); mock.setRetainFirst(5); mock.setRetainLast(5); mock.expectedMessageCount(2000); mock.assertIsSatisfied(); Using this has some limitations. The getExchanges() and getReceivedExchanges() methods on the MockEndpoint will return only the retained copies of the Exchanges. So in the example above, the list will contain 10 Exchanges; the first five, and the last five. The retainFirst and retainLast options also have limitations on which expectation methods you can use. For example the expectedXXX methods that work on message bodies, headers, etc. will only operate on the retained messages. In the example above they can test only the expectations on the 10 retained messages. 227.12. Testing with arrival times Available as of Camel 2.7 The Mock endpoint stores the arrival time of the message as a property on the Exchange. Date time = exchange.getProperty(Exchange.RECEIVED_TIMESTAMP, Date.class); You can use this information to know when the message arrived on the mock. But it also provides foundation to know the time interval between the and message arrived on the mock. You can use this to set expectations using the arrives DSL on the Mock endpoint. For example to say that the first message should arrive between 0-2 seconds before the you can do: mock.message(0).arrives().noLaterThan(2).seconds().beforeNext(); You can also define this as that 2nd message (0 index based) should arrive no later than 0-2 seconds after the : mock.message(1).arrives().noLaterThan(2).seconds().afterPrevious(); You can also use between to set a lower bound. For example suppose that it should be between 1-4 seconds: mock.message(1).arrives().between(1, 4).seconds().afterPrevious(); You can also set the expectation on all messages, for example to say that the gap between them should be at most 1 second: mock.allMessages().arrives().noLaterThan(1).seconds().beforeNext(); Tip Time units In the example above we use seconds as the time unit, but Camel offers milliseconds , and minutes as well. 227.13. See Also Spring Testing Testing	[ "mock:someName[?options]", "mock:name", "MockEndpoint resultEndpoint = context.resolveEndpoint(\"mock:foo\", MockEndpoint.class); // set expectations resultEndpoint.expectedMessageCount(2); // send some messages // now lets assert that the mock:foo endpoint received 2 messages resultEndpoint.assertIsSatisfied();", "MockEndpoint resultEndpoint = context.resolveEndpoint(\"mock:foo\", MockEndpoint.class); resultEndpoint.setAssertPeriod(5000); resultEndpoint.expectedMessageCount(2); // send some messages // now lets assert that the mock:foo endpoint received 2 messages resultEndpoint.assertIsSatisfied();", "resultEndpoint.expectedBodiesReceived(\"firstMessageBody\", \"secondMessageBody\", \"thirdMessageBody\");", "resultEndpoint.message(0).header(\"foo\").isEqualTo(\"bar\");", "@Override protected RouteBuilder createRouteBuilder() throws Exception { return new RouteBuilder() { @Override public void configure() throws Exception { from(\"direct:start\").to(\"direct:foo\").to(\"log:foo\").to(\"mock:result\"); from(\"direct:foo\").transform(constant(\"Bye World\")); } }; }", "public void testAdvisedMockEndpoints() throws Exception { // advice the first route using the inlined AdviceWith route builder // which has extended capabilities than the regular route builder context.getRouteDefinitions().get(0).adviceWith(context, new AdviceWithRouteBuilder() { @Override public void configure() throws Exception { // mock all endpoints mockEndpoints(); } }); getMockEndpoint(\"mock:direct:start\").expectedBodiesReceived(\"Hello World\"); getMockEndpoint(\"mock:direct:foo\").expectedBodiesReceived(\"Hello World\"); getMockEndpoint(\"mock:log:foo\").expectedBodiesReceived(\"Bye World\"); getMockEndpoint(\"mock:result\").expectedBodiesReceived(\"Bye World\"); template.sendBody(\"direct:start\", \"Hello World\"); assertMockEndpointsSatisfied(); // additional test to ensure correct endpoints in registry assertNotNull(context.hasEndpoint(\"direct:start\")); assertNotNull(context.hasEndpoint(\"direct:foo\")); assertNotNull(context.hasEndpoint(\"log:foo\")); assertNotNull(context.hasEndpoint(\"mock:result\")); // all the endpoints was mocked assertNotNull(context.hasEndpoint(\"mock:direct:start\")); assertNotNull(context.hasEndpoint(\"mock:direct:foo\")); assertNotNull(context.hasEndpoint(\"mock:log:foo\")); }", "INFO Adviced endpoint [direct://foo] with mock endpoint [mock:direct:foo]", "public void testAdvisedMockEndpointsWithPattern() throws Exception { // advice the first route using the inlined AdviceWith route builder // which has extended capabilities than the regular route builder context.getRouteDefinitions().get(0).adviceWith(context, new AdviceWithRouteBuilder() { @Override public void configure() throws Exception { // mock only log endpoints mockEndpoints(\"log\"); } }); // now we can refer to log:foo as a mock and set our expectations getMockEndpoint(\"mock:log:foo\").expectedBodiesReceived(\"Bye World\"); getMockEndpoint(\"mock:result\").expectedBodiesReceived(\"Bye World\"); template.sendBody(\"direct:start\", \"Hello World\"); assertMockEndpointsSatisfied(); // additional test to ensure correct endpoints in registry assertNotNull(context.hasEndpoint(\"direct:start\")); assertNotNull(context.hasEndpoint(\"direct:foo\")); assertNotNull(context.hasEndpoint(\"log:foo\")); assertNotNull(context.hasEndpoint(\"mock:result\")); // only the log:foo endpoint was mocked assertNotNull(context.hasEndpoint(\"mock:log:foo\")); assertNull(context.hasEndpoint(\"mock:direct:start\")); assertNull(context.hasEndpoint(\"mock:direct:foo\")); }", "public class IsMockEndpointsJUnit4Test extends CamelTestSupport { @Override public String isMockEndpoints() { // override this method and return the pattern for which endpoints to mock. // use to indicate all return \"\"; } @Test public void testMockAllEndpoints() throws Exception { // notice we have automatic mocked all endpoints and the name of the endpoints is \"mock:uri\" getMockEndpoint(\"mock:direct:start\").expectedBodiesReceived(\"Hello World\"); getMockEndpoint(\"mock:direct:foo\").expectedBodiesReceived(\"Hello World\"); getMockEndpoint(\"mock:log:foo\").expectedBodiesReceived(\"Bye World\"); getMockEndpoint(\"mock:result\").expectedBodiesReceived(\"Bye World\"); template.sendBody(\"direct:start\", \"Hello World\"); assertMockEndpointsSatisfied(); // additional test to ensure correct endpoints in registry assertNotNull(context.hasEndpoint(\"direct:start\")); assertNotNull(context.hasEndpoint(\"direct:foo\")); assertNotNull(context.hasEndpoint(\"log:foo\")); assertNotNull(context.hasEndpoint(\"mock:result\")); // all the endpoints was mocked assertNotNull(context.hasEndpoint(\"mock:direct:start\")); assertNotNull(context.hasEndpoint(\"mock:direct:foo\")); assertNotNull(context.hasEndpoint(\"mock:log:foo\")); } @Override protected RouteBuilder createRouteBuilder() throws Exception { return new RouteBuilder() { @Override public void configure() throws Exception { from(\"direct:start\").to(\"direct:foo\").to(\"log:foo\").to(\"mock:result\"); from(\"direct:foo\").transform(constant(\"Bye World\")); } }; } }", "<!-- this camel route is in the camel-route.xml file --> <camelContext xmlns=\"http://camel.apache.org/schema/spring\"> <route> <from uri=\"direct:start\"/> <to uri=\"direct:foo\"/> <to uri=\"log:foo\"/> <to uri=\"mock:result\"/> </route> <route> <from uri=\"direct:foo\"/> <transform> <constant>Bye World</constant> </transform> </route> </camelContext>", "<!-- the Camel route is defined in another XML file --> <import resource=\"camel-route.xml\"/> <!-- bean which enables mocking all endpoints --> <bean id=\"mockAllEndpoints\" class=\"org.apache.camel.component.mock.InterceptSendToMockEndpointStrategy\"/>", "<bean id=\"mockAllEndpoints\" class=\"org.apache.camel.impl.InterceptSendToMockEndpointStrategy\"> <constructor-arg index=\"0\" value=\"log\"/> </bean>", "public void testAdvisedMockEndpointsWithSkip() throws Exception { // advice the first route using the inlined AdviceWith route builder // which has extended capabilities than the regular route builder context.getRouteDefinitions().get(0).adviceWith(context, new AdviceWithRouteBuilder() { @Override public void configure() throws Exception { // mock sending to direct:foo and direct:bar and skip send to it mockEndpointsAndSkip(\"direct:foo\", \"direct:bar\"); } }); getMockEndpoint(\"mock:result\").expectedBodiesReceived(\"Hello World\"); getMockEndpoint(\"mock:direct:foo\").expectedMessageCount(1); getMockEndpoint(\"mock:direct:bar\").expectedMessageCount(1); template.sendBody(\"direct:start\", \"Hello World\"); assertMockEndpointsSatisfied(); // the message was not send to the direct:foo route and thus not sent to the seda endpoint SedaEndpoint seda = context.getEndpoint(\"seda:foo\", SedaEndpoint.class); assertEquals(0, seda.getCurrentQueueSize()); }", "public class IsMockEndpointsAndSkipJUnit4Test extends CamelTestSupport { @Override public String isMockEndpointsAndSkip() { // override this method and return the pattern for which endpoints to mock, // and skip sending to the original endpoint. return \"direct:foo\"; } @Test public void testMockEndpointAndSkip() throws Exception { // notice we have automatic mocked the direct:foo endpoints and the name of the endpoints is \"mock:uri\" getMockEndpoint(\"mock:result\").expectedBodiesReceived(\"Hello World\"); getMockEndpoint(\"mock:direct:foo\").expectedMessageCount(1); template.sendBody(\"direct:start\", \"Hello World\"); assertMockEndpointsSatisfied(); // the message was not send to the direct:foo route and thus not sent to the seda endpoint SedaEndpoint seda = context.getEndpoint(\"seda:foo\", SedaEndpoint.class); assertEquals(0, seda.getCurrentQueueSize()); } @Override protected RouteBuilder createRouteBuilder() throws Exception { return new RouteBuilder() { @Override public void configure() throws Exception { from(\"direct:start\").to(\"direct:foo\").to(\"mock:result\"); from(\"direct:foo\").transform(constant(\"Bye World\")).to(\"seda:foo\"); } }; } }", "MockEndpoint mock = getMockEndpoint(\"mock:data\"); mock.setRetainFirst(5); mock.setRetainLast(5); mock.expectedMessageCount(2000); mock.assertIsSatisfied();", "Date time = exchange.getProperty(Exchange.RECEIVED_TIMESTAMP, Date.class);", "mock.message(0).arrives().noLaterThan(2).seconds().beforeNext();", "mock.message(1).arrives().noLaterThan(2).seconds().afterPrevious();", "mock.message(1).arrives().between(1, 4).seconds().afterPrevious();", "mock.allMessages().arrives().noLaterThan(1).seconds().beforeNext();" ]	https://docs.redhat.com/en/documentation/red_hat_fuse/7.13/html/apache_camel_component_reference/mock-component
Chapter 23. Boot Options	Chapter 23. Boot Options The Red Hat Enterprise Linux installation system includes a range of boot options for administrators, which modify the default behavior of the installation program by enabling (or disabling) certain functions. To use boot options, append them to the boot command line, as described in Section 23.1, "Configuring the Installation System at the Boot Menu" . Multiple options added to the boot line need to be separated by a single space. There are two basic types of options described in this chapter: Options presented as ending with an "equals" sign ( = ) require a value to be specified - they cannot be used on their own. For example, the inst.vncpassword= option must also contain a value (in this case, a password). The correct form is therefore inst.vncpassword= password . On its own, without a password specified, the option is invalid. Options presented without the " = " sign do not accept any values or parameters. For example, the rd.live.check option forces Anaconda to verify the installation media before starting the installation; if this option is present, the check will be performed, and if it is not present, the check will be skipped. 23.1. Configuring the Installation System at the Boot Menu Note The exact way to specify custom boot options is different on every system architecture. For architecture-specific instructions about editing boot options, see: Section 7.2, "The Boot Menu" for 64-bit AMD, Intel and ARM systems Section 12.1, "The Boot Menu" for IBM Power Systems servers Chapter 21, Parameter and Configuration Files on IBM Z for IBM Z There are several different ways to edit boot options at the boot menu (that is, the menu which appears after you boot the installation media): The boot: prompt, accessed by pressing the Esc key anywhere in the boot menu. When using this prompt, the first option must always specify the installation program image file to be loaded. In most cases, the image can be specified using the linux keyword. After that, additional options can be specified as needed. Pressing the Tab key at this prompt will display help in the form of usable commands where applicable. To start the installation with your options, press the Enter key. To return from the boot: prompt to the boot menu, restart the computer and boot from the installation media again. The > prompt on BIOS-based AMD64 and Intel 64 systems, accessed by highlighting an entry in the boot menu and pressing the Tab key. Unlike the boot: prompt, this prompt allows you to edit a predefined set of boot options. For example, if you highlight the entry labeled Test this media & install Red Hat Enterprise Linux 7.5 , a full set of options used by this menu entry will be displayed on the prompt, allowing you to add your own options. Pressing Enter will start the installation using the options you specified. To cancel editing and return to the boot menu, press the Esc key at any time. The GRUB2 menu on UEFI-based 64-bit AMD, Intel and ARM systems. If your system uses UEFI, you can edit boot options by highlighting an entry and pressing the e key. When you finish editing, press F10 or Ctrl + X to start the installation using the options you specified. In addition to the options described in this chapter, the boot prompt also accepts dracut kernel options. A list of these options is available as the dracut.cmdline(7) man page. Note Boot options specific to the installation program always start with inst. in this guide. Currently, this prefix is optional, for example, resolution=1024x768 will work exactly the same as inst.resolution=1024x768 . However, it is expected that the inst. prefix will be mandatory in future releases. Specifying the Installation Source inst.repo= Specifies the installation source - that is, a location where the installation program can find the images and packages it requires. For example: The target must be either: an installable tree, which is a directory structure containing the installation program's images, packages and repodata as well as a valid .treeinfo file a DVD (a physical disk present in the system's DVD drive) an ISO image of the full Red Hat Enterprise Linux installation DVD, placed on a hard drive or a network location accessible from the installation system (requires specifying NFS Server as the installation source) This option allows for the configuration of different installation methods using different formats. The syntax is described in the table below. Table 23.1. Installation Sources Installation source Option format Any CD/DVD drive inst.repo=cdrom Specific CD/DVD drive inst.repo=cdrom: device Hard Drive inst.repo=hd: device :/ path HMC inst.repo=hmc HTTP Server inst.repo=http:// host / path HTTPS Server inst.repo=https:// host / path FTP Server inst.repo=ftp:// username : password @ host / path NFS Server inst.repo=nfs:[ options :] server :/ path [a] [a] This option uses NFS protocol version 3 by default. To use a different version, add nfsvers= X to options , replacing X with the version number that you want to use. Note In releases of Red Hat Enterprise Linux, there were separate options for an installable tree accessible by NFS (the nfs option) and an ISO image located on an NFS source (the nfsiso option). In Red Hat Enterprise Linux 7, the installation program can automatically detect whether the source is an installable tree or a directory containing an ISO image, and the nfsiso option is deprecated. Disk device names can be set using the following formats: Kernel device name, for example /dev/sda1 or sdb2 File system label, for example LABEL=Flash or LABEL=RHEL7 File system UUID, for example UUID=8176c7bf-04ff-403a-a832-9557f94e61db Non-alphanumeric characters must be represented as \x NN , where NN is the hexadecimal representation of the character. For example, \x20 is a white space (" "). inst.stage2= Specifies the location of the installation program runtime image to be loaded. The syntax is the same as in Specifying the Installation Source . This option expects a path to a directory containing a valid .treeinfo file; the location of the runtime image will be read from this file if found. If a .treeinfo file is not available, Anaconda will try to load the image from LiveOS/squashfs.img . Use the option multiple times to specify multiple HTTP, HTTPS or FTP sources. Note By default, the inst.stage2= boot option is used on the installation media and set to a specific label (for example, inst.stage2=hd:LABEL=RHEL7\x20Server.x86_64 ). If you modify the default label of the file system containing the runtime image, or if you use a customized procedure to boot the installation system, you must ensure this option is set to the correct value. inst.dd= If you need to perform a driver update during the installation, use the inst.dd= option. It can be used multiple times. The location of a driver RPM package can be specified using any of the formats detailed in Specifying the Installation Source . With the exception of the inst.dd=cdrom option, the device name must always be specified. For example: Using this option without any parameters (only as inst.dd ) will prompt the installation program to ask you for a driver update disk with an interactive menu. Driver disks can also be loaded from a hard disk drive or a similar device instead of being loaded over the network or from initrd . Follow this procedure: Load the driver disk on a hard disk drive, a USB or any similar device. Set the label, for example, DD , to this device. Start the installation with: as the boot argument. Replace DD with a specific label and replace dd.rpm with a specific name. Use anything supported by the inst.repo command instead of LABEL to specify your hard disk drive. For more information about driver updates during the installation, see Chapter 6, Updating Drivers During Installation on AMD64 and Intel 64 Systems for AMD64 and Intel 64 systems and Chapter 11, Updating Drivers During Installation on IBM Power Systems for IBM Power Systems servers. Kickstart Boot Options inst.ks= Gives the location of a Kickstart file to be used to automate the installation. Locations can be specified using any of the formats valid for inst.repo . See Specifying the Installation Source for details. Use the option multiple times to specify multiple HTTP, HTTPS and FTP sources. If multiple HTTP, HTTPS and FTP locations are specified, the locations are tried sequentially until one succeeds: If you only specify a device and not a path, the installation program will look for the Kickstart file in /ks.cfg on the specified device. If you use this option without specifying a device, the installation program will use the following: In the above example, -server is the DHCP -server option or the IP address of the DHCP server itself, and filename is the DHCP filename option, or /kickstart/ . If the given file name ends with the / character, ip -kickstart is appended. For example: Table 23.2. Default Kickstart File Location DHCP server address Client address Kickstart file location 192.168.122.1 192.168.122.100 192.168.122.1 : /kickstart/192.168.122.100-kickstart Additionally, starting with Red Hat Enterprise Linux 7.2, the installer will attempt to load a Kickstart file named ks.cfg from a volume with a label of OEMDRV if present. If your Kickstart file is in this location, you do not need to use the inst.ks= boot option at all. inst.ks.sendmac Adds headers to outgoing HTTP requests with the MAC addresses of all network interfaces. For example: This can be useful when using inst.ks=http to provision systems. inst.ks.sendsn Adds a header to outgoing HTTP requests. This header will contain the system's serial number, read from /sys/class/dmi/id/product_serial . The header has the following syntax: Console, Environment and Display Options console= This kernel option specifies a device to be used as the primary console. For example, to use a console on the first serial port, use console=ttyS0 . This option should be used along with the inst.text option. You can use this option multiple times. In that case, the boot message will be displayed on all specified consoles, but only the last one will be used by the installation program afterwards. For example, if you specify console=ttyS0 console=ttyS1 , the installation program will use ttyS1 . noshell Disables access to the root shell during the installation. This is useful with automated (Kickstart) installations - if you use this option, a user can watch the installation progress, but they cannot interfere with it by accessing the root shell by pressing Ctrl + Alt + F2 . inst.lang= Sets the language to be used during the installation. Language codes are the same as the ones used in the lang Kickstart command as described in Section 27.3.1, "Kickstart Commands and Options" . On systems where the system-config-language package is installed, a list of valid values can also be found in /usr/share/system-config-language/locale-list . inst.geoloc= Configures geolocation usage in the installation program. Geolocation is used to preset the language and time zone, and uses the following syntax: inst.geoloc= value The value parameter can be any of the following: Table 23.3. Valid Values for the inst.geoloc Option Disable geolocation inst.geoloc=0 Use the Fedora GeoIP API inst.geoloc=provider_fedora_geoip Use the Hostip.info GeoIP API inst.geoloc=provider_hostip If this option is not specified, Anaconda will use provider_fedora_geoip . inst.keymap= Specifies the keyboard layout to be used by the installation program. Layout codes are the same as the ones used in the keyboard Kickstart command as described in Section 27.3.1, "Kickstart Commands and Options" . inst.text Forces the installation program to run in text mode instead of graphical mode. The text user interface is limited, for example, it does not allow you to modify the partition layout or set up LVM. When installing a system on a machine with a limited graphical capabilities, it is recommended to use VNC as described in Enabling Remote Access . inst.cmdline Forces the installation program to run in command line mode. This mode does not allow any interaction, all options must be specified in a Kickstart file or on the command line. inst.graphical Forces the installation program to run in graphical mode. This mode is the default. inst.resolution= Specifies the screen resolution in graphical mode. The format is N x M , where N is the screen width and M is the screen height (in pixels). The lowest supported resolution is 800x600 . inst.headless Specifies that the machine being installed onto does not have any display hardware. In other words, this option prevents the installation program from trying to detect a screen. inst.xdriver= Specifies the name of the X driver to be used both during the installation and on the installed system. inst.usefbx Tells the installation program to use the frame buffer X driver instead of a hardware-specific driver. This option is equivalent to inst.xdriver=fbdev . modprobe.blacklist= Blacklists (completely disables) one or more drivers. Drivers (mods) disabled using this option will be prevented from loading when the installation starts, and after the installation finishes, the installed system will keep these settings. The blacklisted drivers can then be found in the /etc/modprobe.d/ directory. Use a comma-separated list to disable multiple drivers. For example: inst.sshd=0 By default, sshd is only automatically started on IBM Z, and on other architectures, sshd is not started unless the inst.sshd option is used. This option prevents sshd from starting automatically on IBM Z. inst.sshd Starts the sshd service during the installation, which allows you to connect to the system during the installation using SSH and monitor its progress. For more information on SSH, see the ssh(1) man page and the corresponding chapter in the Red Hat Enterprise Linux 7 System Administrator's Guide . By default, sshd is only automatically started on IBM Z, and on other architectures, sshd is not started unless the inst.sshd option is used. Note During the installation, the root account has no password by default. You can set a root password to be used during the installation with the sshpw Kickstart command as described in Section 27.3.1, "Kickstart Commands and Options" . inst.kdump_addon= Enables or disables the Kdump configuration screen (add-on) in the installer. This screen is enabled by default; use inst.kdump_addon=off to disable it. Note that disabling the add-on will disable the Kdump screens in both the graphical and text-based interface as well as the %addon com_redhat_kdump Kickstart command. Network Boot Options Initial network initialization is handled by dracut . This section only lists some of the more commonly used options; for a complete list, see the dracut.cmdline(7) man page. Additional information on networking is also available in Red Hat Enterprise Linux 7 Networking Guide . ip= Configures one or more network interfaces. To configure multiple interfaces, you can use the ip option multiple times - once for each interface. If multiple interfaces are configured, you must also use the option rd.neednet=1 , and you must specify a primary boot interface using the bootdev option, described below. Alternatively, you can use the ip option once, and then use Kickstart to set up further interfaces. This option accepts several different formats. The most common are described in Table 23.4, "Network Interface Configuration Formats" . Table 23.4. Network Interface Configuration Formats Configuration Method Option format Automatic configuration of any interface ip= method Automatic configuration of a specific interface ip= interface : method Static configuration ip= ip :: gateway : netmask : hostname : interface :none Automatic configuration of a specific interface with an override [a] ip= ip :: gateway : netmask : hostname : interface : method : mtu [a] Brings up the specified interface using the specified method of automatic configuration, such as dhcp , but overrides the automatically obtained IP address, gateway, netmask, host name or other specified parameter. All parameters are optional; only specify the ones you want to override and automatically obtained values will be used for the others. The method parameter can be any the following: Table 23.5. Automatic Interface Configuration Methods Automatic configuration method Value DHCP dhcp IPv6 DHCP dhcp6 IPv6 automatic configuration auto6 iBFT (iSCSI Boot Firmware Table) ibft Note If you use a boot option which requires network access, such as inst.ks=http:// host / path , without specifying the ip option, the installation program will use ip=dhcp . Important To connect automatically to an iSCSI target, a network device for accessing the target needs to be activated. The recommended way to do so is to use ip=ibft boot option. In the above tables, the ip parameter specifies the client's IP address. IPv6 addresses can be specified by putting them in square brackets, for example, [2001:DB8::1] . The gateway parameter is the default gateway. IPv6 addresses are accepted here as well. The netmask parameter is the netmask to be used. This can either be a full netmask for IPv4 (for example 255.255.255.0 ) or a prefix for IPv6 (for example 64 ). The hostname parameter is the host name of the client system. This parameter is optional. nameserver= Specifies the address of the name server. This option can be used multiple times. rd.neednet= You must use the option rd.neednet=1 if you use more than one ip option. Alternatively, to set up multiple network interfaces you can use the ip once, and then set up further interfaces using Kickstart. bootdev= Specifies the boot interface. This option is mandatory if you use more than one ip option. ifname= Assigns a given interface name to a network device with a given MAC address. Can be used multiple times. The syntax is ifname= interface : MAC . For example: Note Using the ifname= option is the only supported way to set custom network interface names during installation. inst.dhcpclass= Specifies the DHCP vendor class identifier. The dhcpd service will see this value as vendor-class-identifier . The default value is anaconda-USD(uname -srm) . inst.waitfornet= Using the inst.waitfornet= SECONDS boot option causes the installation system to wait for network connectivity before installation. The value given in the SECONDS argument specifies maximum amount of time to wait for network connectivity before timing out and continuing the installation process even if network connectivity is not present. vlan= Sets up a Virtual LAN (VLAN) device on a specified interface with a given name. The syntax is vlan= name : interface . For example: The above will set up a VLAN device named vlan5 on the em1 interface. The name can take the following forms: Table 23.6. VLAN Device Naming Conventions Naming scheme Example VLAN_PLUS_VID vlan0005 VLAN_PLUS_VID_NO_PAD vlan5 DEV_PLUS_VID em1.0005 . DEV_PLUS_VID_NO_PAD em1.5 . bond= Set up a bonding device with the following syntax: bond= name [: slaves ][: options ] . Replace name with the bonding device name, slaves with a comma-separated list of physical (ethernet) interfaces, and options with a comma-separated list of bonding options. For example: For a list of available options, execute the modinfo bonding command. Using this option without any parameters will assume bond=bond0:eth0,eth1:mode=balance-rr . team= Set up a team device with the following syntax: team= master : slaves . Replace master with the name of the master team device and slaves with a comma-separated list of physical (ethernet) devices to be used as slaves in the team device. For example: Advanced Installation Options inst.kexec If this option is specified, the installer will use the kexec system call at the end of the installation, instead of performing a reboot. This loads the new system immediately, and bypasses the hardware initialization normally performed by the BIOS or firmware. Important Due to the complexities involved with booting systems using kexec , it cannot be explicitly tested and guaranteed to function in every situation. When kexec is used, device registers (which would normally be cleared during a full system reboot) might stay filled with data, which could potentially create issues for some device drivers. inst.gpt Force the installation program to install partition information into a GUID Partition Table (GPT) instead of a Master Boot Record (MBR). This option is meaningless on UEFI-based systems, unless they are in BIOS compatibility mode. Normally, BIOS-based systems and UEFI-based systems in BIOS compatibility mode will attempt to use the MBR schema for storing partitioning information, unless the disk is 2 32 sectors in size or larger. Most commonly, disk sectors are 512 bytes in size, meaning that this is usually equivalent to 2 TiB. Using this option will change this behavior, allowing a GPT to be written to disks smaller than this. See Section 8.14.1.1, "MBR and GPT Considerations" for more information about GPT and MBR, and Section A.1.4, "GUID Partition Table (GPT)" for more general information about GPT, MBR and disk partitioning in general. inst.multilib Configure the system for multilib packages (that is, to allow installing 32-bit packages on a 64-bit AMD64 or Intel 64 system) and install packages specified in this section as such. Normally, on an AMD64 or Intel 64 system, only packages for this architecture (marked as x86_64 ) and packages for all architectures (marked as noarch would be installed. When you use this option, packages for 32-bit AMD or Intel systems (marked as i686 ) will be automatically installed as well if available. This only applies to packages directly specified in the %packages section. If a package is only installed as a dependency, only the exact specified dependency will be installed. For example, if you are installing package bash which depends on package glibc , the former will be installed in multiple variants, while the latter will only be installed in variants specifically required. selinux=0 By default, SELinux operates in permissive mode in the installer, and in enforcing mode in the installed system. This option disables the use of SELinux in the installer and the installed system entirely. Note The selinux=0 and inst.selinux=0 options are not the same. The selinux=0 option disables the use of SELinux in the installer and the installed system, whereas inst.selinux=0 disables SELinux only in the installer. By default, SELinux is set to operate in permissive mode in the installer, so disabling it has little effect. inst.nosave= This option, introduced in Red Hat Enterprise Linux 7.3, controls which Kickstart files and installation logs are saved to the installed system. It can be especially useful to disable saving such data when performing OEM operating system installations, or when generating images using sensitive resources (such as internal repository URLs), as these resources might otherwise be mentioned in kickstart files, or in logs on the image, or both. Possible values for this option are: input_ks - disables saving of the input Kickstart file (if any). output_ks - disables saving of the output Kickstart file generated by Anaconda. all_ks - disables saving of both input and output Kickstart files. logs - disables saving of all installation logs. all - disables saving of all Kickstart files and all installation logs. Multiple values can be combined as a comma separated list, for example: input_ks,logs inst.zram This option controls the usage of zRAM swap during the installation. It creates a compressed block device inside the system RAM and uses it for swap space instead of the hard drive. This allows the installer to essentially increase the amount of memory available, which makes the installation faster on systems with low memory. By default, swap on zRAM is enabled on systems with 2 GiB or less RAM, and disabled on systems with more than 2 GiB of memory. You can use this option to change this behavior - on a system with more than 2 GiB RAM, use inst.zram=1 to enable it, and on systems with 2 GiB or less memory, use inst.zram=0 to disable this feature. Enabling Remote Access The following options are necessary to configure Anaconda for remote graphical installation. See Chapter 25, Using VNC for more details. inst.vnc Specifies that the installation program's graphical interface should be run in a VNC session. If you specify this option, you will need to connect to the system using a VNC client application to be able to interact with the installation program. VNC sharing is enabled, so multiple clients can connect to the system at the same time. Note A system installed using VNC will start in text mode by default. inst.vncpassword= Sets a password on the VNC server used by the installation program. Any VNC client attempting to connecting to the system will have to provide the correct password to gain access. For example, inst.vncpassword= testpwd will set the password to testpwd . The VNC password must be between 6 and 8 characters long. Note If you specify an invalid password (one that is too short or too long), you will be prompted to specify a new one by a message from the installation program: inst.vncconnect= Connect to a listening VNC client at a specified host and port once the installation starts. The correct syntax is inst.vncconnect= host : port , where host is the address to the VNC client's host, and port specifies which port to use. The port parameter is optional, if you do not specify one, the installation program will use 5900 . Debugging and Troubleshooting inst.updates= Specifies the location of the updates.img file to be applied to the installation program runtime. The syntax is the same as in the inst.repo option - see Table 23.1, "Installation Sources" for details. In all formats, if you do not specify a file name but only a directory, the installation program will look for a file named updates.img . inst.loglevel= Specifies the minimum level for messages to be logged on a terminal. This only concerns terminal logging; log files will always contain messages of all levels. Possible values for this option from the lowest to highest level are: debug , info , warning , error and critical . The default value is info , which means that by default, the logging terminal will display messages ranging from info to critical . inst.syslog= Once the installation starts, this option sends log messages to the syslog process on the specified host. The remote syslog process must be configured to accept incoming connections. For information on how to configure a syslog service to accept incoming connections, see the Red Hat Enterprise Linux 7 System Administrator's Guide . inst.virtiolog= Specifies a virtio port (a character device at /dev/virtio-ports/ name ) to be used for forwarding logs. The default value is org.fedoraproject.anaconda.log.0 ; if this port is present, it will be used. rd.live.ram If this option is specified, the stage 2 image will be copied into RAM. When the stage2 image on NFS repository is used, this option may make the installation proceed smoothly, since the installation is sometimes affected by reconfiguring network in an environment built upon the stage 2 image on NFS. Note that using this option when the stage 2 image is on an NFS server will increase the minimum required memory by the size of the image - roughly 500 MiB. inst.nokill A debugging option that prevents anaconda from and rebooting when a fatal error occurs or at the end of the installation process. This allows you to capture installation logs which would be lost upon reboot. 23.1.1. Deprecated and Removed Boot Options Deprecated Boot Options Options in this list are deprecated . They will still work, but there are other options which offer the same functionality. Using deprecated options is not recommended and they are expected to be removed in future releases. Note Note that as Section 23.1, "Configuring the Installation System at the Boot Menu" describes, options specific to the installation program now use the inst. prefix. For example, the vnc= option is considered deprecated and replaced by the inst.vnc= option. These changes are not listed here. method= Configured the installation method. Use the inst.repo= option instead. repo=nfsiso: server :/ path In NFS installations, specified that the target is an ISO image located on an NFS server instead of an installable tree. The difference is now detected automatically, which means this option is the same as inst.repo=nfs: server :/ path . dns= Configured the Domain Name Server (DNS). Use the nameserver= option instead. netmask= , gateway= , hostname= , ip= , ipv6= These options have been consolidated under the ip= option. ksdevice= Select network device to be used at early stage of installation. Different values have been replaced with different options; see the table below. Table 23.7. Automatic Interface Configuration Methods Value Current behavior Not present Activation of all devices is attempted using dhcp , unless the desired device and configuration is specified by the ip= option or the BOOTIF option. ksdevice=link Similar to the above, with the difference that network will always be activated in the initramfs, whether it is needed or not. The supported rd.neednet dracut option should be used to achieve the same result. ksdevice=bootif Ignored (the BOOTIF= option is used by default when specified) ksdevice=ibft Replaced with the ip=ibft dracut option ksdevice= MAC Replaced with BOOTIF= MAC ksdevice= device Replaced by specifying the device name using the ip= dracut option. blacklist= Used to disable specified drivers. This is now handled by the modprobe.blacklist= option. nofirewire= Disabled support for the FireWire interface. You can disable the FireWire driver ( firewire_ohci ) by using the modprobe.blacklist= option instead: nicdelay= Used to indicate the delay after which the network was considered active; the system waited until either the gateway was successfully pinged, or until the amount of seconds specified in this parameter passed. In RHEL 7, network devices are configured and activated during the early stage of installation by the dracut modules which ensure that the gateway is accessible before proceeding. For more information about dracut , see the dracut.cmdline(7) man page. linksleep= Used to configure how long anaconda should wait for a link on a device before activating it. This functionality is now available in the dracut modules where specific rd.net.timeout.* options can be configured to handle issues caused by slow network device initialization. For more information about dracut , see the dracut.cmdline(7) man page. Removed Boot Options The following options are removed. They were present in releases of Red Hat Enterprise Linux, but they cannot be used anymore. askmethod , asknetwork The installation program's initramfs is now completely non-interactive, which means that these options are not available anymore. Instead, use the inst.repo= to specify the installation method and ip= to configure network settings. serial This option forced Anaconda to use the /dev/ttyS0 console as the output. Use the console=/dev/ttyS0 (or similar) instead. updates= Specified the location of updates for the installation program. Use the inst.updates= option instead. essid= , wepkey= , wpakey= Configured wireless network access. Network configuration is now being handled by dracut , which does not support wireless networking, rendering these options useless. ethtool= Used in the past to configure additional low-level network settings. All network settings are now handled by the ip= option. gdb Allowed you to debug the loader. Use rd.debug instead. mediacheck Verified the installation media before starting the installation. Replaced with the rd.live.check option. ks=floppy Specified a 3.5 inch diskette as the Kickstart file source. These drives are not supported anymore. display= Configured a remote display. Replaced with the inst.vnc option. utf8 Added UTF8 support when installing in text mode. UTF8 support now works automatically. noipv6 Used to disable IPv6 support in the installation program. IPv6 is now built into the kernel so the driver cannot be blacklisted; however, it is possible to disable IPv6 using the ipv6.disable dracut option. upgradeany Upgrades are done in a different way in Red Hat Enterprise Linux 7. For more information about upgrading your system, see Chapter 29, Upgrading Your Current System . vlanid= Used to configure Virtual LAN (802.1q tag) devices. Use the vlan= dracut option instead.	[ "inst.repo=cdrom", "inst.stage2=host1/install.img inst.stage2=host2/install.img inst.stage2=host3/install.img", "inst.dd=/dev/sdb1", "inst.dd=hd: LABEL = DD :/dd.rpm", "inst.ks=host1/ directory /ks.cfg inst.ks=host2/ directory /ks.cfg inst.ks=host3/ directory /ks.cfg", "inst.ks=nfs: next-server :/ filename", "X-RHN-Provisioning-MAC-0: eth0 01:23:45:67:89:ab", "X-System-Serial-Number: R8VA23D", "modprobe.blacklist=ahci,firewire_ohci", "ifname=eth0:01:23:45:67:89:ab", "vlan=vlan5:em1", "bond=bond0:em1,em2:mode=active-backup,tx_queues=32,downdelay=5000", "team=team0:em1,em2", "VNC password must be six to eight characters long. Please enter a new one, or leave blank for no password. Password:", "modprobe.blacklist=firewire_ohci" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/installation_guide/chap-anaconda-boot-options
Chapter 17. Cache Stores	Chapter 17. Cache Stores The cache store connects Red Hat JBoss Data Grid to the persistent data store. Cache stores are associated with individual caches. Different caches attached to the same cache manager can have different cache store configurations. Note If a clustered cache is configured with an unshared cache store (where shared is set to false ), on node join, stale entries which might have been removed from the cluster might still be present in the stores and can reappear. Report a bug 17.1. Cache Loaders and Cache Writers Integration with the persistent store is done through the following SPIs located in org.infinispan.persistence.spi : CacheLoader CacheWriter AdvancedCacheLoader AdvancedCacheWriter CacheLoader and CacheWriter provide basic methods for reading and writing to a store. CacheLoader retrieves data from a data store when the required data is not present in the cache, and CacheWriter is used to enforce entry passivation and activation on eviction in a cache. AdvancedCacheLoader and AdvancedCacheWriter provide operations to manipulate the underlying storage in bulk: parallel iteration and purging of expired entries, clear and size. The org.infinispan.persistence.file.SingleFileStore is a good starting point to write your own store implementation. Note Previously, JBoss Data Grid used the old API ( CacheLoader , extended by CacheStore ), which is also still available. Report a bug	null	https://docs.redhat.com/en/documentation/red_hat_data_grid/6.6/html/administration_and_configuration_guide/chap-cache_stores
Chapter 15. Subscription Management	Chapter 15. Subscription Management Red Hat Enterprise Linux 7 is available using the Red Hat Subscription Management services. The following Knowledge Base article provides a brief overview and instructions on how to register your Red Hat Enterprise Linux 7 system with Red Hat Subscription Management. Certificate-Based Entitlements Red Hat Enterprise Linux 7 supports new certificate-based entitlements through the subscription-manager tool. Legacy entitlements are also supported for Satellite users to provide a transition for users using Red Hat Enterprise Linux 5 and 6. Note that registering to Red Hat Network Classic using the rhn_register or rhnreg_ks tools will not work on Red Hat Enterprise Linux 7. You can use the mentioned tools to register to Red Hat Satellite or Proxy versions 5.6 only.	null	https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/7.0_release_notes/chap-red_hat_enterprise_linux-7.0_release_notes-subscription_management
Serverless	Serverless OpenShift Container Platform 4.12 Create and deploy serverless, event-driven applications using OpenShift Serverless Red Hat OpenShift Documentation Team	null	https://docs.redhat.com/en/documentation/openshift_container_platform/4.12/html/serverless/index