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
5.2. Creating Certificate Signing Requests	5.2. Creating Certificate Signing Requests Traditionally, the following methods are used to generate Certificate requests (CSRs): Generating CSRs using command line utilities Generating CSRs inside a supporting browser Generating CSRs inside an application, such as the installer of a server Some of these methods support direct submission of the CSRs, while some do not. Starting from RHCS 9.7, Server-Side key generation is supported to overcome the inconvenience brought on by the removal of the key generation support inside newer versions of browsers, such as Firefox v69 and up, as well as Chrome. For this reason, in this section, we will not discuss browser support for key generation. Although there is no reason to believe that older versions of those browsers should not continue to function as specified in older RHCS documentation. CSRs generated from an application generally take the form of PKCS#10. Provided that they are generated correctly, they should be supported by RHCS. In the following subsections, we are going to go over the following methods supported by RHCS: Command-line utilities Server-Side Key Generation 5.2.1. Generating CSRs Using Command-Line Utilities Red Hat Certificate System supports using the following utilities to create CSRs: certutil : Supports creating PKCS #10 requests. PKCS10Client : Supports creating PKCS #10 requests. CRMFPopClient : Supports creating CRMF requests. pki client-cert-request : Supports both PKCS#10 and CRMF requests. The following sections provide some examples on how to use these utilities with the feature-rich enrollment profile framework. 5.2.1.1. Creating a CSR Using certutil This section describes examples on how to use the certutil utility to create a CSR. For further details about using certutil , see: The certutil (1) man page The output of the certutil --help command 5.2.1.1.1. Using certutil to Create a CSR with EC Keys The following procedure demonstrates how to use the certutil utility to create an Elliptic Curve (EC) key pair and CSR: Change to the certificate database directory of the user or entity for which the certificate is being requested, for example: Create the binary CSR and store it in the /user_or_entity_database_directory/request.csr file: Enter the required NSS database password when prompted. For further details about the parameters, see the certutil (1) man page. Convert the created binary format CSR to PEM format: Optionally, verify that the CSR file is correct: This is a PKCS#10 PEM certificate request. 5.2.1.1.2. Using certutil to Create a CSR With User-defined Extensions The following procedure demonstrates how to create a CSR with user-defined extensions using the certutil utility. Note that the enrollment requests are constrained by the enrollment profiles defined by the CA. See Example B.3, "Multiple User Supplied Extensions in CSR" . Change to the certificate database directory of the user or entity for which the certificate is being requested, for example: Create the CSR with user-defined Key Usage extension as well as user-defined Extended Key Usage extension and store it in the /user_or_entity_database_directory/request.csr file: Enter the required NSS database password when prompted. For further details about the parameters, see the certutil (1) man page. Optionally, verify that the CSR file is correct: This is a PKCS#10 PEM certificate request. 5.2.1.2. Creating a CSR Using PKCS10Client This section describes examples how to use the PKCS10Client utility to create a CSR. For further details about using PKCS10Client , see: The PKCS10Client (1) man page The output of the PKCS10Client --help command 5.2.1.2.1. Using PKCS10Client to Create a CSR The following procedure explains how to use the PKCS10Client utility to create an Elliptic Curve (EC) key pair and CSR: Change to the certificate database directory of the user or entity for which the certificate is being requested, for example: Create the CSR and store it in the /user_or_entity_database_directory/example.csr file: For further details about the parameters, see the PKCS10Client (1) man page. Optionally, verify that the CSR is correct: 5.2.1.2.2. Using PKCS10Client to Create a CSR for SharedSecret-based CMC The following procedure explains how to use the PKCS10Client utility to create an RSA key pair and CSR for SharedSecret-based CMC. Use it only with the CMC Shared Secret authentication method which is, by default, handled by the caFullCMCSharedTokenCert and caECFullCMCSharedTokenCert profiles. Change to the certificate database directory of the user or entity for which the certificate is being requested, for example: Create the CSR and store it in the /user_or_entity_database_directory/example.csr file: For further details about the parameters, see the PKCS10Client (1) man page. Optionally, verify that the CSR is correct: 5.2.1.3. Creating a CSR Using CRMFPopClient Certificate Request Message Format (CRMF) is a CSR format accepted in CMC that allows key archival information to be securely embedded in the request. This section describes examples how to use the CRMFPopClient utility to create a CSR. For further details about using CRMFPopClient , see the CRMFPopClient (1) man page. 5.2.1.3.1. Using CRMFPopClient to Create a CSR with Key Archival The following procedure explains how to use the CRMFPopClient utility to create an RSA key pair and a CSR with the key archival option: Change to the certificate database directory of the user or entity for which the certificate is being requested, for example: Retrieve the KRA transport certificate: Export the KRA transport certificate: Create the CSR and store it in the /user_or_entity_database_directory/example.csr file: To create an Elliptic Curve (EC) key pair and CSR, pass the -a ec -t false options to the command. For further details about the parameters, see the CRMFPopClient (1) man page. Optionally, verify that the CSR is correct: 5.2.1.3.2. Using CRMFPopClient to Create a CSR for SharedSecret-based CMC The following procedure explains how to use the CRMFPopClient utility to create an RSA key pair and CSR for SharedSecret-based CMC. Use it only with the CMC Shared Secret authentication method which is, by default, handled by the caFullCMCSharedTokenCert and caECFullCMCSharedTokenCert profiles. Change to the certificate database directory of the user or entity for which the certificate is being requested, for example: Retrieve the KRA transport certificate: Export the KRA transport certificate: Create the CSR and store it in the /user_or_entity_database_directory/example.csr file: To create an EC key pair and CSR, pass the -a ec -t false options to the command. For further details about the parameters, see the output of the CRMFPopClient --help command. Optionally, verify that the CSR is correct: 5.2.1.4. Creating a CSR using client-cert-request in the PKI CLI The pki command-line tool can also be used with the client-cert-request command to generate a CSR. However, unlike the previously discussed tools, CSR generated with pki are submitted directly to the CA. Both PKCS#10 or CRMF requests can be generated. Example on generating a PKCS#10 request: Example on generating a CRMF request: A request id will be returned upon success. Once a request is submitted, an agent could approve it by using the pki ca-cert-request-approve command. For example: For more information, see the man page by running the pki client-cert-request --help command. 5.2.2. Generating CSRs Using Server-Side Key Generation Many newer versions of browsers, including Firefox v69 and up, as well as Chrome, have removed the functionality to generate PKI keys and the support for CRMF for key archival. On RHEL, CLIs such as CRMFPopClient (see CRMFPopClient --help ) or pki (see pki client-cert-request --help ) could be used as a workaround. Server-Side Keygen enrollment has been around for a long time since the introduction of Token Key Management System (TMS), where keys could be generated on a KRA instead of locally on smart cards. Red Hat Certificate System now adopts a similar mechanism to resolve the browser keygen deficiency issue. Keys are generated on the server (specifically, on the KRA) and then transferred securely back to the client in PKCS#12. Note It is highly recommended to employ the Server-Side Keygen mechanism only for encryption certificates. 5.2.2.1. Functionality Highlights Certificate request keys are generated on the KRA (Note: a KRA must be installed to work with the CA) The profile default plugin, serverKeygenUserKeyDefaultImpl , provides selection to enable or disable key archival (i.e. the enableArchival parameter) Support for both RSA and EC keys Support for both manual (agent) approval and automatic approval (e.g. directory password-based) 5.2.2.2. Enrolling a Certificate Using Server-Side Keygen The default Sever-Side Keygen enrollment profile can be found on the EE page, under the List Certificate Profiles tab: Manual User Dual-Use Certificate Enrollment Using server-side Key generation Figure 5.1. Server-Side Keygen Enrollment that requires agent manual approval Directory-authenticated User Dual-Use Certificate Enrollment Using server-side Key generation Figure 5.2. Server-Side Keygen Enrollment that will be automatically approved upon successful LDAP uid/pwd authentication Regardless of how the request is approved, the Server-Side Keygen Enrollment mechanism requires the End Entity user to enter a password for the PKCS#12 package which will contain the issued certificate as well as the encrypted private key generated by the server once issued. Important Users should not share their passwords with anyone. Not even the CA or KRA agents. When the enrollment request is approved, the PKCS#12 package will be generated and, In case of manual approval, the PKCS#12 file will be returned to the CA agent that approves the request; the agent is then expected to forward the PKCS#12 file to the user. In case of automatic approval, the PKCS#12 file will be returned to the user who submitted the request Figure 5.3. Enrollment manually approved by an agent Once the PKCS#12 file is received, the user could use a CLI such as pkcs12util to import this file into their own user internal cert/key database for each application. E.g. the Firefox nss database of the user. 5.2.2.3. Key Recovery If the enableArchival parameter is set to true in the certificate enrollment profile, then the private keys are archived at the time of Server-Side Keygen enrollment. The archived private keys could then be recovered by the authorized KRA agents. 5.2.2.4. Additional Information 5.2.2.4.1. KRA Request Records Note Due to the nature of this mechanism, in case the enableArchival parameter is set to true in the profile, there are two KRA requests records per Server-Side keygen request: One for the request type asymkeyGenRequest This request type cannot be filtered using List Requests on the KRA agent page; you can select Show All Requests to see them listed. One for the request type recovery 5.2.2.4.2. Audit Records Some audit records could be observed if enabled: CA SERVER_SIDE_KEYGEN_ENROLL_KEYGEN_REQUEST SERVER_SIDE_KEYGEN_ENROLL_KEY_RETRIEVAL_REQUEST KRA SERVER_SIDE_KEYGEN_ENROLL_KEYGEN_REQUEST_PROCESSED SERVER_SIDE_KEYGEN_ENROLL_KEY_RETRIEVAL_REQUEST_PROCESSED (not yet implemented)	[ "cd /user_or_entity_database_directory/", "certutil -d . -R -k ec -q nistp256 -s \"CN= subject_name \" -o /user_or_entity_database_directory/request-bin.csr", "BtoA /user_or_entity_database_directory/request-bin.csr /user_or_entity_database_directory/request.csr", "cat /user_or_entity_database_directory/request.csr MIICbTCCAVUCAQAwKDEQMA4GA1UEChMHRXhhbXBsZTEUMBIGA1UEAxMLZXhhbXBs", "cd /user_or_entity_database_directory/", "certutil -d . -R -k rsa -g 1024 -s \"CN= subject_name \" --keyUsage keyEncipherment,dataEncipherment,critical --extKeyUsage timeStamp,msTrustListSign,critical -a -o /user_or_entity_database_directory/request.csr", "cat /user_or_entity_database_directory/request.csr Certificate request generated by Netscape certutil Phone: (not specified) Common Name: user 4-2-1-2 Email: (not specified) Organization: (not specified) State: (not specified) Country: (not specified)", "cd /user_or_entity_database_directory/", "PKCS10Client -d . -p NSS_password -a ec -c nistp256 -o /user_or_entity_database_directory/example.csr -n \"CN= subject_name \"", "cat /user_or_entity_database_directory/example.csr -----BEGIN CERTIFICATE REQUEST----- MIICzzCCAbcCAQAwgYkx -----END CERTIFICATE REQUEST-----", "cd /user_or_entity_database_directory/", "PKCS10Client -d . -p NSS_password -o /user_or_entity_database_directory/example.csr -y true -n \"CN= subject_name \"", "cat /user_or_entity_database_directory/example.csr -----BEGIN CERTIFICATE REQUEST----- MIICzzCCAbcCAQAwgYkx -----END CERTIFICATE REQUEST-----", "cd /user_or_entity_database_directory/", "pki ca-cert-find --name \" DRM Transport Certificate \" --------------- 1 entries found --------------- Serial Number: 0x7 Subject DN: CN= DRM Transport Certificate,O=EXAMPLE Status: VALID Type: X.509 version 3 Key A lgorithm: PKCS #1 RSA with 2048-bit key Not Valid Before: Thu Oct 22 18:26:11 CEST 2015 Not Valid After: Wed Oct 11 18:26:11 CEST 2017 Issued On: Thu Oct 22 18:26:11 CEST 2015 Issued By: caadmin ---------------------------- Number of entries returned 1", "pki ca-cert-show 0x7 --output kra.transport", "CRMFPopClient -d . -p password -n \"cn= subject_name \" -q POP_SUCCESS -b kra.transport -w \"AES/CBC/PKCS5Padding\" -v -o /user_or_entity_database_directory/example.csr", "cat /user_or_entity_database_directory/example.csr -----BEGIN CERTIFICATE REQUEST----- MIICzzCCAbcCAQAwgYkx -----END CERTIFICATE REQUEST-----", "cd /user_or_entity_database_directory/", "pki ca-cert-find --name \" DRM Transport Certificate \" --------------- 1 entries found --------------- Serial Number: 0x7 Subject DN: CN= DRM Transport Certificate,O=EXAMPLE Status: VALID Type: X.509 version 3 Key A lgorithm: PKCS #1 RSA with 2048-bit key Not Valid Before: Thu Oct 22 18:26:11 CEST 2015 Not Valid After: Wed Oct 11 18:26:11 CEST 2017 Issued On: Thu Oct 22 18:26:11 CEST 2015 Issued By: caadmin ---------------------------- Number of entries returned 1", "pki ca-cert-show 0x7 --output kra.transport", "CRMFPopClient -d . -p password -n \"cn= subject_name \" -q POP_SUCCESS -b kra.transport -w \"AES/CBC/PKCS5Padding\" -y -v -o /user_or_entity_database_directory/example.csr", "cat /user_or_entity_database_directory/example.csr -----BEGIN CERTIFICATE REQUEST----- MIICzzCCAbcCAQAwgYkx -----END CERTIFICATE REQUEST-----", "pki -d user token db directory -P https -p 8443 -h host.test.com -c user token db passwd client-cert-request \"uid=test2\" --length 4096 --type pkcs10", "pki -d user token db directory -P https -p 8443 -h host.test.com -c user token db passwd client-cert-request \"uid=test2\" --length 4096 --type crmf", "pki -d agent token db directory -P https -p 8443 -h host.test.com -c agent token db passwd -n <CA agent cert nickname> ca-cert-request-approve request id" ]	https://docs.redhat.com/en/documentation/red_hat_certificate_system/10/html/administration_guide/creating_certificate_signing_requests
3.8. Choose a Boot Method	3.8. Choose a Boot Method You can use several methods to boot Red Hat Enterprise Linux. Installing from a DVD requires that you have purchased a Red Hat Enterprise Linux product, you have a Red Hat Enterprise Linux 6.9 DVD, and you have a DVD drive on a system that supports booting from it. Refer to Chapter 2, Making Media for instructions to make an installation DVD. Your BIOS may need to be changed to allow booting from your DVD/CD-ROM drive. For more information about changing your BIOS, refer to Section 7.1.1, "Booting the Installation Program on x86, AMD64, and Intel 64 Systems" . Other than booting from an installation DVD, you can also boot the Red Hat Enterprise Linux installation program from minimal boot media in the form of a bootable CD or USB flash drive. After you boot the system with a piece of minimal boot media, you complete the installation from a different installation source, such as a local hard drive or a location on a network. Refer to Section 2.2, "Making Minimal Boot Media" for instructions on making boot CDs and USB flash drives. Finally, you can boot the installer over the network from a preboot execution environment (PXE) server. Refer to Chapter 30, Setting Up an Installation Server . Again, after you boot the system, you complete the installation from a different installation source, such as a local hard drive or a location on a network.	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/installation_guide/ch03s08
Chapter 15. Troubleshooting	Chapter 15. Troubleshooting There are cases where the Assisted Installer cannot begin the installation or the cluster fails to install properly. In these events, it is helpful to understand the likely failure modes as well as how to troubleshoot the failure. 15.1. Prerequisites You have created an infrastructure environment using the API or have created a cluster using the UI. 15.2. Troubleshooting discovery ISO issues The Assisted Installer uses an ISO image to run an agent that registers the host to the cluster and performs hardware and network validations before attempting to install OpenShift. You can follow these procedures to troubleshoot problems related to the host discovery. Once you start the host with the discovery ISO image, the Assisted Installer discovers the host and presents it in the Assisted Service UI. See Configuring the discovery image for additional details. 15.3. Minimal ISO Image The minimal ISO image should be used when bandwidth over the virtual media connection is limited. It includes only what is required to boot a host with networking. The majority of the content is downloaded upon boot. The resulting ISO image is about 100MB in size compared to 1GB for the full ISO image. 15.3.1. Troubleshooting minimal ISO boot failures If your environment requires static network configuration to access the Assisted Installer service, any issues with that configuration may prevent the Minimal ISO from booting properly. If the boot screen shows that the host has failed to download the root file system image, verify that any additional network configuration is correct. Switching to a Full ISO image will also allow for easier debugging. Example rootfs download failure 15.4. Verify the discovery agent is running Prerequisites You have created an Infrastructure Environment by using the API or have created a cluster by using the UI. You booted a host with the Infrastructure Environment discovery ISO and the host failed to register. You have ssh access to the host. You provided an SSH public key in the "Add hosts" dialog before generating the Discovery ISO so that you can SSH into your machine without a password. Procedure Verify that your host machine is powered on. If you selected DHCP networking , check that the DHCP server is enabled. If you selected Static IP, bridges and bonds networking, check that your configurations are correct. Verify that you can access your host machine using SSH, a console such as the BMC, or a virtual machine console: USD ssh core@<host_ip_address> You can specify private key file using the -i parameter if it isn't stored in the default directory. USD ssh -i <ssh_private_key_file> core@<host_ip_address> If you fail to ssh to the host, the host failed during boot or it failed to configure the network. Upon login you should see this message: Example login If you are not seeing this message it means that the host didn't boot with the assisted-installer ISO. Make sure you configured the boot order properly (The host should boot once from the live-ISO). Check the agent service logs: USD sudo journalctl -u agent.service In the following example, the errors indicate there is a network issue: Example agent service log screenshot of agent service log If there is an error pulling the agent image, check the proxy settings. Verify that the host is connected to the network. You can use nmcli to get additional information about your network configuration. 15.5. Verify the agent can access the assisted-service Prerequisites You have created an Infrastructure Environment by using the API or have created a cluster by using the UI. You booted a host with the Infrastructure Environment discovery ISO and the host failed to register. You verified the discovery agent is running. Procedure Check the agent logs to verify the agent can access the Assisted Service: USD sudo journalctl TAG=agent The errors in the following example indicate that the agent failed to access the Assisted Service. Example agent log Check the proxy settings you configured for the cluster. If configured, the proxy must allow access to the Assisted Service URL. 15.6. Correcting a host's boot order Once the installation that runs as part of the Discovery Image completes, the Assisted Installer reboots the host. The host must boot from its installation disk to continue forming the cluster. If you have not correctly configured the host's boot order, it will boot from another disk instead, interrupting the installation. If the host boots the discovery image again, the Assisted Installer will immediately detect this event and set the host's status to Installing Pending User Action . Alternatively, if the Assisted Installer does not detect that the host has booted the correct disk within the allotted time, it will also set this host status. Procedure Reboot the host and set its boot order to boot from the installation disk. If you didn't select an installation disk, the Assisted Installer selected one for you. To view the selected installation disk, click to expand the host's information in the host inventory, and check which disk has the "Installation disk" role. 15.7. Rectifying partially-successful installations There are cases where the Assisted Installer declares an installation to be successful even though it encountered errors: If you requested to install OLM operators and one or more failed to install, log into the cluster's console to remediate the failures. If you requested to install more than two worker nodes and at least one failed to install, but at least two succeeded, add the failed workers to the installed cluster.	[ "ssh core@<host_ip_address>", "ssh -i <ssh_private_key_file> core@<host_ip_address>", "sudo journalctl -u agent.service", "sudo journalctl TAG=agent" ]	https://docs.redhat.com/en/documentation/openshift_container_platform/4.12/html/assisted_installer_for_openshift_container_platform/assembly_troubleshooting
Chapter 14. Pruning objects to reclaim resources	Chapter 14. Pruning objects to reclaim resources Over time, API objects created in OpenShift Container Platform can accumulate in the cluster's etcd data store through normal user operations, such as when building and deploying applications. Cluster administrators can periodically prune older versions of objects from the cluster that are no longer required. For example, by pruning images you can delete older images and layers that are no longer in use, but are still taking up disk space. 14.1. Basic pruning operations The CLI groups prune operations under a common parent command: USD oc adm prune <object_type> <options> This specifies: The <object_type> to perform the action on, such as groups , builds , deployments , or images . The <options> supported to prune that object type. 14.2. Pruning groups To prune groups records from an external provider, administrators can run the following command: USD oc adm prune groups \ --sync-config=path/to/sync/config [<options>] Table 14.1. oc adm prune groups flags Options Description --confirm Indicate that pruning should occur, instead of performing a dry-run. --blacklist Path to the group blacklist file. --whitelist Path to the group whitelist file. --sync-config Path to the synchronization configuration file. Procedure To see the groups that the prune command deletes, run the following command: USD oc adm prune groups --sync-config=ldap-sync-config.yaml To perform the prune operation, add the --confirm flag: USD oc adm prune groups --sync-config=ldap-sync-config.yaml --confirm 14.3. Pruning deployment resources You can prune resources associated with deployments that are no longer required by the system, due to age and status. The following command prunes replication controllers associated with DeploymentConfig objects: USD oc adm prune deployments [<options>] Note To also prune replica sets associated with Deployment objects, use the --replica-sets flag. This flag is currently a Technology Preview feature. Table 14.2. oc adm prune deployments flags Option Description --confirm Indicate that pruning should occur, instead of performing a dry-run. --keep-complete=<N> Per the DeploymentConfig object, keep the last N replication controllers that have a status of Complete and replica count of zero. The default is 5 . --keep-failed=<N> Per the DeploymentConfig object, keep the last N replication controllers that have a status of Failed and replica count of zero. The default is 1 . --keep-younger-than=<duration> Do not prune any replication controller that is younger than <duration> relative to the current time. Valid units of measurement include nanoseconds ( ns ), microseconds ( us ), milliseconds ( ms ), seconds ( s ), minutes ( m ), and hours ( h ). The default is 60m . --orphans Prune all replication controllers that no longer have a DeploymentConfig object, has status of Complete or Failed , and has a replica count of zero. --replica-sets=true\|false If true , replica sets are included in the pruning process. The default is false . Important This flag is a Technology Preview feature. Procedure To see what a pruning operation would delete, run the following command: USD oc adm prune deployments --orphans --keep-complete=5 --keep-failed=1 \ --keep-younger-than=60m To actually perform the prune operation, add the --confirm flag: USD oc adm prune deployments --orphans --keep-complete=5 --keep-failed=1 \ --keep-younger-than=60m --confirm 14.4. Pruning builds To prune builds that are no longer required by the system due to age and status, administrators can run the following command: USD oc adm prune builds [<options>] Table 14.3. oc adm prune builds flags Option Description --confirm Indicate that pruning should occur, instead of performing a dry-run. --orphans Prune all builds whose build configuration no longer exists, status is complete, failed, error, or canceled. --keep-complete=<N> Per build configuration, keep the last N builds whose status is complete. The default is 5 . --keep-failed=<N> Per build configuration, keep the last N builds whose status is failed, error, or canceled. The default is 1 . --keep-younger-than=<duration> Do not prune any object that is younger than <duration> relative to the current time. The default is 60m . Procedure To see what a pruning operation would delete, run the following command: USD oc adm prune builds --orphans --keep-complete=5 --keep-failed=1 \ --keep-younger-than=60m To actually perform the prune operation, add the --confirm flag: USD oc adm prune builds --orphans --keep-complete=5 --keep-failed=1 \ --keep-younger-than=60m --confirm Note Developers can enable automatic build pruning by modifying their build configuration. Additional resources Performing advanced builds Pruning builds 14.5. Automatically pruning images Images from the OpenShift image registry that are no longer required by the system due to age, status, or exceed limits are automatically pruned. Cluster administrators can configure the Pruning Custom Resource, or suspend it. Prerequisites Cluster administrator permissions. Install the oc CLI. Procedure Verify that the object named imagepruners.imageregistry.operator.openshift.io/cluster contains the following spec and status fields: spec: schedule: 0 0 * * * 1 suspend: false 2 keepTagRevisions: 3 3 keepYoungerThanDuration: 60m 4 keepYoungerThan: 3600000000000 5 resources: {} 6 affinity: {} 7 nodeSelector: {} 8 tolerations: [] 9 successfulJobsHistoryLimit: 3 10 failedJobsHistoryLimit: 3 11 status: observedGeneration: 2 12 conditions: 13 - type: Available status: "True" lastTransitionTime: 2019-10-09T03:13:45 reason: Ready message: "Periodic image pruner has been created." - type: Scheduled status: "True" lastTransitionTime: 2019-10-09T03:13:45 reason: Scheduled message: "Image pruner job has been scheduled." - type: Failed staus: "False" lastTransitionTime: 2019-10-09T03:13:45 reason: Succeeded message: "Most recent image pruning job succeeded." 1 schedule : CronJob formatted schedule. This is an optional field, default is daily at midnight. 2 suspend : If set to true , the CronJob running pruning is suspended. This is an optional field, default is false . The initial value on new clusters is false . 3 keepTagRevisions : The number of revisions per tag to keep. This is an optional field, default is 3 . The initial value is 3 . 4 keepYoungerThanDuration : Retain images younger than this duration. This is an optional field. If a value is not specified, either keepYoungerThan or the default value 60m (60 minutes) is used. 5 keepYoungerThan : Deprecated. The same as keepYoungerThanDuration , but the duration is specified as an integer in nanoseconds. This is an optional field. When keepYoungerThanDuration is set, this field is ignored. 6 resources : Standard pod resource requests and limits. This is an optional field. 7 affinity : Standard pod affinity. This is an optional field. 8 nodeSelector : Standard pod node selector. This is an optional field. 9 tolerations : Standard pod tolerations. This is an optional field. 10 successfulJobsHistoryLimit : The maximum number of successful jobs to retain. Must be >= 1 to ensure metrics are reported. This is an optional field, default is 3 . The initial value is 3 . 11 failedJobsHistoryLimit : The maximum number of failed jobs to retain. Must be >= 1 to ensure metrics are reported. This is an optional field, default is 3 . The initial value is 3 . 12 observedGeneration : The generation observed by the Operator. 13 conditions : The standard condition objects with the following types: Available : Indicates if the pruning job has been created. Reasons can be Ready or Error. Scheduled : Indicates if the pruning job has been scheduled. Reasons can be Scheduled, Suspended, or Error. Failed : Indicates if the most recent pruning job failed. Important The Image Registry Operator's behavior for managing the pruner is orthogonal to the managementState specified on the Image Registry Operator's ClusterOperator object. If the Image Registry Operator is not in the Managed state, the image pruner can still be configured and managed by the Pruning Custom Resource. However, the managementState of the Image Registry Operator alters the behavior of the deployed image pruner job: Managed : the --prune-registry flag for the image pruner is set to true . Removed : the --prune-registry flag for the image pruner is set to false , meaning it only prunes image metadata in etcd. 14.6. Manually pruning images The pruning custom resource enables automatic image pruning for the images from the OpenShift image registry. However, administrators can manually prune images that are no longer required by the system due to age, status, or exceed limits. There are two methods to manually prune images: Running image pruning as a Job or CronJob on the cluster. Running the oc adm prune images command. Prerequisites To prune images, you must first log in to the CLI as a user with an access token. The user must also have the system:image-pruner cluster role or greater (for example, cluster-admin ). Expose the image registry. Procedure To manually prune images that are no longer required by the system due to age, status, or exceed limits, use one of the following methods: Run image pruning as a Job or CronJob on the cluster by creating a YAML file for the pruner service account, for example: USD oc create -f <filename>.yaml Example output kind: List apiVersion: v1 items: - apiVersion: v1 kind: ServiceAccount metadata: name: pruner namespace: openshift-image-registry - apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: name: openshift-image-registry-pruner roleRef: apiGroup: rbac.authorization.k8s.io kind: ClusterRole name: system:image-pruner subjects: - kind: ServiceAccount name: pruner namespace: openshift-image-registry - apiVersion: batch/v1 kind: CronJob metadata: name: image-pruner namespace: openshift-image-registry spec: schedule: "0 0 * * *" concurrencyPolicy: Forbid successfulJobsHistoryLimit: 1 failedJobsHistoryLimit: 3 jobTemplate: spec: template: spec: restartPolicy: OnFailure containers: - image: "quay.io/openshift/origin-cli:4.1" resources: requests: cpu: 1 memory: 1Gi terminationMessagePolicy: FallbackToLogsOnError command: - oc args: - adm - prune - images - --certificate-authority=/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt - --keep-tag-revisions=5 - --keep-younger-than=96h - --confirm=true name: image-pruner serviceAccountName: pruner Run the oc adm prune images [<options>] command: USD oc adm prune images [<options>] Pruning images removes data from the integrated registry unless --prune-registry=false is used. Pruning images with the --namespace flag does not remove images, only image streams. Images are non-namespaced resources. Therefore, limiting pruning to a particular namespace makes it impossible to calculate its current usage. By default, the integrated registry caches metadata of blobs to reduce the number of requests to storage, and to increase the request-processing speed. Pruning does not update the integrated registry cache. Images that still contain pruned layers after pruning will be broken because the pruned layers that have metadata in the cache will not be pushed. Therefore, you must redeploy the registry to clear the cache after pruning: USD oc rollout restart deployment/image-registry -n openshift-image-registry If the integrated registry uses a Redis cache, you must clean the database manually. If redeploying the registry after pruning is not an option, then you must permanently disable the cache. oc adm prune images operations require a route for your registry. Registry routes are not created by default. The Prune images CLI configuration options table describes the options you can use with the oc adm prune images <options> command. Table 14.4. Prune images CLI configuration options Option Description --all Include images that were not pushed to the registry, but have been mirrored by pullthrough. This is on by default. To limit the pruning to images that were pushed to the integrated registry, pass --all=false . --certificate-authority The path to a certificate authority file to use when communicating with the OpenShift Container Platform-managed registries. Defaults to the certificate authority data from the current user's configuration file. If provided, a secure connection is initiated. --confirm Indicate that pruning should occur, instead of performing a test-run. This requires a valid route to the integrated container image registry. If this command is run outside of the cluster network, the route must be provided using --registry-url . --force-insecure Use caution with this option. Allow an insecure connection to the container registry that is hosted via HTTP or has an invalid HTTPS certificate. --keep-tag-revisions=<N> For each imagestream, keep up to at most N image revisions per tag (default 3 ). --keep-younger-than=<duration> Do not prune any image that is younger than <duration> relative to the current time. Alternately, do not prune any image that is referenced by any other object that is younger than <duration> relative to the current time (default 60m ). --prune-over-size-limit Prune each image that exceeds the smallest limit defined in the same project. This flag cannot be combined with --keep-tag-revisions nor --keep-younger-than . --registry-url The address to use when contacting the registry. The command attempts to use a cluster-internal URL determined from managed images and image streams. In case it fails (the registry cannot be resolved or reached), an alternative route that works needs to be provided using this flag. The registry hostname can be prefixed by https:// or http:// , which enforces particular connection protocol. --prune-registry In conjunction with the conditions stipulated by the other options, this option controls whether the data in the registry corresponding to the OpenShift Container Platform image API object is pruned. By default, image pruning processes both the image API objects and corresponding data in the registry. This option is useful when you are only concerned with removing etcd content, to reduce the number of image objects but are not concerned with cleaning up registry storage, or if you intend to do that separately by hard pruning the registry during an appropriate maintenance window for the registry. 14.6.1. Image prune conditions You can apply conditions to your manually pruned images. To remove any image managed by OpenShift Container Platform, or images with the annotation openshift.io/image.managed : Created at least --keep-younger-than minutes ago and are not currently referenced by any: Pods created less than --keep-younger-than minutes ago Image streams created less than --keep-younger-than minutes ago Running pods Pending pods Replication controllers Deployments Deployment configs Replica sets Build configurations Builds Jobs Cronjobs Stateful sets --keep-tag-revisions most recent items in stream.status.tags[].items That are exceeding the smallest limit defined in the same project and are not currently referenced by any: Running pods Pending pods Replication controllers Deployments Deployment configs Replica sets Build configurations Builds Jobs Cronjobs Stateful sets There is no support for pruning from external registries. When an image is pruned, all references to the image are removed from all image streams that have a reference to the image in status.tags . Image layers that are no longer referenced by any images are removed. Note The --prune-over-size-limit flag cannot be combined with the --keep-tag-revisions flag nor the --keep-younger-than flags. Doing so returns information that this operation is not allowed. Separating the removal of OpenShift Container Platform image API objects and image data from the registry by using --prune-registry=false , followed by hard pruning the registry, can narrow timing windows and is safer when compared to trying to prune both through one command. However, timing windows are not completely removed. For example, you can still create a pod referencing an image as pruning identifies that image for pruning. You should still keep track of an API object created during the pruning operations that might reference images so that you can mitigate any references to deleted content. Re-doing the pruning without the --prune-registry option or with --prune-registry=true does not lead to pruning the associated storage in the image registry for images previously pruned by --prune-registry=false . Any images that were pruned with --prune-registry=false can only be deleted from registry storage by hard pruning the registry. 14.6.2. Running the image prune operation Procedure To see what a pruning operation would delete: Keeping up to three tag revisions, and keeping resources (images, image streams, and pods) younger than 60 minutes: USD oc adm prune images --keep-tag-revisions=3 --keep-younger-than=60m Pruning every image that exceeds defined limits: USD oc adm prune images --prune-over-size-limit To perform the prune operation with the options from the step: USD oc adm prune images --keep-tag-revisions=3 --keep-younger-than=60m --confirm USD oc adm prune images --prune-over-size-limit --confirm 14.6.3. Using secure or insecure connections The secure connection is the preferred and recommended approach. It is done over HTTPS protocol with a mandatory certificate verification. The prune command always attempts to use it if possible. If it is not possible, in some cases it can fall-back to insecure connection, which is dangerous. In this case, either certificate verification is skipped or plain HTTP protocol is used. The fall-back to insecure connection is allowed in the following cases unless --certificate-authority is specified: The prune command is run with the --force-insecure option. The provided registry-url is prefixed with the http:// scheme. The provided registry-url is a local-link address or localhost . The configuration of the current user allows for an insecure connection. This can be caused by the user either logging in using --insecure-skip-tls-verify or choosing the insecure connection when prompted. Important If the registry is secured by a certificate authority different from the one used by OpenShift Container Platform, it must be specified using the --certificate-authority flag. Otherwise, the prune command fails with an error. 14.6.4. Image pruning problems Images not being pruned If your images keep accumulating and the prune command removes just a small portion of what you expect, ensure that you understand the image prune conditions that must apply for an image to be considered a candidate for pruning. Ensure that images you want removed occur at higher positions in each tag history than your chosen tag revisions threshold. For example, consider an old and obsolete image named sha256:abz . By running the following command in your namespace, where the image is tagged, the image is tagged three times in a single image stream named myapp : USD oc get is -n <namespace> -o go-template='{{range USDisi, USDis := .items}}{{range USDti, USDtag := USDis.status.tags}}'\ '{{range USDii, USDitem := USDtag.items}}{{if eq USDitem.image "sha256:<hash>"}}{{USDis.metadata.name}}:{{USDtag.tag}} at position {{USDii}} out of {{len USDtag.items}}\n'\ '{{end}}{{end}}{{end}}{{end}}' Example output myapp:v2 at position 4 out of 5 myapp:v2.1 at position 2 out of 2 myapp:v2.1-may-2016 at position 0 out of 1 When default options are used, the image is never pruned because it occurs at position 0 in a history of myapp:v2.1-may-2016 tag. For an image to be considered for pruning, the administrator must either: Specify --keep-tag-revisions=0 with the oc adm prune images command. Warning This action removes all the tags from all the namespaces with underlying images, unless they are younger or they are referenced by objects younger than the specified threshold. Delete all the istags where the position is below the revision threshold, which means myapp:v2.1 and myapp:v2.1-may-2016 . Move the image further in the history, either by running new builds pushing to the same istag , or by tagging other image. This is not always desirable for old release tags. Tags having a date or time of a particular image's build in their names should be avoided, unless the image must be preserved for an undefined amount of time. Such tags tend to have just one image in their history, which prevents them from ever being pruned. Using a secure connection against insecure registry If you see a message similar to the following in the output of the oc adm prune images command, then your registry is not secured and the oc adm prune images client attempts to use a secure connection: error: error communicating with registry: Get https://172.30.30.30:5000/healthz: http: server gave HTTP response to HTTPS client The recommended solution is to secure the registry. Otherwise, you can force the client to use an insecure connection by appending --force-insecure to the command; however, this is not recommended. Using an insecure connection against a secured registry If you see one of the following errors in the output of the oc adm prune images command, it means that your registry is secured using a certificate signed by a certificate authority other than the one used by oc adm prune images client for connection verification: error: error communicating with registry: Get http://172.30.30.30:5000/healthz: malformed HTTP response "\x15\x03\x01\x00\x02\x02" error: error communicating with registry: [Get https://172.30.30.30:5000/healthz: x509: certificate signed by unknown authority, Get http://172.30.30.30:5000/healthz: malformed HTTP response "\x15\x03\x01\x00\x02\x02"] By default, the certificate authority data stored in the user's configuration files is used; the same is true for communication with the master API. Use the --certificate-authority option to provide the right certificate authority for the container image registry server. Using the wrong certificate authority The following error means that the certificate authority used to sign the certificate of the secured container image registry is different from the authority used by the client: error: error communicating with registry: Get https://172.30.30.30:5000/: x509: certificate signed by unknown authority Make sure to provide the right one with the flag --certificate-authority . As a workaround, the --force-insecure flag can be added instead. However, this is not recommended. Additional resources Accessing the registry Exposing the registry See Image Registry Operator in OpenShift Container Platform for information on how to create a registry route. 14.7. Hard pruning the registry The OpenShift Container Registry can accumulate blobs that are not referenced by the OpenShift Container Platform cluster's etcd. The basic pruning images procedure, therefore, is unable to operate on them. These are called orphaned blobs . Orphaned blobs can occur from the following scenarios: Manually deleting an image with oc delete image <sha256:image-id> command, which only removes the image from etcd, but not from the registry's storage. Pushing to the registry initiated by daemon failures, which causes some blobs to get uploaded, but the image manifest (which is uploaded as the very last component) does not. All unique image blobs become orphans. OpenShift Container Platform refusing an image because of quota restrictions. The standard image pruner deleting an image manifest, but is interrupted before it deletes the related blobs. A bug in the registry pruner, which fails to remove the intended blobs, causing the image objects referencing them to be removed and the blobs becoming orphans. Hard pruning the registry, a separate procedure from basic image pruning, allows cluster administrators to remove orphaned blobs. You should hard prune if you are running out of storage space in your OpenShift Container Registry and believe you have orphaned blobs. This should be an infrequent operation and is necessary only when you have evidence that significant numbers of new orphans have been created. Otherwise, you can perform standard image pruning at regular intervals, for example, once a day (depending on the number of images being created). Procedure To hard prune orphaned blobs from the registry: Log in. Log in to the cluster with the CLI as kubeadmin or another privileged user that has access to the openshift-image-registry namespace. Run a basic image prune . Basic image pruning removes additional images that are no longer needed. The hard prune does not remove images on its own. It only removes blobs stored in the registry storage. Therefore, you should run this just before the hard prune. Switch the registry to read-only mode. If the registry is not running in read-only mode, any pushes happening at the same time as the prune will either: fail and cause new orphans, or succeed although the images cannot be pulled (because some of the referenced blobs were deleted). Pushes will not succeed until the registry is switched back to read-write mode. Therefore, the hard prune must be carefully scheduled. To switch the registry to read-only mode: In configs.imageregistry.operator.openshift.io/cluster , set spec.readOnly to true : USD oc patch configs.imageregistry.operator.openshift.io/cluster -p '{"spec":{"readOnly":true}}' --type=merge Add the system:image-pruner role. The service account used to run the registry instances requires additional permissions to list some resources. Get the service account name: USD service_account=USD(oc get -n openshift-image-registry \ -o jsonpath='{.spec.template.spec.serviceAccountName}' deploy/image-registry) Add the system:image-pruner cluster role to the service account: USD oc adm policy add-cluster-role-to-user \ system:image-pruner -z \ USD{service_account} -n openshift-image-registry Optional: Run the pruner in dry-run mode. To see how many blobs would be removed, run the hard pruner in dry-run mode. No changes are actually made. The following example references an image registry pod called image-registry-3-vhndw : USD oc -n openshift-image-registry exec pod/image-registry-3-vhndw -- /bin/sh -c '/usr/bin/dockerregistry -prune=check' Alternatively, to get the exact paths for the prune candidates, increase the logging level: USD oc -n openshift-image-registry exec pod/image-registry-3-vhndw -- /bin/sh -c 'REGISTRY_LOG_LEVEL=info /usr/bin/dockerregistry -prune=check' Example output time="2017-06-22T11:50:25.066156047Z" level=info msg="start prune (dry-run mode)" distribution_version="v2.4.1+unknown" kubernetes_version=v1.6.1+USDFormat:%hUSD openshift_version=unknown time="2017-06-22T11:50:25.092257421Z" level=info msg="Would delete blob: sha256:00043a2a5e384f6b59ab17e2c3d3a3d0a7de01b2cabeb606243e468acc663fa5" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6 time="2017-06-22T11:50:25.092395621Z" level=info msg="Would delete blob: sha256:0022d49612807cb348cabc562c072ef34d756adfe0100a61952cbcb87ee6578a" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6 time="2017-06-22T11:50:25.092492183Z" level=info msg="Would delete blob: sha256:0029dd4228961086707e53b881e25eba0564fa80033fbbb2e27847a28d16a37c" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6 time="2017-06-22T11:50:26.673946639Z" level=info msg="Would delete blob: sha256:ff7664dfc213d6cc60fd5c5f5bb00a7bf4a687e18e1df12d349a1d07b2cf7663" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6 time="2017-06-22T11:50:26.674024531Z" level=info msg="Would delete blob: sha256:ff7a933178ccd931f4b5f40f9f19a65be5eeeec207e4fad2a5bafd28afbef57e" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6 time="2017-06-22T11:50:26.674675469Z" level=info msg="Would delete blob: sha256:ff9b8956794b426cc80bb49a604a0b24a1553aae96b930c6919a6675db3d5e06" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6 ... Would delete 13374 blobs Would free up 2.835 GiB of disk space Use -prune=delete to actually delete the data Run the hard prune. Execute the following command inside one running instance of a image-registry pod to run the hard prune. The following example references an image registry pod called image-registry-3-vhndw : USD oc -n openshift-image-registry exec pod/image-registry-3-vhndw -- /bin/sh -c '/usr/bin/dockerregistry -prune=delete' Example output Deleted 13374 blobs Freed up 2.835 GiB of disk space Switch the registry back to read-write mode. After the prune is finished, the registry can be switched back to read-write mode. In configs.imageregistry.operator.openshift.io/cluster , set spec.readOnly to false : USD oc patch configs.imageregistry.operator.openshift.io/cluster -p '{"spec":{"readOnly":false}}' --type=merge 14.8. Pruning cron jobs Cron jobs can perform pruning of successful jobs, but might not properly handle failed jobs. Therefore, the cluster administrator should perform regular cleanup of jobs manually. They should also restrict the access to cron jobs to a small group of trusted users and set appropriate quota to prevent the cron job from creating too many jobs and pods. Additional resources Running tasks in pods using jobs Resource quotas across multiple projects Using RBAC to define and apply permissions	[ "oc adm prune <object_type> <options>", "oc adm prune groups --sync-config=path/to/sync/config [<options>]", "oc adm prune groups --sync-config=ldap-sync-config.yaml", "oc adm prune groups --sync-config=ldap-sync-config.yaml --confirm", "oc adm prune deployments [<options>]", "oc adm prune deployments --orphans --keep-complete=5 --keep-failed=1 --keep-younger-than=60m", "oc adm prune deployments --orphans --keep-complete=5 --keep-failed=1 --keep-younger-than=60m --confirm", "oc adm prune builds [<options>]", "oc adm prune builds --orphans --keep-complete=5 --keep-failed=1 --keep-younger-than=60m", "oc adm prune builds --orphans --keep-complete=5 --keep-failed=1 --keep-younger-than=60m --confirm", "spec: schedule: 0 0 * * * 1 suspend: false 2 keepTagRevisions: 3 3 keepYoungerThanDuration: 60m 4 keepYoungerThan: 3600000000000 5 resources: {} 6 affinity: {} 7 nodeSelector: {} 8 tolerations: [] 9 successfulJobsHistoryLimit: 3 10 failedJobsHistoryLimit: 3 11 status: observedGeneration: 2 12 conditions: 13 - type: Available status: \"True\" lastTransitionTime: 2019-10-09T03:13:45 reason: Ready message: \"Periodic image pruner has been created.\" - type: Scheduled status: \"True\" lastTransitionTime: 2019-10-09T03:13:45 reason: Scheduled message: \"Image pruner job has been scheduled.\" - type: Failed staus: \"False\" lastTransitionTime: 2019-10-09T03:13:45 reason: Succeeded message: \"Most recent image pruning job succeeded.\"", "oc create -f <filename>.yaml", "kind: List apiVersion: v1 items: - apiVersion: v1 kind: ServiceAccount metadata: name: pruner namespace: openshift-image-registry - apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: name: openshift-image-registry-pruner roleRef: apiGroup: rbac.authorization.k8s.io kind: ClusterRole name: system:image-pruner subjects: - kind: ServiceAccount name: pruner namespace: openshift-image-registry - apiVersion: batch/v1 kind: CronJob metadata: name: image-pruner namespace: openshift-image-registry spec: schedule: \"0 0 * * *\" concurrencyPolicy: Forbid successfulJobsHistoryLimit: 1 failedJobsHistoryLimit: 3 jobTemplate: spec: template: spec: restartPolicy: OnFailure containers: - image: \"quay.io/openshift/origin-cli:4.1\" resources: requests: cpu: 1 memory: 1Gi terminationMessagePolicy: FallbackToLogsOnError command: - oc args: - adm - prune - images - --certificate-authority=/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt - --keep-tag-revisions=5 - --keep-younger-than=96h - --confirm=true name: image-pruner serviceAccountName: pruner", "oc adm prune images [<options>]", "oc rollout restart deployment/image-registry -n openshift-image-registry", "oc adm prune images --keep-tag-revisions=3 --keep-younger-than=60m", "oc adm prune images --prune-over-size-limit", "oc adm prune images --keep-tag-revisions=3 --keep-younger-than=60m --confirm", "oc adm prune images --prune-over-size-limit --confirm", "oc get is -n <namespace> -o go-template='{{range USDisi, USDis := .items}}{{range USDti, USDtag := USDis.status.tags}}' '{{range USDii, USDitem := USDtag.items}}{{if eq USDitem.image \"sha256:<hash>\"}}{{USDis.metadata.name}}:{{USDtag.tag}} at position {{USDii}} out of {{len USDtag.items}}\\n' '{{end}}{{end}}{{end}}{{end}}'", "myapp:v2 at position 4 out of 5 myapp:v2.1 at position 2 out of 2 myapp:v2.1-may-2016 at position 0 out of 1", "error: error communicating with registry: Get https://172.30.30.30:5000/healthz: http: server gave HTTP response to HTTPS client", "error: error communicating with registry: Get http://172.30.30.30:5000/healthz: malformed HTTP response \"\\x15\\x03\\x01\\x00\\x02\\x02\" error: error communicating with registry: [Get https://172.30.30.30:5000/healthz: x509: certificate signed by unknown authority, Get http://172.30.30.30:5000/healthz: malformed HTTP response \"\\x15\\x03\\x01\\x00\\x02\\x02\"]", "error: error communicating with registry: Get https://172.30.30.30:5000/: x509: certificate signed by unknown authority", "oc patch configs.imageregistry.operator.openshift.io/cluster -p '{\"spec\":{\"readOnly\":true}}' --type=merge", "service_account=USD(oc get -n openshift-image-registry -o jsonpath='{.spec.template.spec.serviceAccountName}' deploy/image-registry)", "oc adm policy add-cluster-role-to-user system:image-pruner -z USD{service_account} -n openshift-image-registry", "oc -n openshift-image-registry exec pod/image-registry-3-vhndw -- /bin/sh -c '/usr/bin/dockerregistry -prune=check'", "oc -n openshift-image-registry exec pod/image-registry-3-vhndw -- /bin/sh -c 'REGISTRY_LOG_LEVEL=info /usr/bin/dockerregistry -prune=check'", "time=\"2017-06-22T11:50:25.066156047Z\" level=info msg=\"start prune (dry-run mode)\" distribution_version=\"v2.4.1+unknown\" kubernetes_version=v1.6.1+USDFormat:%hUSD openshift_version=unknown time=\"2017-06-22T11:50:25.092257421Z\" level=info msg=\"Would delete blob: sha256:00043a2a5e384f6b59ab17e2c3d3a3d0a7de01b2cabeb606243e468acc663fa5\" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6 time=\"2017-06-22T11:50:25.092395621Z\" level=info msg=\"Would delete blob: sha256:0022d49612807cb348cabc562c072ef34d756adfe0100a61952cbcb87ee6578a\" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6 time=\"2017-06-22T11:50:25.092492183Z\" level=info msg=\"Would delete blob: sha256:0029dd4228961086707e53b881e25eba0564fa80033fbbb2e27847a28d16a37c\" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6 time=\"2017-06-22T11:50:26.673946639Z\" level=info msg=\"Would delete blob: sha256:ff7664dfc213d6cc60fd5c5f5bb00a7bf4a687e18e1df12d349a1d07b2cf7663\" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6 time=\"2017-06-22T11:50:26.674024531Z\" level=info msg=\"Would delete blob: sha256:ff7a933178ccd931f4b5f40f9f19a65be5eeeec207e4fad2a5bafd28afbef57e\" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6 time=\"2017-06-22T11:50:26.674675469Z\" level=info msg=\"Would delete blob: sha256:ff9b8956794b426cc80bb49a604a0b24a1553aae96b930c6919a6675db3d5e06\" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6 Would delete 13374 blobs Would free up 2.835 GiB of disk space Use -prune=delete to actually delete the data", "oc -n openshift-image-registry exec pod/image-registry-3-vhndw -- /bin/sh -c '/usr/bin/dockerregistry -prune=delete'", "Deleted 13374 blobs Freed up 2.835 GiB of disk space", "oc patch configs.imageregistry.operator.openshift.io/cluster -p '{\"spec\":{\"readOnly\":false}}' --type=merge" ]	https://docs.redhat.com/en/documentation/openshift_container_platform/4.13/html/building_applications/pruning-objects
Chapter 1. Introduction	Chapter 1. Introduction JBoss EAP 7 can be used with the Microsoft Azure platform, as long as you use it within the specific supported configurations for running JBoss EAP in Azure. If you are configuring a clustered JBoss EAP environment, you must apply the specific configurations necessary to use JBoss EAP clustering features in Azure. This guide details the supported configurations of using JBoss EAP in Microsoft Azure, as well as the specific JBoss EAP configuration required to enable JBoss EAP clustering in Azure. All other JBoss EAP features not mentioned in this guide operate normally in Azure as with any other JBoss EAP installation. See the other JBoss EAP documentation for non-Azure-specific configuration instructions. 1.1. Subscription models for JBoss EAP on Azure You can choose between two subscription models for deploying JBoss EAP on Azure: bring your own subscription (BYOS) and pay-as-you-go (PAYG). The following are the differences between the two offerings: BYOS If you already have an existing Red Hat subscription, you can use it for deploying JBoss EAP on Azure with the BYOS model. For more information, see About Red Hat Cloud Access . PAYG If you do not have an existing Red Hat subscription, you can choose to pay based on the number of computing resources you used by using the PAYG model. 1.2. About Red Hat Cloud Access If you have an existing Red Hat subscription, Red Hat Cloud Access provides support for JBoss EAP on Red Hat certified cloud infrastructure providers, such as Amazon EC2 and Microsoft Azure. Red Hat Cloud Access allows you to cost-effectively move your subscriptions between traditional servers and public cloud-based resources. You can find more information about Red Hat Cloud Access on the Customer Portal .	null	https://docs.redhat.com/en/documentation/red_hat_jboss_enterprise_application_platform/7.4/html/using_jboss_eap_in_microsoft_azure/introduction
4.10. Maintaining SELinux Labels	4.10. Maintaining SELinux Labels These sections describe what happens to SELinux contexts when copying, moving, and archiving files and directories. Also, it explains how to preserve contexts when copying and archiving. 4.10.1. Copying Files and Directories When a file or directory is copied, a new file or directory is created if it does not exist. That new file or directory's context is based on default-labeling rules, not the original file or directory's context unless options were used to preserve the original context. For example, files created in user home directories are labeled with the user_home_t type: If such a file is copied to another directory, such as /etc , the new file is created in accordance to default-labeling rules for /etc . Copying a file without additional options may not preserve the original context: When file1 is copied to /etc , if /etc/file1 does not exist, /etc/file1 is created as a new file. As shown in the example above, /etc/file1 is labeled with the etc_t type, in accordance to default-labeling rules. When a file is copied over an existing file, the existing file's context is preserved, unless the user specified cp options to preserve the context of the original file, such as --preserve=context . SELinux policy may prevent contexts from being preserved during copies. Procedure 4.11. Copying Without Preserving SELinux Contexts This procedure shows that when copying a file with the cp command, if no options are given, the type is inherited from the targeted, parent directory. Create a file in a user's home directory. The file is labeled with the user_home_t type: The /var/www/html/ directory is labeled with the httpd_sys_content_t type, as shown with the following command: When file1 is copied to /var/www/html/ , it inherits the httpd_sys_content_t type: Procedure 4.12. Preserving SELinux Contexts When Copying This procedure shows how to use the --preserve=context option to preserve contexts when copying. Create a file in a user's home directory. The file is labeled with the user_home_t type: The /var/www/html/ directory is labeled with the httpd_sys_content_t type, as shown with the following command: Using the --preserve=context option preserves SELinux contexts during copy operations. As shown below, the user_home_t type of file1 was preserved when the file was copied to /var/www/html/ : Procedure 4.13. Copying and Changing the Context This procedure show how to use the --context option to change the destination copy's context. The following example is performed in the user's home directory: Create a file in a user's home directory. The file is labeled with the user_home_t type: Use the --context option to define the SELinux context: Without --context , file2 would be labeled with the unconfined_u:object_r:user_home_t context: Procedure 4.14. Copying a File Over an Existing File This procedure shows that when a file is copied over an existing file, the existing file's context is preserved unless an option is used to preserve contexts. As root, create a new file, file1 in the /etc directory. As shown below, the file is labeled with the etc_t type: Create another file, file2 , in the /tmp directory. As shown below, the file is labeled with the user_tmp_t type: Overwrite file1 with file2 : After copying, the following command shows file1 labeled with the etc_t type, not the user_tmp_t type from /tmp/file2 that replaced /etc/file1 : Important Copy files and directories, rather than moving them. This helps ensure they are labeled with the correct SELinux contexts. Incorrect SELinux contexts can prevent processes from accessing such files and directories. 4.10.2. Moving Files and Directories Files and directories keep their current SELinux context when they are moved. In many cases, this is incorrect for the location they are being moved to. The following example demonstrates moving a file from a user's home directory to the /var/www/html/ directory, which is used by the Apache HTTP Server. Since the file is moved, it does not inherit the correct SELinux context: Procedure 4.15. Moving Files and Directories Change into your home directory and create file in it. The file is labeled with the user_home_t type: Enter the following command to view the SELinux context of the /var/www/html/ directory: By default, /var/www/html/ is labeled with the httpd_sys_content_t type. Files and directories created under /var/www/html/ inherit this type, and as such, they are labeled with this type. As root, move file1 to /var/www/html/ . Since this file is moved, it keeps its current user_home_t type: By default, the Apache HTTP Server cannot read files that are labeled with the user_home_t type. If all files comprising a web page are labeled with the user_home_t type, or another type that the Apache HTTP Server cannot read, permission is denied when attempting to access them using web browsers, such as Mozilla Firefox . Important Moving files and directories with the mv command may result in the incorrect SELinux context, preventing processes, such as the Apache HTTP Server and Samba, from accessing such files and directories. 4.10.3. Checking the Default SELinux Context Use the matchpathcon utility to check if files and directories have the correct SELinux context. This utility queries the system policy and then provides the default security context associated with the file path. [6] The following example demonstrates using matchpathcon to verify that files in /var/www/html/ directory are labeled correctly: Procedure 4.16. Checking the Default SELinux Conxtext with matchpathcon As the root user, create three files ( file1 , file2 , and file3 ) in the /var/www/html/ directory. These files inherit the httpd_sys_content_t type from /var/www/html/ : As root, change the file1 type to samba_share_t . Note that the Apache HTTP Server cannot read files or directories labeled with the samba_share_t type. The matchpathcon -V option compares the current SELinux context to the correct, default context in SELinux policy. Enter the following command to check all files in the /var/www/html/ directory: The following output from the matchpathcon command explains that file1 is labeled with the samba_share_t type, but should be labeled with the httpd_sys_content_t type: To resolve the label problem and allow the Apache HTTP Server access to file1 , as root, use the restorecon utility: 4.10.4. Archiving Files with tar The tar utility does not retain extended attributes by default. Since SELinux contexts are stored in extended attributes, contexts can be lost when archiving files. Use the tar --selinux command to create archives that retain contexts and to restore files from the archives. If a tar archive contains files without extended attributes, or if you want the extended attributes to match the system defaults, use the restorecon utility: Note that depending on the directory, you may need to be the root user to run the restorecon . The following example demonstrates creating a tar archive that retains SELinux contexts: Procedure 4.17. Creating a tar Archive Change to the /var/www/html/ directory and view its SELinux context: As root, create three files ( file1 , file2 , and file3 ) in /var/www/html/ . These files inherit the httpd_sys_content_t type from /var/www/html/ : As root, enter the following command to create a tar archive named test.tar . Use the --selinux to retain the SELinux context: As root, create a new directory named test/ , and then allow all users full access to it: Copy the test.tar file into test/ : Change into test/ directory. Once in this directory, enter the following command to extract the tar archive. Specify the --selinux option again otherwise the SELinux context will be changed to default_t : View the SELinux contexts. The httpd_sys_content_t type has been retained, rather than being changed to default_t , which would have happened had the --selinux not been used: If the test/ directory is no longer required, as root, enter the following command to remove it, as well as all files in it: See the tar (1) manual page for further information about tar , such as the --xattrs option that retains all extended attributes. 4.10.5. Archiving Files with star The star utility does not retain extended attributes by default. Since SELinux contexts are stored in extended attributes, contexts can be lost when archiving files. Use the star -xattr -H=exustar command to create archives that retain contexts. The star package is not installed by default. To install star , run the yum install star command as the root user. The following example demonstrates creating a star archive that retains SELinux contexts: Procedure 4.18. Creating a star Archive As root, create three files ( file1 , file2 , and file3 ) in the /var/www/html/ . These files inherit the httpd_sys_content_t type from /var/www/html/ : Change into /var/www/html/ directory. Once in this directory, as root, enter the following command to create a star archive named test.star : As root, create a new directory named test/ , and then allow all users full access to it: Enter the following command to copy the test.star file into test/ : Change into test/ . Once in this directory, enter the following command to extract the star archive: View the SELinux contexts. The httpd_sys_content_t type has been retained, rather than being changed to default_t , which would have happened had the -xattr -H=exustar option not been used: If the test/ directory is no longer required, as root, enter the following command to remove it, as well as all files in it: If star is no longer required, as root, remove the package: See the star (1) manual page for further information about star . [6] See the matchpathcon (8) manual page for further information about matchpathcon .	[ "~]USD touch file1", "~]USD ls -Z file1 -rw-rw-r-- user1 group1 unconfined_u:object_r:user_home_t:s0 file1", "~]USD ls -Z file1 -rw-rw-r-- user1 group1 unconfined_u:object_r:user_home_t:s0 file1", "~]# cp file1 /etc/", "~]USD ls -Z /etc/file1 -rw-r--r-- root root unconfined_u:object_r:etc_t:s0 /etc/file1", "~]USD touch file1", "~]USD ls -Z file1 -rw-rw-r-- user1 group1 unconfined_u:object_r:user_home_t:s0 file1", "~]USD ls -dZ /var/www/html/ drwxr-xr-x root root system_u:object_r:httpd_sys_content_t:s0 /var/www/html/", "~]# cp file1 /var/www/html/", "~]USD ls -Z /var/www/html/file1 -rw-r--r-- root root unconfined_u:object_r:httpd_sys_content_t:s0 /var/www/html/file1", "~]USD touch file1", "~]USD ls -Z file1 -rw-rw-r-- user1 group1 unconfined_u:object_r:user_home_t:s0 file1", "~]USD ls -dZ /var/www/html/ drwxr-xr-x root root system_u:object_r:httpd_sys_content_t:s0 /var/www/html/", "~]# cp --preserve=context file1 /var/www/html/", "~]USD ls -Z /var/www/html/file1 -rw-r--r-- root root unconfined_u:object_r:user_home_t:s0 /var/www/html/file1", "~]USD touch file1", "~]USD ls -Z file1 -rw-rw-r-- user1 group1 unconfined_u:object_r:user_home_t:s0 file1", "~]USD cp --context=system_u:object_r:samba_share_t:s0 file1 file2", "~]USD ls -Z file1 file2 -rw-rw-r-- user1 group1 unconfined_u:object_r:user_home_t:s0 file1 -rw-rw-r-- user1 group1 system_u:object_r:samba_share_t:s0 file2", "~]# touch /etc/file1", "~]USD ls -Z /etc/file1 -rw-r--r-- root root unconfined_u:object_r:etc_t:s0 /etc/file1", "~]USD touch /tmp/file2", "~USD ls -Z /tmp/file2 -rw-r--r-- root root unconfined_u:object_r:user_tmp_t:s0 /tmp/file2", "~]# cp /tmp/file2 /etc/file1", "~]USD ls -Z /etc/file1 -rw-r--r-- root root unconfined_u:object_r:etc_t:s0 /etc/file1", "~]USD touch file1", "~]USD ls -Z file1 -rw-rw-r-- user1 group1 unconfined_u:object_r:user_home_t:s0 file1", "~]USD ls -dZ /var/www/html/ drwxr-xr-x root root system_u:object_r:httpd_sys_content_t:s0 /var/www/html/", "~]# mv file1 /var/www/html/", "~]# ls -Z /var/www/html/file1 -rw-rw-r-- user1 group1 unconfined_u:object_r:user_home_t:s0 /var/www/html/file1", "~]# touch /var/www/html/file{1,2,3}", "~]# ls -Z /var/www/html/ -rw-r--r-- root root unconfined_u:object_r:httpd_sys_content_t:s0 file1 -rw-r--r-- root root unconfined_u:object_r:httpd_sys_content_t:s0 file2 -rw-r--r-- root root unconfined_u:object_r:httpd_sys_content_t:s0 file3", "~]# chcon -t samba_share_t /var/www/html/file1", "~]USD matchpathcon -V /var/www/html/* /var/www/html/file1 has context unconfined_u:object_r:samba_share_t:s0, should be system_u:object_r:httpd_sys_content_t:s0 /var/www/html/file2 verified. /var/www/html/file3 verified.", "/var/www/html/file1 has context unconfined_u:object_r:samba_share_t:s0, should be system_u:object_r:httpd_sys_content_t:s0", "~]# restorecon -v /var/www/html/file1 restorecon reset /var/www/html/file1 context unconfined_u:object_r:samba_share_t:s0->system_u:object_r:httpd_sys_content_t:s0", "~]USD tar -xvf archive.tar \| restorecon -f -", "~]USD cd /var/www/html/", "html]USD ls -dZ /var/www/html/ drwxr-xr-x. root root system_u:object_r:httpd_sys_content_t:s0 .", "html]# touch file{1,2,3}", "html]USD ls -Z /var/www/html/ -rw-r--r-- root root unconfined_u:object_r:httpd_sys_content_t:s0 file1 -rw-r--r-- root root unconfined_u:object_r:httpd_sys_content_t:s0 file2 -rw-r--r-- root root unconfined_u:object_r:httpd_sys_content_t:s0 file3", "html]# tar --selinux -cf test.tar file{1,2,3}", "~]# mkdir /test", "~]# chmod 777 /test/", "~]USD cp /var/www/html/test.tar /test/", "~]USD cd /test/", "test]USD tar --selinux -xvf test.tar", "test]USD ls -lZ /test/ -rw-r--r-- user1 group1 unconfined_u:object_r:httpd_sys_content_t:s0 file1 -rw-r--r-- user1 group1 unconfined_u:object_r:httpd_sys_content_t:s0 file2 -rw-r--r-- user1 group1 unconfined_u:object_r:httpd_sys_content_t:s0 file3 -rw-r--r-- user1 group1 unconfined_u:object_r:default_t:s0 test.tar", "~]# rm -ri /test/", "~]# touch /var/www/html/file{1,2,3}", "~]# ls -Z /var/www/html/ -rw-r--r-- root root unconfined_u:object_r:httpd_sys_content_t:s0 file1 -rw-r--r-- root root unconfined_u:object_r:httpd_sys_content_t:s0 file2 -rw-r--r-- root root unconfined_u:object_r:httpd_sys_content_t:s0 file3", "~]USD cd /var/www/html", "html]# star -xattr -H=exustar -c -f=test.star file{1,2,3} star: 1 blocks + 0 bytes (total of 10240 bytes = 10.00k).", "~]# mkdir /test", "~]# chmod 777 /test/", "~]USD cp /var/www/html/test.star /test/", "~]USD cd /test/", "test]USD star -x -f=test.star star: 1 blocks + 0 bytes (total of 10240 bytes = 10.00k).", "~]USD ls -lZ /test/ -rw-r--r-- user1 group1 unconfined_u:object_r:httpd_sys_content_t:s0 file1 -rw-r--r-- user1 group1 unconfined_u:object_r:httpd_sys_content_t:s0 file2 -rw-r--r-- user1 group1 unconfined_u:object_r:httpd_sys_content_t:s0 file3 -rw-r--r-- user1 group1 unconfined_u:object_r:default_t:s0 test.star", "~]# rm -ri /test/", "~]# yum remove star" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/selinux_users_and_administrators_guide/sect-Security-Enhanced_Linux-Working_with_SELinux-Maintaining_SELinux_Labels_
Appendix A. Using your subscription	Appendix A. Using your subscription AMQ is provided through a software subscription. To manage your subscriptions, access your account at the Red Hat Customer Portal. A.1. Accessing your account Procedure Go to access.redhat.com . If you do not already have an account, create one. Log in to your account. A.2. Activating a subscription Procedure Go to access.redhat.com . Navigate to My Subscriptions . Navigate to Activate a subscription and enter your 16-digit activation number. A.3. Downloading release files To access .zip, .tar.gz, and other release files, use the customer portal to find the relevant files for download. If you are using RPM packages or the Red Hat Maven repository, this step is not required. Procedure Open a browser and log in to the Red Hat Customer Portal Product Downloads page at access.redhat.com/downloads . Locate the Red Hat AMQ entries in the INTEGRATION AND AUTOMATION category. Select the desired AMQ product. The Software Downloads page opens. Click the Download link for your component. A.4. Registering your system for packages To install RPM packages for this product on Red Hat Enterprise Linux, your system must be registered. If you are using downloaded release files, this step is not required. Procedure Go to access.redhat.com . Navigate to Registration Assistant . Select your OS version and continue to the page. Use the listed command in your system terminal to complete the registration. For more information about registering your system, see one of the following resources: Red Hat Enterprise Linux 7 - Registering the system and managing subscriptions Red Hat Enterprise Linux 8 - Registering the system and managing subscriptions	null	https://docs.redhat.com/en/documentation/red_hat_amq/2021.q3/html/using_the_amq_openwire_jms_client/using_your_subscription
Chapter 4. Modifying a compute machine set	Chapter 4. Modifying a compute machine set You can modify a compute machine set, such as adding labels, changing the instance type, or changing block storage. Note If you need to scale a compute machine set without making other changes, see Manually scaling a compute machine set . 4.1. Modifying a compute machine set by using the CLI You can modify the configuration of a compute machine set, and then propagate the changes to the machines in your cluster by using the CLI. By updating the compute machine set configuration, you can enable features or change the properties of the machines it creates. When you modify a compute machine set, your changes only apply to compute machines that are created after you save the updated MachineSet custom resource (CR). The changes do not affect existing machines. Note Changes made in the underlying cloud provider are not reflected in the Machine or MachineSet CRs. To adjust instance configuration in cluster-managed infrastructure, use the cluster-side resources. You can replace the existing machines with new ones that reflect the updated configuration by scaling the compute machine set to create twice the number of replicas and then scaling it down to the original number of replicas. If you need to scale a compute machine set without making other changes, you do not need to delete the machines. Note By default, the OpenShift Container Platform router pods are deployed on compute machines. Because the router is required to access some cluster resources, including the web console, do not scale the compute machine set to 0 unless you first relocate the router pods. The output examples in this procedure use the values for an AWS cluster. Prerequisites Your OpenShift Container Platform cluster uses the Machine API. You are logged in to the cluster as an administrator by using the OpenShift CLI ( oc ). Procedure List the compute machine sets in your cluster by running the following command: USD oc get machinesets.machine.openshift.io -n openshift-machine-api Example output NAME DESIRED CURRENT READY AVAILABLE AGE <compute_machine_set_name_1> 1 1 1 1 55m <compute_machine_set_name_2> 1 1 1 1 55m Edit a compute machine set by running the following command: USD oc edit machinesets.machine.openshift.io <machine_set_name> \ -n openshift-machine-api Note the value of the spec.replicas field, because you need it when scaling the machine set to apply the changes. apiVersion: machine.openshift.io/v1beta1 kind: MachineSet metadata: name: <machine_set_name> namespace: openshift-machine-api spec: replicas: 2 1 # ... 1 The examples in this procedure show a compute machine set that has a replicas value of 2 . Update the compute machine set CR with the configuration options that you want and save your changes. List the machines that are managed by the updated compute machine set by running the following command: USD oc get machines.machine.openshift.io \ -n openshift-machine-api \ -l machine.openshift.io/cluster-api-machineset=<machine_set_name> Example output for an AWS cluster NAME PHASE TYPE REGION ZONE AGE <machine_name_original_1> Running m6i.xlarge us-west-1 us-west-1a 4h <machine_name_original_2> Running m6i.xlarge us-west-1 us-west-1a 4h For each machine that is managed by the updated compute machine set, set the delete annotation by running the following command: USD oc annotate machine.machine.openshift.io/<machine_name_original_1> \ -n openshift-machine-api \ machine.openshift.io/delete-machine="true" To create replacement machines with the new configuration, scale the compute machine set to twice the number of replicas by running the following command: USD oc scale --replicas=4 \ 1 machineset.machine.openshift.io <machine_set_name> \ -n openshift-machine-api 1 The original example value of 2 is doubled to 4 . List the machines that are managed by the updated compute machine set by running the following command: USD oc get machines.machine.openshift.io \ -n openshift-machine-api \ -l machine.openshift.io/cluster-api-machineset=<machine_set_name> Example output for an AWS cluster NAME PHASE TYPE REGION ZONE AGE <machine_name_original_1> Running m6i.xlarge us-west-1 us-west-1a 4h <machine_name_original_2> Running m6i.xlarge us-west-1 us-west-1a 4h <machine_name_updated_1> Provisioned m6i.xlarge us-west-1 us-west-1a 55s <machine_name_updated_2> Provisioning m6i.xlarge us-west-1 us-west-1a 55s When the new machines are in the Running phase, you can scale the compute machine set to the original number of replicas. To remove the machines that were created with the old configuration, scale the compute machine set to the original number of replicas by running the following command: USD oc scale --replicas=2 \ 1 machineset.machine.openshift.io <machine_set_name> \ -n openshift-machine-api 1 The original example value of 2 . Verification To verify that a machine created by the updated machine set has the correct configuration, examine the relevant fields in the CR for one of the new machines by running the following command: USD oc describe machine.machine.openshift.io <machine_name_updated_1> \ -n openshift-machine-api To verify that the compute machines without the updated configuration are deleted, list the machines that are managed by the updated compute machine set by running the following command: USD oc get machines.machine.openshift.io \ -n openshift-machine-api \ -l machine.openshift.io/cluster-api-machineset=<machine_set_name> Example output while deletion is in progress for an AWS cluster NAME PHASE TYPE REGION ZONE AGE <machine_name_original_1> Deleting m6i.xlarge us-west-1 us-west-1a 4h <machine_name_original_2> Deleting m6i.xlarge us-west-1 us-west-1a 4h <machine_name_updated_1> Running m6i.xlarge us-west-1 us-west-1a 5m41s <machine_name_updated_2> Running m6i.xlarge us-west-1 us-west-1a 5m41s Example output when deletion is complete for an AWS cluster NAME PHASE TYPE REGION ZONE AGE <machine_name_updated_1> Running m6i.xlarge us-west-1 us-west-1a 6m30s <machine_name_updated_2> Running m6i.xlarge us-west-1 us-west-1a 6m30s Additional resources Lifecycle hooks for the machine deletion phase Scaling a compute machine set manually Controlling pod placement using the scheduler	[ "oc get machinesets.machine.openshift.io -n openshift-machine-api", "NAME DESIRED CURRENT READY AVAILABLE AGE <compute_machine_set_name_1> 1 1 1 1 55m <compute_machine_set_name_2> 1 1 1 1 55m", "oc edit machinesets.machine.openshift.io <machine_set_name> -n openshift-machine-api", "apiVersion: machine.openshift.io/v1beta1 kind: MachineSet metadata: name: <machine_set_name> namespace: openshift-machine-api spec: replicas: 2 1", "oc get machines.machine.openshift.io -n openshift-machine-api -l machine.openshift.io/cluster-api-machineset=<machine_set_name>", "NAME PHASE TYPE REGION ZONE AGE <machine_name_original_1> Running m6i.xlarge us-west-1 us-west-1a 4h <machine_name_original_2> Running m6i.xlarge us-west-1 us-west-1a 4h", "oc annotate machine.machine.openshift.io/<machine_name_original_1> -n openshift-machine-api machine.openshift.io/delete-machine=\"true\"", "oc scale --replicas=4 \\ 1 machineset.machine.openshift.io <machine_set_name> -n openshift-machine-api", "oc get machines.machine.openshift.io -n openshift-machine-api -l machine.openshift.io/cluster-api-machineset=<machine_set_name>", "NAME PHASE TYPE REGION ZONE AGE <machine_name_original_1> Running m6i.xlarge us-west-1 us-west-1a 4h <machine_name_original_2> Running m6i.xlarge us-west-1 us-west-1a 4h <machine_name_updated_1> Provisioned m6i.xlarge us-west-1 us-west-1a 55s <machine_name_updated_2> Provisioning m6i.xlarge us-west-1 us-west-1a 55s", "oc scale --replicas=2 \\ 1 machineset.machine.openshift.io <machine_set_name> -n openshift-machine-api", "oc describe machine.machine.openshift.io <machine_name_updated_1> -n openshift-machine-api", "oc get machines.machine.openshift.io -n openshift-machine-api -l machine.openshift.io/cluster-api-machineset=<machine_set_name>", "NAME PHASE TYPE REGION ZONE AGE <machine_name_original_1> Deleting m6i.xlarge us-west-1 us-west-1a 4h <machine_name_original_2> Deleting m6i.xlarge us-west-1 us-west-1a 4h <machine_name_updated_1> Running m6i.xlarge us-west-1 us-west-1a 5m41s <machine_name_updated_2> Running m6i.xlarge us-west-1 us-west-1a 5m41s", "NAME PHASE TYPE REGION ZONE AGE <machine_name_updated_1> Running m6i.xlarge us-west-1 us-west-1a 6m30s <machine_name_updated_2> Running m6i.xlarge us-west-1 us-west-1a 6m30s" ]	https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/machine_management/modifying-machineset
1.2. Default Cgroup Hierarchies	1.2. Default Cgroup Hierarchies By default, systemd automatically creates a hierarchy of slice , scope and service units to provide a unified structure for the cgroup tree. With the systemctl command, you can further modify this structure by creating custom slices, as shown in Section 2.1, "Creating Control Groups" . Also, systemd automatically mounts hierarchies for important kernel resource controllers (see Available Controllers in Red Hat Enterprise Linux 7 ) in the /sys/fs/cgroup/ directory. Warning The deprecated cgconfig tool from the libcgroup package is available to mount and handle hierarchies for controllers not yet supported by systemd (most notably the net-prio controller). Never use libcgropup tools to modify the default hierarchies mounted by systemd since it would lead to unexpected behavior. The libcgroup library will be removed in future versions of Red Hat Enterprise Linux. For more information on how to use cgconfig , see Chapter 3, Using libcgroup Tools . Systemd Unit Types All processes running on the system are child processes of the systemd init process. Systemd provides three unit types that are used for the purpose of resource control (for a complete list of systemd 's unit types, see the chapter called Managing Services with systemd in Red Hat Enterprise Linux 7 System Administrator's Guide ): Service - A process or a group of processes, which systemd started based on a unit configuration file. Services encapsulate the specified processes so that they can be started and stopped as one set. Services are named in the following way: name . service Where name stands for the name of the service. Scope - A group of externally created processes. Scopes encapsulate processes that are started and stopped by arbitrary processes through the fork() function and then registered by systemd at runtime. For instance, user sessions, containers, and virtual machines are treated as scopes. Scopes are named as follows: name . scope Here, name stands for the name of the scope. Slice - A group of hierarchically organized units. Slices do not contain processes, they organize a hierarchy in which scopes and services are placed. The actual processes are contained in scopes or in services. In this hierarchical tree, every name of a slice unit corresponds to the path to a location in the hierarchy. The dash (" - ") character acts as a separator of the path components. For example, if the name of a slice looks as follows: parent - name . slice it means that a slice called parent - name . slice is a subslice of the parent . slice . This slice can have its own subslice named parent - name - name2 . slice , and so on. There is one root slice denoted as: -.slice Service, scope, and slice units directly map to objects in the cgroup tree. When these units are activated, they map directly to cgroup paths built from the unit names. For example, the ex.service residing in the test-waldo.slice is mapped to the cgroup test.slice/test-waldo.slice/ex.service/ . Services, scopes, and slices are created manually by the system administrator or dynamically by programs. By default, the operating system defines a number of built-in services that are necessary to run the system. Also, there are four slices created by default: -.slice - the root slice; system.slice - the default place for all system services; user.slice - the default place for all user sessions; machine.slice - the default place for all virtual machines and Linux containers. Note that all user sessions are automatically placed in a separated scope unit, as well as virtual machines and container processes. Furthermore, all users are assigned with an implicit subslice. Besides the above default configuration, the system administrator can define new slices and assign services and scopes to them. The following tree is a simplified example of a cgroup tree. This output was generated with the systemd-cgls command described in Section 2.4, "Obtaining Information about Control Groups" : As you can see, services and scopes contain processes and are placed in slices that do not contain processes of their own. The only exception is PID 1 that is located in the special systemd slice marked as -.slice . Also note that -.slice is not shown as it is implicitly identified with the root of the entire tree. Service and slice units can be configured with persistent unit files as described in Section 2.3.2, "Modifying Unit Files" , or created dynamically at runtime by API calls to PID 1 (see the section called "Online Documentation" for API reference). Scope units can be created only dynamically. Units created dynamically with API calls are transient and exist only during runtime. Transient units are released automatically as soon as they finish, get deactivated, or the system is rebooted.	[ "├─1 /usr/lib/systemd/systemd --switched-root --system --deserialize 20 ├─user.slice │ └─user-1000.slice │ └─session-1.scope │ ├─11459 gdm-session-worker [pam/gdm-password] │ ├─11471 gnome-session --session gnome-classic │ ├─11479 dbus-launch --sh-syntax --exit-with-session │ ├─11480 /bin/dbus-daemon --fork --print-pid 4 --print-address 6 --session │ │ └─system.slice ├─systemd-journald.service │ └─422 /usr/lib/systemd/systemd-journald ├─bluetooth.service │ └─11691 /usr/sbin/bluetoothd -n ├─systemd-localed.service │ └─5328 /usr/lib/systemd/systemd-localed ├─colord.service │ └─5001 /usr/libexec/colord ├─sshd.service │ └─1191 /usr/sbin/sshd -D │" ]	https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/resource_management_guide/sec-Default_Cgroup_Hierarchies
Chapter 13. Configuring Applications for Single Sign-On	Chapter 13. Configuring Applications for Single Sign-On Some common applications, such as browsers and email clients, can be configured to use Kerberos tickets, SSL certifications, or tokens as a means of authenticating users. The precise procedures to configure any application depend on that application itself. The examples in this chapter (Mozilla Thunderbird and Mozilla Firefox) are intended to give you an idea of how to configure a user application to use Kerberos or other credentials. 13.1. Configuring Firefox to Use Kerberos for Single Sign-On Firefox can use Kerberos for single sign-on (SSO) to intranet sites and other protected websites. For Firefox to use Kerberos, it first has to be configured to send Kerberos credentials to the appropriate KDC. Even after Firefox is configured to pass Kerberos credentials, it still requires a valid Kerberos ticket to use. To generate a Kerberos ticket, use the kinit command and supply the user password for the user on the KDC. To configure Firefox to use Kerberos for SSO: In the address bar of Firefox, type about:config to display the list of current configuration options. In the Filter field, type negotiate to restrict the list of options. Double-click the network.negotiate-auth.trusted-uris entry. Enter the name of the domain against which to authenticate, including the preceding period (.). If you want to add multiple domains, enter them in a comma-separated list. Figure 13.1. Manual Firefox Configuration Important It is not recommended to configure delegation using the network.negotiate-auth.delegation-uris entry in the Firefox configuration options because this enables every Kerberos-aware server to act as the user. Note For more information, see Configuring the Browser for Kerberos Authentication in the Linux Domain Identity, Authentication, and Policy Guide ..	[ "[jsmith@host ~] USD kinit Password for [email protected]:" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/system-level_authentication_guide/configuring_applications_for_sso
Red Hat Data Grid	Red Hat Data Grid Data Grid is a high-performance, distributed in-memory data store. Schemaless data structure Flexibility to store different objects as key-value pairs. Grid-based data storage Designed to distribute and replicate data across clusters. Elastic scaling Dynamically adjust the number of nodes to meet demand without service disruption. Data interoperability Store, retrieve, and query data in the grid from different endpoints.	null	https://docs.redhat.com/en/documentation/red_hat_data_grid/8.5/html/data_grid_rest_api/red-hat-data-grid
1.2. Installing Querying for Red Hat JBoss Data Grid	1.2. Installing Querying for Red Hat JBoss Data Grid In Red Hat JBoss Data Grid, the JAR files required to perform queries are packaged within the JBoss Data Grid Library and Remote Client-Server mode downloads. For details about downloading and installing JBoss Data Grid, see the Getting Started Guide 's Download and Install JBoss Data Grid chapter. Warning The Infinispan query API directly exposes the Hibernate Search and the Lucene APIs and cannot be embedded within the infinispan-embedded-query.jar file. Do not include other versions of Hibernate Search and Lucene in the same deployment as infinispan-embedded-query . This action will cause classpath conflicts and result in unexpected behavior. Report a bug	null	https://docs.redhat.com/en/documentation/red_hat_data_grid/6.6/html/infinispan_query_guide/downloading_infinispan_query
6.2. Authentication Modules for Data Source Security	6.2. Authentication Modules for Data Source Security In some use cases, a user might need to supply credentials to data sources based on the logged in user, rather than shared credentials for all the logged users. To support this feature, JBoss EAP and JBoss Data Virtualization provide additional authentication modules to be used in conjunction with the main security domain: Caller Identity Login Module Role-Based Credential Map Identity Login Module	null	https://docs.redhat.com/en/documentation/red_hat_jboss_data_virtualization/6.4/html/security_guide/data_source_security
2.2. Client Access Control	2.2. Client Access Control libvirt 's client access control framework allows system administrators to setup fine-grained permission rules across client users, managed objects, and API operations. This allows client connections to be locked down to a minimal set of privileges. In the default configuration, the libvirtd daemon has three levels of access control: All connections start off in an unauthenticated state, where the only API operations allowed are those required to complete authentication. After successful authentication, a connection either has full, unrestricted access to all libvirt API calls, or is locked down to only "read only" operations, according to what socket the client connection originated on. The access control framework allows authenticated connections to have fine-grained permission rules to be defined by the administrator. Every API call in libvirt has a set of permissions that will be validated against the object being used. Further permissions will also be checked if certain flags are set in the API call. In addition to checks on the object passed in to an API call, some methods will filter their results. 2.2.1. Access Control Drivers The access control framework is designed as a pluggable system to enable future integration with arbitrary access control technologies. By default, the none driver is used, which performs no access control checks at all. Currently, libvirt provides support for using polkit as a real access control driver. To learn how to use the polkit access driver see the configuration documentation . The access driver is configured in the /etc/libvirt/libvirtd.conf configuration file, using the access_drivers parameter. This parameter accepts an array of access control driver names. If more than one access driver is requested, then all must succeed in order for access to be granted. To enable 'polkit' as the driver, use the augtool command: To set the driver back to the default (no access control), enter the following command: For the changes made to libvirtd.conf to take effect, restart the libvirtd service. 2.2.2. Objects and Permissions libvirt applies access control to all the main object types in its API. Each object type, in turn, has a set of permissions defined. To determine what permissions are checked for a specific API call, consult the API reference manual documentation for the API in question. For the complete list of objects and permissions, see libvirt.org . 2.2.3. Security Concerns when Adding Block Devices to a Guest The host physical machine should not use file system labels to identify file systems in the fstab file, the initrd file or on the kernel command line. Doing so presents a security risk if guest virtual machines have write access to whole partitions or LVM volumes, because a guest virtual machine could potentially write a file-system label belonging to the host physical machine, to its own block device storage. Upon reboot of the host physical machine, the host physical machine could then mistakenly use the guest virtual machine's disk as a system disk, which would compromise the host physical machine system. It is preferable to use the UUID of a device to identify it in the /etc/fstab file, the /dev/initrd file, or on the kernel command line. Guest virtual machines should not be given write access to entire disks or block devices (for example, /dev/sdb ). Guest virtual machines with access to entire block devices may be able to modify volume labels, which can be used to compromise the host physical machine system. Use partitions (for example, /dev/sdb1 ) or LVM volumes to prevent this problem. See LVM Administration with CLI Commands or LVM Configuration Examples for information on LVM administration and configuration examples. If you are using raw access to partitions, for example /dev/sdb1 or raw disks such as /dev/sdb, you should configure LVM to only scan disks that are safe, using the global_filter setting. See the Logical Volume Manager Administration Guide for an example of an LVM configuration script using the global_filter command.	[ "augtool -s set '/files/etc/libvirt/libvirtd.conf/access_drivers[1]' polkit", "augtool -s rm /files/etc/libvirt/libvirtd.conf/access_drivers", "systemctl restart libvirtd.service" ]	https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/virtualization_security_guide/sect-securing_the_host_physical_machine_and_improving_performance-client_access_control
Chapter 5. Customizing the storage service for HCI	Chapter 5. Customizing the storage service for HCI Red Hat OpenStack Platform (RHOSP) director provides the necessary heat templates and environment files to enable a basic Ceph Storage configuration. Director uses the /usr/share/openstack-tripleo-heat-templates/environments/cephadm/cephadm.yaml environment file to add additional configuration to the Ceph cluster deployed by openstack overcloud ceph deploy . For more information about containerized services in RHOSP, see Configuring a basic overcloud with the CLI tools in Director Installation and Usage . 5.1. Configuring Compute service resources for HCI Colocating Ceph OSD and Compute services on hyperconverged nodes risks resource contention between Red Hat Ceph Storage and Compute services. This occurs because the services are not aware of the colcation. Resource contention can result in service degradation, which offsets the benefits of hyperconvergence. Configuring the resources used by the Compute service mitigates resource contention and improves HCI performance. Procedure Log in to the undercloud host as the stack user. Source the stackrc undercloud credentials file: Add the NovaReservedHostMemory parameter to the ceph-overrides.yaml file. The following is a usage example. The NovaReservedHostMemory parameter overrides the default value of reserved_host_memory_mb in /etc/nova/nova.conf . This parameter is set to stop Nova scheduler giving memory, that a Ceph OSD needs, to a virtual machine. The example above reserves 5 GB per OSD for 10 OSDs per host in addition to the default reserved memory for the hypervisor. In an IOPS-optimized cluster, you can improve performance by reserving more memory per OSD. The 5 GB number is provided as a starting point that you can further refine as necessary. Important Include this file when you use the openstack overcloud deploy command. 5.2. Configuring a custom environment file Director applies basic, default settings to the deployed Red Hat Ceph Storage cluster. You must define additional configuration in a custom environment file. Procedure Log in to the undercloud as the stack user. Create a file to define the custom configuration. vi /home/stack/templates/storage-config.yaml Add a parameter_defaults section to the file. Add the custom configuration parameters. For more information about parameter definitions, see Overcloud Parameters . Note Parameters defined in a custom configuration file override any corresponding default settings in /usr/share/openstack-tripleo-heat-templates/environments/cephadm/cephadm.yaml . Save the file. Additional resources The custom configuration is applied during overcloud deployment. 5.3. Enabling Ceph Metadata Server The Ceph Metadata Server (MDS) runs the ceph-mds daemon. This daemon manages metadata related to files stored on CephFS. CephFS can be consumed natively or through the NFS protocol. Note Red Hat supports deploying Ceph MDS with the native CephFS and CephFS NFS back ends for the Shared File Systems service (manila). Procedure To enable Ceph MDS, use the following environment file when you deploy the overcloud: Note By default, Ceph MDS is deployed on the Controller node. You can deploy Ceph MDS on its own dedicated node. Additional resources Red Hat Ceph Storage File System Guide 5.4. Ceph Object Gateway object storage The Ceph Object Gateway (RGW) provides an interface to access object storage capabilities within a Red Hat Ceph Storage cluster. When you use director to deploy Ceph, director automatically enables RGW. This is a direct replacement for the Object Storage service (swift). Services that normally use the Object Storage service can use RGW instead without additional configuration. The Object Storage service remains available as an object storage option for upgraded Ceph clusters. There is no requirement for a separate RGW environment file to enable it. For more information about environment files for other object storage options, see Section 5.5, "Deployment options for Red Hat OpenStack Platform object storage" . By default, Ceph Storage allows 250 placement groups per Object Storage Daemon (OSD). When you enable RGW, Ceph Storage creates the following six additional pools required by RGW: .rgw.root <zone_name>.rgw.control <zone_name>.rgw.meta <zone_name>.rgw.log <zone_name>.rgw.buckets.index <zone_name>.rgw.buckets.data Note In your deployment, <zone_name> is replaced with the name of the zone to which the pools belong. Additional resources For more information about RGW, see the Red Hat Ceph Storage Object Gateway Guide . For more information about using RGW instead of Swift, see the Block Storage Backup Guide . 5.5. Deployment options for Red Hat OpenStack Platform object storage There are three options for deploying overcloud object storage: Ceph Object Gateway (RGW) To deploy RGW as described in Section 5.4, "Ceph Object Gateway object storage" , include the following environment file during overcloud deployment: This environment file configures both Ceph block storage (RBD) and RGW. Object Storage service (swift) To deploy the Object Storage service (swift) instead of RGW, include the following environment file during overcloud deployment: The cephadm-rbd-only.yaml file configures Ceph RBD but not RGW. Note If you used the Object Storage service (swift) before upgrading your Red Hat Ceph Storage cluster, you can continue to use the Object Storage service (swift) instead of RGW by replacing the environments/ceph-ansible/ceph-ansible.yaml file with the environments/cephadm/cephadm-rbd-only.yaml during the upgrade. For more information, see Keeping Red Hat OpenStack Platform Updated . Red Hat OpenStack Platform does not support migration from the Object Storage service (swift) to Ceph Object Gateway (RGW). No object storage To deploy Ceph with RBD but not with RGW or the Object Storage service (swift), include the following environment files during overcloud deployment: The cephadm-rbd-only.yaml file configures RBD but not RGW. The disable-swift.yaml file ensures that the Object Storage service (swift) does not deploy. 5.6. Configuring the Block Storage Backup Service to use Ceph The Block Storage Backup service (cinder-backup) is disabled by default. It must be enabled to use it with Ceph. Procedure To enable the Block Storage Backup service (cinder-backup), use the following environment file when you deploy the overcloud: 5.7. Configuring multiple bonded interfaces for Ceph nodes Use a bonded interface to combine multiple NICs and add redundancy to a network connection. If you have enough NICs on your Ceph nodes, you can create multiple bonded interfaces on each node to expand redundancy capability. Use a bonded interface for each network connection the node requires. This provides both redundancy and a dedicated connection for each network. See Provisioning the overcloud networks in the Director Installation and Usage guide for information and procedures. 5.8. Initiating overcloud deployment for HCI To implement the changes you made to your Red Hat OpenStack Platform (RHOSP) environment, you must deploy the overcloud. Prerequisites Before undercloud installation, set generate_service_certificate=false in the undercloud.conf file. Otherwise, you must configure SSL/TLS on the overcloud as described in Enabling SSL/TLS on overcloud public endpoints in the Security and Hardening Guide . Note If you want to add Ceph Dashboard during your overcloud deployment, see Adding the Red Hat Ceph Storage Dashboard to an overcloud deployment in Deploying Red Hat Ceph Storage and Red Hat OpenStack Platform together with director . Procedure Deploy the overcloud. The deployment command requires additional arguments, for example: The example command uses the following options: --templates - Creates the overcloud from the default heat template collection, /usr/share/openstack-tripleo-heat-templates/ . -r /home/stack/templates/roles_data_custom.yaml - Specifies a customized roles definition file. -e /usr/share/openstack-tripleo-heat-templates/environments/cephadm/cephadm.yaml - Sets the director to finalize the previously deployed Ceph Storage cluster. This environment file deploys RGW by default. It also creates pools, keys, and daemons. -e /usr/share/openstack-tripleo-heat-templates/environments/cephadm/ceph-mds.yaml - Enables the Ceph Metadata Server. -e /usr/share/openstack-tripleo-heat-templates/environments/cinder-backup.yaml - Enables the Block Storage Backup service. -e /home/stack/templates/storage-config.yaml - Adds the environment file that contains your custom Ceph Storage configuration. -e /home/stack/templates/deployed-ceph.yaml - Adds the environment file that contains your Ceph cluster settings, as output by the openstack overcloud ceph deploy command run earlier. --ntp-server pool.ntp.org - Sets the NTP server. Note For a full list of options, run the openstack help overcloud deploy command. Additional resources For more information, see Configuring a basic overcloud with the CLI tools in the Director Installation and Usage guide.	[ "source ~/stackrc", "parameter_defaults: ComputeHCIParameters: NovaReservedHostMemory: 75000", "parameter_defaults: CinderEnableIscsiBackend: false CinderEnableRbdBackend: true CinderBackupBackend: ceph NovaEnableRbdBackend: true GlanceBackend: rbd", "/usr/share/openstack-tripleo-heat-templates/environments/cephadm/ceph-mds.yaml", "-e environments/cephadm/cephadm.yaml", "-e environments/cephadm/cephadm-rbd-only.yaml", "-e environments/cephadm/cephadm-rbd-only.yaml -e environments/disable-swift.yaml", "`/usr/share/openstack-tripleo-heat-templates/environments/cinder-backup.yaml`.", "openstack overcloud deploy --templates -r /home/stack/templates/roles_data_custom.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/cephadm/cephadm.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/cephadm/ceph-mds.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/cinder-backup.yaml -e /home/stack/templates/storage-config.yaml -e /home/stack/templates/deployed-ceph.yaml --ntp-server pool.ntp.org" ]	https://docs.redhat.com/en/documentation/red_hat_openstack_platform/17.0/html/hyperconverged_infrastructure_guide/assembly_customizing-hci-storage-service
5.278. redhat-rpm-config	5.278. redhat-rpm-config 5.278.1. RHBA-2012:0911 - redhat-rpm-config bug fix and enhancement update An updated redhat-rpm-config package that fixes several bugs and adds an enhancement is now available for Red Hat Enterprise Linux 6. The redhat-rpm-config package is used during building of RPM packages to apply various default distribution options determined by Red Hat. It also provides a few Red Hat RPM macro customizations, such as those used during the building of Driver Update packages. Bug Fixes BZ# 680029 Previously, the %kernel_module_package macro did not handle the "-v" and "-r" optional version and release override parameters correctly. Consequently, the specified version and release number were not used when the RPM package was built. This bug has been fixed and these parameters are now handled properly. BZ# 713638 Previously, a script, which generates "modalias"-style dependencies for Driver Update packages in Red Hat Enterprise Linux 6, was not executable and thus could not function properly. This bug has been fixed and these dependencies are now generated as expected. BZ# 713992 When the kabi-whitelists package is installed, the %kernel_module_package macro did not automatically perform a check against the Red Hat kernel ABI interface (kABI). Consequently, when a package was being built, the macro did not warn when the resulting modules used kernel symbols that were exported but not part of the kABI. With this update, the abi_check.py script has been added to perform the check and return a warning during the build process if kabi-whitelists is not installed, thus fixing this bug. BZ# 767738 In certain cases, the dependency-generation scripts that produce information about automatic kernel symbol during the build process of a Driver Update package generated incorrect dependencies. This bug has been fixed and dependencies are now generated correctly. Enhancement BZ# 652084 The path of the autoconf configuration script invoked by the %configure macro can now be customized by overriding the %_configure macro. In addition, this can be of use when building out-of-tree packages. Users of redhat-rpm-config are advised to upgrade to this updated package, which fixes these bugs and adds this enhancement.	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/6.3_technical_notes/redhat-rpm-config
Chapter 79. JaegerTracing schema reference	Chapter 79. JaegerTracing schema reference The type JaegerTracing has been deprecated. Used in: KafkaBridgeSpec , KafkaConnectSpec , KafkaMirrorMaker2Spec , KafkaMirrorMakerSpec The type property is a discriminator that distinguishes use of the JaegerTracing type from OpenTelemetryTracing . It must have the value jaeger for the type JaegerTracing . Property Property type Description type string Must be jaeger .	null	https://docs.redhat.com/en/documentation/red_hat_streams_for_apache_kafka/2.7/html/streams_for_apache_kafka_api_reference/type-JaegerTracing-reference
3.4. Deploy a VDB via Management Console	3.4. Deploy a VDB via Management Console Prerequisites Red Hat JBoss Data Virtualization must be installed. The JBoss Enterprise Application Platform (EAP) server must be running. You must have a JBoss EAP Management User registered. Procedure 3.2. Deploy a VDB via Management Console Launch the console in a Web browser Open http://localhost:9990/console/ in a web browser. Authenticate to the console Enter your JBoss EAP administrator username and password when prompted. Open the Deployments panel In the Runtime view, select Server Manage Deployments . Add the virtual database Select the Add button. Select Choose File and choose the VDB file you want to deploy. Select to review the deployment names then select Save . Select En/Disable to enable the VDB.	null	https://docs.redhat.com/en/documentation/red_hat_jboss_data_virtualization/6.4/html/administration_and_configuration_guide/deploy_a_vdb_via_management_console
Providing feedback on Red Hat documentation	Providing feedback on Red Hat documentation We appreciate your feedback on our documentation. Let us know how we can improve it. Use the Create Issue form in Red Hat Jira to provide your feedback. The Jira issue is created in the Red Hat Satellite Jira project, where you can track its progress. Prerequisites Ensure you have registered a Red Hat account . Procedure Click the following link: Create Issue . If Jira displays a login error, log in and proceed after you are redirected to the form. Complete the Summary and Description fields. In the Description field, include the documentation URL, chapter or section number, and a detailed description of the issue. Do not modify any other fields in the form. Click Create .	null	https://docs.redhat.com/en/documentation/red_hat_satellite/6.15/html/managing_security_compliance/providing-feedback-on-red-hat-documentation_security-compliance
B.3. LVM Profiles	B.3. LVM Profiles An LVM profile is a set of selected customizable configuration settings that can be used to achieve certain characteristics in various environments or uses. Normally, the name of the profile should reflect that environment or use. An LVM profile overrides existing configuration. There are two groups of LVM profiles that LVM recognizes: command profiles and metadata profiles. A command profile is used to override selected configuration settings at the global LVM command level. The profile is applied at the beginning of LVM command execution and it is used throughout the time of the LVM command execution. You apply a command profile by specifying the --commandprofile ProfileName option when executing an LVM command. A metadata profile is used to override selected configuration settings at the volume group/logical volume level. It is applied independently for each volume group/logical volume that is being processed. As such, each volume group/logical volume can store the profile name used in its metadata so that time the volume group/logical volume is processed, the profile is applied automatically. If the volume group and any of its logical volumes have different profiles defined, the profile defined for the logical volume is preferred. You can attach a metadata profile to a volume group or logical volume by specifying the --metadataprofile ProfileName option when you create the volume group or logical volume with the vgcreate or lvcreate command. You can attach or detach a metadata profile to an existing volume group or logical volume by specifying the --metadataprofile ProfileName or the --detachprofile option of the lvchange or vgchange command. You can specify the -o vg_profile and -o lv_profile output options of the vgs and lvs commands to display the metadata profile currently attached to a volume group or a logical volume. The set of options allowed for command profiles and the set of options allowed for metadata profiles are mutually exclusive. The settings that belong to either of these two sets cannot be mixed together and the LVM tools will reject such profiles. LVM provides a few predefined configuration profiles. The LVM profiles are stored in the /etc/lvm/profile directory by default. This location can be changed by using the profile_dir setting in the /etc/lvm/lvm.conf file. Each profile configuration is stored in ProfileName .profile file in the profile directory. When referencing the profile in an LVM command, the .profile suffix is omitted. You can create additional profiles with different values. For this purpose, LVM provides the command_profile_template.profile file (for command profiles) and the metadata_profile_template.profile file (for metadata profiles) which contain all settings that are customizable by profiles of each type. You can copy these template profiles and edit them as needed. Alternatively, you can use the lvmconfig command to generate a new profile for a given section of the profile file for either profile type. The following command creates a new command profile named ProfileName .profile consisting of the settings in section . The following command creates a new metadata profile named ProfileName .profile consisting of the settings in section . If the section is not specified, all settings that can be customized by a profile are reported.	[ "lvmconfig --file ProfileName .profile --type profilable-command section", "lvmconfig --file ProfileName .profile --type profilable-metadata section" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/logical_volume_manager_administration/lvm_profiles
Appendix A. Troubleshooting	Appendix A. Troubleshooting This section provides the multiple troubleshooting scenarios while using the dashboard. A.1. Dashboard response is slow If the dashboard response is slow, clear the browser cache and reload the dashboard. A.2. Dashboard shows a service is down Dashboard is only a replica of the cluster. If the service is down, check the service status on the node as dashboard displays information collected via node-exporter running on the node. The issue may be in the cluster, configuration, or network. A.3. Task failure on Dashboard While performing any task on the dashboard, if there is any failure, check the respective Ceph daemons. For more information refer to the Troubleshooting Guide A.4. Images cannot be viewed An image can only be viewed under Block > Images if the pool it is in has the RBD application enabled on it. Additional resources For more information, refer to the Troubleshooting Guide	null	https://docs.redhat.com/en/documentation/red_hat_ceph_storage/4/html/dashboard_guide/troubleshooting-scenarios_dash
11.10. Additional Resources	11.10. Additional Resources The following are resources which explain more about network interfaces. Installed Documentation /usr/share/doc/initscripts- version /sysconfig.txt - A guide to available options for network configuration files, including IPv6 options not covered in this chapter. Online Resources http://linux-ip.net/gl/ip-cref/ - This document contains a wealth of information about the ip command, which can be used to manipulate routing tables, among other things. Red Hat Access Labs - The Red Hat Access Labs includes a " Network Bonding Helper " . See Also Appendix E, The proc File System - Describes the sysctl utility and the virtual files within the /proc/ directory, which contain networking parameters and statistics among other things.	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/deployment_guide/s1-networkscripts-resources
Preface	Preface The Red Hat build of Cryostat is a container-native implementation of JDK Flight Recorder (JFR) that you can use to securely monitor the Java Virtual Machine (JVM) performance in workloads that run on an OpenShift Container Platform cluster. You can use Cryostat 2.4 to start, stop, retrieve, archive, import, and export JFR data for JVMs inside your containerized applications by using a web console or an HTTP API. Depending on your use case, you can store and analyze your recordings directly on your Red Hat OpenShift cluster by using the built-in tools that Cryostat provides or you can export recordings to an external monitoring application to perform a more in-depth analysis of your recorded data. Important Red Hat build of Cryostat is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope .	null	https://docs.redhat.com/en/documentation/red_hat_build_of_cryostat/2/html/configuring_advanced_cryostat_configurations/preface-cryostat
Chapter 7. Working with heat templates	Chapter 7. Working with heat templates The custom configurations in this guide use heat templates and environment files to define certain aspects of the overcloud. This chapter contains a basic introduction to the structure of heat templates in the context of Red Hat OpenStack Platform. The purpose of a template is to define and create a stack, which is a collection of resources that heat creates, and the configuration of the resources. Resources are objects in OpenStack and can include compute resources, network configurations, security groups, scaling rules, and custom resources. The structure of a heat template has three main sections: Parameters Parameters are settings passed to heat. Use these parameters to define and customize both default and non-default values. Define these parameters in the parameters section of a template. Resources Resources are the specific objects that you want to create and configure as part of a stack. OpenStack contains a set of core resources that span across all components. Define resources in the resources section of a template. Output These are values passed from heat after the stack creation. You can access these values either through the heat API or through the client tools. Define these values in the output section of a template. When heat processes a template, it creates a stack for the template and a set of child stacks for resource templates. This hierarchy of stacks descends from the main stack that you define with your template. You can view the stack hierarchy with the following command: 7.1. Core heat templates Red Hat OpenStack Platform contains a core heat template collection for the overcloud. You can find this collection in the /usr/share/openstack-tripleo-heat-templates directory. There are many heat templates and environment files in this collection. This section contains information about the main files and directories that you can use to customize your deployment. overcloud.j2.yaml This file is the main template file used to create the overcloud environment. This file uses Jinja2 syntax and iterates over certain sections in the template to create custom roles. The Jinja2 formatting is rendered into YAML during the overcloud deployment process. overcloud-resource-registry-puppet.j2.yaml This file is the main environment file that you use to create the overcloud environment. This file contains a set of configurations for Puppet modules on the overcloud image. After the director writes the overcloud image to each node, heat starts the Puppet configuration for each node using the resources registered in this environment file. This file uses Jinja2 syntax and iterates over certain sections in the template to create custom roles. The Jinja2 formatting is rendered into YAML during the overcloud deployment process. roles_data.yaml This file contains definitions of the roles in an overcloud, and maps services to each role. network_data.yaml This file contains definitions of the networks in an overcloud and their properties, including subnets, allocation pools, and VIP status. The default network_data.yaml file contains only the default networks: External, Internal Api, Storage, Storage Management, Tenant, and Management. You can create a custom network_data.yaml file and include it in the openstack overcloud deploy command with the -n option. plan-environment.yaml This file contains definitions of the metadata for your overcloud plan, including the plan name, the main template that you want to use, and environment files that you want to apply to the overcloud. capabilities-map.yaml This file contains a mapping of environment files for an overcloud plan. Use this file to describe and enable environment files in the director web UI. If you include custom environment files in the environments directory but do not define these files in the capabilities-map.yaml file, you can find these environment files in the Other sub-tab of the Overall Settings page on the web UI. environments This directory contains additional heat environment files that you can use with your overcloud creation. These environment files enable extra functions for your Red Hat OpenStack Platform environment. For example, you can use the cinder-netapp-config.yaml environment file to enable NetApp back end storage for the Block Storage service (cinder). If you include custom environment files in the environments directory but do not define these files in the capabilities-map.yaml file, you can find these environment files in the Other sub-tab of the Overall Settings page on the web UI. network This directory contains a set of heat templates that you can use to create isolated networks and ports. puppet This directory contains puppet templates. The overcloud-resource-registry-puppet.j2.yaml environment file uses the files in the puppet directory to drive the application of the Puppet configuration on each node. puppet/services This directory contains heat templates for all services in the composable service architecture. extraconfig This directory contains templates that you can use to enable extra functionality. For example, you can use the extraconfig/pre_deploy/rhel-registration directory to register your nodes with the Red Hat Content Delivery network, or with your own Red Hat Satellite server.	[ "heat stack-list --show-nested" ]	https://docs.redhat.com/en/documentation/red_hat_openstack_platform/17.0/html/standalone_deployment_guide/working-with-heat-templates
Chapter 2. CSIDriver [storage.k8s.io/v1]	Chapter 2. CSIDriver [storage.k8s.io/v1] Description CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced. Type object Required spec 2.1. Specification Property Type Description apiVersion string APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources kind string Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds metadata ObjectMeta Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata spec object CSIDriverSpec is the specification of a CSIDriver. 2.1.1. .spec Description CSIDriverSpec is the specification of a CSIDriver. Type object Property Type Description attachRequired boolean attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called. This field is immutable. fsGroupPolicy string fsGroupPolicy defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details. This field is immutable. Defaults to ReadWriteOnceWithFSType, which will examine each volume to determine if Kubernetes should modify ownership and permissions of the volume. With the default policy the defined fsGroup will only be applied if a fstype is defined and the volume's access mode contains ReadWriteOnce. podInfoOnMount boolean podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations, if set to true. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume defined by a CSIVolumeSource, otherwise "false" "csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver. This field is immutable. requiresRepublish boolean requiresRepublish indicates the CSI driver wants NodePublishVolume being periodically called to reflect any possible change in the mounted volume. This field defaults to false. Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container. seLinuxMount boolean seLinuxMount specifies if the CSI driver supports "-o context" mount option. When "true", the CSI driver must ensure that all volumes provided by this CSI driver can be mounted separately with different -o context options. This is typical for storage backends that provide volumes as filesystems on block devices or as independent shared volumes. Kubernetes will call NodeStage / NodePublish with "-o context=xyz" mount option when mounting a ReadWriteOncePod volume used in Pod that has explicitly set SELinux context. In the future, it may be expanded to other volume AccessModes. In any case, Kubernetes will ensure that the volume is mounted only with a single SELinux context. When "false", Kubernetes won't pass any special SELinux mount options to the driver. This is typical for volumes that represent subdirectories of a bigger shared filesystem. Default is "false". storageCapacity boolean storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information, if set to true. The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object. Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published. This field was immutable in Kubernetes ⇐ 1.22 and now is mutable. tokenRequests array tokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": { "<audience>": { "token": <token>, "expirationTimestamp": <expiration timestamp in RFC3339>, }, ... } Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically. tokenRequests[] object TokenRequest contains parameters of a service account token. volumeLifecycleModes array (string) volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. This field is beta. This field is immutable. 2.1.2. .spec.tokenRequests Description tokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": { "<audience>": { "token": <token>, "expirationTimestamp": <expiration timestamp in RFC3339>, }, ... } Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically. Type array 2.1.3. .spec.tokenRequests[] Description TokenRequest contains parameters of a service account token. Type object Required audience Property Type Description audience string audience is the intended audience of the token in "TokenRequestSpec". It will default to the audiences of kube apiserver. expirationSeconds integer expirationSeconds is the duration of validity of the token in "TokenRequestSpec". It has the same default value of "ExpirationSeconds" in "TokenRequestSpec". 2.2. API endpoints The following API endpoints are available: /apis/storage.k8s.io/v1/csidrivers DELETE : delete collection of CSIDriver GET : list or watch objects of kind CSIDriver POST : create a CSIDriver /apis/storage.k8s.io/v1/watch/csidrivers GET : watch individual changes to a list of CSIDriver. deprecated: use the 'watch' parameter with a list operation instead. /apis/storage.k8s.io/v1/csidrivers/{name} DELETE : delete a CSIDriver GET : read the specified CSIDriver PATCH : partially update the specified CSIDriver PUT : replace the specified CSIDriver /apis/storage.k8s.io/v1/watch/csidrivers/{name} GET : watch changes to an object of kind CSIDriver. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. 2.2.1. /apis/storage.k8s.io/v1/csidrivers HTTP method DELETE Description delete collection of CSIDriver Table 2.1. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed Table 2.2. HTTP responses HTTP code Reponse body 200 - OK Status schema 401 - Unauthorized Empty HTTP method GET Description list or watch objects of kind CSIDriver Table 2.3. HTTP responses HTTP code Reponse body 200 - OK CSIDriverList schema 401 - Unauthorized Empty HTTP method POST Description create a CSIDriver Table 2.4. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 2.5. Body parameters Parameter Type Description body CSIDriver schema Table 2.6. HTTP responses HTTP code Reponse body 200 - OK CSIDriver schema 201 - Created CSIDriver schema 202 - Accepted CSIDriver schema 401 - Unauthorized Empty 2.2.2. /apis/storage.k8s.io/v1/watch/csidrivers HTTP method GET Description watch individual changes to a list of CSIDriver. deprecated: use the 'watch' parameter with a list operation instead. Table 2.7. HTTP responses HTTP code Reponse body 200 - OK WatchEvent schema 401 - Unauthorized Empty 2.2.3. /apis/storage.k8s.io/v1/csidrivers/{name} Table 2.8. Global path parameters Parameter Type Description name string name of the CSIDriver HTTP method DELETE Description delete a CSIDriver Table 2.9. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed Table 2.10. HTTP responses HTTP code Reponse body 200 - OK CSIDriver schema 202 - Accepted CSIDriver schema 401 - Unauthorized Empty HTTP method GET Description read the specified CSIDriver Table 2.11. HTTP responses HTTP code Reponse body 200 - OK CSIDriver schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified CSIDriver Table 2.12. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 2.13. HTTP responses HTTP code Reponse body 200 - OK CSIDriver schema 201 - Created CSIDriver schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified CSIDriver Table 2.14. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 2.15. Body parameters Parameter Type Description body CSIDriver schema Table 2.16. HTTP responses HTTP code Reponse body 200 - OK CSIDriver schema 201 - Created CSIDriver schema 401 - Unauthorized Empty 2.2.4. /apis/storage.k8s.io/v1/watch/csidrivers/{name} Table 2.17. Global path parameters Parameter Type Description name string name of the CSIDriver HTTP method GET Description watch changes to an object of kind CSIDriver. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. Table 2.18. HTTP responses HTTP code Reponse body 200 - OK WatchEvent schema 401 - Unauthorized Empty	null	https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/storage_apis/csidriver-storage-k8s-io-v1
function::sock_fam_str2num	function::sock_fam_str2num Name function::sock_fam_str2num - Given a protocol family name (string), return the corresponding Synopsis Arguments family The family name. Description protocol family number.	[ "function sock_fam_str2num:long(family:string)" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/systemtap_tapset_reference/api-sock-fam-str2num
Chapter 3. Using realmd to Connect to an Active Directory Domain	Chapter 3. Using realmd to Connect to an Active Directory Domain The realmd system provides a clear and simple way to discover and join identity domains to achieve direct domain integration. It configures underlying Linux system services, such as SSSD or Winbind, to connect to the domain. Chapter 2, Using Active Directory as an Identity Provider for SSSD describes how to use the System Security Services Daemon (SSSD) on a local system and Active Directory as a back-end identity provider. Ensuring that the system is properly configured for this can be a complex task: there are a number of different configuration parameters for each possible identity provider and for SSSD itself. In addition, all domain information must be available in advance and then properly formatted in the SSSD configuration for SSSD to integrate the local system with AD. The realmd system simplifies that configuration. It can run a discovery search to identify available AD and Identity Management domains and then join the system to the domain, as well as set up the required client services used to connect to the given identity domain and manage user access. Additionally, because SSSD as an underlying service supports multiple domains, realmd can discover and support multiple domains as well. 3.1. Supported Domain Types and Clients The realmd system supports the following domain types: Microsoft Active Directory Red Hat Enterprise Linux Identity Management The following domain clients are supported by realmd : SSSD for both Red Hat Enterprise Linux Identity Management and Microsoft Active Directory Winbind for Microsoft Active Directory	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/windows_integration_guide/ch-Configuring_Authentication
Installing on GCP	Installing on GCP OpenShift Container Platform 4.15 Installing OpenShift Container Platform on Google Cloud Platform Red Hat OpenShift Documentation Team	null	https://docs.redhat.com/en/documentation/openshift_container_platform_installation/4.15/html/installing_on_gcp/index
Deploying OpenShift Data Foundation using IBM Power	Deploying OpenShift Data Foundation using IBM Power Red Hat OpenShift Data Foundation 4.18 Instructions on deploying Red Hat OpenShift Data Foundation on IBM Power Red Hat Storage Documentation Team	null	https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.18/html/deploying_openshift_data_foundation_using_ibm_power/index
Chapter 2. Integrating OpenStack Identity (keystone) with Red Hat Identity Manager (IdM)	Chapter 2. Integrating OpenStack Identity (keystone) with Red Hat Identity Manager (IdM) When you integrate OpenStack Identity (keystone) with Red Hat Identity Manager (IdM), OpenStack Identity authenticates certain Red Hat Identity Management (IdM) users but retains authorization settings and critical service accounts in the Identity Service database. As a result, Identity Service has read-only access to IdM for user account authentication, while retaining management over the privileges assigned to authenticated accounts. You can also use tripleo-ipa or novajoin to enroll your nodes with IdM. Note The configuration files for this integration are managed by Puppet. Therefore, any custom configuration that you add might be overwritten the time you run the openstack overcloud deploy command. You can use director to configure LDAP authentication instead of manually editing the configuration files. Review the following key terms before you plan and configure the IdM integration: Authentication - The process of using a password to verify that the user is who they claim to be. Authorization - Validating that authenticated users have proper permissions to the systems they're attempting to access. Domain - Refers to the additional back ends configured in Identity Service. For example, Identity Service can be configured to authenticate users from external IdM environments. The resulting collection of users can be thought of as a domain . The process to integrate OpenStack Identity with IdM includes the following stages: Enroll the undercloud and overcloud in IdM with novajoin Implement TLS-e on the undercloud and overcloud with Ansible Configure IdM server credentials and export the LDAPS certificate Install and configure the LDAPS certificate in OpenStack Configure director to use one or more LDAP backends Configure Controller nodes to access the IdM backend Configure IdM user or group access to OpenStack projects Verify that the domain and user lists are created correctly Optional: Create credential files for non-admin users 2.1. Planning the Red Hat Identity Manager (IdM) integration When you plan your OpenStack Identity integration with Red Hat Identity Manager (IdM), ensure that both services are configured and operational and review the impact of the integration on user management and firewall settings. Prerequisites Red Hat Identity Management is configured and operational. Red Hat OpenStack Platform is configured and operational. DNS name resolution is fully functional and all hosts are registered appropriately. Permissions and roles This integration allows IdM users to authenticate to OpenStack and access resources. OpenStack service accounts (such as keystone and glance), and authorization management (permissions and roles) will remain in the Identity Service database. Permissions and roles are assigned to the IdM accounts using Identity Service management tools. High availability options This configuration creates a dependency on the availability of a single IdM server: Project users will be affected if Identity Service is unable to authenticate to the IdM Server. You can configure keystone to query a different IdM server, should one become unavailable, or you can use a load balancer. Do not use a load balancer when you use IdM with SSSD, as this configuration has failover implemented on the client. Outage requirements The Identity Service will need to be restarted in order to add the IdM back end. Users will be unable to access the dashboard until their accounts have been created in IdM. To reduce downtime, consider pre-staging the IdM accounts well in advance of this change. Firewall configuration Communication between IdM and OpenStack consists of the following: Authenticating users IdM retrieval of the certificate revocation list (CRL) from the controllers every two hours Certmonger requests for new certificates upon expiration Note A periodic certmonger task will continue to request new certificates if the initial request fails. If firewalls are filtering traffic between IdM and OpenStack, you will need to allow access through the following port: Source Destination Type Port OpenStack Controller Node Red Hat Identity Management LDAPS TCP 636 2.2. Identity Management (IdM) server recommendations for OpenStack Red Hat provides the following information to help you integrate your IdM server and OpenStack environment. For information on preparing Red Hat Enterprise Linux for an IdM installation, see Installing Identity Management . Run the ipa-server-install command to install and configure IdM. You can use command parameters to skip interactive prompts. Use the following recommendations so that your IdM server can integrate with your Red Hat OpenStack Platform environment: Table 2.1. Parameter recommendations Option Recommendation --admin-password Note the value you provide. You will need this password when configuring Red Hat OpenStack Platform to work with IdM. --ip-address Note the value you provide. The undercloud and overcloud nodes require network access to this ip address. --setup-dns Use this option to install an integrated DNS service on the IdM server. The undercloud and overcloud nodes use the IdM server for domain name resolution. --auto-forwarders Use this option to use the addresses in /etc/resolv.conf as DNS forwarders. --auto-reverse Use this option to resolve reverse records and zones for the IdM server IP addresses. If neither reverse records or zones are resolvable, IdM creates the reverse zones. This simplifies the IdM deployment. --ntp-server , --ntp-pool You can use both or either of these options to configure your NTP source. Both the IdM server and your OpenStack environment must have correct and synchronized time. You must open the firewall ports required by IdM to enable communication with Red Hat OpenStack Platform nodes. For more information, see Opening the ports required by IdM . Additional resources Configuring and Managing Identity Management Red Hat Identity Management Documentation 2.3. Implementing TLS-e with Ansible You can use the new tripleo-ipa method to enable SSL/TLS on overcloud endpoints, called TLS everywhere (TLS-e). Due to the number of certificates required, Red Hat OpenStack Platform integrates with Red Hat Identity management (IdM). When you use tripleo-ipa to configure TLS-e, IdM is the certificate authority. Prerequisites Ensure that all configuration steps for the undercloud, such as the creation of the stack user, are complete. For more details, see Director Installation and Usage for more details Procedure Use the following procedure to implement TLS-e on a new installation of Red Hat OpenStack Platform, or an existing deployment that you want to configure with TLS-e. You must use this method if you deploy Red Hat OpenStack Platform with TLS-e on pre-provisioned nodes. Note If you are implementing TLS-e for an existing environment, you are required to run commands such as openstack undercloud install , and openstack overcloud deploy . These procedures are idempotent and only adjust your existing deployment configuration to match updated templates and configuration files. Configure the /etc/resolv.conf file: Set the appropriate search domains and the nameserver on the undercloud in /etc/resolv.conf . For example, if the deployment domain is example.com , and the domain of the FreeIPA server is bigcorp.com , then add the following lines to /etc/resolv.conf: Install required software: Export environmental variables with values specific to your environment.: 1 2 The IdM user credentials are an administrative user that can add new hosts and services. 3 The value of the UNDERCLOUD_FQDN parameter matches the first hostname-to-IP address mapping in /etc/hosts . Run the undercloud-ipa-install.yaml ansible playbook on the undercloud: Add the following parameters to undercloud.conf [Optional] If your IPA realm does not match your IPA domain, set the value of the certmonger_krb_realm parameter: Set the value of the certmonger_krb_realm in /home/stack/hiera_override.yaml : Set the value of the custom_env_files parameter in undercloud.conf to /home/stack/hiera_override.yaml : Deploy the undercloud: Verification Verify that the undercloud was enrolled correctly by completing the following steps: List the hosts in IdM: Confirm that /etc/novajoin/krb5.keytab exists on the undercloud. Note The novajoin directory name is for legacy naming purposes only. Configuring TLS-e on the overcloud When you deploy the overcloud with TLS everywhere (TLS-e), IP addresses from the Undercloud and Overcloud will automatically be registered with IdM. Before deploying the overcloud, create a YAML file tls-parameters.yaml with contents similar to the following. The values you select will be specific for your environment: The shown value of the OS::TripleO::Services::IpaClient parameter overrides the default setting in the enable-internal-tls.yaml file. You must ensure the tls-parameters.yaml file follows enable-internal-tls.yaml in the openstack overcloud deploy command. For more information about the parameters that you use to implement TLS-e, see Parameters for tripleo-ipa Deploy the overcloud. You will need to include the tls-parameters.yaml in the deployment command: Confirm each endpoint is using HTTPS by querying keystone for a list of endpoints: 2.4. Enrolling nodes in Red Hat Identity Manager (IdM) with novajoin Novajoin is the default tool that you use to enroll your nodes with Red Hat Identity Manager (IdM) as part of the deployment process. Red Hat recommends the new ansible-based tripleo-ipa solution over the default novajoin solution to configure your undercloud and overcloud with TLS-e. For more information see Implementing TLS-e with Ansible . You must perform the enrollment process before you proceed with the rest of the IdM integration. The enrollment process includes the following steps: Adding the undercloud node to the certificate authority (CA) Adding the undercloud node to IdM Optional: Setting the IdM server as the DNS server for the overcloud Preparing the environment files and deploying the overcloud Testing the overcloud enrollment in IdM and in RHOSP Optional: Adding DNS entries for novajoin in IdM Note IdM enrollment with novajoin is currently only available for the undercloud and overcloud nodes. Novajoin integration for overcloud instances is expected to be supported in a later release. 2.4.1. Adding the undercloud node to the certificate authority Before you deploy the overcloud, add the undercloud to the certificate authority (CA) by installing the python3-novajoin package on the undercloud node and running the novajoin-ipa-setup script. Procedure On the undercloud node, install the python3-novajoin package: On the undercloud node, run the novajoin-ipa-setup script, and adjust the values to suit your deployment: Use the resulting One-Time Password (OTP) to enroll the undercloud. 2.4.2. Adding the undercloud node to Red Hat Identity Manager (IdM) After you add the undercloud node to the certificate authority (CA), register the undercloud with IdM and configure novajoin. Configure the following settings in the [DEFAULT] section of the undercloud.conf file. Procedure Enable the novajoin service: Set a One-Time Password (OTP) so that you can register the undercloud node with IdM: Set the overcloud's domain name to be served by neutron's DHCP server: Set the hostname for the undercloud: Set IdM as the nameserver for the undercloud: For larger environments, review the novajoin connection timeout values. In the undercloud.conf file, add a reference to a new file called undercloud-timeout.yaml : Add the following options to undercloud-timeout.yaml . You can specify the timeout value in seconds, for example, 5 : Optional: If you want the local openSSL certificate authority to generate the SSL certificates for the public endpoints in director, set the generate_service_certificate parameter to true : Save the undercloud.conf file. Run the undercloud deployment command to apply the changes to your existing undercloud: 2.4.3. Setting Red Hat Identity Manager (IdM) as the DNS server for the overcloud To enable automatic detection of your IdM environment and easier enrollment, set IdM as your DNS server. This procedure is optional but recommended. Procedure Connect to your undercloud: Configure the control plane subnet to use IdM as the DNS name server: Set the DnsServers parameter in an environment file to use your IdM server: This parameter is usually defined in a custom network-environment.yaml file. 2.4.4. Preparing environment files and deploying the overcloud with novajoin enrollment To deploy the overcloud with IdM integration, you create and edit environment files to configure the overcloud to use the custom domain parameters CloudDomain and CloudName based on the domains that you define in the overcloud. You then deploy the overcloud with all the environment files and any additional environment files that you need for the deployment. Procedure Create a copy of the /usr/share/openstack-tripleo-heat-templates/environments/predictable-placement/custom-domain.yaml environment file: Edit the /home/stack/templates/custom-domain.yaml environment file and set the CloudDomain and CloudName* values to suit your deployment: Choose the implementation of TLS appropriate for your environment: Use the enable-tls.yaml environment file to protect external endpoints with your custom certificate: Copy /usr/share/openstack-tripleo-heat-templates/environments/ssl/enable-tls.yaml to /home/stack/templates . Modify the /home/stack/enable-tls.yaml environment file to include your custom certificate and key. Include the following environment files in your deployment to protect internal and external endpoints: enable-internal-tls.yaml tls-every-endpoints-dns.yaml custom-domain.yaml enable-tls.yaml Use the haproxy-public-tls-certmonger.yaml environment file to protect external endpoints with an IdM issued certificate. For this implementation, you must create DNS entries for the VIP endpoints used by novajoin: You must create DNS entries for the VIP endpoints used by novajoin. Identify the overcloud networks located in your custom network-environment.yaml file in `/home/stack/templates : Create a list of virtual IP addresses for each overcloud network in a heat template, for example, /home/stack/public_vip.yaml . Add DNS entries to the IdM for each of the VIPs, and zones as needed: Include the following environment files in your deployment to protect internal and external endpoints: enable-internal-tls.yaml tls-everywhere-endpoints-dns.yaml haproxy-public-tls-certmonger.yaml custom-domain.yaml public_vip.yaml Note You cannot use novajoin to implement TLS everywhere (TLS-e) on a pre-existing deployment. Additional resources Implementing TLS-e with Ansible 2.4.5. Testing overcloud enrollment in Red Hat Identity Manager (IdM) After you complete the undercloud and overcloud enrollment in IdM with novajoin, you can test that the enrollment is successful by searching for an overcloud node in IdM and checking that the host entry includes Keytab:True . You can also log in to the overcloud node and confirm that the sssd command can query IdM users. Locate an overcloud node in IdM and confirm that the host entry includes Keytab:True : Log in to the overcloud node and confirm that sssd can query IdM users. For example, to query an IdM user named susan : 2.5. Encrypting memcached traffic under TLS everywhere (TLS-e) This feature is available in this release as a Technology Preview , and therefore is not fully supported by Red Hat. It should only be used for testing, and should not be deployed in a production environment. For more information about Technology Preview features, see Scope of Coverage Details . You can now encrypt memcached traffic with TLS-e. This feature works with both novajoin and tripleo-ipa: Create an environment file called memcached.yaml with the following contents to add TLS support for memcached: Include the memcached.yaml environment file in the overcloud deployment process: Additional Resources For more information about deploying TLSe with tripleo-ipa, see Implementing TLS-e with Ansible . For more information about deploying TLSe with novajoin, see Enrolling nodes in Red Hat Identity Manager (IdM) with novajoin 2.6. Configuring Red Hat Identity Manager (IdM) server credentials To configure the Red Hat Identity Manager (IdM) to integrate with OpenStack Identity, set up an LDAP account for Identity service to use, create a user group for Red Hat OpenStack users, and set up the password for the lookup account. Prerequisites Red Hat Identity Manager (IdM) is configured and operational. Red Hat OpenStack Platform (RHOSP) is configured and operational. DNS name resolution is fully functional and all hosts are registered appropriately. IdM authentication traffic is encrypted with LDAPS, using port 636. Recommended: Implement IdM with a high availability or load balancing solution to avoid a single point of failure. Procedure Perform this procedure on the IdM server. Create the LDAP lookup account to use in OpenStack Identity Service to query the IdM LDAP service: Note Review the password expiration settings of this account, once created. Create a group for RHOSP users, called grp-openstack . Only members of this group can have permissions assigned in OpenStack Identity. Set the svc-ldap account password and add it to the grp-openstack group: Login as svc-ldap user and change the password when prompted: 2.7. Installing the Red Hat Identity Manager (IdM) LDAPS certificate OpenStack Identity (keystone) uses LDAPS queries to validate user accounts. To encrypt this traffic, keystone uses the certificate file defined by keystone.conf . To install the LDAPS certificate, copy the certificate from the Red Hat Identity Manager (IdM) server to a location where keystone will be able to reference it, and convert the certificate from .crt to .pem format. Note When using multiple domains for LDAP authentication, you might receive various errors, such as Unable to retrieve authorized projects , or Peer's Certificate issuer is not recognized . This can arise if keystone uses the incorrect certificate for a certain domain. As a workaround, merge all of the LDAPS public keys into a single .crt bundle, and configure all of your keystone domains to use this file. Prerequisites IdM server credentials are configured. Procedure In your IdM environment, locate the LDAPS certificate. This file can be located using /etc/openldap/ldap.conf : Copy the file to the Controller node that runs the keystone service. For example, the scp command copies the ca.crt file to the node node.lab.local : Copy the ca.crt file to the certificate directory. This is the location that the keystone service will use to access the certificate: Optional: If you need to run diagnostic commands, such as ldapsearch , you also need to add the certificate to the RHEL certificate store: 3. On the Controller node, convert the .crt to .pem format: Install the .pem on the Controller node. For example, in Red Hat Enterprise Linux: 2.8. Configuring director to use domain-specific LDAP backends To configure director to use one or more LDAP backends, set the KeystoneLDAPDomainEnable flag to true in your heat templates, and set up environment files with the information about each LDAP backend. Director then uses a separate LDAP backend for each keystone domain. Note The default directory for domain configuration files is set to /etc/keystone/domains/ . You can override this by setting the required path with the keystone::domain_config_directory hiera key and adding it as an ExtraConfig parameter within an environment file. Procedure In the heat template for your deployment, set the KeystoneLDAPDomainEnable flag to true . This configures the domain_specific_drivers_enabled option in keystone within the identity configuration group. Add a specification of the LDAP backend configuration by setting the KeystoneLDAPBackendConfigs parameter in tripleo-heat-templates , where you can then specify your required LDAP options. Create a copy of the keystone_domain_specific_ldap_backend.yaml environment file: Edit the /home/stack/templates/keystone_domain_specific_ldap_backend.yaml environment file and set the values to suit your deployment. For example, this parameter create a LDAP configuration for a keystone domain named testdomain : Note The keystone_domain_specific_ldap_backend.yaml environment file contains the following deprecated write parameters: user_allow_create user_allow_update user_allow_delete The values for these parameters have no effect on the deployment, and can be safely removed. Optional: Add more domains to the environment file. For example: This results in two domains named domain1 and domain2 ; each will have a different LDAP domain with its own configuration. 2.9. Granting the admin user access to the OpenStack Identity domain To allow the admin user to access the OpenStack Identity (keystone) domain and see the Domain tab, get the ID of the domain and the admin user, and then assign the admin role to the user in the domain. Note This does not grant the OpenStack admin account any permissions on the external service domain. In this case, the term domain refers to OpenStack's usage of the keystone domain. Procedure This procedure uses the LAB domain. Replace the domain name with the actual name of the domain that you are configuring. Get the ID of the LAB domain: Get the ID of the admin user from the default domain: Get the ID of the admin role: The output depends on the external service you are integrating with: Active Directory Domain Service (AD DS): Red Hat Identity Manager (IdM): Use the domain and admin IDs to construct the command that adds the admin user to the admin role of the keystone LAB domain: 2.10. Granting external groups access to Red Hat OpenStack Platform projects To grant multiple authenticated users access to Red Hat OpenStack Platform (RHOSP) resources, you can authorize certain groups from the external user management service to grant access to RHOSP projects, instead of requiring OpenStack administrators to manually allocate each user to a role in a project. As a result, all members of these groups can access pre-determined projects. Prerequisites Ensure that the external service administrator completed the following steps: Creating a group named grp-openstack-admin . Creating a group named grp-openstack-demo . Adding your RHOSP users to one of these groups as needed. Adding your users to the grp-openstack group. Create the OpenStack Identity domain. This procedure uses the LAB domain. Create or choose a RHOSP project. This procedure uses a project called demo that was created with the openstack project create --domain default --description "Demo Project" demo command. Procedure Retrieve a list of user groups from the OpenStack Identity domain: The command output depends on the external user management service that you are integrating with: Active Directory Domain Service (AD DS): Red Hat Identity Manager (IdM): Retrieve a list of roles: The command output depends on the external user management service that you are integrating with: Active Directory Domain Service (AD DS): Red Hat Identity Manager (IdM): Grant the user groups access to RHOSP projects by adding them to one or more of these roles. For example, if you want users in the grp-openstack-demo group to be general users of the demo project, you must add the group to the member or _member_ role, depending on the external service that you are integrating with: Active Directory Domain Service (AD DS): Red Hat Identity Manager (IdM): Result Members of grp-openstack-demo can log in to the dashboard by entering their username and password and entering LAB in the Domain field: Note If users receive the error Error: Unable to retrieve container list. , and expect to be able to manage containers, then they must be added to the SwiftOperator role. Additional resources Section 2.11, "Granting external users access to Red Hat OpenStack Platform projects" 2.11. Granting external users access to Red Hat OpenStack Platform projects To grant specific authenticated users from the grp-openstack group access to OpenStack resources, you can grant these users direct access to Red Hat OpenStack Platform (RHOSP) projects. Use this process in cases where you want to grant access to individual users instead of granting access to groups. Prerequisites Ensure that the external service administrator completed the following steps: Adding your RHOSP users to the grp-openstack group. Creating the OpenStack Identity domain. This procedure uses the LAB domain. Create or choose a RHOSP project. This procedure uses a project called demo that was created with the openstack project create --domain default --description "Demo Project" demo command. Procedure Retrieve a list of users from the OpenStack Identity domain: Retrieve a list of roles: The command output depends on the external user management service that you are integrating with: Active Directory Domain Service (AD DS): Red Hat Identity Manager (IdM): Grant users access to RHOSP projects by adding them to one or more of these roles. For example, if you want user1 to be a general user of the demo project, you add them to the member or _member_ role, depending on the external service that you are integrating with: Active Directory Domain Service (AD DS): Red Hat Identity Manager (IdM): If you want user1 to be an administrative user of the demo project, add the user to the admin role: Result The user1 user is able to log in to the dashboard by entering their external username and password and entering LAB in the Domain field: Note If users receive the error Error: Unable to retrieve container list. , and expect to be able to manage containers, then they must be added to the SwiftOperator role. Additional resources Section 2.10, "Granting external groups access to Red Hat OpenStack Platform projects" 2.12. Viewing the list of OpenStack Identity domains and users Use the openstack domain list command to list the available entries. Configuring multiple domains in Identity Service enables a new Domain field in the dashboard login page. Users are expected to enter the domain that matches their login credentials. Important After you complete the integration, you need to decide whether to create new projects in the Default domain or in newly created keystone domains. You must consider your workflow and how you administer user accounts. If possible, use the Default domain as an internal domain to manage service accounts and the admin project, and keep your external users in a separate domain. In this example, external accounts need to specify the LAB domain. The built-in keystone accounts, such as admin , must specify Default as their domain. Procedure Show the list of domains: Show the list of users in a specific domain. This command example specifies the --domain LAB and returns users in the LAB domain that are members of the grp-openstack group: You can also append --domain Default to show the built-in keystone accounts: 2.13. Creating a credentials file for a non-admin user After you configure users and domains for OpenStack Identity, you might need to create a credentials file for a non-admin user. Procedure Create a credentials (RC) file for a non-admin user. This example uses the user1 user in the file. 2.14. Testing OpenStack Identity integration with an external user management service To test that OpenStack Identity (keystone) successfully integrated with Active Directory Domain Service (AD DS), test user access to dashboard features. Prerequisites Integration with an external user management service, such as Active Directory (AD) or Red Hat Identity Manager (IdM) Procedure Create a test user in the external user management service, and add the user to the grp-openstack group. In Red Hat OpenStack Platform, add the user to the _member_ role of the demo project. Log in to the dashboard with the credentials of the AD test user. Click on each of the tabs to confirm that they are presented successfully without error messages. Use the dashboard to build a test instance. Note If you experience issues with these steps, log in to the dashboard with the admin account and perform the subsequent steps as that user. If the test is successful, it means that OpenStack is still working as expected and that an issue exists somewhere in the integration settings between OpenStack Identity and Active Directory. Additional resources Section 1.10, "Troubleshooting Active Directory integration" 2.15. Troubleshooting Red Hat Identity Manager (IdM) integration If you encounter errors when using the Red Hat Identity Manager (IdM) integration with OpenStack Identity, you might need to test the LDAP connection or test the certificate trust configuration. You might also need to check that the LDAPS port is accessible. Note Depending on the error type and location, perform only the relevant steps in this procedure. Procedure Test the LDAP connection by using the ldapsearch command to remotely perform test queries against the IdM server. A successful result here indicates that network connectivity is working, and the IdM services are up. In this example, a test query is performed against the server idm.lab.local on port 636 : Note ldapsearch is a part of the openldap-clients package. You can install this using # dnf install openldap-clients . Use the nc command to check that LDAPS port 636 is remotely accessible. In this example, a probe is performed against the server idm.lab.local . Press ctrl-c to exit the prompt. Failure to establish a connection could indicate a firewall configuration issue.	[ "search example.com bigcorp.com nameserver USDIDM_SERVER_IP_ADDR", "sudo dnf install -y python3-ipalib python3-ipaclient krb5-devel", "export IPA_DOMAIN=bigcorp.com export IPA_REALM=BIGCORP.COM export IPA_ADMIN_USER=USDIPA_USER 1 export IPA_ADMIN_PASSWORD=USDIPA_PASSWORD 2 export IPA_SERVER_HOSTNAME=ipa.bigcorp.com export UNDERCLOUD_FQDN=undercloud.example.com 3 export USER=stack export CLOUD_DOMAIN=example.com", "ansible-playbook --ssh-extra-args \"-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null\" /usr/share/ansible/tripleo-playbooks/undercloud-ipa-install.yaml", "undercloud_nameservers = USDIDM_SERVER_IP_ADDR overcloud_domain_name = example.com", "parameter_defaults: certmonger_krb_realm = EXAMPLE.COMPANY.COM", "custom_env_files = /home/stack/hiera_override.yaml", "openstack undercloud install", "kinit admin ipa host-find", "ls /etc/novajoin/krb5.keytab", "parameter_defaults: DnsSearchDomains: [\"example.com\"] DnsServers: [\"192.168.1.13\"] CloudDomain: example.com CloudName: overcloud.example.com CloudNameInternal: overcloud.internalapi.example.com CloudNameStorage: overcloud.storage.example.com CloudNameStorageManagement: overcloud.storagemgmt.example.com CloudNameCtlplane: overcloud.ctlplane.example.com IdMServer: freeipa-0.redhat.local IdMDomain: redhat.local IdMInstallClientPackages: False resource_registry: OS::TripleO::Services::IpaClient: /usr/share/openstack-tripleo-heat-templates/deployment/ipa/ipaservices-baremetal-ansible.yaml", "DEFAULT_TEMPLATES=/usr/share/openstack-tripleo-heat-templates/ CUSTOM_TEMPLATES=/home/stack/templates openstack overcloud deploy -e USD{DEFAULT_TEMPLATES}/environments/ssl/tls-everywhere-endpoints-dns.yaml -e USD{DEFAULT_TEMPLATES}/environments/services/haproxy-public-tls-certmonger.yaml -e USD{DEFAULT_TEMPLATES}/environments/ssl/enable-internal-tls.yaml -e USD{CUSTOM_TEMPLATES}/tls-parameters.yaml", "openstack endpoint list", "sudo dnf install python3-novajoin", "sudo /usr/libexec/novajoin-ipa-setup --principal admin --password <IdM admin password> --server <IdM server hostname> --realm <realm> --domain <overcloud cloud domain> --hostname <undercloud hostname> --precreate", "[DEFAULT] enable_novajoin = true", "ipa_otp = <otp>", "overcloud_domain_name = <domain>", "undercloud_hostname = <undercloud FQDN>", "undercloud_nameservers = <IdM IP>", "hieradata_override = /home/stack/undercloud-timeout.yaml", "nova::api::vendordata_dynamic_connect_timeout: <timeout value> nova::api::vendordata_dynamic_read_timeout: <timeout value>", "generate_service_certificate = true", "openstack undercloud install", "source ~/stackrc", "openstack subnet set ctlplane-subnet --dns-nameserver <idm_server_address>", "parameter_defaults: DnsServers: [\"<idm_server_address>\"]", "cp /usr/share/openstack-tripleo-heat-templates/environments/predictable-placement/custom-domain.yaml /home/stack/templates/custom-domain.yaml", "parameter_defaults: CloudDomain: lab.local CloudName: overcloud.lab.local CloudNameInternal: overcloud.internalapi.lab.local CloudNameStorage: overcloud.storage.lab.local CloudNameStorageManagement: overcloud.storagemgmt.lab.local CloudNameCtlplane: overcloud.ctlplane.lab.local", "openstack overcloud deploy --templates -e /usr/share/openstack-tripleo-heat-templates/environments/ssl/enable-internal-tls.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/ssl/tls-everywhere-endpoints-dns.yaml -e /home/stack/templates/custom-domain.yaml -e /home/stack/templates/enable-tls.yaml", "parameter_defaults: ControlPlaneDefaultRoute: 192.168.24.1 ExternalAllocationPools: - end: 10.0.0.149 start: 10.0.0.101 InternalApiAllocationPools: - end: 172.17.1.149 start: 172.17.1.10 StorageAllocationPools: - end: 172.17.3.149 start: 172.17.3.10 StorageMgmtAllocationPools: - end: 172.17.4.149 start: 172.17.4.10", "parameter_defaults: ControlFixedIPs: [{'ip_address':'192.168.24.101'}] PublicVirtualFixedIPs: [{'ip_address':'10.0.0.101'}] InternalApiVirtualFixedIPs: [{'ip_address':'172.17.1.101'}] StorageVirtualFixedIPs: [{'ip_address':'172.17.3.101'}] StorageMgmtVirtualFixedIPs: [{'ip_address':'172.17.4.101'}] RedisVirtualFixedIPs: [{'ip_address':'172.17.1.102'}]", "ipa dnsrecord-add lab.local overcloud --a-rec 10.0.0.101 ipa dnszone-add ctlplane.lab.local ipa dnsrecord-add ctlplane.lab.local overcloud --a-rec 192.168.24.101 ipa dnszone-add internalapi.lab.local ipa dnsrecord-add internalapi.lab.local overcloud --a-rec 172.17.1.101 ipa dnszone-add storage.lab.local ipa dnsrecord-add storage.lab.local overcloud --a-rec 172.17.3.101 ipa dnszone-add storagemgmt.lab.local ipa dnsrecord-add storagemgmt.lab.local overcloud --a-rec 172.17.4.101", "openstack overcloud deploy --templates -e /usr/share/openstack-tripleo-heat-templates/environments/ssl/enable-internal-tls.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/ssl/tls-everywhere-endpoints-dns.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/services/haproxy-public-tls-certmonger.yaml -e /home/stack/templates/custom-domain.yaml -e /home/stack/templates/public-vip.yaml", "ipa host-show overcloud-node-01 Host name: overcloud-node-01.lab.local Principal name: host/[email protected] Principal alias: host/[email protected] SSH public key fingerprint: <snip> Password: False Keytab: True Managed by: overcloud-node-01.lab.local", "getent passwd susan uid=1108400007(susan) gid=1108400007(bob) groups=1108400007(susan)", "parameter_defaults: MemcachedTLS: true MemcachedPort: 11212", "openstack overcloud deploy --templates -e /usr/share/openstack-tripleo-heat-templates/environments/ssl/enable-internal-tls.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/ssl/tls-everywhere-endpoints-dns.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/services/haproxy-public-tls-certmonger.yaml -e /home/stack/memcached.yaml", "kinit admin ipa user-add First name: OpenStack Last name: LDAP User [radministrator]: svc-ldap", "ipa group-add --desc=\"OpenStack Users\" grp-openstack", "ipa passwd svc-ldap ipa group-add-member --users=svc-ldap grp-openstack", "kinit svc-ldap", "TLS_CACERT /etc/ipa/ca.crt", "scp /etc/ipa/ca.crt [email protected]:/root/", "cp ca.crt /etc/pki/ca-trust/source/anchors", "openssl x509 -in ca.crt -out ca.pem -outform PEM", "cp ca.pem /etc/pki/ca-trust/source/anchors/ update-ca-trust", "cp /usr/share/openstack-tripleo-heat-templates/environments/services/keystone_domain_specific_ldap_backend.yaml /home/stack/templates/", "parameter_defaults: KeystoneLDAPDomainEnable: true KeystoneLDAPBackendConfigs: testdomain: url: ldaps://192.0.2.250 user: cn=openstack,ou=Users,dc=director,dc=example,dc=com password: RedactedComplexPassword suffix: dc=director,dc=example,dc=com user_tree_dn: ou=Users,dc=director,dc=example,dc=com user_filter: \"(memberOf=cn=OSuser,ou=Groups,dc=director,dc=example,dc=com)\" user_objectclass: person user_id_attribute: cn", "KeystoneLDAPBackendConfigs: domain1: url: ldaps://domain1.example.com user: cn=openstack,ou=Users,dc=director,dc=example,dc=com password: RedactedComplexPassword domain2: url: ldaps://domain2.example.com user: cn=openstack,ou=Users,dc=director,dc=example,dc=com password: RedactedComplexPassword", "openstack domain show LAB +---------+----------------------------------+ \| Field \| Value \| +---------+----------------------------------+ \| enabled \| True \| \| id \| 6800b0496429431ab1c4efbb3fe810d4 \| \| name \| LAB \| +---------+----------------------------------+", "openstack user list --domain default \| grep admin \| 3d75388d351846c6a880e53b2508172a \| admin \|", "openstack role list", "+----------------------------------+-----------------+ \| ID \| Name \| +----------------------------------+-----------------+ \| 01d92614cd224a589bdf3b171afc5488 \| admin \| \| 034e4620ed3d45969dfe8992af001514 \| member \| \| 0aa377a807df4149b0a8c69b9560b106 \| ResellerAdmin \| \| 9369f2bf754443f199c6d6b96479b1fa \| heat_stack_user \| \| cfea5760d9c948e7b362abc1d06e557f \| reader \| \| d5cb454559e44b47aaa8821df4e11af1 \| swiftoperator \| \| ef3d3f510a474d6c860b4098ad658a29 \| service \| +----------------------------------+-----------------+", "+----------------------------------+---------------+ \| ID \| Name \| +----------------------------------+---------------+ \| 544d48aaffde48f1b3c31a52c35f01f9 \| SwiftOperator \| \| 6d005d783bf0436e882c55c62457d33d \| ResellerAdmin \| \| 785c70b150ee4c778fe4de088070b4cf \| admin \| \| 9fe2ff9ee4384b1894a90878d3e92bab \| _member_ \| +----------------------------------+---------------+", "openstack role add --domain 6800b0496429431ab1c4efbb3fe810d4 --user 3d75388d351846c6a880e53b2508172a 785c70b150ee4c778fe4de088070b4cf", "openstack group list --domain LAB", "+------------------------------------------------------------------+---------------------+ \| ID \| Name \| +------------------------------------------------------------------+---------------------+ \| 185277be62ae17e498a69f98a59b66934fb1d6b7f745f14f5f68953a665b8851 \| grp-openstack \| \| a8d17f19f464c4548c18b97e4aa331820f9d3be52654aa8094e698a9182cbb88 \| grp-openstack-admin \| \| d971bb3bd5e64a454cbd0cc7af4c0773e78d61b5f81321809f8323216938cae8 \| grp-openstack-demo \| +------------------------------------------------------------------+---------------------+", "+------------------------------------------------------------------+---------------------+ \| ID \| Name \| +------------------------------------------------------------------+---------------------+ \| 185277be62ae17e498a69f98a59b66934fb1d6b7f745f14f5f68953a665b8851 \| grp-openstack \| \| a8d17f19f464c4548c18b97e4aa331820f9d3be52654aa8094e698a9182cbb88 \| grp-openstack-admin \| \| d971bb3bd5e64a454cbd0cc7af4c0773e78d61b5f81321809f8323216938cae8 \| grp-openstack-demo \| +------------------------------------------------------------------+---------------------+", "openstack role list", "+----------------------------------+-----------------+ \| ID \| Name \| +----------------------------------+-----------------+ \| 01d92614cd224a589bdf3b171afc5488 \| admin \| \| 034e4620ed3d45969dfe8992af001514 \| member \| \| 0aa377a807df4149b0a8c69b9560b106 \| ResellerAdmin \| \| 9369f2bf754443f199c6d6b96479b1fa \| heat_stack_user \| \| cfea5760d9c948e7b362abc1d06e557f \| reader \| \| d5cb454559e44b47aaa8821df4e11af1 \| swiftoperator \| \| ef3d3f510a474d6c860b4098ad658a29 \| service \| +----------------------------------+-----------------+", "+----------------------------------+---------------+ \| ID \| Name \| +----------------------------------+---------------+ \| 0969957bce5e4f678ca6cef00e1abf8a \| ResellerAdmin \| \| 1fcb3c9b50aa46ee8196aaaecc2b76b7 \| admin \| \| 9fe2ff9ee4384b1894a90878d3e92bab \| _member_ \| \| d3570730eb4b4780a7fed97eba197e1b \| SwiftOperator \| +----------------------------------+---------------+", "openstack role add --project demo --group d971bb3bd5e64a454cbd0cc7af4c0773e78d61b5f81321809f8323216938cae8 member", "openstack role add --project demo --group d971bb3bd5e64a454cbd0cc7af4c0773e78d61b5f81321809f8323216938cae8 _member_", "openstack user list --domain LAB +------------------------------------------------------------------+----------------+ \| ID \| Name \| +------------------------------------------------------------------+----------------+ \| 1f24ec1f11aeb90520079c29f70afa060d22e2ce92b2eba7784c841ac418091e \| user1 \| \| 12c062faddc5f8b065434d9ff6fce03eb9259537c93b411224588686e9a38bf1 \| user2 \| \| afaf48031eb54c3e44e4cb0353f5b612084033ff70f63c22873d181fdae2e73c \| user3 \| \| e47fc21dcf0d9716d2663766023e2d8dc15a6d9b01453854a898cabb2396826e \| user4 \| +------------------------------------------------------------------+----------------+", "openstack role list", "+----------------------------------+-----------------+ \| ID \| Name \| +----------------------------------+-----------------+ \| 01d92614cd224a589bdf3b171afc5488 \| admin \| \| 034e4620ed3d45969dfe8992af001514 \| member \| \| 0aa377a807df4149b0a8c69b9560b106 \| ResellerAdmin \| \| 9369f2bf754443f199c6d6b96479b1fa \| heat_stack_user \| \| cfea5760d9c948e7b362abc1d06e557f \| reader \| \| d5cb454559e44b47aaa8821df4e11af1 \| swiftoperator \| \| ef3d3f510a474d6c860b4098ad658a29 \| service \| +----------------------------------+-----------------+", "+----------------------------------+---------------+ \| ID \| Name \| +----------------------------------+---------------+ \| 0969957bce5e4f678ca6cef00e1abf8a \| ResellerAdmin \| \| 1fcb3c9b50aa46ee8196aaaecc2b76b7 \| admin \| \| 9fe2ff9ee4384b1894a90878d3e92bab \| _member_ \| \| d3570730eb4b4780a7fed97eba197e1b \| SwiftOperator \| +----------------------------------+---------------+", "openstack role add --project demo --user 1f24ec1f11aeb90520079c29f70afa060d22e2ce92b2eba7784c841ac418091e member", "openstack role add --project demo --user 1f24ec1f11aeb90520079c29f70afa060d22e2ce92b2eba7784c841ac418091e _member_", "openstack role add --project demo --user 1f24ec1f11aeb90520079c29f70afa060d22e2ce92b2eba7784c841ac418091e admin", "openstack domain list +----------------------------------+---------+---------+----------------------------------------------------------------------+ \| ID \| Name \| Enabled \| Description \| +----------------------------------+---------+---------+----------------------------------------------------------------------+ \| 6800b0496429431ab1c4efbb3fe810d4 \| LAB \| True \| \| \| default \| Default \| True \| Owns users and projects available on Identity API v2. \| +----------------------------------+---------+---------+----------------------------------------------------------------------+", "openstack user list --domain LAB", "openstack user list --domain Default", "cat overcloudrc-v3-user1 Clear any old environment that may conflict. for key in USD( set \| awk '{FS=\"=\"} /^OS_/ {print USD1}' ); do unset USDkey ; done export OS_USERNAME=user1 export NOVA_VERSION=1.1 export OS_PROJECT_NAME=demo export OS_PASSWORD=RedactedComplexPassword export OS_NO_CACHE=True export COMPUTE_API_VERSION=1.1 export no_proxy=,10.0.0.5,192.168.2.11 export OS_CLOUDNAME=overcloud export OS_AUTH_URL=https://10.0.0.5:5000/v3 export OS_AUTH_TYPE=password export PYTHONWARNINGS=\"ignore:Certificate has no, ignore:A true SSLContext object is not available\" export OS_IDENTITY_API_VERSION=3 export OS_PROJECT_DOMAIN_NAME=Default export OS_USER_DOMAIN_NAME=LAB", "ldapsearch -D \"cn=directory manager\" -H ldaps://idm.lab.local:636 -b \"dc=lab,dc=local\" -s sub \"(objectclass=*)\" -w RedactedComplexPassword", "nc -v idm.lab.local 636 Ncat: Version 6.40 ( http://nmap.org/ncat ) Ncat: Connected to 192.168.200.10:636. ^C" ]	https://docs.redhat.com/en/documentation/red_hat_openstack_platform/16.2/html/integrate_openstack_identity_with_external_user_management_services/assembly-integrating-identity-with-idm_rhosp
Chapter 3. Differences between OpenShift Container Platform 3 and 4	Chapter 3. Differences between OpenShift Container Platform 3 and 4 OpenShift Container Platform 4.16 introduces architectural changes and enhancements/ The procedures that you used to manage your OpenShift Container Platform 3 cluster might not apply to OpenShift Container Platform 4. For information on configuring your OpenShift Container Platform 4 cluster, review the appropriate sections of the OpenShift Container Platform documentation. For information on new features and other notable technical changes, review the OpenShift Container Platform 4.16 release notes . It is not possible to upgrade your existing OpenShift Container Platform 3 cluster to OpenShift Container Platform 4. You must start with a new OpenShift Container Platform 4 installation. Tools are available to assist in migrating your control plane settings and application workloads. 3.1. Architecture With OpenShift Container Platform 3, administrators individually deployed Red Hat Enterprise Linux (RHEL) hosts, and then installed OpenShift Container Platform on top of these hosts to form a cluster. Administrators were responsible for properly configuring these hosts and performing updates. OpenShift Container Platform 4 represents a significant change in the way that OpenShift Container Platform clusters are deployed and managed. OpenShift Container Platform 4 includes new technologies and functionality, such as Operators, machine sets, and Red Hat Enterprise Linux CoreOS (RHCOS), which are core to the operation of the cluster. This technology shift enables clusters to self-manage some functions previously performed by administrators. This also ensures platform stability and consistency, and simplifies installation and scaling. Beginning with OpenShift Container Platform 4.13, RHCOS now uses Red Hat Enterprise Linux (RHEL) 9.2 packages. This enhancement enables the latest fixes and features as well as the latest hardware support and driver updates. For more information about how this upgrade to RHEL 9.2 might affect your options configuration and services as well as driver and container support, see the RHCOS now uses RHEL 9.2 in the OpenShift Container Platform 4.13 release notes . For more information, see OpenShift Container Platform architecture . Immutable infrastructure OpenShift Container Platform 4 uses Red Hat Enterprise Linux CoreOS (RHCOS), which is designed to run containerized applications, and provides efficient installation, Operator-based management, and simplified upgrades. RHCOS is an immutable container host, rather than a customizable operating system like RHEL. RHCOS enables OpenShift Container Platform 4 to manage and automate the deployment of the underlying container host. RHCOS is a part of OpenShift Container Platform, which means that everything runs inside a container and is deployed using OpenShift Container Platform. In OpenShift Container Platform 4, control plane nodes must run RHCOS, ensuring that full-stack automation is maintained for the control plane. This makes rolling out updates and upgrades a much easier process than in OpenShift Container Platform 3. For more information, see Red Hat Enterprise Linux CoreOS (RHCOS) . Operators Operators are a method of packaging, deploying, and managing a Kubernetes application. Operators ease the operational complexity of running another piece of software. They watch over your environment and use the current state to make decisions in real time. Advanced Operators are designed to upgrade and react to failures automatically. For more information, see Understanding Operators . 3.2. Installation and upgrade Installation process To install OpenShift Container Platform 3.11, you prepared your Red Hat Enterprise Linux (RHEL) hosts, set all of the configuration values your cluster needed, and then ran an Ansible playbook to install and set up your cluster. In OpenShift Container Platform 4.16, you use the OpenShift installation program to create a minimum set of resources required for a cluster. After the cluster is running, you use Operators to further configure your cluster and to install new services. After first boot, Red Hat Enterprise Linux CoreOS (RHCOS) systems are managed by the Machine Config Operator (MCO) that runs in the OpenShift Container Platform cluster. For more information, see Installation process . If you want to add Red Hat Enterprise Linux (RHEL) worker machines to your OpenShift Container Platform 4.16 cluster, you use an Ansible playbook to join the RHEL worker machines after the cluster is running. For more information, see Adding RHEL compute machines to an OpenShift Container Platform cluster . Infrastructure options In OpenShift Container Platform 3.11, you installed your cluster on infrastructure that you prepared and maintained. In addition to providing your own infrastructure, OpenShift Container Platform 4 offers an option to deploy a cluster on infrastructure that the OpenShift Container Platform installation program provisions and the cluster maintains. For more information, see OpenShift Container Platform installation overview . Upgrading your cluster In OpenShift Container Platform 3.11, you upgraded your cluster by running Ansible playbooks. In OpenShift Container Platform 4.16, the cluster manages its own updates, including updates to Red Hat Enterprise Linux CoreOS (RHCOS) on cluster nodes. You can easily upgrade your cluster by using the web console or by using the oc adm upgrade command from the OpenShift CLI and the Operators will automatically upgrade themselves. If your OpenShift Container Platform 4.16 cluster has RHEL worker machines, then you will still need to run an Ansible playbook to upgrade those worker machines. For more information, see Updating clusters . 3.3. Migration considerations Review the changes and other considerations that might affect your transition from OpenShift Container Platform 3.11 to OpenShift Container Platform 4. 3.3.1. Storage considerations Review the following storage changes to consider when transitioning from OpenShift Container Platform 3.11 to OpenShift Container Platform 4.16. Local volume persistent storage Local storage is only supported by using the Local Storage Operator in OpenShift Container Platform 4.16. It is not supported to use the local provisioner method from OpenShift Container Platform 3.11. For more information, see Persistent storage using local volumes . FlexVolume persistent storage The FlexVolume plugin location changed from OpenShift Container Platform 3.11. The new location in OpenShift Container Platform 4.16 is /etc/kubernetes/kubelet-plugins/volume/exec . Attachable FlexVolume plugins are no longer supported. For more information, see Persistent storage using FlexVolume . Container Storage Interface (CSI) persistent storage Persistent storage using the Container Storage Interface (CSI) was Technology Preview in OpenShift Container Platform 3.11. OpenShift Container Platform 4.16 ships with several CSI drivers . You can also install your own driver. For more information, see Persistent storage using the Container Storage Interface (CSI) . Red Hat OpenShift Data Foundation OpenShift Container Storage 3, which is available for use with OpenShift Container Platform 3.11, uses Red Hat Gluster Storage as the backing storage. Red Hat OpenShift Data Foundation 4, which is available for use with OpenShift Container Platform 4, uses Red Hat Ceph Storage as the backing storage. For more information, see Persistent storage using Red Hat OpenShift Data Foundation and the interoperability matrix article. Unsupported persistent storage options Support for the following persistent storage options from OpenShift Container Platform 3.11 has changed in OpenShift Container Platform 4.16: GlusterFS is no longer supported. CephFS as a standalone product is no longer supported. Ceph RBD as a standalone product is no longer supported. If you used one of these in OpenShift Container Platform 3.11, you must choose a different persistent storage option for full support in OpenShift Container Platform 4.16. For more information, see Understanding persistent storage . Migration of in-tree volumes to CSI drivers OpenShift Container Platform 4 is migrating in-tree volume plugins to their Container Storage Interface (CSI) counterparts. In OpenShift Container Platform 4.16, CSI drivers are the new default for the following in-tree volume types: Amazon Web Services (AWS) Elastic Block Storage (EBS) Azure Disk Azure File Google Cloud Platform Persistent Disk (GCP PD) OpenStack Cinder VMware vSphere Note As of OpenShift Container Platform 4.13, VMware vSphere is not available by default. However, you can opt into VMware vSphere. All aspects of volume lifecycle, such as creation, deletion, mounting, and unmounting, is handled by the CSI driver. For more information, see CSI automatic migration . 3.3.2. Networking considerations Review the following networking changes to consider when transitioning from OpenShift Container Platform 3.11 to OpenShift Container Platform 4.16. Network isolation mode The default network isolation mode for OpenShift Container Platform 3.11 was ovs-subnet , though users frequently switched to use ovn-multitenant . The default network isolation mode for OpenShift Container Platform 4.16 is controlled by a network policy. If your OpenShift Container Platform 3.11 cluster used the ovs-subnet or ovs-multitenant mode, it is recommended to switch to a network policy for your OpenShift Container Platform 4.16 cluster. Network policies are supported upstream, are more flexible, and they provide the functionality that ovs-multitenant does. If you want to maintain the ovs-multitenant behavior while using a network policy in OpenShift Container Platform 4.16, follow the steps to configure multitenant isolation using network policy . For more information, see About network policy . OVN-Kubernetes as the default networking plugin in Red Hat OpenShift Networking In OpenShift Container Platform 3.11, OpenShift SDN was the default networking plugin in Red Hat OpenShift Networking. In OpenShift Container Platform 4.16, OVN-Kubernetes is now the default networking plugin. For information on migrating to OVN-Kubernetes from OpenShift SDN, see Migrating from the OpenShift SDN network plugin . Warning It is not possible to upgrade a cluster to OpenShift Container Platform 4.17 if it is using the OpenShift SDN network plugin. You must migrate to the OVN-Kubernetes plugin before upgrading to OpenShift Container Platform 4.17. 3.3.3. Logging considerations Review the following logging changes to consider when transitioning from OpenShift Container Platform 3.11 to OpenShift Container Platform 4.16. Deploying OpenShift Logging OpenShift Container Platform 4 provides a simple deployment mechanism for OpenShift Logging, by using a Cluster Logging custom resource. For more information, see Installing OpenShift Logging . Aggregated logging data You cannot transition your aggregate logging data from OpenShift Container Platform 3.11 into your new OpenShift Container Platform 4 cluster. For more information, see About OpenShift Logging . Unsupported logging configurations Some logging configurations that were available in OpenShift Container Platform 3.11 are no longer supported in OpenShift Container Platform 4.16. For more information on the explicitly unsupported logging cases, see the logging support documentation . 3.3.4. Security considerations Review the following security changes to consider when transitioning from OpenShift Container Platform 3.11 to OpenShift Container Platform 4.16. Unauthenticated access to discovery endpoints In OpenShift Container Platform 3.11, an unauthenticated user could access the discovery endpoints (for example, /api/* and /apis/* ). For security reasons, unauthenticated access to the discovery endpoints is no longer allowed in OpenShift Container Platform 4.16. If you do need to allow unauthenticated access, you can configure the RBAC settings as necessary; however, be sure to consider the security implications as this can expose internal cluster components to the external network. Identity providers Configuration for identity providers has changed for OpenShift Container Platform 4, including the following notable changes: The request header identity provider in OpenShift Container Platform 4.16 requires mutual TLS, where in OpenShift Container Platform 3.11 it did not. The configuration of the OpenID Connect identity provider was simplified in OpenShift Container Platform 4.16. It now obtains data, which previously had to specified in OpenShift Container Platform 3.11, from the provider's /.well-known/openid-configuration endpoint. For more information, see Understanding identity provider configuration . OAuth token storage format Newly created OAuth HTTP bearer tokens no longer match the names of their OAuth access token objects. The object names are now a hash of the bearer token and are no longer sensitive. This reduces the risk of leaking sensitive information. Default security context constraints The restricted security context constraints (SCC) in OpenShift Container Platform 4 can no longer be accessed by any authenticated user as the restricted SCC in OpenShift Container Platform 3.11. The broad authenticated access is now granted to the restricted-v2 SCC, which is more restrictive than the old restricted SCC. The restricted SCC still exists; users that want to use it must be specifically given permissions to do it. For more information, see Managing security context constraints . 3.3.5. Monitoring considerations Review the following monitoring changes when transitioning from OpenShift Container Platform 3.11 to OpenShift Container Platform 4.16. You cannot migrate Hawkular configurations and metrics to Prometheus. Alert for monitoring infrastructure availability The default alert that triggers to ensure the availability of the monitoring structure was called DeadMansSwitch in OpenShift Container Platform 3.11. This was renamed to Watchdog in OpenShift Container Platform 4. If you had PagerDuty integration set up with this alert in OpenShift Container Platform 3.11, you must set up the PagerDuty integration for the Watchdog alert in OpenShift Container Platform 4. For more information, see Configuring alert routing for default platform alerts .	null	https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/migrating_from_version_3_to_4/planning-migration-3-4
3.7. Uninstalling a Client	3.7. Uninstalling a Client Uninstalling a client removes the client from the IdM domain, along with all of the IdM-specific configuration for system services, such as SSSD. This restores the client machine's configuration. Run the ipa-client-install --uninstall command: Remove the DNS entries for the client host manually from the server. See Section 33.4.6, "Deleting Records from DNS Zones" .	[ "ipa-client-install --uninstall" ]	https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/linux_domain_identity_authentication_and_policy_guide/client-uninstall
probe::tty.unregister	probe::tty.unregister Name probe::tty.unregister - Called when a tty device is being unregistered Synopsis Values driver_name the driver name name the driver .dev_name name index the tty index requested module the module name	[ "tty.unregister" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/systemtap_tapset_reference/api-tty-unregister
Chapter 1. Introducing WSDL Contracts	Chapter 1. Introducing WSDL Contracts Abstract WSDL documents define services using Web Service Description Language and a number of possible extensions. The documents have a logical part and a concrete part. The abstract part of the contract defines the service in terms of implementation neutral data types and messages. The concrete part of the document defines how an endpoint implementing a service will interact with the outside world. The recommended approach to design services is to define your services in WSDL and XML Schema before writing any code. When hand-editing WSDL documents you must make sure that the document is valid, as well as correct. To do this you must have some familiarity with WSDL. You can find the standard on the W3C web site, www.w3.org . 1.1. Structure of a WSDL document Overview A WSDL document is, at its simplest, a collection of elements contained within a root definition element. These elements describe a service and how an endpoint implementing that service is accessed. A WSDL document has two distinct parts: A logical part that defines the service in implementation neutral terms A concrete part that defines how an endpoint implementing the service is exposed on a network The logical part The logical part of a WSDL document contains the types , the message , and the portType elements. It describes the service's interface and the messages exchanged by the service. Within the types element, XML Schema is used to define the structure of the data that makes up the messages. A number of message elements are used to define the structure of the messages used by the service. The portType element contains one or more operation elements that define the messages sent by the operations exposed by the service. The concrete part The concrete part of a WSDL document contains the binding and the service elements. It describes how an endpoint that implements the service connects to the outside world. The binding elements describe how the data units described by the message elements are mapped into a concrete, on-the-wire data format, such as SOAP. The service elements contain one or more port elements which define the endpoints implementing the service. 1.2. WSDL elements A WSDL document is made up of the following elements: definitions - The root element of a WSDL document. The attributes of this element specify the name of the WSDL document, the document's target namespace, and the shorthand definitions for the namespaces referenced in the WSDL document. types - The XML Schema definitions for the data units that form the building blocks of the messages used by a service. For information about defining data types see Chapter 2, Defining Logical Data Units . message - The description of the messages exchanged during invocation of a services operations. These elements define the arguments of the operations making up your service. For information on defining messages see Chapter 3, Defining Logical Messages Used by a Service . portType - A collection of operation elements describing the logical interface of a service. For information about defining port types see Chapter 4, Defining Your Logical Interfaces . operation - The description of an action performed by a service. Operations are defined by the messages passed between two endpoints when the operation is invoked. For information on defining operations see the section called "Operations" . binding - The concrete data format specification for an endpoint. A binding element defines how the abstract messages are mapped into the concrete data format used by an endpoint. This element is where specifics such as parameter order and return values are specified. service - A collection of related port elements. These elements are repositories for organizing endpoint definitions. port - The endpoint defined by a binding and a physical address. These elements bring all of the abstract definitions together, combined with the definition of transport details, and they define the physical endpoint on which a service is exposed. 1.3. Designing a contract To design a WSDL contract for your services you must perform the following steps: Define the data types used by your services. Define the messages used by your services. Define the interfaces for your services. Define the bindings between the messages used by each interface and the concrete representation of the data on the wire. Define the transport details for each of the services.	null	https://docs.redhat.com/en/documentation/red_hat_fuse/7.13/html/apache_cxf_development_guide/wsdlintro
Chapter 4. Upgrading Camel K	Chapter 4. Upgrading Camel K You can upgrade installed Camel K operator automatically, but it does not automatically upgrade the Camel K integrations. You must manually trigger the upgrade for the Camel K integrations. This chapter explains how to upgrade both Camel K operator and Camel K integrations. 4.1. Upgrading Camel K operator The subscription of an installed Camel K operator specifies an update channel, for example, 1.10.x channel, which is used to track and receive updates for the operator. To upgrade the operator to start tracking and receiving updates from a newer channel, you can change the update channel in the subscription. See Upgrading installed operators for more information about changing the update channel for installed operator. Note Installed Operators cannot change to a channel that is older than the current channel. If the approval strategy in the subscription is set to Automatic, the upgrade process initiates as soon as a new Operator version is available in the selected channel. If the approval strategy is set to Manual, you must manually approve pending upgrades. Prerequisites Camel K operator is installed using Operator Lifecycle Manager (OLM). Procedure In the Administrator perspective of the OpenShift Container Platform web console, navigate to Operators Installed Operators . Click the Camel K Operator . Click the Subscription tab. Click the name of the update channel under Channel . Click the newer update channel that you want to change to. For example, latest . Click Save . This will start the upgrade to the latest Camel K version. For subscriptions with an Automatic approval strategy, the upgrade begins automatically. Navigate back to the Operators Installed Operators page to monitor the progress of the upgrade. When complete, the status changes to Succeeded and Up to date. For subscriptions with a Manual approval strategy, you can manually approve the upgrade from the Subscription tab. 4.2. Upgrading Camel K integrations When you trigger the upgrade for Camel K operator, the operator prepares the integrations to be upgraded, but does not trigger an upgrade for each one, to avoid service interruptions. When upgrading the operator, integration custom resources are not automatically upgraded to the newer version, so for example, the operator may be at version 1.10.3 , while integrations report the status.version field of the custom resource the version 1.8.2 . Prerequisites Camel K operator is installed and upgraded using Operator Lifecycle Manager (OLM). Procedure Open the terminal and run the following command to upgrade the Camel K intergations. This will clear the status of the integration resource and the operator will start the deployment of the integration using the artifacts from upgraded version, for example, version 1.10.3 . 4.3. Downgrading Camel K You can downgrade to older version of Camel K operator by installing a version of the operator. This needs to be triggered manually using OC CLI. For more infromation about installing specific version of the operator using CLI see Installing a specific version of an Operator . Important You must remove the existing Camel K operator and then install the specifc version of the operator as downgrading is not supported in OLM. Once you install the older version of operator, use the kamel rebuild command to downgrade the integrations to the operator version. For example,	[ "kamel rebuild myintegration", "kamel rebuild myintegration" ]	https://docs.redhat.com/en/documentation/red_hat_build_of_apache_camel_k/1.10.9/html/getting_started_with_camel_k/upgrading-camel-k
6.6. Diagnosing and Correcting Problems in a Cluster	6.6. Diagnosing and Correcting Problems in a Cluster For information about diagnosing and correcting problems in a cluster, contact an authorized Red Hat support representative.	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/4/html/cluster_administration/s1-admin-problems-ca
Chapter 9. Creating the control plane for NFV environments	Chapter 9. Creating the control plane for NFV environments The Red Hat OpenStack Services on OpenShift (RHOSO) control plane contains the RHOSO services that manage the cloud. These control plane services are services that provide APIs and do not run Compute node workloads. The RHOSO control plane services run as a Red Hat OpenShift Container Platform (RHOCP) workload, and you deploy these services using Operators in OpenShift. When you configure these OpenStack control plane services, you use one custom resource (CR) definition called OpenStackControlPlane . Note Creating the control plane also creates an OpenStackClient pod that you can access through a remote shell ( rsh ) to run RHOSO CLI commands. 9.1. Prerequisites The RHOCP cluster is prepared for RHOSO network isolation. For more information, see Preparing RHOCP for RHOSO networks . The OpenStack Operator ( openstack-operator ) is installed. For more information, see Installing and preparing the Operators . The RHOCP cluster is not configured with any network policies that prevent communication between the openstack-operators namespace and the control plane namespace (default openstack ). Use the following command to check the existing network policies on the cluster: You are logged on to a workstation that has access to the RHOCP cluster, as a user with cluster-admin privileges. 9.2. Creating the control plane Define an OpenStackControlPlane custom resource (CR) to perform the following tasks: Create the control plane. Enable the Red Hat OpenStack Services on OpenShift (RHOSO) services. The following procedure creates an initial control plane with the recommended configurations for each service. The procedure helps you create an operational control plane environment. You can use the environment to test and troubleshoot issues before additional required service customization. Services can be added and customized after the initial deployment. To configure a service, you use the CustomServiceConfig field in a service specification to pass OpenStack configuration parameters in INI file format. For more information about the available configuration parameters, see Configuration reference . For more information on how to customize your control plane after deployment, see the Customizing the Red Hat OpenStack Services on OpenShift deployment guide. For more information, see Example OpenStackControlPlane CR . Tip Use the following commands to view the OpenStackControlPlane CRD definition and specification schema: USD oc describe crd openstackcontrolplane USD oc explain openstackcontrolplane.spec For NFV environments, when you add the Networking service (neutron) and OVN service configurations, you must supply the following information: Physical networks where your gateways are located. Path to vhost sockets. VLAN ranges. Number of NUMA nodes. NICs that connect to the gateway networks. Note If you are using SR-IOV, you must also add the sriovnicswitch mechanism driver to the Networking service configuration. Procedure Create the openstack project for the deployed RHOSO environment: USD oc new-project openstack Ensure the openstack namespace is labeled to enable privileged pod creation by the OpenStack Operators: USD oc get namespace openstack -ojsonpath='{.metadata.labels}' \| jq { "kubernetes.io/metadata.name": "openstack", "pod-security.kubernetes.io/enforce": "privileged", "security.openshift.io/scc.podSecurityLabelSync": "false" } If the security context constraint (SCC) is not "privileged", use the following commands to change it: USD oc label ns openstack security.openshift.io/scc.podSecurityLabelSync=false --overwrite USD oc label ns openstack pod-security.kubernetes.io/enforce=privileged --overwrite Create a file on your workstation named openstack_control_plane.yaml to define the OpenStackControlPlane CR: apiVersion: core.openstack.org/v1beta1 kind: OpenStackControlPlane metadata: name: openstack-control-plane namespace: openstack Specify the Secret CR you created to provide secure access to the RHOSO service pods in Providing secure access to the Red Hat OpenStack Services on OpenShift services : apiVersion: core.openstack.org/v1beta1 kind: OpenStackControlPlane metadata: name: openstack-control-plane spec: secret: osp-secret Specify the storageClass you created for your Red Hat OpenShift Container Platform (RHOCP) cluster storage back end: apiVersion: core.openstack.org/v1beta1 kind: OpenStackControlPlane metadata: name: openstack-control-plane spec: secret: osp-secret storageClass: your-RHOCP-storage-class Note For information about storage classes, see Creating a storage class . Add the following service configurations: Block Storage service (cinder): cinder: apiOverride: route: {} template: databaseInstance: openstack secret: osp-secret cinderAPI: replicas: 3 override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer cinderScheduler: replicas: 1 cinderBackup: networkAttachments: - storage replicas: 0 # backend needs to be configured to activate the service cinderVolumes: volume1: networkAttachments: - storage replicas: 0 # backend needs to be configured to activate the service Important This definition for the Block Storage service is only a sample. You might need to modify it for your NFV environment. For more information, see Planning storage and shared file systems in Planning your deployment . Note For the initial control plane deployment, the cinderBackup and cinderVolumes services are deployed but not activated (replicas: 0). You can configure your control plane post-deployment with a back end for the Block Storage service and the backup service. Compute service (nova): nova: apiOverride: route: {} template: apiServiceTemplate: replicas: 3 override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer schedulerServiceTemplate: customServiceConfig: \| [filter_scheduler] enabled_filters = AvailabilityZoneFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ServerGroupAntiAffinityFilter, ServerGroupAffinityFilter, PciPassthroughFilter, AggregateInstanceExtraSpecsFilter available_filters = nova.scheduler.filters.all_filters metadataServiceTemplate: replicas: 3 override: service: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer schedulerServiceTemplate: replicas: 3 override: service: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer cellTemplates: cell1: noVNCProxyServiceTemplate: enabled: true networkAttachments: - ctlplane secret: osp-secret Note A full set of Compute services (nova) are deployed by default for each of the default cells, cell0 and cell1 : nova-api , nova-metadata , nova-scheduler , and nova-conductor . The novncproxy service is also enabled for cell1 by default. DNS service for the data plane: dns: template: options: 1 - key: server 2 values: 3 - 192.168.122.1 - key: server values: - 192.168.122.2 override: service: metadata: annotations: metallb.universe.tf/address-pool: ctlplane metallb.universe.tf/allow-shared-ip: ctlplane metallb.universe.tf/loadBalancerIPs: 192.168.122.80 spec: type: LoadBalancer replicas: 2 1 Defines the dnsmasq instances required for each DNS server by using key-value pairs. In this example, there are two key-value pairs defined because there are two DNS servers configured to forward requests to. 2 Specifies the dnsmasq parameter to customize for the deployed dnsmasq instance. Set to one of the following valid values: server rev-server srv-host txt-record ptr-record rebind-domain-ok naptr-record cname host-record caa-record dns-rr auth-zone synth-domain no-negcache local 3 Specifies the values for the dnsmasq parameter. You can specify a generic DNS server as the value, for example, 1.1.1.1 , or a DNS server for a specific domain, for example, /google.com/8.8.8.8 . A Galera cluster for use by all RHOSO services ( openstack ), and a Galera cluster for use by the Compute service for cell1 ( openstack-cell1 ): galera: templates: openstack: storageRequest: 5000M secret: osp-secret replicas: 3 openstack-cell1: storageRequest: 5000M secret: osp-secret replicas: 3 Identity service (keystone) keystone: apiOverride: route: {} template: override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer databaseInstance: openstack secret: osp-secret replicas: 3 Image service (glance): glance: apiOverrides: default: route: {} template: databaseInstance: openstack storage: storageRequest: 10G secret: osp-secret keystoneEndpoint: default glanceAPIs: default: replicas: 0 # backend needs to be configured to activate the service override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer networkAttachments: - storage Note For the initial control plane deployment, the Image service is deployed but not activated (replicas: 0). You can configure your control plane post-deployment with a back end for the Image service. Key Management service (barbican): barbican: apiOverride: route: {} template: databaseInstance: openstack secret: osp-secret barbicanAPI: replicas: 3 override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer barbicanWorker: replicas: 3 barbicanKeystoneListener: replicas: 1 Memcached: memcached: templates: memcached: replicas: 3 Networking service (neutron): If you are using SR-IOV, you must also add the sriovnicswitch mechanism driver, for example, mechanism_drivers = ovn,sriovnicswitch . Replace <path> with the absolute path to the vhost sockets, for example, /var/lib/vhost . Replace <network_name1> and <network_name2> with the names of the physical networks that your gateways are on. (This network is set in the neutron network provider:name field.) Replace <VLAN-ID1> and`<VLAN-ID2>` with the VLAN IDs you are using. Object Storage service (swift): swift: enabled: true proxyOverride: route: {} template: swiftProxy: networkAttachments: - storage override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer replicas: 1 swiftRing: ringReplicas: 1 swiftStorage: networkAttachments: - storage replicas: 1 storageClass: local-storage storageRequest: 10Gi OVN: Replace <network_name> with the name of the physical network your gateway is on. (This network is set in the neutron network provider:name field.) Replace <nic_name> with the name of the NIC connecting to the gateway network. Optional: Add additional <network_name>:<nic_name> pairs under nicMappings as required. Placement service (placement): placement: apiOverride: route: {} template: override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer databaseInstance: openstack replicas: 3 secret: osp-secret RabbitMQ: rabbitmq: templates: rabbitmq: replicas: 3 override: service: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.85 spec: type: LoadBalancer rabbitmq-cell1: replicas: 3 override: service: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.86 spec: type: LoadBalancer Telemetry service (ceilometer, prometheus): telemetry: enabled: true template: metricStorage: enabled: true monitoringStack: alertingEnabled: true scrapeInterval: 30s storage: strategy: persistent retention: 24h persistent: pvcStorageRequest: 20G autoscaling: 1 enabled: false aodh: passwordSelectors: databaseAccount: aodh databaseInstance: openstack memcachedInstance: memcached secret: osp-secret heatInstance: heat ceilometer: enabled: true secret: osp-secret logging: enabled: false ipaddr: 172.17.0.80 1 You must have the autoscaling field present, even if autoscaling is disabled. Create the control plane: USD oc create -f openstack_control_plane.yaml -n openstack Note Creating the control plane also creates an OpenStackClient pod that you can access through a remote shell ( rsh ) to run RHOSO CLI commands. USD oc rsh -n openstack openstackclient Wait until RHOCP creates the resources related to the OpenStackControlPlane CR. Check the status of the control plane deployment: USD oc get openstackcontrolplane -n openstack Sample output NAME STATUS MESSAGE openstack-control-plane Unknown Setup started The OpenStackControlPlane resources are created when the status is "Setup complete". Tip Append the -w option to the end of the get command to track deployment progress. Note Creating the control plane also creates an OpenStackClient pod that you can access through a remote shell ( rsh ) to run RHOSO CLI commands. USD oc rsh -n openstack openstackclient Optional: Confirm that the control plane is deployed by reviewing the pods in the openstack namespace: USD oc get pods -n openstack The control plane is deployed when all the pods are either completed or running. Verification Open a remote shell connection to the OpenStackClient pod: USD oc rsh -n openstack openstackclient Confirm that the internal service endpoints are registered with each service: USD openstack endpoint list -c 'Service Name' -c Interface -c URL --service glance Sample output +--------------+-----------+---------------------------------------------------------------+ \| Service Name \| Interface \| URL \| +--------------+-----------+---------------------------------------------------------------+ \| glance \| internal \| http://glance-internal.openstack.svc:9292 \| \| glance \| public \| http://glance-public-openstack.apps.ostest.test.metalkube.org \| +--------------+-----------+---------------------------------------------------------------+ Exit the OpenStackClient pod: USD exit 9.3. Example OpenStackControlPlane CR The following example OpenStackControlPlane CR is a complete control plane configuration that includes all the key services that must always be enabled for a successful deployment. 1 The storage class that you created for your Red Hat OpenShift Container Platform (RHOCP) cluster storage back end. 2 Service-specific parameters for the Block Storage service (cinder). 3 The Block Storage service back end. For more information on configuring storage services, see the Configuring persistent storage guide. 4 The Block Storage service configuration. For more information on configuring storage services, see the Configuring persistent storage guide. 5 The list of networks that each service pod is directly attached to, specified by using the NetworkAttachmentDefinition resource names. A NIC is configured for the service for each specified network attachment. Note If you do not configure the isolated networks that each service pod is attached to, then the default pod network is used. For example, the Block Storage service uses the storage network to connect to a storage back end; the Identity service (keystone) uses an LDAP or Active Directory (AD) network; the ovnDBCluster service uses the internalapi network; and the ovnController service uses the tenant network. 6 Service-specific parameters for the Compute service (nova). 7 Service API route definition. You can customize the service route by using route-specific annotations. For more information, see Route-specific annotations in the RHOCP Networking guide. Set route: to {} to apply the default route template. 8 The internal service API endpoint registered as a MetalLB service with the IPAddressPool internalapi . 9 The virtual IP (VIP) address for the service. The IP is shared with other services by default. 10 The RabbitMQ instances exposed to an isolated network with distinct IP addresses defined in the loadBalancerIPs annotation, as indicated in 11 and 12 . Note Multiple RabbitMQ instances cannot share the same VIP as they use the same port. If you need to expose multiple RabbitMQ instances to the same network, then you must use distinct IP addresses. 11 The distinct IP address for a RabbitMQ instance that is exposed to an isolated network. 12 The distinct IP address for a RabbitMQ instance that is exposed to an isolated network. 9.4. Removing a service from the control plane You can completely remove a service and the service database from the control plane after deployment by disabling the service. Many services are enabled by default, which means that the OpenStack Operator creates resources such as the service database and Identity service (keystone) users, even if no service pod is created because replicas is set to 0 . Warning Remove a service with caution. Removing a service is not the same as stopping service pods. Removing a service is irreversible. Disabling a service removes the service database and any resources that referenced the service are no longer tracked. Create a backup of the service database before removing a service. Procedure Open the OpenStackControlPlane CR file on your workstation. Locate the service you want to remove from the control plane and disable it: Update the control plane: Wait until RHOCP removes the resource related to the disabled service. Run the following command to check the status: The OpenStackControlPlane resource is updated with the disabled service when the status is "Setup complete". Tip Append the -w option to the end of the get command to track deployment progress. Optional: Confirm that the pods from the disabled service are no longer listed by reviewing the pods in the openstack namespace: Check that the service is removed: This command returns the following message when the service is successfully removed: Check that the API endpoints for the service are removed from the Identity service (keystone): This command returns the following message when the API endpoints for the service are successfully removed: 9.5. Additional resources Kubernetes NMState Operator The Kubernetes NMState project Load balancing with MetalLB MetalLB documentation MetalLB in layer 2 mode Specify network interfaces that LB IP can be announced from Multiple networks Using the Multus CNI in OpenShift macvlan plugin whereabouts IPAM CNI plugin - Extended configuration About advertising for the IP address pools Dynamic provisioning Configuring the Block Storage backup service in Configuring persistent storage . Configuring the Image service (glance) in Configuring persistent storage .	[ "oc rsh -n openstack openstackclient", "oc get networkpolicy -n openstack", "oc describe crd openstackcontrolplane oc explain openstackcontrolplane.spec", "oc new-project openstack", "oc get namespace openstack -ojsonpath='{.metadata.labels}' \| jq { \"kubernetes.io/metadata.name\": \"openstack\", \"pod-security.kubernetes.io/enforce\": \"privileged\", \"security.openshift.io/scc.podSecurityLabelSync\": \"false\" }", "oc label ns openstack security.openshift.io/scc.podSecurityLabelSync=false --overwrite oc label ns openstack pod-security.kubernetes.io/enforce=privileged --overwrite", "apiVersion: core.openstack.org/v1beta1 kind: OpenStackControlPlane metadata: name: openstack-control-plane namespace: openstack", "apiVersion: core.openstack.org/v1beta1 kind: OpenStackControlPlane metadata: name: openstack-control-plane spec: secret: osp-secret", "apiVersion: core.openstack.org/v1beta1 kind: OpenStackControlPlane metadata: name: openstack-control-plane spec: secret: osp-secret storageClass: your-RHOCP-storage-class", "cinder: apiOverride: route: {} template: databaseInstance: openstack secret: osp-secret cinderAPI: replicas: 3 override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer cinderScheduler: replicas: 1 cinderBackup: networkAttachments: - storage replicas: 0 # backend needs to be configured to activate the service cinderVolumes: volume1: networkAttachments: - storage replicas: 0 # backend needs to be configured to activate the service", "nova: apiOverride: route: {} template: apiServiceTemplate: replicas: 3 override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer schedulerServiceTemplate: customServiceConfig: \| [filter_scheduler] enabled_filters = AvailabilityZoneFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ServerGroupAntiAffinityFilter, ServerGroupAffinityFilter, PciPassthroughFilter, AggregateInstanceExtraSpecsFilter available_filters = nova.scheduler.filters.all_filters metadataServiceTemplate: replicas: 3 override: service: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer schedulerServiceTemplate: replicas: 3 override: service: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer cellTemplates: cell1: noVNCProxyServiceTemplate: enabled: true networkAttachments: - ctlplane secret: osp-secret", "dns: template: options: 1 - key: server 2 values: 3 - 192.168.122.1 - key: server values: - 192.168.122.2 override: service: metadata: annotations: metallb.universe.tf/address-pool: ctlplane metallb.universe.tf/allow-shared-ip: ctlplane metallb.universe.tf/loadBalancerIPs: 192.168.122.80 spec: type: LoadBalancer replicas: 2", "galera: templates: openstack: storageRequest: 5000M secret: osp-secret replicas: 3 openstack-cell1: storageRequest: 5000M secret: osp-secret replicas: 3", "keystone: apiOverride: route: {} template: override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer databaseInstance: openstack secret: osp-secret replicas: 3", "glance: apiOverrides: default: route: {} template: databaseInstance: openstack storage: storageRequest: 10G secret: osp-secret keystoneEndpoint: default glanceAPIs: default: replicas: 0 # backend needs to be configured to activate the service override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer networkAttachments: - storage", "barbican: apiOverride: route: {} template: databaseInstance: openstack secret: osp-secret barbicanAPI: replicas: 3 override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer barbicanWorker: replicas: 3 barbicanKeystoneListener: replicas: 1", "memcached: templates: memcached: replicas: 3", "neutron: apiOverride: route: {} template: replicas: 3 override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer databaseInstance: openstack secret: osp-secret networkAttachments: - internalapi customServiceConfig: \| [DEFAULT] global_physnet_mtu = 9000 [ml2] mechanism_drivers = ovn [ovn] vhost_sock_dir = <path> [ml2_type_vlan] network_vlan_ranges = <network_name1>:<VLAN-ID1>:<VLAN-ID2> , <network_name2>:<VLAN-ID1>:<VLAN-ID2>", "swift: enabled: true proxyOverride: route: {} template: swiftProxy: networkAttachments: - storage override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer replicas: 1 swiftRing: ringReplicas: 1 swiftStorage: networkAttachments: - storage replicas: 1 storageClass: local-storage storageRequest: 10Gi", "ovn: template: ovnDBCluster: ovndbcluster-nb: replicas: 3 dbType: NB storageRequest: 10G networkAttachment: internalapi ovndbcluster-sb: replicas: 3 dbType: SB storageRequest: 10G networkAttachment: internalapi ovnNorthd: {} ovnController: networkAttachment: tenant nicMappings: <network_name>: <nic_name>", "placement: apiOverride: route: {} template: override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer databaseInstance: openstack replicas: 3 secret: osp-secret", "rabbitmq: templates: rabbitmq: replicas: 3 override: service: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.85 spec: type: LoadBalancer rabbitmq-cell1: replicas: 3 override: service: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.86 spec: type: LoadBalancer", "telemetry: enabled: true template: metricStorage: enabled: true monitoringStack: alertingEnabled: true scrapeInterval: 30s storage: strategy: persistent retention: 24h persistent: pvcStorageRequest: 20G autoscaling: 1 enabled: false aodh: passwordSelectors: databaseAccount: aodh databaseInstance: openstack memcachedInstance: memcached secret: osp-secret heatInstance: heat ceilometer: enabled: true secret: osp-secret logging: enabled: false ipaddr: 172.17.0.80", "oc create -f openstack_control_plane.yaml -n openstack", "oc rsh -n openstack openstackclient", "oc get openstackcontrolplane -n openstack", "NAME STATUS MESSAGE openstack-control-plane Unknown Setup started", "oc rsh -n openstack openstackclient", "oc get pods -n openstack", "oc rsh -n openstack openstackclient", "openstack endpoint list -c 'Service Name' -c Interface -c URL --service glance", "+--------------+-----------+---------------------------------------------------------------+ \| Service Name \| Interface \| URL \| +--------------+-----------+---------------------------------------------------------------+ \| glance \| internal \| http://glance-internal.openstack.svc:9292 \| \| glance \| public \| http://glance-public-openstack.apps.ostest.test.metalkube.org \| +--------------+-----------+---------------------------------------------------------------+", "exit", "apiVersion: core.openstack.org/v1beta1 kind: OpenStackControlPlane metadata: name: openstack-control-plane namespace: openstack spec: secret: osp-secret storageClass: your-RHOCP-storage-class 1 cinder: 2 apiOverride: route: {} template: databaseInstance: openstack secret: osp-secret cinderAPI: replicas: 3 override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer cinderScheduler: replicas: 1 cinderBackup: 3 networkAttachments: - storage replicas: 0 # backend needs to be configured to activate the service cinderVolumes: 4 volume1: networkAttachments: 5 - storage replicas: 0 # backend needs to be configured to activate the service nova: 6 apiOverride: 7 route: {} template: apiServiceTemplate: replicas: 3 override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi 8 metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 9 spec: type: LoadBalancer metadataServiceTemplate: replicas: 3 override: service: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer schedulerServiceTemplate: replicas: 3 cellTemplates: cell0: cellDatabaseAccount: nova-cell0 cellDatabaseInstance: openstack cellMessageBusInstance: rabbitmq hasAPIAccess: true cell1: cellDatabaseAccount: nova-cell1 cellDatabaseInstance: openstack-cell1 cellMessageBusInstance: rabbitmq-cell1 noVNCProxyServiceTemplate: enabled: true networkAttachments: - ctlplane hasAPIAccess: true secret: osp-secret dns: template: options: - key: server values: - 192.168.122.1 - key: server values: - 192.168.122.2 override: service: metadata: annotations: metallb.universe.tf/address-pool: ctlplane metallb.universe.tf/allow-shared-ip: ctlplane metallb.universe.tf/loadBalancerIPs: 192.168.122.80 spec: type: LoadBalancer replicas: 2 galera: templates: openstack: storageRequest: 5000M secret: osp-secret replicas: 3 openstack-cell1: storageRequest: 5000M secret: osp-secret replicas: 3 keystone: apiOverride: route: {} template: override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer databaseInstance: openstack secret: osp-secret replicas: 3 glance: apiOverrides: default: route: {} template: databaseInstance: openstack storage: storageRequest: 10G secret: osp-secret keystoneEndpoint: default glanceAPIs: default: replicas: 0 # Configure back end; set to 3 when deploying service override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer networkAttachments: - storage barbican: apiOverride: route: {} template: databaseInstance: openstack secret: osp-secret barbicanAPI: replicas: 3 override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer barbicanWorker: replicas: 3 barbicanKeystoneListener: replicas: 1 memcached: templates: memcached: replicas: 3 neutron: apiOverride: route: {} template: replicas: 3 override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer databaseInstance: openstack secret: osp-secret networkAttachments: - internalapi swift: enabled: true proxyOverride: route: {} template: swiftProxy: networkAttachments: - storage override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer replicas: 1 swiftRing: ringReplicas: 1 swiftStorage: networkAttachments: - storage replicas: 1 storageRequest: 10Gi ovn: template: ovnDBCluster: ovndbcluster-nb: replicas: 3 dbType: NB storageRequest: 10G networkAttachment: internalapi ovndbcluster-sb: replicas: 3 dbType: SB storageRequest: 10G networkAttachment: internalapi ovnNorthd: {} placement: apiOverride: route: {} template: override: service: internal: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/allow-shared-ip: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.80 spec: type: LoadBalancer databaseInstance: openstack replicas: 3 secret: osp-secret rabbitmq: 10 templates: rabbitmq: replicas: 3 override: service: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.85 11 spec: type: LoadBalancer rabbitmq-cell1: replicas: 3 override: service: metadata: annotations: metallb.universe.tf/address-pool: internalapi metallb.universe.tf/loadBalancerIPs: 172.17.0.86 12 spec: type: LoadBalancer telemetry: enabled: true template: metricStorage: enabled: true dashboardsEnabled: true monitoringStack: alertingEnabled: true scrapeInterval: 30s storage: strategy: persistent retention: 24h persistent: pvcStorageRequest: 20G autoscaling: enabled: false aodh: databaseAccount: aodh databaseInstance: openstack passwordSelector: aodhService: AodhPassword rabbitMqClusterName: rabbitmq serviceUser: aodh secret: osp-secret heatInstance: heat ceilometer: enabled: true secret: osp-secret logging: enabled: false ipaddr: 172.17.0.80", "cinder: enabled: false apiOverride: route: {}", "oc apply -f openstack_control_plane.yaml -n openstack", "oc get openstackcontrolplane -n openstack NAME STATUS MESSAGE openstack-control-plane Unknown Setup started", "oc get pods -n openstack", "oc get cinder -n openstack", "No resources found in openstack namespace.", "oc rsh -n openstack openstackclient openstack endpoint list --service volumev3", "No service with a type, name or ID of 'volumev3' exists." ]	https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html/deploying_a_network_functions_virtualization_environment/create-ctrl-plane-nfv
2.6. Displaying the Full Cluster Configuration	2.6. Displaying the Full Cluster Configuration Use the following command to display the full current cluster configuration.	[ "pcs config" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/configuring_the_red_hat_high_availability_add-on_with_pacemaker/s1-pcsfullconfig-haar
Chapter 1. Web console	Chapter 1. Web console Learn how to access and use components of the Red Hat Advanced Cluster Management for Kubernetes console from the following documentation: Console overview Search in the console Accessing your console Enabling virtual machine actions (Technology Preview) 1.1. Console overview Learn more about console components that you can use to view, manage, or customize your console. See the following image of the Navigation from the Red Hat Advanced Cluster Management for Kubernetes console, which is described in more detail later in each section. See that the navigation represents major production function. 1.1.1. Console components Home Infrastructure Applications Governance Credentials 1.1.2. Home From the Red Hat Advanced Cluster Management for Kubernetes Home page in the All clusters view, you can access more information and you can search across the product. Click Welcome for more introductory information about each product function. 1.1.2.1. Overview Click Overview to see summary information, or to access clickable Cluster percentage values for policy violations, and more. From the Overview page, you can view the following information: Cluster and node counts across all clusters and for each provider Cluster status Cluster compliance Pod status Cluster add-ons You can also access all APIs from the integrated console. From the local-cluster view, go to Home > API Explorer to explore API groups. You can also use the Fleet view switch from the Overview page header to filter the page data by using cluster labels, and display metrics. The following information is displayed from the Fleet view switch: Number of clusters Application types Number of enabled policies on your cluster Cluster version Total number of nodes on your cluster Number of worker cores The following information from Red Hat Insights is displayed: Cluster recommendations Number of risk predictions Cluster health which includes the status and violations A view of your resources based on your custom query. If observability is enabled, alert and failing operator metrics from across your fleet are also displayed. To learn about Search, see Search in the console . 1.1.2.2. Command line tools From the Home page, you can access Command Line Interface (CLI) downloads by using the following steps: Click the ? icon in the toolbar of the console. Click Command Line Tools from the drop-down menu. Find the Advanced Cluster Management header to find a list of tools that are available for Red Hat Advanced Cluster Management, which is specified with the operating system and architecture. Select the appropriate binary file to download and use on your local system. 1.1.3. Infrastructure From Clusters , you can create new clusters or import existing clusters. From Automation , you can create an Ansible template. For more information about managing clusters, see The multicluster engine operator cluster lifecycle overview . Additionally, see specific information on these cluster types at Configuring Ansible Automation Platform tasks to run on managed clusters . 1.1.4. Applications Create an application and edit a .yaml file. Access an overview or more advanced information about each application. For more information about application resources, see Managing applications . 1.1.5. Governance Create and edit a .yaml file to create a policy. Use the Governance dashboard to manage policies and policy controllers. For more information, see Governance . 1.1.6. Credentials The credential stores the access information for a cloud provider. Each provider account requires its own credential, as does each domain on a single provider. Review your credentials or add a credential. See Managing credentials overview for more specific information about providers and credentials. 1.2. Search in the console For Red Hat Advanced Cluster Management for Kubernetes, search provides visibility into your Kubernetes resources across all of your clusters. Search also indexes the Kubernetes resources and the relationships to other resources. Search components Search customization and configurations Search operations and data types 1.2.1. Search components The search architecture is composed of the following components: Table 1.1. Search component table Component name Metrics Metric type Description search-collector Watches the Kubernetes resources, collects the resource metadata, computes relationships for resources across all of your managed clusters, and sends the collected data to the search-indexer . The search-collector on your managed cluster runs as a pod named, klusterlet-addon-search . search-indexer Receives resource metadata from the collectors and writes to PostgreSQL database. The search-indexer also watches resources in the hub cluster to keep track of active managed clusters. search_indexer_request_duration Histogram Time (seconds) the search indexer takes to process a request (from managed cluster). search_indexer_request_size Histogram Total changes (add, update, delete) in the search indexer request (from managed cluster). search_indexer_request_count Counter Total requests received by the search indexer (from managed clusters). search_indexer_requests_in_flight Gauge Total requests the search indexer is processing at a given time. search-api Provides access to all cluster data in the search-indexer through GraphQL and enforces role-based access control (RBAC). search_api_requests Histogram Histogram of HTTP requests duration in seconds. search_dbquery_duration_seconds Histogram Latency of database requests in seconds. search_api_db_connection_failed_total Counter The total number of database connection attempts that failed. search-postgres Stores collected data from all managed clusters in an instance of the PostgreSQL database. Search is configured by default on the hub cluster. When you provision or manually import a managed cluster, the klusterlet-addon-search is enabled. If you want to disable search on your managed cluster, see Modifying the klusterlet add-ons settings of your cluster for more information. 1.2.2. Search customization and configurations You can modify the default values in the search-v2-operator custom resource. To view details of the custom resource, run the following command: oc get search search-v2-operator -o yaml The search operator watches the search-v2-operator custom resource, reconciles the changes and updates active pods. View the following descriptions of the configurations: PostgreSQL database storage: When you install Red Hat Advanced Cluster Management, the PostgreSQL database is configured to save the PostgreSQL data in an empty directory ( emptyDir ) volume. If the empty directory size is limited, you can save the PostgreSQL data on a Persistent Volume Claim (PVC) to improve search performance. You can select a storageclass from your Red Hat Advanced Cluster Management hub cluster to back up your search data. For example, if you select the gp2 storageclass your configuration might resemble the following example: apiVersion: search.open-cluster-management.io/v1alpha1 kind: Search metadata: name: search-v2-operator namespace: open-cluster-management labels: cluster.open-cluster-management.io/backup: "" spec: dbStorage: size: 10Gi storageClassName: gp2 This configuration creates a PVC named gp2-search and is mounted to the search-postgres pod. By default, the storage size is 10Gi . You can modify the storage size. For example, 20Gi might be sufficient for about 200 managed clusters. Optimize cost by tuning the pod memory or CPU requirements, replica count, and update log levels for any of the four search pods ( indexer , database , queryapi , or collector pod). Update the deployment section of the search-v2-operator custom resource. There are four deployments managed by the search-v2-operator , which can be updated individually. Your search-v2-operator custom resource might resemble the following file: apiVersion: search.open-cluster-management.io/v1alpha1 kind: Search metadata: name: search-v2-operator namespace: open-cluster-management spec: deployments: collector: resources: 1 limits: cpu: 500m memory: 128Mi requests: cpu: 250m memory: 64Mi indexer: replicaCount: 3 database: 2 envVar: - name: POSTGRESQL_EFFECTIVE_CACHE_SIZE value: 1024MB - name: POSTGRESQL_SHARED_BUFFERS value: 512MB - name: WORK_MEM value: 128MB queryapi: arguments: 3 - -v=3 1 You can apply resources to an indexer , database , queryapi , or collector pod. 2 You can add multiple environment variables in the envVar section to specify a value for each variable that you name. 3 You can control the log level verbosity for any of the four pods by adding the - -v=3 argument. See the following example where memory resources are applied to the indexer pod: indexer: resources: limits: memory: 5Gi requests: memory: 1Gi You can define the node placement for search pods. You can update the Placement resource of search pods by using the nodeSelector parameter, or the tolerations parameter. View the following example configuration: spec: dbStorage: size: 10Gi deployments: collector: {} database: {} indexer: {} queryapi: {} nodeSelector: node-role.kubernetes.io/infra: "" tolerations: - effect: NoSchedule key: node-role.kubernetes.io/infra operator: Exists Specify your search query by selecting the Advanced search drop-down button to filter the Column , Operator , and Value options or add a search constraint. 1.2.3. Search operations and data types Specify your search query by using search operations as conditions. Characters such as >, >=, <, <=, != are supported. See the following search operation table: Table 1.2. Search operation table Default operation Data type Description = string, number This is the default operation. ! or != string, number This represents the NOT operation, which means to exclude from the search results. <, ⇐, >, >= number > date Dates matching the last hour, day, week, month, and year. * string Partial string match. 1.2.4. Additional resources For instruction about how to manage search, see Managing search . For more topics about the Red Hat Advanced Cluster Management for Kubernetes console, see Web console . 1.2.5. Managing search Use search to query resource data from your clusters. Required access: Cluster administrator Continue reading the following topics: Creating search configurable collection Customizing the search console Querying in the console Updating klusterlet-addon-search deployments on managed clusters 1.2.5.1. Creating search configurable collection To define which Kubernetes resources get collected from the cluster, create the search-collector-config config map. Complete the following steps: Run the following command to create the search-collector-config config map: oc apply -f <your-search-collector-config>.yaml List the resources in the allow ( data.AllowedResources ) and deny list ( data.DeniedResources ) sections within the config map. Your config map might resemble the following YAML file: apiVersion: v1 kind: ConfigMap metadata: name: search-collector-config namespace: <namespace where search-collector add-on is deployed> data: AllowedResources: \|- 1 - apiGroups: - "" resources: - services - pods - apiGroups: - admission.k8s.io - authentication.k8s.io resources: - "" DeniedResources: \|- 2 - apiGroups: - "*" resources: - secrets - apiGroups: - admission.k8s.io resources: - policies - iampolicies - certificatepolicies 1 The config map example displays services and pods to be collected from all apiGroups , while allowing all resources to be collected from the admission.k8s.io and authentication.k8s.io apiGroups . 2 The config map example also prevents the central collection of secrets from all apiGroups while preventing the collection of policies , iampolicies , and certificatepolicies from the apiGroup admission.k8s.io . Note: If you do not provide a config map, all resources are collected by default. If you only provide AllowedResources , all resources not listed in AllowedResources are automatically excluded. Resources listed in AllowedResources and DeniedResources at the same time are also excluded. 1.2.5.2. Customizing the search console Customize your search results and limits. Complete the following tasks to perform the customization: Customize the search result limit from the OpenShift Container Platform console. Update the console-mce-config in the multicluster-engine namespace. These settings apply to all users and might affect performance. View the following performance parameter descriptions: SAVED_SEARCH_LIMIT - The maximum amount of saved searches for each user. By default, there is a limit of ten saved searches for each user. The default value is 10 . To update the limit, add the following key value to the console-config config map: SAVED_SEARCH_LIMIT: x . SEARCH_RESULT_LIMIT - The maximum amount of search results displayed in the console. Default value is 1000 . To remove this limit set to -1 . SEARCH_AUTOCOMPLETE_LIMIT - The maximum number of suggestions retrieved for the search bar typeahead. Default value is 10,000 . To remove this limit set to -1 . Run the following patch command from the OpenShift Container Platform console to change the search result to 100 items: oc patch configmap console-mce-config -n multicluster-engine --type merge -p '{"data":{"SEARCH_RESULT_LIMIT":"100"}}' To add, edit, or remove suggested searches, create a config map named console-search-config and configure the suggestedSearches section. Suggested searches that are listed are also displayed from the console. It is required to have an id, name, and searchText for each search object. View the following config map example: kind: ConfigMap apiVersion: v1 metadata: name: console-search-config namespace: <acm-namespace> 1 data: suggestedSearches: \|- [ { "id": "search.suggested.workloads.name", "name": "Workloads", "description": "Show workloads running on your fleet", "searchText": "kind:DaemonSet,Deployment,Job,StatefulSet,ReplicaSet" }, { "id": "search.suggested.unhealthy.name", "name": "Unhealthy pods", "description": "Show pods with unhealthy status", "searchText": "kind:Pod status:Pending,Error,Failed,Terminating,ImagePullBackOff,CrashLoopBackOff,RunContainerError,ContainerCreating" }, { "id": "search.suggested.createdLastHour.name", "name": "Created last hour", "description": "Show resources created within the last hour", "searchText": "created:hour" }, { "id": "search.suggested.virtualmachines.name", "name": "Virtual Machines", "description": "Show virtual machine resources", "searchText": "kind:VirtualMachine" } ] 1 Add the namespace where search is enabled. 1.2.5.3. Querying in the console You can type any text value in the Search box and results include anything with that value from any property, such as a name or namespace. Queries that contain an empty space are not supported. For more specific search results, include the property selector in your search. You can combine related values for the property for a more precise scope of your search. For example, search for cluster:dev red to receive results that match the string "red" in the dev cluster. Complete the following steps to make queries with search: Click Search in the navigation menu. Type a word in the Search box , then Search finds your resources that contain that value. As you search for resources, you receive other resources that are related to your original search result, which help you visualize how the resources interact with other resources in the system. Search returns and lists each cluster with the resource that you search. For resources in the hub cluster, the cluster name is displayed as local-cluster . Your search results are grouped by kind , and each resource kind is grouped in a table. Your search options depend on your cluster objects. You can refine your results with specific labels. Search is case-sensitive when you query labels. See the following examples that you can select for filtering: name , namespace , status , and other resource fields. Auto-complete provides suggestions to refine your search. See the following example: Search for a single field, such as kind:pod to find all pod resources. Search for multiple fields, such as kind:pod namespace:default to find the pods in the default namespace. Notes: When you search for more than one property selector with multiple values, the search returns either of the values that were queried. View the following examples: When you search for kind:Pod name:a , any pod named a is returned. When you search for kind:Pod name:a,b , any pod named a or b are returned. Search for kind:pod status:!Running to find all pod resources where the status is not Running . Search for kind:pod restarts:>1 to find all pods that restarted at least twice. If you want to save your search, click the Save search icon. To download your search results, select the Export as CSV button. 1.2.5.4. Updating klusterlet-addon-search deployments on managed clusters To collect the Kubernetes objects from the managed clusters, the klusterlet-addon-search pod is run on all the managed clusters where search is enabled. This deployment is run in the open-cluster-management-agent-addon namespace. A managed cluster with a high number of resources might require more memory for the klusterlet-addon-search deployment to function. Resource requirements for the klusterlet-addon-search pod in a managed cluster can be specified in the ManagedClusterAddon custom resource in your Red Hat Advanced Cluster Management hub cluster. There is a namespace for each managed cluster with the managed cluster name. Complete the following steps: Edit the ManagedClusterAddon custom resource from the namespace matching the managed cluster name. Run the following command to update the resource requirement in xyz managed cluster: oc edit managedclusteraddon search-collector -n xyz Append the resource requirements as annotations. View the following example: apiVersion: addon.open-cluster-management.io/v1alpha1 kind: ManagedClusterAddOn metadata: annotations: addon.open-cluster-management.io/search_memory_limit: 2048Mi addon.open-cluster-management.io/search_memory_request: 512Mi The annotation overrides the resource requirements on the managed clusters and automatically restarts the pod with new resource requirements. Note: You can discover all resources defined in your managed cluster by using the API Explorer in the console. Alternatively, you can discover all resources by running the following command: oc api-resources 1.2.5.5. Additional resources See multicluster global hub for more details. See Observing environments introduction . 1.3. Accessing your console The Red Hat Advanced Cluster Management for Kubernetes web console is integrated with the Red Hat OpenShift Container Platform web console as a console plug-in. You can access Red Hat Advanced Cluster Management within the OpenShift Container Platform console from the cluster switcher by selecting All Clusters . The cluster switcher is a drop-down menu that initially displays local-cluster . Select local-cluster when you want to use OpenShift Container Platform console features on the cluster where you installed Red Hat Advanced Cluster Management. Select All Clusters when you want to use Red Hat Advanced Cluster Management features to manage your fleet of clusters. If the cluster switcher is not present, the required console plug-ins might not be enabled. For new installations, the console plug-ins are enabled by default. If you upgraded from a version of Red Hat Advanced Cluster Management and want to enable the plug-ins, or if you want to disable the plug-ins, complete the following steps: To disable the plug-in, be sure you are in the Administrator perspective in the OpenShift Container Platform console. Find Administration in the navigation and click Cluster Settings , then click the Configuration tab. From the list of Configuration resources , click the Console resource with the operator.openshift.io API group, which contains cluster-wide configuration for the web console. Select the Console plug-ins tab. Both the acm and mce plug-ins are listed. Modify plug-in status from the table. In a few moments, you are prompted to refresh the console. Note: To enable and disable the console, see MultiClusterHub advanced for information. To learn more about the Red Hat Advanced Cluster Management for Kubernetes console, see Console overview . 1.4. Enabling virtual machine actions (Technology Preview) To view VirtualMachine resources across all the clusters that Red Hat Advanced Cluster Management for Kubernetes manages, use the Search feature to list and filter the VirtualMachine resources created with the Red Hat OpenShift Virtualization. You can also enable the following actions from the Red Hat Advanced Cluster Management console on your VirtualMachine resources: Start Stop Restart Pause Unpause Required access: Cluster administrator 1.4.1. Prerequisites Confirm that the ManagedServiceAccount add-on is enabled. See ManagedServiceAccount add-on . 1.4.2. Enabling virtual machine actions for Red Hat Advanced Cluster Management You can enable the virtual machine actions for Red Hat Advanced Cluster Management by updating the console config map. Complete the following steps: To update the Red Hat Advanced Cluster Management console config map for enabling virtual machine actions, run the following command: oc patch configmap console-mce-config -n multicluster-engine -p '{"data": {"VIRTUAL_MACHINE_ACTIONS": "enabled"}}' To configure Red Hat Advanced Cluster Management to process the actions, create and configure a ManagedServiceAccount resource for each managed cluster. Save the following YAML file: apiVersion: authentication.open-cluster-management.io/v1beta1 kind: ManagedServiceAccount metadata: name: vm-actor labels: app: search spec: rotation: {} --- apiVersion: rbac.open-cluster-management.io/v1alpha1 kind: ClusterPermission metadata: name: vm-actions labels: app: search spec: clusterRole: rules: - apiGroups: - subresources.kubevirt.io resources: - virtualmachines/start - virtualmachines/stop - virtualmachines/restart - virtualmachineinstances/pause - virtualmachineinstances/unpause verbs: - update clusterRoleBinding: subject: kind: ServiceAccount name: vm-actor namespace: open-cluster-management-agent-addon Note: You must repeat this step for each new managed cluster. Apply the ManagedServiceAccount resource to your hub cluster by running the following command: oc apply -n <MANAGED_CLUSTER> -f /path/to/file The virtual machine actions are enabled for Red Hat Advanced Cluster Management. 1.4.3. Disabling virtual machine actions To disable virtual machine actions for Red Hat Advanced Cluster Management, run the following command: oc patch configmap console-mce-config -n multicluster-engine -p '{"data": {"VIRTUAL_MACHINE_ACTIONS": "disabled"}}' The virtual machine actions are disabled for Red Hat Advanced Cluster Management. 1.4.4. Deleting ManagedServiceAccounts and ClusterPermissions resources To delete ManagedServiceAccounts and ClusterPermissions resources that use virtual machine actions, complete the following steps: To delete the resources, run the following command: oc delete managedserviceaccount,clusterpermission -A -l app=search You might receive the following output: managedserviceaccount.authentication.open-cluster-management.io "vm-actor" deleted managedserviceaccount.authentication.open-cluster-management.io "vm-actor" deleted clusterpermission.rbac.open-cluster-management.io "vm-actions" deleted clusterpermission.rbac.open-cluster-management.io "vm-actions" deleted To confirm that the clean up is complete, run the following command: oc get managedserviceaccount,clusterpermission -A -l app=search When the resources are deleted successfully, you receive the following message: "No resources found" The ManagedServiceAccounts and ClusterPermissions resources are deleted.	[ "get search search-v2-operator -o yaml", "apiVersion: search.open-cluster-management.io/v1alpha1 kind: Search metadata: name: search-v2-operator namespace: open-cluster-management labels: cluster.open-cluster-management.io/backup: \"\" spec: dbStorage: size: 10Gi storageClassName: gp2", "apiVersion: search.open-cluster-management.io/v1alpha1 kind: Search metadata: name: search-v2-operator namespace: open-cluster-management spec: deployments: collector: resources: 1 limits: cpu: 500m memory: 128Mi requests: cpu: 250m memory: 64Mi indexer: replicaCount: 3 database: 2 envVar: - name: POSTGRESQL_EFFECTIVE_CACHE_SIZE value: 1024MB - name: POSTGRESQL_SHARED_BUFFERS value: 512MB - name: WORK_MEM value: 128MB queryapi: arguments: 3 - -v=3", "indexer: resources: limits: memory: 5Gi requests: memory: 1Gi", "spec: dbStorage: size: 10Gi deployments: collector: {} database: {} indexer: {} queryapi: {} nodeSelector: node-role.kubernetes.io/infra: \"\" tolerations: - effect: NoSchedule key: node-role.kubernetes.io/infra operator: Exists", "apply -f <your-search-collector-config>.yaml", "apiVersion: v1 kind: ConfigMap metadata: name: search-collector-config namespace: <namespace where search-collector add-on is deployed> data: AllowedResources: \|- 1 - apiGroups: - \"\" resources: - services - pods - apiGroups: - admission.k8s.io - authentication.k8s.io resources: - \"\" DeniedResources: \|- 2 - apiGroups: - \"*\" resources: - secrets - apiGroups: - admission.k8s.io resources: - policies - iampolicies - certificatepolicies", "patch configmap console-mce-config -n multicluster-engine --type merge -p '{\"data\":{\"SEARCH_RESULT_LIMIT\":\"100\"}}'", "kind: ConfigMap apiVersion: v1 metadata: name: console-search-config namespace: <acm-namespace> 1 data: suggestedSearches: \|- [ { \"id\": \"search.suggested.workloads.name\", \"name\": \"Workloads\", \"description\": \"Show workloads running on your fleet\", \"searchText\": \"kind:DaemonSet,Deployment,Job,StatefulSet,ReplicaSet\" }, { \"id\": \"search.suggested.unhealthy.name\", \"name\": \"Unhealthy pods\", \"description\": \"Show pods with unhealthy status\", \"searchText\": \"kind:Pod status:Pending,Error,Failed,Terminating,ImagePullBackOff,CrashLoopBackOff,RunContainerError,ContainerCreating\" }, { \"id\": \"search.suggested.createdLastHour.name\", \"name\": \"Created last hour\", \"description\": \"Show resources created within the last hour\", \"searchText\": \"created:hour\" }, { \"id\": \"search.suggested.virtualmachines.name\", \"name\": \"Virtual Machines\", \"description\": \"Show virtual machine resources\", \"searchText\": \"kind:VirtualMachine\" } ]", "edit managedclusteraddon search-collector -n xyz", "apiVersion: addon.open-cluster-management.io/v1alpha1 kind: ManagedClusterAddOn metadata: annotations: addon.open-cluster-management.io/search_memory_limit: 2048Mi addon.open-cluster-management.io/search_memory_request: 512Mi", "patch configmap console-mce-config -n multicluster-engine -p '{\"data\": {\"VIRTUAL_MACHINE_ACTIONS\": \"enabled\"}}'", "apiVersion: authentication.open-cluster-management.io/v1beta1 kind: ManagedServiceAccount metadata: name: vm-actor labels: app: search spec: rotation: {} --- apiVersion: rbac.open-cluster-management.io/v1alpha1 kind: ClusterPermission metadata: name: vm-actions labels: app: search spec: clusterRole: rules: - apiGroups: - subresources.kubevirt.io resources: - virtualmachines/start - virtualmachines/stop - virtualmachines/restart - virtualmachineinstances/pause - virtualmachineinstances/unpause verbs: - update clusterRoleBinding: subject: kind: ServiceAccount name: vm-actor namespace: open-cluster-management-agent-addon", "apply -n <MANAGED_CLUSTER> -f /path/to/file", "patch configmap console-mce-config -n multicluster-engine -p '{\"data\": {\"VIRTUAL_MACHINE_ACTIONS\": \"disabled\"}}'", "delete managedserviceaccount,clusterpermission -A -l app=search", "managedserviceaccount.authentication.open-cluster-management.io \"vm-actor\" deleted managedserviceaccount.authentication.open-cluster-management.io \"vm-actor\" deleted clusterpermission.rbac.open-cluster-management.io \"vm-actions\" deleted clusterpermission.rbac.open-cluster-management.io \"vm-actions\" deleted", "get managedserviceaccount,clusterpermission -A -l app=search", "\"No resources found\"" ]	https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/web_console/web-console
About	About Red Hat OpenShift Service on AWS 4 OpenShift Service on AWS Documentation. Red Hat OpenShift Documentation Team	null	https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/about/index