Datasets:

mtpti5iD
/

redhat-docs_dataset

Dataset card Data Studio Files Files and versions Community

Split (2)

train · 44.6k rows

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.

title stringlengths 4 168	content stringlengths 7 1.74M	commands listlengths 1 5.62k ⌀	url stringlengths 79 342
5.8. Using Zones to Manage Incoming Traffic Depending on Source	5.8. Using Zones to Manage Incoming Traffic Depending on Source You can use zones to manage incoming traffic based on its source. That enables you to sort incoming traffic and route it through different zones to allow or disallow services that can be reached by that traffic. If you add a source to a zone, the zone becomes active and any incoming traffic from that source will be directed through it. You can specify different settings for each zone, which is applied to the traffic from the given sources accordingly. You can use more zones even if you only have one network interface. 5.8.1. Adding a Source To route incoming traffic into a specific source, add the source to that zone. The source can be an IP address or an IP mask in the Classless Inter-domain Routing (CIDR) notation. To set the source in the current zone: To set the source IP address for a specific zone: The following procedure allows all incoming traffic from 192.168.2.15 in the trusted zone: List all available zones: Add the source IP to the trusted zone in the permanent mode: Make the new settings persistent: 5.8.2. Removing a Source Removing a source from the zone cuts off the traffic coming from it. List allowed sources for the required zone: Remove the source from the zone permanently: Make the new settings persistent: 5.8.3. Adding a Source Port To enable sorting the traffic based on a port of origin, specify a source port using the --add-source-port option. You can also combine this with the --add-source option to limit the traffic to a certain IP address or IP range. To add a source port: 5.8.4. Removing a Source Port By removing a source port you disable sorting the traffic based on a port of origin. To remove a source port: 5.8.5. Using Zones and Sources to Allow a Service for Only a Specific Domain To allow traffic from a specific network to use a service on a machine, use zones and source. The following procedure allows only HTTP traffic from the 192.0.2.0/24 network while any other traffic is blocked. Warning When you configure this scenario, use a zone that has the default target. Using a zone that has the target set to ACCEPT is a security risk, because for traffic from 192.0.2.0/24 , all network connections would be accepted. List all available zones: Add the IP range to the internal zone to route the traffic originating from the source through the zone: Add the http service to the internal zone: Make the new settings persistent: Check that the internal zone is active and that the service is allowed in it: 5.8.6. Configuring Traffic Accepted by a Zone Based on Protocol You can allow incoming traffic to be accepted by a zone based on the protocol. All traffic using the specified protocol is accepted by a zone, in which you can apply further rules and filtering. Adding a Protocol to a Zone By adding a protocol to a certain zone, you allow all traffic with this protocol to be accepted by this zone. To add a protocol to a zone: Note To receive multicast traffic, use the igmp value with the --add-protocol option. Removing a Protocol from a Zone By removing a protocol from a certain zone, you stop accepting all traffic based on this protocol by the zone. To remove a protocol from a zone:	[ "~]# firewall-cmd --add-source=<source>", "~]# firewall-cmd --zone= zone-name --add-source=<source>", "~]# firewall-cmd --get-zones", "~]# firewall-cmd --zone=trusted --add-source= 192.168.2.15", "~]# firewall-cmd --runtime-to-permanent", "~]# firewall-cmd --zone= zone-name --list-sources", "~]# firewall-cmd --zone= zone-name --remove-source=<source>", "~]# firewall-cmd --runtime-to-permanent", "~]# firewall-cmd --zone= zone-name --add-source-port=<port-name>/<tcp\|udp\|sctp\|dccp>", "~]# firewall-cmd --zone= zone-name --remove-source-port=<port-name>/<tcp\|udp\|sctp\|dccp>", "~]# firewall-cmd --get-zones block dmz drop external home internal public trusted work", "~]# firewall-cmd --zone=internal --add-source=192.0.2.0/24", "~]# firewall-cmd --zone=internal --add-service=http", "~]# firewall-cmd --runtime-to-permanent", "~]# firewall-cmd --zone=internal --list-all internal (active) target: default icmp-block-inversion: no interfaces: sources: 192.0.2.0/24 services: dhcpv6-client mdns samba-client ssh http", "~]# firewall-cmd --zone= zone-name --add-protocol= port-name / tcp\|udp\|sctp\|dccp\|igmp", "~]# firewall-cmd --zone= zone-name --remove-protocol= port-name / tcp\|udp\|sctp\|dccp\|igmp" ]	https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/security_guide/sec-using_zones_to_manage_incoming_traffic_depending_on_source
Chapter 5. Installing a cluster on Azure with customizations	Chapter 5. Installing a cluster on Azure with customizations In OpenShift Container Platform version 4.16, you can install a customized cluster on infrastructure that the installation program provisions on Microsoft Azure. To customize the installation, you modify parameters in the install-config.yaml file before you install the cluster. 5.1. Prerequisites You reviewed details about the OpenShift Container Platform installation and update processes. You read the documentation on selecting a cluster installation method and preparing it for users . You configured an Azure account to host the cluster and determined the tested and validated region to deploy the cluster to. If you use a firewall, you configured it to allow the sites that your cluster requires access to. If you use customer-managed encryption keys, you prepared your Azure environment for encryption . 5.2. Internet access for OpenShift Container Platform In OpenShift Container Platform 4.16, you require access to the internet to install your cluster. You must have internet access to: Access OpenShift Cluster Manager to download the installation program and perform subscription management. If the cluster has internet access and you do not disable Telemetry, that service automatically entitles your cluster. Access Quay.io to obtain the packages that are required to install your cluster. Obtain the packages that are required to perform cluster updates. Important If your cluster cannot have direct internet access, you can perform a restricted network installation on some types of infrastructure that you provision. During that process, you download the required content and use it to populate a mirror registry with the installation packages. With some installation types, the environment that you install your cluster in will not require internet access. Before you update the cluster, you update the content of the mirror registry. 5.3. Generating a key pair for cluster node SSH access During an OpenShift Container Platform installation, you can provide an SSH public key to the installation program. The key is passed to the Red Hat Enterprise Linux CoreOS (RHCOS) nodes through their Ignition config files and is used to authenticate SSH access to the nodes. The key is added to the ~/.ssh/authorized_keys list for the core user on each node, which enables password-less authentication. After the key is passed to the nodes, you can use the key pair to SSH in to the RHCOS nodes as the user core . To access the nodes through SSH, the private key identity must be managed by SSH for your local user. If you want to SSH in to your cluster nodes to perform installation debugging or disaster recovery, you must provide the SSH public key during the installation process. The ./openshift-install gather command also requires the SSH public key to be in place on the cluster nodes. Important Do not skip this procedure in production environments, where disaster recovery and debugging is required. Note You must use a local key, not one that you configured with platform-specific approaches such as AWS key pairs . Procedure If you do not have an existing SSH key pair on your local machine to use for authentication onto your cluster nodes, create one. For example, on a computer that uses a Linux operating system, run the following command: USD ssh-keygen -t ed25519 -N '' -f <path>/<file_name> 1 1 Specify the path and file name, such as ~/.ssh/id_ed25519 , of the new SSH key. If you have an existing key pair, ensure your public key is in the your ~/.ssh directory. Note If you plan to install an OpenShift Container Platform cluster that uses the RHEL cryptographic libraries that have been submitted to NIST for FIPS 140-2/140-3 Validation on only the x86_64 , ppc64le , and s390x architectures, do not create a key that uses the ed25519 algorithm. Instead, create a key that uses the rsa or ecdsa algorithm. View the public SSH key: USD cat <path>/<file_name>.pub For example, run the following to view the ~/.ssh/id_ed25519.pub public key: USD cat ~/.ssh/id_ed25519.pub Add the SSH private key identity to the SSH agent for your local user, if it has not already been added. SSH agent management of the key is required for password-less SSH authentication onto your cluster nodes, or if you want to use the ./openshift-install gather command. Note On some distributions, default SSH private key identities such as ~/.ssh/id_rsa and ~/.ssh/id_dsa are managed automatically. If the ssh-agent process is not already running for your local user, start it as a background task: USD eval "USD(ssh-agent -s)" Example output Agent pid 31874 Note If your cluster is in FIPS mode, only use FIPS-compliant algorithms to generate the SSH key. The key must be either RSA or ECDSA. Add your SSH private key to the ssh-agent : USD ssh-add <path>/<file_name> 1 1 Specify the path and file name for your SSH private key, such as ~/.ssh/id_ed25519 Example output Identity added: /home/<you>/<path>/<file_name> (<computer_name>) steps When you install OpenShift Container Platform, provide the SSH public key to the installation program. 5.4. Using the Azure Marketplace offering Using the Azure Marketplace offering lets you deploy an OpenShift Container Platform cluster, which is billed on pay-per-use basis (hourly, per core) through Azure, while still being supported directly by Red Hat. To deploy an OpenShift Container Platform cluster using the Azure Marketplace offering, you must first obtain the Azure Marketplace image. The installation program uses this image to deploy worker or control plane nodes. When obtaining your image, consider the following: While the images are the same, the Azure Marketplace publisher is different depending on your region. If you are located in North America, specify redhat as the publisher. If you are located in EMEA, specify redhat-limited as the publisher. The offer includes a rh-ocp-worker SKU and a rh-ocp-worker-gen1 SKU. The rh-ocp-worker SKU represents a Hyper-V generation version 2 VM image. The default instance types used in OpenShift Container Platform are version 2 compatible. If you plan to use an instance type that is only version 1 compatible, use the image associated with the rh-ocp-worker-gen1 SKU. The rh-ocp-worker-gen1 SKU represents a Hyper-V version 1 VM image. Important Installing images with the Azure marketplace is not supported on clusters with 64-bit ARM instances. Prerequisites You have installed the Azure CLI client (az) . Your Azure account is entitled for the offer and you have logged into this account with the Azure CLI client. Procedure Display all of the available OpenShift Container Platform images by running one of the following commands: North America: USD az vm image list --all --offer rh-ocp-worker --publisher redhat -o table Example output Offer Publisher Sku Urn Version ------------- -------------- ------------------ -------------------------------------------------------------- ----------------- rh-ocp-worker RedHat rh-ocp-worker RedHat:rh-ocp-worker:rh-ocp-worker:4.15.2024072409 4.15.2024072409 rh-ocp-worker RedHat rh-ocp-worker-gen1 RedHat:rh-ocp-worker:rh-ocp-worker-gen1:4.15.2024072409 4.15.2024072409 EMEA: USD az vm image list --all --offer rh-ocp-worker --publisher redhat-limited -o table Example output Offer Publisher Sku Urn Version ------------- -------------- ------------------ -------------------------------------------------------------- ----------------- rh-ocp-worker redhat-limited rh-ocp-worker redhat-limited:rh-ocp-worker:rh-ocp-worker:4.15.2024072409 4.15.2024072409 rh-ocp-worker redhat-limited rh-ocp-worker-gen1 redhat-limited:rh-ocp-worker:rh-ocp-worker-gen1:4.15.2024072409 4.15.2024072409 Note Use the latest image that is available for compute and control plane nodes. If required, your VMs are automatically upgraded as part of the installation process. Inspect the image for your offer by running one of the following commands: North America: USD az vm image show --urn redhat:rh-ocp-worker:rh-ocp-worker:<version> EMEA: USD az vm image show --urn redhat-limited:rh-ocp-worker:rh-ocp-worker:<version> Review the terms of the offer by running one of the following commands: North America: USD az vm image terms show --urn redhat:rh-ocp-worker:rh-ocp-worker:<version> EMEA: USD az vm image terms show --urn redhat-limited:rh-ocp-worker:rh-ocp-worker:<version> Accept the terms of the offering by running one of the following commands: North America: USD az vm image terms accept --urn redhat:rh-ocp-worker:rh-ocp-worker:<version> EMEA: USD az vm image terms accept --urn redhat-limited:rh-ocp-worker:rh-ocp-worker:<version> Record the image details of your offer. You must update the compute section in the install-config.yaml file with values for publisher , offer , sku , and version before deploying the cluster. You may also update the controlPlane section to deploy control plane machines with the specified image details, or the defaultMachinePlatform section to deploy both control plane and compute machines with the specified image details. Use the latest available image for control plane and compute nodes. Sample install-config.yaml file with the Azure Marketplace compute nodes apiVersion: v1 baseDomain: example.com compute: - hyperthreading: Enabled name: worker platform: azure: type: Standard_D4s_v5 osImage: publisher: redhat offer: rh-ocp-worker sku: rh-ocp-worker version: 413.92.2023101700 replicas: 3 5.5. Obtaining the installation program Before you install OpenShift Container Platform, download the installation file on the host you are using for installation. Prerequisites You have a computer that runs Linux or macOS, with at least 1.2 GB of local disk space. Procedure Go to the Cluster Type page on the Red Hat Hybrid Cloud Console. If you have a Red Hat account, log in with your credentials. If you do not, create an account. Tip You can also download the binaries for a specific OpenShift Container Platform release . Select your infrastructure provider from the Run it yourself section of the page. Select your host operating system and architecture from the dropdown menus under OpenShift Installer and click Download Installer . Place the downloaded file in the directory where you want to store the installation configuration files. Important The installation program creates several files on the computer that you use to install your cluster. You must keep the installation program and the files that the installation program creates after you finish installing the cluster. Both of the files are required to delete the cluster. Deleting the files created by the installation program does not remove your cluster, even if the cluster failed during installation. To remove your cluster, complete the OpenShift Container Platform uninstallation procedures for your specific cloud provider. Extract the installation program. For example, on a computer that uses a Linux operating system, run the following command: USD tar -xvf openshift-install-linux.tar.gz Download your installation pull secret from Red Hat OpenShift Cluster Manager . This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for OpenShift Container Platform components. Tip Alternatively, you can retrieve the installation program from the Red Hat Customer Portal , where you can specify a version of the installation program to download. However, you must have an active subscription to access this page. 5.6. Creating the installation configuration file You can customize the OpenShift Container Platform cluster you install on Microsoft Azure. Prerequisites You have the OpenShift Container Platform installation program and the pull secret for your cluster. You have an Azure subscription ID and tenant ID. If you are installing the cluster using a service principal, you have its application ID and password. If you are installing the cluster using a system-assigned managed identity, you have enabled it on the virtual machine that you will run the installation program from. If you are installing the cluster using a user-assigned managed identity, you have met these prerequisites: You have its client ID. You have assigned it to the virtual machine that you will run the installation program from. Procedure Optional: If you have run the installation program on this computer before, and want to use an alternative service principal or managed identity, go to the ~/.azure/ directory and delete the osServicePrincipal.json configuration file. Deleting this file prevents the installation program from automatically reusing subscription and authentication values from a installation. Create the install-config.yaml file. Change to the directory that contains the installation program and run the following command: USD ./openshift-install create install-config --dir <installation_directory> 1 1 For <installation_directory> , specify the directory name to store the files that the installation program creates. When specifying the directory: Verify that the directory has the execute permission. This permission is required to run Terraform binaries under the installation directory. Use an empty directory. Some installation assets, such as bootstrap X.509 certificates, have short expiration intervals, therefore you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier OpenShift Container Platform version. At the prompts, provide the configuration details for your cloud: Optional: Select an SSH key to use to access your cluster machines. Note For production OpenShift Container Platform clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your ssh-agent process uses. Select azure as the platform to target. If the installation program cannot locate the osServicePrincipal.json configuration file from a installation, you are prompted for Azure subscription and authentication values. Enter the following Azure parameter values for your subscription: azure subscription id : Enter the subscription ID to use for the cluster. azure tenant id : Enter the tenant ID. Depending on the Azure identity you are using to deploy the cluster, do one of the following when prompted for the azure service principal client id : If you are using a service principal, enter its application ID. If you are using a system-assigned managed identity, leave this value blank. If you are using a user-assigned managed identity, specify its client ID. Depending on the Azure identity you are using to deploy the cluster, do one of the following when prompted for the azure service principal client secret : If you are using a service principal, enter its password. If you are using a system-assigned managed identity, leave this value blank. If you are using a user-assigned managed identity, leave this value blank. Select the region to deploy the cluster to. Select the base domain to deploy the cluster to. The base domain corresponds to the Azure DNS Zone that you created for your cluster. Enter a descriptive name for your cluster. Important All Azure resources that are available through public endpoints are subject to resource name restrictions, and you cannot create resources that use certain terms. For a list of terms that Azure restricts, see Resolve reserved resource name errors in the Azure documentation. Modify the install-config.yaml file. You can find more information about the available parameters in the "Installation configuration parameters" section. Note If you are installing a three-node cluster, be sure to set the compute.replicas parameter to 0 . This ensures that the cluster's control planes are schedulable. For more information, see "Installing a three-node cluster on Azure". Back up the install-config.yaml file so that you can use it to install multiple clusters. Important The install-config.yaml file is consumed during the installation process. If you want to reuse the file, you must back it up now. If previously not detected, the installation program creates an osServicePrincipal.json configuration file and stores this file in the ~/.azure/ directory on your computer. This ensures that the installation program can load the profile when it is creating an OpenShift Container Platform cluster on the target platform. Additional resources Installation configuration parameters for Azure 5.6.1. Minimum resource requirements for cluster installation Each cluster machine must meet the following minimum requirements: Table 5.1. Minimum resource requirements Machine Operating System vCPU [1] Virtual RAM Storage Input/Output Per Second (IOPS) [2] Bootstrap RHCOS 4 16 GB 100 GB 300 Control plane RHCOS 4 16 GB 100 GB 300 Compute RHCOS, RHEL 8.6 and later [3] 2 8 GB 100 GB 300 One vCPU is equivalent to one physical core when simultaneous multithreading (SMT), or Hyper-Threading, is not enabled. When enabled, use the following formula to calculate the corresponding ratio: (threads per core x cores) x sockets = vCPUs. OpenShift Container Platform and Kubernetes are sensitive to disk performance, and faster storage is recommended, particularly for etcd on the control plane nodes which require a 10 ms p99 fsync duration. Note that on many cloud platforms, storage size and IOPS scale together, so you might need to over-allocate storage volume to obtain sufficient performance. As with all user-provisioned installations, if you choose to use RHEL compute machines in your cluster, you take responsibility for all operating system life cycle management and maintenance, including performing system updates, applying patches, and completing all other required tasks. Use of RHEL 7 compute machines is deprecated and has been removed in OpenShift Container Platform 4.10 and later. Note As of OpenShift Container Platform version 4.13, RHCOS is based on RHEL version 9.2, which updates the micro-architecture requirements. The following list contains the minimum instruction set architectures (ISA) that each architecture requires: x86-64 architecture requires x86-64-v2 ISA ARM64 architecture requires ARMv8.0-A ISA IBM Power architecture requires Power 9 ISA s390x architecture requires z14 ISA For more information, see Architectures (RHEL documentation). Important You are required to use Azure virtual machines that have the premiumIO parameter set to true . If an instance type for your platform meets the minimum requirements for cluster machines, it is supported to use in OpenShift Container Platform. Additional resources Optimizing storage 5.6.2. Tested instance types for Azure The following Microsoft Azure instance types have been tested with OpenShift Container Platform. Example 5.1. Machine types based on 64-bit x86 architecture standardBSFamily standardBsv2Family standardDADSv5Family standardDASv4Family standardDASv5Family standardDCACCV5Family standardDCADCCV5Family standardDCADSv5Family standardDCASv5Family standardDCSv3Family standardDCSv2Family standardDDCSv3Family standardDDSv4Family standardDDSv5Family standardDLDSv5Family standardDLSv5Family standardDSFamily standardDSv2Family standardDSv2PromoFamily standardDSv3Family standardDSv4Family standardDSv5Family standardEADSv5Family standardEASv4Family standardEASv5Family standardEBDSv5Family standardEBSv5Family standardECACCV5Family standardECADCCV5Family standardECADSv5Family standardECASv5Family standardEDSv4Family standardEDSv5Family standardEIADSv5Family standardEIASv4Family standardEIASv5Family standardEIBDSv5Family standardEIBSv5Family standardEIDSv5Family standardEISv3Family standardEISv5Family standardESv3Family standardESv4Family standardESv5Family standardFXMDVSFamily standardFSFamily standardFSv2Family standardGSFamily standardHBrsv2Family standardHBSFamily standardHBv4Family standardHCSFamily standardHXFamily standardLASv3Family standardLSFamily standardLSv2Family standardLSv3Family standardMDSMediumMemoryv2Family standardMDSMediumMemoryv3Family standardMIDSMediumMemoryv2Family standardMISMediumMemoryv2Family standardMSFamily standardMSMediumMemoryv2Family standardMSMediumMemoryv3Family StandardNCADSA100v4Family Standard NCASv3_T4 Family standardNCSv3Family standardNDSv2Family standardNPSFamily StandardNVADSA10v5Family standardNVSv3Family standardXEISv4Family 5.6.3. Tested instance types for Azure on 64-bit ARM infrastructures The following Microsoft Azure ARM64 instance types have been tested with OpenShift Container Platform. Example 5.2. Machine types based on 64-bit ARM architecture standardBpsv2Family standardDPSv5Family standardDPDSv5Family standardDPLDSv5Family standardDPLSv5Family standardEPSv5Family standardEPDSv5Family 5.6.4. Enabling trusted launch for Azure VMs You can enable two trusted launch features when installing your cluster on Azure: secure boot and virtualized Trusted Platform Modules . See the Azure documentation about virtual machine sizes to learn what sizes of virtual machines support these features. Important Trusted launch 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 . Prerequisites You have created an install-config.yaml file. Procedure Use a text editor to edit the install-config.yaml file prior to deploying your cluster and add the following stanza: controlPlane: 1 platform: azure: settings: securityType: TrustedLaunch 2 trustedLaunch: uefiSettings: secureBoot: Enabled 3 virtualizedTrustedPlatformModule: Enabled 4 1 Specify controlPlane.platform.azure or compute.platform.azure to enable trusted launch on only control plane or compute nodes respectively. Specify platform.azure.defaultMachinePlatform to enable trusted launch on all nodes. 2 Enable trusted launch features. 3 Enable secure boot. For more information, see the Azure documentation about secure boot . 4 Enable the virtualized Trusted Platform Module. For more information, see the Azure documentation about virtualized Trusted Platform Modules . 5.6.5. Enabling confidential VMs You can enable confidential VMs when installing your cluster. You can enable confidential VMs for compute nodes, control plane nodes, or all nodes. Important Using confidential VMs 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 . You can use confidential VMs with the following VM sizes: DCasv5-series DCadsv5-series ECasv5-series ECadsv5-series Important Confidential VMs are currently not supported on 64-bit ARM architectures. Prerequisites You have created an install-config.yaml file. Procedure Use a text editor to edit the install-config.yaml file prior to deploying your cluster and add the following stanza: controlPlane: 1 platform: azure: settings: securityType: ConfidentialVM 2 confidentialVM: uefiSettings: secureBoot: Enabled 3 virtualizedTrustedPlatformModule: Enabled 4 osDisk: securityProfile: securityEncryptionType: VMGuestStateOnly 5 1 Specify controlPlane.platform.azure or compute.platform.azure to deploy confidential VMs on only control plane or compute nodes respectively. Specify platform.azure.defaultMachinePlatform to deploy confidential VMs on all nodes. 2 Enable confidential VMs. 3 Enable secure boot. For more information, see the Azure documentation about secure boot . 4 Enable the virtualized Trusted Platform Module. For more information, see the Azure documentation about virtualized Trusted Platform Modules . 5 Specify VMGuestStateOnly to encrypt the VM guest state. 5.6.6. Sample customized install-config.yaml file for Azure You can customize the install-config.yaml file to specify more details about your OpenShift Container Platform cluster's platform or modify the values of the required parameters. Important This sample YAML file is provided for reference only. You must obtain your install-config.yaml file by using the installation program and modify it. apiVersion: v1 baseDomain: example.com 1 controlPlane: 2 hyperthreading: Enabled 3 4 name: master platform: azure: encryptionAtHost: true ultraSSDCapability: Enabled osDisk: diskSizeGB: 1024 5 diskType: Premium_LRS diskEncryptionSet: resourceGroup: disk_encryption_set_resource_group name: disk_encryption_set_name subscriptionId: secondary_subscription_id osImage: publisher: example_publisher_name offer: example_image_offer sku: example_offer_sku version: example_image_version type: Standard_D8s_v3 replicas: 3 compute: 6 - hyperthreading: Enabled 7 name: worker platform: azure: ultraSSDCapability: Enabled type: Standard_D2s_v3 encryptionAtHost: true osDisk: diskSizeGB: 512 8 diskType: Standard_LRS diskEncryptionSet: resourceGroup: disk_encryption_set_resource_group name: disk_encryption_set_name subscriptionId: secondary_subscription_id osImage: publisher: example_publisher_name offer: example_image_offer sku: example_offer_sku version: example_image_version zones: 9 - "1" - "2" - "3" replicas: 5 metadata: name: test-cluster 10 networking: clusterNetwork: - cidr: 10.128.0.0/14 hostPrefix: 23 machineNetwork: - cidr: 10.0.0.0/16 networkType: OVNKubernetes 11 serviceNetwork: - 172.30.0.0/16 platform: azure: defaultMachinePlatform: osImage: 12 publisher: example_publisher_name offer: example_image_offer sku: example_offer_sku version: example_image_version ultraSSDCapability: Enabled baseDomainResourceGroupName: resource_group 13 region: centralus 14 resourceGroupName: existing_resource_group 15 outboundType: Loadbalancer cloudName: AzurePublicCloud pullSecret: '{"auths": ...}' 16 fips: false 17 sshKey: ssh-ed25519 AAAA... 18 1 10 14 16 Required. The installation program prompts you for this value. 2 6 If you do not provide these parameters and values, the installation program provides the default value. 3 7 The controlPlane section is a single mapping, but the compute section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the compute section must begin with a hyphen, - , and the first line of the controlPlane section must not. Only one control plane pool is used. 4 Whether to enable or disable simultaneous multithreading, or hyperthreading . By default, simultaneous multithreading is enabled to increase the performance of your machines' cores. You can disable it by setting the parameter value to Disabled . If you disable simultaneous multithreading in some cluster machines, you must disable it in all cluster machines. Important If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance. Use larger virtual machine types, such as Standard_D8s_v3 , for your machines if you disable simultaneous multithreading. 5 8 You can specify the size of the disk to use in GB. Minimum recommendation for control plane nodes is 1024 GB. 9 Specify a list of zones to deploy your machines to. For high availability, specify at least two zones. 11 The cluster network plugin to install. The default value OVNKubernetes is the only supported value. 12 Optional: A custom Red Hat Enterprise Linux CoreOS (RHCOS) image that should be used to boot control plane and compute machines. The publisher , offer , sku , and version parameters under platform.azure.defaultMachinePlatform.osImage apply to both control plane and compute machines. If the parameters under controlPlane.platform.azure.osImage or compute.platform.azure.osImage are set, they override the platform.azure.defaultMachinePlatform.osImage parameters. 13 Specify the name of the resource group that contains the DNS zone for your base domain. 15 Specify the name of an already existing resource group to install your cluster to. If undefined, a new resource group is created for the cluster. 17 Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the Red Hat Enterprise Linux CoreOS (RHCOS) machines that OpenShift Container Platform runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with RHCOS instead. Important To enable FIPS mode for your cluster, you must run the installation program from a Red Hat Enterprise Linux (RHEL) computer configured to operate in FIPS mode. For more information about configuring FIPS mode on RHEL, see Switching RHEL to FIPS mode . When running Red Hat Enterprise Linux (RHEL) or Red Hat Enterprise Linux CoreOS (RHCOS) booted in FIPS mode, OpenShift Container Platform core components use the RHEL cryptographic libraries that have been submitted to NIST for FIPS 140-2/140-3 Validation on only the x86_64, ppc64le, and s390x architectures. 18 You can optionally provide the sshKey value that you use to access the machines in your cluster. Note For production OpenShift Container Platform clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your ssh-agent process uses. 5.6.7. Configuring the cluster-wide proxy during installation Production environments can deny direct access to the internet and instead have an HTTP or HTTPS proxy available. You can configure a new OpenShift Container Platform cluster to use a proxy by configuring the proxy settings in the install-config.yaml file. Prerequisites You have an existing install-config.yaml file. You reviewed the sites that your cluster requires access to and determined whether any of them need to bypass the proxy. By default, all cluster egress traffic is proxied, including calls to hosting cloud provider APIs. You added sites to the Proxy object's spec.noProxy field to bypass the proxy if necessary. Note The Proxy object status.noProxy field is populated with the values of the networking.machineNetwork[].cidr , networking.clusterNetwork[].cidr , and networking.serviceNetwork[] fields from your installation configuration. For installations on Amazon Web Services (AWS), Google Cloud Platform (GCP), Microsoft Azure, and Red Hat OpenStack Platform (RHOSP), the Proxy object status.noProxy field is also populated with the instance metadata endpoint ( 169.254.169.254 ). Procedure Edit your install-config.yaml file and add the proxy settings. For example: apiVersion: v1 baseDomain: my.domain.com proxy: httpProxy: http://<username>:<pswd>@<ip>:<port> 1 httpsProxy: https://<username>:<pswd>@<ip>:<port> 2 noProxy: example.com 3 additionalTrustBundle: \| 4 -----BEGIN CERTIFICATE----- <MY_TRUSTED_CA_CERT> -----END CERTIFICATE----- additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> 5 1 A proxy URL to use for creating HTTP connections outside the cluster. The URL scheme must be http . 2 A proxy URL to use for creating HTTPS connections outside the cluster. 3 A comma-separated list of destination domain names, IP addresses, or other network CIDRs to exclude from proxying. Preface a domain with . to match subdomains only. For example, .y.com matches x.y.com , but not y.com . Use * to bypass the proxy for all destinations. 4 If provided, the installation program generates a config map that is named user-ca-bundle in the openshift-config namespace that contains one or more additional CA certificates that are required for proxying HTTPS connections. The Cluster Network Operator then creates a trusted-ca-bundle config map that merges these contents with the Red Hat Enterprise Linux CoreOS (RHCOS) trust bundle, and this config map is referenced in the trustedCA field of the Proxy object. The additionalTrustBundle field is required unless the proxy's identity certificate is signed by an authority from the RHCOS trust bundle. 5 Optional: The policy to determine the configuration of the Proxy object to reference the user-ca-bundle config map in the trustedCA field. The allowed values are Proxyonly and Always . Use Proxyonly to reference the user-ca-bundle config map only when http/https proxy is configured. Use Always to always reference the user-ca-bundle config map. The default value is Proxyonly . Note The installation program does not support the proxy readinessEndpoints field. Note If the installer times out, restart and then complete the deployment by using the wait-for command of the installer. For example: USD ./openshift-install wait-for install-complete --log-level debug Save the file and reference it when installing OpenShift Container Platform. The installation program creates a cluster-wide proxy that is named cluster that uses the proxy settings in the provided install-config.yaml file. If no proxy settings are provided, a cluster Proxy object is still created, but it will have a nil spec . Note Only the Proxy object named cluster is supported, and no additional proxies can be created. Additional resources For more details about Accelerated Networking, see Accelerated Networking for Microsoft Azure VMs . 5.7. Configuring user-defined tags for Azure In OpenShift Container Platform, you can use the tags for grouping resources and for managing resource access and cost. You can define the tags on the Azure resources in the install-config.yaml file only during OpenShift Container Platform cluster creation. You cannot modify the user-defined tags after cluster creation. Support for user-defined tags is available only for the resources created in the Azure Public Cloud. User-defined tags are not supported for the OpenShift Container Platform clusters upgraded to OpenShift Container Platform 4.16. User-defined and OpenShift Container Platform specific tags are applied only to the resources created by the OpenShift Container Platform installer and its core operators such as Machine api provider azure Operator, Cluster Ingress Operator, Cluster Image Registry Operator. By default, OpenShift Container Platform installer attaches the OpenShift Container Platform tags to the Azure resources. These OpenShift Container Platform tags are not accessible for the users. You can use the .platform.azure.userTags field in the install-config.yaml file to define the list of user-defined tags as shown in the following install-config.yaml file. Sample install-config.yaml file additionalTrustBundlePolicy: Proxyonly 1 apiVersion: v1 baseDomain: catchall.azure.devcluster.openshift.com 2 compute: 3 - architecture: amd64 hyperthreading: Enabled 4 name: worker platform: {} replicas: 3 controlPlane: 5 architecture: amd64 hyperthreading: Enabled 6 name: master platform: {} replicas: 3 metadata: creationTimestamp: null name: user 7 networking: clusterNetwork: - cidr: 10.128.0.0/14 hostPrefix: 23 machineNetwork: - cidr: 10.0.0.0/16 networkType: OVNKubernetes 8 serviceNetwork: - 172.30.0.0/16 platform: azure: baseDomainResourceGroupName: os4-common 9 cloudName: AzurePublicCloud 10 outboundType: Loadbalancer region: southindia 11 userTags: 12 createdBy: user environment: dev 1 Defines the trust bundle policy. 2 Required. The baseDomain parameter specifies the base domain of your cloud provider. The installation program prompts you for this value. 3 The configuration for the machines that comprise compute. The compute section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the compute section must begin with a hyphen, - . If you do not provide these parameters and values, the installation program provides the default value. 4 To enable or disable simultaneous multithreading, or hyperthreading . By default, simultaneous multithreading is enabled to increase the performance of your machines' cores. You can disable it by setting the parameter value to Disabled . If you disable simultaneous multithreading in some cluster machines, you must disable it in all cluster machines. 5 The configuration for the machines that comprise the control plane. The controlPlane section is a single mapping. The first line of the controlPlane section must not begin with a hyphen, - . You can use only one control plane pool. If you do not provide these parameters and values, the installation program provides the default value. 6 To enable or disable simultaneous multithreading, or hyperthreading . By default, simultaneous multithreading is enabled to increase the performance of your machines' cores. You can disable it by setting the parameter value to Disabled . If you disable simultaneous multithreading in some cluster machines, you must disable it in all cluster machines. 7 The installation program prompts you for this value. 8 The cluster network plugin to install. The default value OVNKubernetes is the only supported value. 9 Specifies the resource group for the base domain of the Azure DNS zone. 10 Specifies the name of the Azure cloud environment. You can use the cloudName field to configure the Azure SDK with the Azure API endpoints. If you do not provide value, the default value is Azure Public Cloud. 11 Required. Specifies the name of the Azure region that hosts your cluster. The installation program prompts you for this value. 12 Defines the additional keys and values that the installation program adds as tags to all Azure resources that it creates. The user-defined tags have the following limitations: A tag key can have a maximum of 128 characters. A tag key must begin with a letter, end with a letter, number or underscore, and can contain only letters, numbers, underscores, periods, and hyphens. Tag keys are case-insensitive. Tag keys cannot be name . It cannot have prefixes such as kubernetes.io , openshift.io , microsoft , azure , and windows . A tag value can have a maximum of 256 characters. You can configure a maximum of 10 tags for resource group and resources. For more information about Azure tags, see Azure user-defined tags 5.8. Querying user-defined tags for Azure After creating the OpenShift Container Platform cluster, you can access the list of defined tags for the Azure resources. The format of the OpenShift Container Platform tags is kubernetes.io_cluster.<cluster_id>:owned . The cluster_id parameter is the value of .status.infrastructureName present in config.openshift.io/Infrastructure . Query the tags defined for Azure resources by running the following command: USD oc get infrastructures.config.openshift.io cluster -o=jsonpath-as-json='{.status.platformStatus.azure.resourceTags}' Example output [ [ { "key": "createdBy", "value": "user" }, { "key": "environment", "value": "dev" } ] ] 5.9. Installing the OpenShift CLI You can install the OpenShift CLI ( oc ) to interact with OpenShift Container Platform from a command-line interface. You can install oc on Linux, Windows, or macOS. Important If you installed an earlier version of oc , you cannot use it to complete all of the commands in OpenShift Container Platform 4.16. Download and install the new version of oc . Installing the OpenShift CLI on Linux You can install the OpenShift CLI ( oc ) binary on Linux by using the following procedure. Procedure Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal. Select the architecture from the Product Variant drop-down list. Select the appropriate version from the Version drop-down list. Click Download Now to the OpenShift v4.16 Linux Clients entry and save the file. Unpack the archive: USD tar xvf <file> Place the oc binary in a directory that is on your PATH . To check your PATH , execute the following command: USD echo USDPATH Verification After you install the OpenShift CLI, it is available using the oc command: USD oc <command> Installing the OpenShift CLI on Windows You can install the OpenShift CLI ( oc ) binary on Windows by using the following procedure. Procedure Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal. Select the appropriate version from the Version drop-down list. Click Download Now to the OpenShift v4.16 Windows Client entry and save the file. Unzip the archive with a ZIP program. Move the oc binary to a directory that is on your PATH . To check your PATH , open the command prompt and execute the following command: C:\> path Verification After you install the OpenShift CLI, it is available using the oc command: C:\> oc <command> Installing the OpenShift CLI on macOS You can install the OpenShift CLI ( oc ) binary on macOS by using the following procedure. Procedure Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal. Select the appropriate version from the Version drop-down list. Click Download Now to the OpenShift v4.16 macOS Clients entry and save the file. Note For macOS arm64, choose the OpenShift v4.16 macOS arm64 Client entry. Unpack and unzip the archive. Move the oc binary to a directory on your PATH. To check your PATH , open a terminal and execute the following command: USD echo USDPATH Verification Verify your installation by using an oc command: USD oc <command> 5.10. Alternatives to storing administrator-level secrets in the kube-system project By default, administrator secrets are stored in the kube-system project. If you configured the credentialsMode parameter in the install-config.yaml file to Manual , you must use one of the following alternatives: To manage long-term cloud credentials manually, follow the procedure in Manually creating long-term credentials . To implement short-term credentials that are managed outside the cluster for individual components, follow the procedures in Configuring an Azure cluster to use short-term credentials . 5.10.1. Manually creating long-term credentials The Cloud Credential Operator (CCO) can be put into manual mode prior to installation in environments where the cloud identity and access management (IAM) APIs are not reachable, or the administrator prefers not to store an administrator-level credential secret in the cluster kube-system namespace. Procedure If you did not set the credentialsMode parameter in the install-config.yaml configuration file to Manual , modify the value as shown: Sample configuration file snippet apiVersion: v1 baseDomain: example.com credentialsMode: Manual # ... If you have not previously created installation manifest files, do so by running the following command: USD openshift-install create manifests --dir <installation_directory> where <installation_directory> is the directory in which the installation program creates files. Set a USDRELEASE_IMAGE variable with the release image from your installation file by running the following command: USD RELEASE_IMAGE=USD(./openshift-install version \| awk '/release image/ {print USD3}') Extract the list of CredentialsRequest custom resources (CRs) from the OpenShift Container Platform release image by running the following command: USD oc adm release extract \ --from=USDRELEASE_IMAGE \ --credentials-requests \ --included \ 1 --install-config=<path_to_directory_with_installation_configuration>/install-config.yaml \ 2 --to=<path_to_directory_for_credentials_requests> 3 1 The --included parameter includes only the manifests that your specific cluster configuration requires. 2 Specify the location of the install-config.yaml file. 3 Specify the path to the directory where you want to store the CredentialsRequest objects. If the specified directory does not exist, this command creates it. This command creates a YAML file for each CredentialsRequest object. Sample CredentialsRequest object apiVersion: cloudcredential.openshift.io/v1 kind: CredentialsRequest metadata: name: <component_credentials_request> namespace: openshift-cloud-credential-operator ... spec: providerSpec: apiVersion: cloudcredential.openshift.io/v1 kind: AzureProviderSpec roleBindings: - role: Contributor ... Create YAML files for secrets in the openshift-install manifests directory that you generated previously. The secrets must be stored using the namespace and secret name defined in the spec.secretRef for each CredentialsRequest object. Sample CredentialsRequest object with secrets apiVersion: cloudcredential.openshift.io/v1 kind: CredentialsRequest metadata: name: <component_credentials_request> namespace: openshift-cloud-credential-operator ... spec: providerSpec: apiVersion: cloudcredential.openshift.io/v1 kind: AzureProviderSpec roleBindings: - role: Contributor ... secretRef: name: <component_secret> namespace: <component_namespace> ... Sample Secret object apiVersion: v1 kind: Secret metadata: name: <component_secret> namespace: <component_namespace> data: azure_subscription_id: <base64_encoded_azure_subscription_id> azure_client_id: <base64_encoded_azure_client_id> azure_client_secret: <base64_encoded_azure_client_secret> azure_tenant_id: <base64_encoded_azure_tenant_id> azure_resource_prefix: <base64_encoded_azure_resource_prefix> azure_resourcegroup: <base64_encoded_azure_resourcegroup> azure_region: <base64_encoded_azure_region> Important Before upgrading a cluster that uses manually maintained credentials, you must ensure that the CCO is in an upgradeable state. 5.10.2. Configuring an Azure cluster to use short-term credentials To install a cluster that uses Microsoft Entra Workload ID, you must configure the Cloud Credential Operator utility and create the required Azure resources for your cluster. 5.10.2.1. Configuring the Cloud Credential Operator utility To create and manage cloud credentials from outside of the cluster when the Cloud Credential Operator (CCO) is operating in manual mode, extract and prepare the CCO utility ( ccoctl ) binary. Note The ccoctl utility is a Linux binary that must run in a Linux environment. Prerequisites You have access to an OpenShift Container Platform account with cluster administrator access. You have installed the OpenShift CLI ( oc ). You have created a global Microsoft Azure account for the ccoctl utility to use with the following permissions: Example 5.3. Required Azure permissions Microsoft.Resources/subscriptions/resourceGroups/read Microsoft.Resources/subscriptions/resourceGroups/write Microsoft.Resources/subscriptions/resourceGroups/delete Microsoft.Authorization/roleAssignments/read Microsoft.Authorization/roleAssignments/delete Microsoft.Authorization/roleAssignments/write Microsoft.Authorization/roleDefinitions/read Microsoft.Authorization/roleDefinitions/write Microsoft.Authorization/roleDefinitions/delete Microsoft.Storage/storageAccounts/listkeys/action Microsoft.Storage/storageAccounts/delete Microsoft.Storage/storageAccounts/read Microsoft.Storage/storageAccounts/write Microsoft.Storage/storageAccounts/blobServices/containers/write Microsoft.Storage/storageAccounts/blobServices/containers/delete Microsoft.Storage/storageAccounts/blobServices/containers/read Microsoft.ManagedIdentity/userAssignedIdentities/delete Microsoft.ManagedIdentity/userAssignedIdentities/read Microsoft.ManagedIdentity/userAssignedIdentities/write Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials/read Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials/write Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials/delete Microsoft.Storage/register/action Microsoft.ManagedIdentity/register/action Procedure Set a variable for the OpenShift Container Platform release image by running the following command: USD RELEASE_IMAGE=USD(./openshift-install version \| awk '/release image/ {print USD3}') Obtain the CCO container image from the OpenShift Container Platform release image by running the following command: USD CCO_IMAGE=USD(oc adm release info --image-for='cloud-credential-operator' USDRELEASE_IMAGE -a ~/.pull-secret) Note Ensure that the architecture of the USDRELEASE_IMAGE matches the architecture of the environment in which you will use the ccoctl tool. Extract the ccoctl binary from the CCO container image within the OpenShift Container Platform release image by running the following command: USD oc image extract USDCCO_IMAGE \ --file="/usr/bin/ccoctl.<rhel_version>" \ 1 -a ~/.pull-secret 1 For <rhel_version> , specify the value that corresponds to the version of Red Hat Enterprise Linux (RHEL) that the host uses. If no value is specified, ccoctl.rhel8 is used by default. The following values are valid: rhel8 : Specify this value for hosts that use RHEL 8. rhel9 : Specify this value for hosts that use RHEL 9. Change the permissions to make ccoctl executable by running the following command: USD chmod 775 ccoctl.<rhel_version> Verification To verify that ccoctl is ready to use, display the help file. Use a relative file name when you run the command, for example: USD ./ccoctl.rhel9 Example output OpenShift credentials provisioning tool Usage: ccoctl [command] Available Commands: aws Manage credentials objects for AWS cloud azure Manage credentials objects for Azure gcp Manage credentials objects for Google cloud help Help about any command ibmcloud Manage credentials objects for IBM Cloud nutanix Manage credentials objects for Nutanix Flags: -h, --help help for ccoctl Use "ccoctl [command] --help" for more information about a command. 5.10.2.2. Creating Azure resources with the Cloud Credential Operator utility You can use the ccoctl azure create-all command to automate the creation of Azure resources. Note By default, ccoctl creates objects in the directory in which the commands are run. To create the objects in a different directory, use the --output-dir flag. This procedure uses <path_to_ccoctl_output_dir> to refer to this directory. Prerequisites You must have: Extracted and prepared the ccoctl binary. Access to your Microsoft Azure account by using the Azure CLI. Procedure Set a USDRELEASE_IMAGE variable with the release image from your installation file by running the following command: USD RELEASE_IMAGE=USD(./openshift-install version \| awk '/release image/ {print USD3}') Extract the list of CredentialsRequest objects from the OpenShift Container Platform release image by running the following command: USD oc adm release extract \ --from=USDRELEASE_IMAGE \ --credentials-requests \ --included \ 1 --install-config=<path_to_directory_with_installation_configuration>/install-config.yaml \ 2 --to=<path_to_directory_for_credentials_requests> 3 1 The --included parameter includes only the manifests that your specific cluster configuration requires. 2 Specify the location of the install-config.yaml file. 3 Specify the path to the directory where you want to store the CredentialsRequest objects. If the specified directory does not exist, this command creates it. Note This command might take a few moments to run. To enable the ccoctl utility to detect your Azure credentials automatically, log in to the Azure CLI by running the following command: USD az login Use the ccoctl tool to process all CredentialsRequest objects by running the following command: USD ccoctl azure create-all \ --name=<azure_infra_name> \ 1 --output-dir=<ccoctl_output_dir> \ 2 --region=<azure_region> \ 3 --subscription-id=<azure_subscription_id> \ 4 --credentials-requests-dir=<path_to_credentials_requests_directory> \ 5 --dnszone-resource-group-name=<azure_dns_zone_resource_group_name> \ 6 --tenant-id=<azure_tenant_id> 7 1 Specify the user-defined name for all created Azure resources used for tracking. 2 Optional: Specify the directory in which you want the ccoctl utility to create objects. By default, the utility creates objects in the directory in which the commands are run. 3 Specify the Azure region in which cloud resources will be created. 4 Specify the Azure subscription ID to use. 5 Specify the directory containing the files for the component CredentialsRequest objects. 6 Specify the name of the resource group containing the cluster's base domain Azure DNS zone. 7 Specify the Azure tenant ID to use. Note If your cluster uses Technology Preview features that are enabled by the TechPreviewNoUpgrade feature set, you must include the --enable-tech-preview parameter. To see additional optional parameters and explanations of how to use them, run the azure create-all --help command. Verification To verify that the OpenShift Container Platform secrets are created, list the files in the <path_to_ccoctl_output_dir>/manifests directory: USD ls <path_to_ccoctl_output_dir>/manifests Example output azure-ad-pod-identity-webhook-config.yaml cluster-authentication-02-config.yaml openshift-cloud-controller-manager-azure-cloud-credentials-credentials.yaml openshift-cloud-network-config-controller-cloud-credentials-credentials.yaml openshift-cluster-api-capz-manager-bootstrap-credentials-credentials.yaml openshift-cluster-csi-drivers-azure-disk-credentials-credentials.yaml openshift-cluster-csi-drivers-azure-file-credentials-credentials.yaml openshift-image-registry-installer-cloud-credentials-credentials.yaml openshift-ingress-operator-cloud-credentials-credentials.yaml openshift-machine-api-azure-cloud-credentials-credentials.yaml You can verify that the Microsoft Entra ID service accounts are created by querying Azure. For more information, refer to Azure documentation on listing Entra ID service accounts. 5.10.2.3. Incorporating the Cloud Credential Operator utility manifests To implement short-term security credentials managed outside the cluster for individual components, you must move the manifest files that the Cloud Credential Operator utility ( ccoctl ) created to the correct directories for the installation program. Prerequisites You have configured an account with the cloud platform that hosts your cluster. You have configured the Cloud Credential Operator utility ( ccoctl ). You have created the cloud provider resources that are required for your cluster with the ccoctl utility. Procedure If you did not set the credentialsMode parameter in the install-config.yaml configuration file to Manual , modify the value as shown: Sample configuration file snippet apiVersion: v1 baseDomain: example.com credentialsMode: Manual # ... If you used the ccoctl utility to create a new Azure resource group instead of using an existing resource group, modify the resourceGroupName parameter in the install-config.yaml as shown: Sample configuration file snippet apiVersion: v1 baseDomain: example.com # ... platform: azure: resourceGroupName: <azure_infra_name> 1 # ... 1 This value must match the user-defined name for Azure resources that was specified with the --name argument of the ccoctl azure create-all command. If you have not previously created installation manifest files, do so by running the following command: USD openshift-install create manifests --dir <installation_directory> where <installation_directory> is the directory in which the installation program creates files. Copy the manifests that the ccoctl utility generated to the manifests directory that the installation program created by running the following command: USD cp /<path_to_ccoctl_output_dir>/manifests/* ./manifests/ Copy the tls directory that contains the private key to the installation directory: USD cp -a /<path_to_ccoctl_output_dir>/tls . 5.11. Deploying the cluster You can install OpenShift Container Platform on a compatible cloud platform. Important You can run the create cluster command of the installation program only once, during initial installation. Prerequisites You have configured an account with the cloud platform that hosts your cluster. You have the OpenShift Container Platform installation program and the pull secret for your cluster. You have an Azure subscription ID and tenant ID. Procedure Change to the directory that contains the installation program and initialize the cluster deployment: USD ./openshift-install create cluster --dir <installation_directory> \ 1 --log-level=info 2 1 For <installation_directory> , specify the location of your customized ./install-config.yaml file. 2 To view different installation details, specify warn , debug , or error instead of info . Verification When the cluster deployment completes successfully: The terminal displays directions for accessing your cluster, including a link to the web console and credentials for the kubeadmin user. Credential information also outputs to <installation_directory>/.openshift_install.log . Important Do not delete the installation program or the files that the installation program creates. Both are required to delete the cluster. Example output ... INFO Install complete! INFO To access the cluster as the system:admin user when using 'oc', run 'export KUBECONFIG=/home/myuser/install_dir/auth/kubeconfig' INFO Access the OpenShift web-console here: https://console-openshift-console.apps.mycluster.example.com INFO Login to the console with user: "kubeadmin", and password: "password" INFO Time elapsed: 36m22s Important The Ignition config files that the installation program generates contain certificates that expire after 24 hours, which are then renewed at that time. If the cluster is shut down before renewing the certificates and the cluster is later restarted after the 24 hours have elapsed, the cluster automatically recovers the expired certificates. The exception is that you must manually approve the pending node-bootstrapper certificate signing requests (CSRs) to recover kubelet certificates. See the documentation for Recovering from expired control plane certificates for more information. It is recommended that you use Ignition config files within 12 hours after they are generated because the 24-hour certificate rotates from 16 to 22 hours after the cluster is installed. By using the Ignition config files within 12 hours, you can avoid installation failure if the certificate update runs during installation. 5.12. Logging in to the cluster by using the CLI You can log in to your cluster as a default system user by exporting the cluster kubeconfig file. The kubeconfig file contains information about the cluster that is used by the CLI to connect a client to the correct cluster and API server. The file is specific to a cluster and is created during OpenShift Container Platform installation. Prerequisites You deployed an OpenShift Container Platform cluster. You installed the oc CLI. Procedure Export the kubeadmin credentials: USD export KUBECONFIG=<installation_directory>/auth/kubeconfig 1 1 For <installation_directory> , specify the path to the directory that you stored the installation files in. Verify you can run oc commands successfully using the exported configuration: USD oc whoami Example output system:admin Additional resources See Accessing the web console for more details about accessing and understanding the OpenShift Container Platform web console. 5.13. Telemetry access for OpenShift Container Platform In OpenShift Container Platform 4.16, the Telemetry service, which runs by default to provide metrics about cluster health and the success of updates, requires internet access. If your cluster is connected to the internet, Telemetry runs automatically, and your cluster is registered to OpenShift Cluster Manager . After you confirm that your OpenShift Cluster Manager inventory is correct, either maintained automatically by Telemetry or manually by using OpenShift Cluster Manager, use subscription watch to track your OpenShift Container Platform subscriptions at the account or multi-cluster level. Additional resources See About remote health monitoring for more information about the Telemetry service 5.14. steps Customize your cluster . If necessary, you can opt out of remote health reporting .	[ "ssh-keygen -t ed25519 -N '' -f <path>/<file_name> 1", "cat <path>/<file_name>.pub", "cat ~/.ssh/id_ed25519.pub", "eval \"USD(ssh-agent -s)\"", "Agent pid 31874", "ssh-add <path>/<file_name> 1", "Identity added: /home/<you>/<path>/<file_name> (<computer_name>)", "az vm image list --all --offer rh-ocp-worker --publisher redhat -o table", "Offer Publisher Sku Urn Version ------------- -------------- ------------------ -------------------------------------------------------------- ----------------- rh-ocp-worker RedHat rh-ocp-worker RedHat:rh-ocp-worker:rh-ocp-worker:4.15.2024072409 4.15.2024072409 rh-ocp-worker RedHat rh-ocp-worker-gen1 RedHat:rh-ocp-worker:rh-ocp-worker-gen1:4.15.2024072409 4.15.2024072409", "az vm image list --all --offer rh-ocp-worker --publisher redhat-limited -o table", "Offer Publisher Sku Urn Version ------------- -------------- ------------------ -------------------------------------------------------------- ----------------- rh-ocp-worker redhat-limited rh-ocp-worker redhat-limited:rh-ocp-worker:rh-ocp-worker:4.15.2024072409 4.15.2024072409 rh-ocp-worker redhat-limited rh-ocp-worker-gen1 redhat-limited:rh-ocp-worker:rh-ocp-worker-gen1:4.15.2024072409 4.15.2024072409", "az vm image show --urn redhat:rh-ocp-worker:rh-ocp-worker:<version>", "az vm image show --urn redhat-limited:rh-ocp-worker:rh-ocp-worker:<version>", "az vm image terms show --urn redhat:rh-ocp-worker:rh-ocp-worker:<version>", "az vm image terms show --urn redhat-limited:rh-ocp-worker:rh-ocp-worker:<version>", "az vm image terms accept --urn redhat:rh-ocp-worker:rh-ocp-worker:<version>", "az vm image terms accept --urn redhat-limited:rh-ocp-worker:rh-ocp-worker:<version>", "apiVersion: v1 baseDomain: example.com compute: - hyperthreading: Enabled name: worker platform: azure: type: Standard_D4s_v5 osImage: publisher: redhat offer: rh-ocp-worker sku: rh-ocp-worker version: 413.92.2023101700 replicas: 3", "tar -xvf openshift-install-linux.tar.gz", "./openshift-install create install-config --dir <installation_directory> 1", "controlPlane: 1 platform: azure: settings: securityType: TrustedLaunch 2 trustedLaunch: uefiSettings: secureBoot: Enabled 3 virtualizedTrustedPlatformModule: Enabled 4", "controlPlane: 1 platform: azure: settings: securityType: ConfidentialVM 2 confidentialVM: uefiSettings: secureBoot: Enabled 3 virtualizedTrustedPlatformModule: Enabled 4 osDisk: securityProfile: securityEncryptionType: VMGuestStateOnly 5", "apiVersion: v1 baseDomain: example.com 1 controlPlane: 2 hyperthreading: Enabled 3 4 name: master platform: azure: encryptionAtHost: true ultraSSDCapability: Enabled osDisk: diskSizeGB: 1024 5 diskType: Premium_LRS diskEncryptionSet: resourceGroup: disk_encryption_set_resource_group name: disk_encryption_set_name subscriptionId: secondary_subscription_id osImage: publisher: example_publisher_name offer: example_image_offer sku: example_offer_sku version: example_image_version type: Standard_D8s_v3 replicas: 3 compute: 6 - hyperthreading: Enabled 7 name: worker platform: azure: ultraSSDCapability: Enabled type: Standard_D2s_v3 encryptionAtHost: true osDisk: diskSizeGB: 512 8 diskType: Standard_LRS diskEncryptionSet: resourceGroup: disk_encryption_set_resource_group name: disk_encryption_set_name subscriptionId: secondary_subscription_id osImage: publisher: example_publisher_name offer: example_image_offer sku: example_offer_sku version: example_image_version zones: 9 - \"1\" - \"2\" - \"3\" replicas: 5 metadata: name: test-cluster 10 networking: clusterNetwork: - cidr: 10.128.0.0/14 hostPrefix: 23 machineNetwork: - cidr: 10.0.0.0/16 networkType: OVNKubernetes 11 serviceNetwork: - 172.30.0.0/16 platform: azure: defaultMachinePlatform: osImage: 12 publisher: example_publisher_name offer: example_image_offer sku: example_offer_sku version: example_image_version ultraSSDCapability: Enabled baseDomainResourceGroupName: resource_group 13 region: centralus 14 resourceGroupName: existing_resource_group 15 outboundType: Loadbalancer cloudName: AzurePublicCloud pullSecret: '{\"auths\": ...}' 16 fips: false 17 sshKey: ssh-ed25519 AAAA... 18", "apiVersion: v1 baseDomain: my.domain.com proxy: httpProxy: http://<username>:<pswd>@<ip>:<port> 1 httpsProxy: https://<username>:<pswd>@<ip>:<port> 2 noProxy: example.com 3 additionalTrustBundle: \| 4 -----BEGIN CERTIFICATE----- <MY_TRUSTED_CA_CERT> -----END CERTIFICATE----- additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> 5", "./openshift-install wait-for install-complete --log-level debug", "additionalTrustBundlePolicy: Proxyonly 1 apiVersion: v1 baseDomain: catchall.azure.devcluster.openshift.com 2 compute: 3 - architecture: amd64 hyperthreading: Enabled 4 name: worker platform: {} replicas: 3 controlPlane: 5 architecture: amd64 hyperthreading: Enabled 6 name: master platform: {} replicas: 3 metadata: creationTimestamp: null name: user 7 networking: clusterNetwork: - cidr: 10.128.0.0/14 hostPrefix: 23 machineNetwork: - cidr: 10.0.0.0/16 networkType: OVNKubernetes 8 serviceNetwork: - 172.30.0.0/16 platform: azure: baseDomainResourceGroupName: os4-common 9 cloudName: AzurePublicCloud 10 outboundType: Loadbalancer region: southindia 11 userTags: 12 createdBy: user environment: dev", "oc get infrastructures.config.openshift.io cluster -o=jsonpath-as-json='{.status.platformStatus.azure.resourceTags}'", "[ [ { \"key\": \"createdBy\", \"value\": \"user\" }, { \"key\": \"environment\", \"value\": \"dev\" } ] ]", "tar xvf <file>", "echo USDPATH", "oc <command>", "C:\\> path", "C:\\> oc <command>", "echo USDPATH", "oc <command>", "apiVersion: v1 baseDomain: example.com credentialsMode: Manual", "openshift-install create manifests --dir <installation_directory>", "RELEASE_IMAGE=USD(./openshift-install version \| awk '/release image/ {print USD3}')", "oc adm release extract --from=USDRELEASE_IMAGE --credentials-requests --included \\ 1 --install-config=<path_to_directory_with_installation_configuration>/install-config.yaml \\ 2 --to=<path_to_directory_for_credentials_requests> 3", "apiVersion: cloudcredential.openshift.io/v1 kind: CredentialsRequest metadata: name: <component_credentials_request> namespace: openshift-cloud-credential-operator spec: providerSpec: apiVersion: cloudcredential.openshift.io/v1 kind: AzureProviderSpec roleBindings: - role: Contributor", "apiVersion: cloudcredential.openshift.io/v1 kind: CredentialsRequest metadata: name: <component_credentials_request> namespace: openshift-cloud-credential-operator spec: providerSpec: apiVersion: cloudcredential.openshift.io/v1 kind: AzureProviderSpec roleBindings: - role: Contributor secretRef: name: <component_secret> namespace: <component_namespace>", "apiVersion: v1 kind: Secret metadata: name: <component_secret> namespace: <component_namespace> data: azure_subscription_id: <base64_encoded_azure_subscription_id> azure_client_id: <base64_encoded_azure_client_id> azure_client_secret: <base64_encoded_azure_client_secret> azure_tenant_id: <base64_encoded_azure_tenant_id> azure_resource_prefix: <base64_encoded_azure_resource_prefix> azure_resourcegroup: <base64_encoded_azure_resourcegroup> azure_region: <base64_encoded_azure_region>", "RELEASE_IMAGE=USD(./openshift-install version \| awk '/release image/ {print USD3}')", "CCO_IMAGE=USD(oc adm release info --image-for='cloud-credential-operator' USDRELEASE_IMAGE -a ~/.pull-secret)", "oc image extract USDCCO_IMAGE --file=\"/usr/bin/ccoctl.<rhel_version>\" \\ 1 -a ~/.pull-secret", "chmod 775 ccoctl.<rhel_version>", "./ccoctl.rhel9", "OpenShift credentials provisioning tool Usage: ccoctl [command] Available Commands: aws Manage credentials objects for AWS cloud azure Manage credentials objects for Azure gcp Manage credentials objects for Google cloud help Help about any command ibmcloud Manage credentials objects for IBM Cloud nutanix Manage credentials objects for Nutanix Flags: -h, --help help for ccoctl Use \"ccoctl [command] --help\" for more information about a command.", "RELEASE_IMAGE=USD(./openshift-install version \| awk '/release image/ {print USD3}')", "oc adm release extract --from=USDRELEASE_IMAGE --credentials-requests --included \\ 1 --install-config=<path_to_directory_with_installation_configuration>/install-config.yaml \\ 2 --to=<path_to_directory_for_credentials_requests> 3", "az login", "ccoctl azure create-all --name=<azure_infra_name> \\ 1 --output-dir=<ccoctl_output_dir> \\ 2 --region=<azure_region> \\ 3 --subscription-id=<azure_subscription_id> \\ 4 --credentials-requests-dir=<path_to_credentials_requests_directory> \\ 5 --dnszone-resource-group-name=<azure_dns_zone_resource_group_name> \\ 6 --tenant-id=<azure_tenant_id> 7", "ls <path_to_ccoctl_output_dir>/manifests", "azure-ad-pod-identity-webhook-config.yaml cluster-authentication-02-config.yaml openshift-cloud-controller-manager-azure-cloud-credentials-credentials.yaml openshift-cloud-network-config-controller-cloud-credentials-credentials.yaml openshift-cluster-api-capz-manager-bootstrap-credentials-credentials.yaml openshift-cluster-csi-drivers-azure-disk-credentials-credentials.yaml openshift-cluster-csi-drivers-azure-file-credentials-credentials.yaml openshift-image-registry-installer-cloud-credentials-credentials.yaml openshift-ingress-operator-cloud-credentials-credentials.yaml openshift-machine-api-azure-cloud-credentials-credentials.yaml", "apiVersion: v1 baseDomain: example.com credentialsMode: Manual", "apiVersion: v1 baseDomain: example.com platform: azure: resourceGroupName: <azure_infra_name> 1", "openshift-install create manifests --dir <installation_directory>", "cp /<path_to_ccoctl_output_dir>/manifests/* ./manifests/", "cp -a /<path_to_ccoctl_output_dir>/tls .", "./openshift-install create cluster --dir <installation_directory> \\ 1 --log-level=info 2", "INFO Install complete! INFO To access the cluster as the system:admin user when using 'oc', run 'export KUBECONFIG=/home/myuser/install_dir/auth/kubeconfig' INFO Access the OpenShift web-console here: https://console-openshift-console.apps.mycluster.example.com INFO Login to the console with user: \"kubeadmin\", and password: \"password\" INFO Time elapsed: 36m22s", "export KUBECONFIG=<installation_directory>/auth/kubeconfig 1", "oc whoami", "system:admin" ]	https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/installing_on_azure/installing-azure-customizations
Chapter 1. Security APIs	Chapter 1. Security APIs 1.1. CertificateSigningRequest [certificates.k8s.io/v1] Description CertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request, and having it asynchronously approved and issued. Kubelets use this API to obtain: 1. client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client-kubelet" signerName). 2. serving certificates for TLS endpoints kube-apiserver can connect to securely (with the "kubernetes.io/kubelet-serving" signerName). This API can be used to request client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client" signerName), or to obtain certificates from custom non-Kubernetes signers. Type object 1.2. CredentialsRequest [cloudcredential.openshift.io/v1] Description CredentialsRequest is the Schema for the credentialsrequests API Type object 1.3. PodSecurityPolicyReview [security.openshift.io/v1] Description PodSecurityPolicyReview checks which service accounts (not users, since that would be cluster-wide) can create the PodTemplateSpec in question. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). Type object 1.4. PodSecurityPolicySelfSubjectReview [security.openshift.io/v1] Description PodSecurityPolicySelfSubjectReview checks whether this user/SA tuple can create the PodTemplateSpec Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). Type object 1.5. PodSecurityPolicySubjectReview [security.openshift.io/v1] Description PodSecurityPolicySubjectReview checks whether a particular user/SA tuple can create the PodTemplateSpec. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). Type object 1.6. RangeAllocation [security.openshift.io/v1] Description RangeAllocation is used so we can easily expose a RangeAllocation typed for security group Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. Type object 1.7. Secret [v1] Description Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes. Type object 1.8. SecurityContextConstraints [security.openshift.io/v1] Description SecurityContextConstraints governs the ability to make requests that affect the SecurityContext that will be applied to a container. For historical reasons SCC was exposed under the core Kubernetes API group. That exposure is deprecated and will be removed in a future release - users should instead use the security.openshift.io group to manage SecurityContextConstraints. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). Type object 1.9. ServiceAccount [v1] Description ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets Type object	null	https://docs.redhat.com/en/documentation/openshift_container_platform/4.12/html/security_apis/security-apis
Chapter 7. Kafka Streams configuration properties	Chapter 7. Kafka Streams configuration properties application.id Type: string Importance: high An identifier for the stream processing application. Must be unique within the Kafka cluster. It is used as 1) the default client-id prefix, 2) the group-id for membership management, 3) the changelog topic prefix. bootstrap.servers Type: list Importance: high A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping-this list only impacts the initial hosts used to discover the full set of servers. This list should be in the form host1:port1,host2:port2,... . Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down). num.standby.replicas Type: int Default: 0 Importance: high The number of standby replicas for each task. state.dir Type: string Default: /tmp/kafka-streams Importance: high Directory location for state store. This path must be unique for each streams instance sharing the same underlying filesystem. acceptable.recovery.lag Type: long Default: 10000 Valid Values: [0,... ] Importance: medium The maximum acceptable lag (number of offsets to catch up) for a client to be considered caught-up enough to receive an active task assignment. Upon assignment, it will still restore the rest of the changelog before processing. To avoid a pause in processing during rebalances, this config should correspond to a recovery time of well under a minute for a given workload. Must be at least 0. cache.max.bytes.buffering Type: long Default: 10485760 Valid Values: [0,... ] Importance: medium Maximum number of memory bytes to be used for buffering across all threads. client.id Type: string Default: "" Importance: medium An ID prefix string used for the client IDs of internal [main-\|restore-\|global-]consumer, producer, and admin clients with pattern <client.id>-[Global]StreamThread[-<threadSequenceNumberUSDgt;]-<consumer\|producer\|restore-consumer\|global-consumer> . default.deserialization.exception.handler Type: class Default: org.apache.kafka.streams.errors.LogAndFailExceptionHandler Importance: medium Exception handling class that implements the org.apache.kafka.streams.errors.DeserializationExceptionHandler interface. default.key.serde Type: class Default: null Importance: medium Default serializer / deserializer class for key that implements the org.apache.kafka.common.serialization.Serde interface. Note when windowed serde class is used, one needs to set the inner serde class that implements the org.apache.kafka.common.serialization.Serde interface via 'default.windowed.key.serde.inner' or 'default.windowed.value.serde.inner' as well. default.list.key.serde.inner Type: class Default: null Importance: medium Default inner class of list serde for key that implements the org.apache.kafka.common.serialization.Serde interface. This configuration will be read if and only if default.key.serde configuration is set to org.apache.kafka.common.serialization.Serdes.ListSerde . default.list.key.serde.type Type: class Default: null Importance: medium Default class for key that implements the java.util.List interface. This configuration will be read if and only if default.key.serde configuration is set to org.apache.kafka.common.serialization.Serdes.ListSerde Note when list serde class is used, one needs to set the inner serde class that implements the org.apache.kafka.common.serialization.Serde interface via 'default.list.key.serde.inner'. default.list.value.serde.inner Type: class Default: null Importance: medium Default inner class of list serde for value that implements the org.apache.kafka.common.serialization.Serde interface. This configuration will be read if and only if default.value.serde configuration is set to org.apache.kafka.common.serialization.Serdes.ListSerde . default.list.value.serde.type Type: class Default: null Importance: medium Default class for value that implements the java.util.List interface. This configuration will be read if and only if default.value.serde configuration is set to org.apache.kafka.common.serialization.Serdes.ListSerde Note when list serde class is used, one needs to set the inner serde class that implements the org.apache.kafka.common.serialization.Serde interface via 'default.list.value.serde.inner'. default.production.exception.handler Type: class Default: org.apache.kafka.streams.errors.DefaultProductionExceptionHandler Importance: medium Exception handling class that implements the org.apache.kafka.streams.errors.ProductionExceptionHandler interface. default.timestamp.extractor Type: class Default: org.apache.kafka.streams.processor.FailOnInvalidTimestamp Importance: medium Default timestamp extractor class that implements the org.apache.kafka.streams.processor.TimestampExtractor interface. default.value.serde Type: class Default: null Importance: medium Default serializer / deserializer class for value that implements the org.apache.kafka.common.serialization.Serde interface. Note when windowed serde class is used, one needs to set the inner serde class that implements the org.apache.kafka.common.serialization.Serde interface via 'default.windowed.key.serde.inner' or 'default.windowed.value.serde.inner' as well. max.task.idle.ms Type: long Default: 0 Importance: medium This config controls whether joins and merges may produce out-of-order results. The config value is the maximum amount of time in milliseconds a stream task will stay idle when it is fully caught up on some (but not all) input partitions to wait for producers to send additional records and avoid potential out-of-order record processing across multiple input streams. The default (zero) does not wait for producers to send more records, but it does wait to fetch data that is already present on the brokers. This default means that for records that are already present on the brokers, Streams will process them in timestamp order. Set to -1 to disable idling entirely and process any locally available data, even though doing so may produce out-of-order processing. max.warmup.replicas Type: int Default: 2 Valid Values: [1,... ] Importance: medium The maximum number of warmup replicas (extra standbys beyond the configured num.standbys) that can be assigned at once for the purpose of keeping the task available on one instance while it is warming up on another instance it has been reassigned to. Used to throttle how much extra broker traffic and cluster state can be used for high availability. Must be at least 1.Note that one warmup replica corresponds to one Stream Task. Furthermore, note that each warmup replica can only be promoted to an active task during a rebalance (normally during a so-called probing rebalance, which occur at a frequency specified by the probing.rebalance.interval.ms config). This means that the maximum rate at which active tasks can be migrated from one Kafka Streams Instance to another instance can be determined by ( max.warmup.replicas / probing.rebalance.interval.ms ). num.stream.threads Type: int Default: 1 Importance: medium The number of threads to execute stream processing. processing.guarantee Type: string Default: at_least_once Valid Values: [at_least_once, exactly_once, exactly_once_beta, exactly_once_v2] Importance: medium The processing guarantee that should be used. Possible values are at_least_once (default) and exactly_once_v2 (requires brokers version 2.5 or higher). Deprecated options are exactly_once (requires brokers version 0.11.0 or higher) and exactly_once_beta (requires brokers version 2.5 or higher). Note that exactly-once processing requires a cluster of at least three brokers by default what is the recommended setting for production; for development you can change this, by adjusting broker setting transaction.state.log.replication.factor and transaction.state.log.min.isr . rack.aware.assignment.non_overlap_cost Type: int Default: null Importance: medium Cost associated with moving tasks from existing assignment. This config and rack.aware.assignment.traffic_cost controls whether the optimization algorithm favors minimizing cross rack traffic or minimize the movement of tasks in existing assignment. If set a larger value org.apache.kafka.streams.processor.internals.assignment.RackAwareTaskAssignor will optimize to maintain the existing assignment. The default value is null which means it will use default non_overlap cost values in different assignors. rack.aware.assignment.strategy Type: string Default: none Valid Values: [none, min_traffic, balance_subtopology] Importance: medium The strategy we use for rack aware assignment. Rack aware assignment will take client.rack and racks of TopicPartition into account when assigning tasks to minimize cross rack traffic. Valid settings are : none (default), which will disable rack aware assignment; min_traffic , which will compute minimum cross rack traffic assignment; balance_subtopology , which will compute minimum cross rack traffic and try to balance the tasks of same subtopolgies across different clients. rack.aware.assignment.tags Type: list Default: "" Valid Values: List containing maximum of 5 elements Importance: medium List of client tag keys used to distribute standby replicas across Kafka Streams instances. When configured, Kafka Streams will make a best-effort to distribute the standby tasks over each client tag dimension. rack.aware.assignment.traffic_cost Type: int Default: null Importance: medium Cost associated with cross rack traffic. This config and rack.aware.assignment.non_overlap_cost controls whether the optimization algorithm favors minimizing cross rack traffic or minimize the movement of tasks in existing assignment. If set a larger value org.apache.kafka.streams.processor.internals.assignment.RackAwareTaskAssignor will optimize for minimizing cross rack traffic. The default value is null which means it will use default traffic cost values in different assignors. replication.factor Type: int Default: -1 Importance: medium The replication factor for change log topics and repartition topics created by the stream processing application. The default of -1 (meaning: use broker default replication factor) requires broker version 2.4 or newer. security.protocol Type: string Default: PLAINTEXT Valid Values: (case insensitive) [SASL_SSL, PLAINTEXT, SSL, SASL_PLAINTEXT] Importance: medium Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL. statestore.cache.max.bytes Type: long Default: 10485760 (10 mebibytes) Valid Values: [0,... ] Importance: medium Maximum number of memory bytes to be used for statestore cache across all threads. task.timeout.ms Type: long Default: 300000 (5 minutes) Valid Values: [0,... ] Importance: medium The maximum amount of time in milliseconds a task might stall due to internal errors and retries until an error is raised. For a timeout of 0ms, a task would raise an error for the first internal error. For any timeout larger than 0ms, a task will retry at least once before an error is raised. topology.optimization Type: string Default: none Valid Values: org.apache.kafka.streams.StreamsConfigUSDUSDLambdaUSD31/0x00007f269c00d000@7e32c033 Importance: medium A configuration telling Kafka Streams if it should optimize the topology and what optimizations to apply. Acceptable values are: "NO_OPTIMIZATION", "OPTIMIZE", or a comma separated list of specific optimizations: ("REUSE_KTABLE_SOURCE_TOPICS", "MERGE_REPARTITION_TOPICS" + "SINGLE_STORE_SELF_JOIN+")."NO_OPTIMIZATION" by default. application.server Type: string Default: "" Importance: low A host:port pair pointing to a user-defined endpoint that can be used for state store discovery and interactive queries on this KafkaStreams instance. auto.include.jmx.reporter Type: boolean Default: true Importance: low Deprecated. Whether to automatically include JmxReporter even if it's not listed in metric.reporters . This configuration will be removed in Kafka 4.0, users should instead include org.apache.kafka.common.metrics.JmxReporter in metric.reporters in order to enable the JmxReporter. buffered.records.per.partition Type: int Default: 1000 Importance: low Maximum number of records to buffer per partition. built.in.metrics.version Type: string Default: latest Valid Values: [latest] Importance: low Version of the built-in metrics to use. commit.interval.ms Type: long Default: 30000 (30 seconds) Valid Values: [0,... ] Importance: low The frequency in milliseconds with which to commit processing progress. For at-least-once processing, committing means to save the position (ie, offsets) of the processor. For exactly-once processing, it means to commit the transaction which includes to save the position and to make the committed data in the output topic visible to consumers with isolation level read_committed. (Note, if processing.guarantee is set to exactly_once_v2 , exactly_once ,the default value is 100 , otherwise the default value is 30000 . connections.max.idle.ms Type: long Default: 540000 (9 minutes) Importance: low Close idle connections after the number of milliseconds specified by this config. default.client.supplier Type: class Default: org.apache.kafka.streams.processor.internals.DefaultKafkaClientSupplier Importance: low Client supplier class that implements the org.apache.kafka.streams.KafkaClientSupplier interface. default.dsl.store Type: string Default: rocksDB Valid Values: [rocksDB, in_memory] Importance: low The default state store type used by DSL operators. dsl.store.suppliers.class Type: class Default: org.apache.kafka.streams.state.BuiltInDslStoreSuppliersUSDRocksDBDslStoreSuppliers Importance: low Defines which store implementations to plug in to DSL operators. Must implement the org.apache.kafka.streams.state.DslStoreSuppliers interface. enable.metrics.push Type: boolean Default: true Importance: low Whether to enable pushing of internal [main-\|restore-\|global]consumer, producer, and admin client metrics to the cluster, if the cluster has a client metrics subscription which matches a client. metadata.max.age.ms Type: long Default: 300000 (5 minutes) Valid Values: [0,... ] Importance: low The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions. metric.reporters Type: list Default: "" Importance: low A list of classes to use as metrics reporters. Implementing the org.apache.kafka.common.metrics.MetricsReporter interface allows plugging in classes that will be notified of new metric creation. The JmxReporter is always included to register JMX statistics. metrics.num.samples Type: int Default: 2 Valid Values: [1,... ] Importance: low The number of samples maintained to compute metrics. metrics.recording.level Type: string Default: INFO Valid Values: [INFO, DEBUG, TRACE] Importance: low The highest recording level for metrics. metrics.sample.window.ms Type: long Default: 30000 (30 seconds) Valid Values: [0,... ] Importance: low The window of time a metrics sample is computed over. poll.ms Type: long Default: 100 Importance: low The amount of time in milliseconds to block waiting for input. probing.rebalance.interval.ms Type: long Default: 600000 (10 minutes) Valid Values: [60000,... ] Importance: low The maximum time in milliseconds to wait before triggering a rebalance to probe for warmup replicas that have finished warming up and are ready to become active. Probing rebalances will continue to be triggered until the assignment is balanced. Must be at least 1 minute. receive.buffer.bytes Type: int Default: 32768 (32 kibibytes) Valid Values: [-1,... ] Importance: low The size of the TCP receive buffer (SO_RCVBUF) to use when reading data. If the value is -1, the OS default will be used. reconnect.backoff.max.ms Type: long Default: 1000 (1 second) Valid Values: [0,... ] Importance: low The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect. If provided, the backoff per host will increase exponentially for each consecutive connection failure, up to this maximum. After calculating the backoff increase, 20% random jitter is added to avoid connection storms. reconnect.backoff.ms Type: long Default: 50 Valid Values: [0,... ] Importance: low The base amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all connection attempts by the client to a broker. This value is the initial backoff value and will increase exponentially for each consecutive connection failure, up to the reconnect.backoff.max.ms value. repartition.purge.interval.ms Type: long Default: 30000 (30 seconds) Valid Values: [0,... ] Importance: low The frequency in milliseconds with which to delete fully consumed records from repartition topics. Purging will occur after at least this value since the last purge, but may be delayed until later. (Note, unlike commit.interval.ms , the default for this value remains unchanged when processing.guarantee is set to exactly_once_v2 ). request.timeout.ms Type: int Default: 40000 (40 seconds) Valid Values: [0,... ] Importance: low The configuration controls the maximum amount of time the client will wait for the response of a request. If the response is not received before the timeout elapses the client will resend the request if necessary or fail the request if retries are exhausted. retries Type: int Default: 0 Valid Values: [0,... ,2147483647] Importance: low Setting a value greater than zero will cause the client to resend any request that fails with a potentially transient error. It is recommended to set the value to either zero or MAX_VALUE and use corresponding timeout parameters to control how long a client should retry a request. retry.backoff.ms Type: long Default: 100 Valid Values: [0,... ] Importance: low The amount of time to wait before attempting to retry a failed request to a given topic partition. This avoids repeatedly sending requests in a tight loop under some failure scenarios. This value is the initial backoff value and will increase exponentially for each failed request, up to the retry.backoff.max.ms value. rocksdb.config.setter Type: class Default: null Importance: low A Rocks DB config setter class or class name that implements the org.apache.kafka.streams.state.RocksDBConfigSetter interface. send.buffer.bytes Type: int Default: 131072 (128 kibibytes) Valid Values: [-1,... ] Importance: low The size of the TCP send buffer (SO_SNDBUF) to use when sending data. If the value is -1, the OS default will be used. state.cleanup.delay.ms Type: long Default: 600000 (10 minutes) Importance: low The amount of time in milliseconds to wait before deleting state when a partition has migrated. Only state directories that have not been modified for at least state.cleanup.delay.ms will be removed. upgrade.from Type: string Default: null Valid Values: [null, 0.10.0, 0.10.1, 0.10.2, 0.11.0, 1.0, 1.1, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6] Importance: low Allows upgrading in a backward compatible way. This is needed when upgrading from [0.10.0, 1.1] to 2.0+, or when upgrading from [2.0, 2.3] to 2.4+. When upgrading from 3.3 to a newer version it is not required to specify this config. Default is null . Accepted values are "0.10.0", "0.10.1", "0.10.2", "0.11.0", "1.0", "1.1", "2.0", "2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7", "2.8", "3.0", "3.1", "3.2", "3.3", "3.4", "3.5", "3.6(for upgrading from the corresponding old version). window.size.ms Type: long Default: null Importance: low Sets window size for the deserializer in order to calculate window end times. windowed.inner.class.serde Type: string Default: null Importance: low Default serializer / deserializer for the inner class of a windowed record. Must implement the org.apache.kafka.common.serialization.Serde interface. Note that setting this config in KafkaStreams application would result in an error as it is meant to be used only from Plain consumer client. windowstore.changelog.additional.retention.ms Type: long Default: 86400000 (1 day) Importance: low Added to a windows maintainMs to ensure data is not deleted from the log prematurely. Allows for clock drift. Default is 1 day.	null	https://docs.redhat.com/en/documentation/red_hat_streams_for_apache_kafka/2.7/html/kafka_configuration_properties/kafka-streams-configuration-properties-str
8.11. Scanning and Remediating Configuration Compliance of Container Images and Containers Using atomic scan	8.11. Scanning and Remediating Configuration Compliance of Container Images and Containers Using atomic scan 8.11.1. Scanning for Configuration Compliance of Container Images and Containers Using atomic scan Use this type of scanning to evaluate Red Hat Enterprise Linux-based container images and containers with the SCAP content provided by the SCAP Security Guide (SSG) bundled inside the OpenSCAP container image. This enables scanning against any profile provided by the SCAP Security Guide. Warning The atomic scan functionality is deprecated, and the OpenSCAP container image is no longer updated with the new security compliance content. Therefore, prefer the oscap-docker utility for security compliance scanning purposes. Note For a detailed description of the usage of the atomic command and containers, see the Product Documentation for Red Hat Enterprise Linux Atomic Host 7 . The Red Hat Customer Portal also provides a guide to the atomic command-line interface (CLI) . Prerequisites You have downloaded and installed the OpenSCAP container image from Red Hat Container Catalog (RHCC) using the atomic install rhel7/openscap command. Procedure List SCAP content provided by the OpenSCAP image for the configuration_compliance scan: Verify compliance of the latest Red Hat Enterprise Linux 7 container image with the Defense Information Systems Agency Security Technical Implementation Guide (DISA STIG) policy and generate an HTML report from the scan: The output of the command contains the information about files associated with the scan at the end: The atomic scan generates a subdirectory with all the results and reports from a scan in the /var/lib/atomic/openscap/ directory. The arf.xml file with results is generated on every scanning for configuration compliance. To generate a human-readable HTML report file, add the report suboption to the --scanner_args option. Optional: To generate XCCDF results readable by DISA STIG Viewer , add the stig-viewer suboption to the --scanner_args option. The results are placed in stig.xml . Note When the xccdf-id suboption of the --scanner_args option is omitted, the scanner searches for a profile in the first XCCDF component of the selected data stream file. For more details about data stream files, see Section 8.3.1, "Configuration Compliance in RHEL 7" . 8.11.2. Remediating Configuration Compliance of Container Images and Containers Using atomic scan You can run the configuration compliance scan against the original container image to check its compliance with the DISA STIG policy. Based on the scan results, a fix script containing bash remediations for the failed scan results is generated. The fix script is then applied to the original container image - this is called a remediation. The remediation results in a container image with an altered configuration, which is added as a new layer on top of the original container image. Important Note that the original container image remains unchanged and only a new layer is created on top of it. The remediation process builds a new container image that contains all the configuration improvements. The content of this layer is defined by the security policy of scanning - in the case, the DISA STIG policy. This also means that the remediated container image is no longer signed by Red Hat, which is expected, because it differs from the original container image by containing the remediated layer. Warning The atomic scan functionality is deprecated, and the OpenSCAP container image is no longer updated with the new security compliance content. Therefore, prefer the oscap-docker utility for security compliance scanning purposes. Prerequisites You have downloaded and installed the OpenSCAP container image from Red Hat Container Catalog (RHCC) using the atomic install rhel7/openscap command. Procedure List SCAP content provided by the OpenSCAP image for the configuration_compliance scan: To remediate container images to the specified policy, add the --remediate option to the atomic scan command when scanning for configuration compliance. The following command builds a new remediated container image compliant with the DISA STIG policy from the Red Hat Enterprise Linux 7 container image: Optional: The output of the atomic scan command reports a remediated image ID. To make the image easier to remember, tag it with some name, for example:	[ "~]# atomic help registry.access.redhat.com/rhel7/openscap", "~]# atomic scan --scan_type configuration_compliance --scanner_args xccdf-id= scap_org.open-scap_cref_ssg-rhel7-xccdf-1.2.xml , profile= xccdf_org.ssgproject.content_profile_stig-rhel7-disa , report registry.access.redhat.com/rhel7:latest", "......... Files associated with this scan are in /var/lib/atomic/openscap/2017-11-03-13-35-34-296606. ~]# tree /var/lib/atomic/openscap/2017-11-03-13-35-34-296606 /var/lib/atomic/openscap/2017-11-03-13-35-34-296606 ├── db7a70a0414e589d7c8c162712b329d4fc670fa47ddde721250fb9fcdbed9cc2 │ ├── arf.xml │ ├── fix.sh │ ├── json │ └── report.html └── environment.json 1 directory, 5 files", "~]# atomic help registry.access.redhat.com/rhel7/openscap", "~]# atomic scan --remediate --scan_type configuration_compliance --scanner_args profile= xccdf_org.ssgproject.content_profile_stig-rhel7-disa , report registry.access.redhat.com/rhel7:latest registry.access.redhat.com/rhel7:latest (db7a70a0414e589) The following issues were found: ......... Configure Time Service Maxpoll Interval Severity: Low XCCDF result: fail Configure LDAP Client to Use TLS For All Transactions Severity: Moderate XCCDF result: fail ......... Remediating rule 43/44: 'xccdf_org.ssgproject.content_rule_chronyd_or_ntpd_set_maxpoll' Remediating rule 44/44: 'xccdf_org.ssgproject.content_rule_ldap_client_start_tls' Successfully built 9bbc7083760e Successfully built remediated image 9bbc7083760e from db7a70a0414e589d7c8c162712b329d4fc670fa47ddde721250fb9fcdbed9cc2. Files associated with this scan are in /var/lib/atomic/openscap/2017-11-06-13-01-42-785000.", "~]# docker tag 9bbc7083760e rhel7_disa_stig" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/security_guide/scanning-and-remediating-configuration-compliance-images-containers-atomic_assessing-security-compliance-container-image-baseline_scanning-compliance-and-vulnerabilities
CI/CD overview	CI/CD overview OpenShift Container Platform 4.18 Contains information about CI/CD for OpenShift Container Platform Red Hat OpenShift Documentation Team	null	https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/cicd_overview/index
Chapter 17. KubeAPIServer [operator.openshift.io/v1]	Chapter 17. KubeAPIServer [operator.openshift.io/v1] Description KubeAPIServer provides information to configure an operator to manage kube-apiserver. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). Type object Required spec 17.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's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata spec object spec is the specification of the desired behavior of the Kubernetes API Server status object status is the most recently observed status of the Kubernetes API Server 17.1.1. .spec Description spec is the specification of the desired behavior of the Kubernetes API Server Type object Property Type Description failedRevisionLimit integer failedRevisionLimit is the number of failed static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default) forceRedeploymentReason string forceRedeploymentReason can be used to force the redeployment of the operand by providing a unique string. This provides a mechanism to kick a previously failed deployment and provide a reason why you think it will work this time instead of failing again on the same config. logLevel string logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal". managementState string managementState indicates whether and how the operator should manage the component observedConfig `` observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator operatorLogLevel string operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal". succeededRevisionLimit integer succeededRevisionLimit is the number of successful static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default) unsupportedConfigOverrides `` unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster. 17.1.2. .status Description status is the most recently observed status of the Kubernetes API Server Type object Property Type Description conditions array conditions is a list of conditions and their status conditions[] object OperatorCondition is just the standard condition fields. generations array generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction. generations[] object GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made. latestAvailableRevision integer latestAvailableRevision is the deploymentID of the most recent deployment latestAvailableRevisionReason string latestAvailableRevisionReason describe the detailed reason for the most recent deployment nodeStatuses array nodeStatuses track the deployment values and errors across individual nodes nodeStatuses[] object NodeStatus provides information about the current state of a particular node managed by this operator. observedGeneration integer observedGeneration is the last generation change you've dealt with readyReplicas integer readyReplicas indicates how many replicas are ready and at the desired state serviceAccountIssuers array serviceAccountIssuers tracks history of used service account issuers. The item without expiration time represents the currently used service account issuer. The other items represents service account issuers that were used previously and are still being trusted. The default expiration for the items is set by the platform and it defaults to 24h. see: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#service-account-token-volume-projection serviceAccountIssuers[] object version string version is the level this availability applies to 17.1.3. .status.conditions Description conditions is a list of conditions and their status Type array 17.1.4. .status.conditions[] Description OperatorCondition is just the standard condition fields. Type object Property Type Description lastTransitionTime string message string reason string status string type string 17.1.5. .status.generations Description generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction. Type array 17.1.6. .status.generations[] Description GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made. Type object Property Type Description group string group is the group of the thing you're tracking hash string hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps lastGeneration integer lastGeneration is the last generation of the workload controller involved name string name is the name of the thing you're tracking namespace string namespace is where the thing you're tracking is resource string resource is the resource type of the thing you're tracking 17.1.7. .status.nodeStatuses Description nodeStatuses track the deployment values and errors across individual nodes Type array 17.1.8. .status.nodeStatuses[] Description NodeStatus provides information about the current state of a particular node managed by this operator. Type object Property Type Description currentRevision integer currentRevision is the generation of the most recently successful deployment lastFailedCount integer lastFailedCount is how often the installer pod of the last failed revision failed. lastFailedReason string lastFailedReason is a machine readable failure reason string. lastFailedRevision integer lastFailedRevision is the generation of the deployment we tried and failed to deploy. lastFailedRevisionErrors array (string) lastFailedRevisionErrors is a list of human readable errors during the failed deployment referenced in lastFailedRevision. lastFailedTime string lastFailedTime is the time the last failed revision failed the last time. lastFallbackCount integer lastFallbackCount is how often a fallback to a revision happened. nodeName string nodeName is the name of the node targetRevision integer targetRevision is the generation of the deployment we're trying to apply 17.1.9. .status.serviceAccountIssuers Description serviceAccountIssuers tracks history of used service account issuers. The item without expiration time represents the currently used service account issuer. The other items represents service account issuers that were used previously and are still being trusted. The default expiration for the items is set by the platform and it defaults to 24h. see: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#service-account-token-volume-projection Type array 17.1.10. .status.serviceAccountIssuers[] Description Type object Property Type Description expirationTime string expirationTime is the time after which this service account issuer will be pruned and removed from the trusted list of service account issuers. name string name is the name of the service account issuer --- 17.2. API endpoints The following API endpoints are available: /apis/operator.openshift.io/v1/kubeapiservers DELETE : delete collection of KubeAPIServer GET : list objects of kind KubeAPIServer POST : create a KubeAPIServer /apis/operator.openshift.io/v1/kubeapiservers/{name} DELETE : delete a KubeAPIServer GET : read the specified KubeAPIServer PATCH : partially update the specified KubeAPIServer PUT : replace the specified KubeAPIServer /apis/operator.openshift.io/v1/kubeapiservers/{name}/status GET : read status of the specified KubeAPIServer PATCH : partially update status of the specified KubeAPIServer PUT : replace status of the specified KubeAPIServer 17.2.1. /apis/operator.openshift.io/v1/kubeapiservers HTTP method DELETE Description delete collection of KubeAPIServer Table 17.1. HTTP responses HTTP code Reponse body 200 - OK Status schema 401 - Unauthorized Empty HTTP method GET Description list objects of kind KubeAPIServer Table 17.2. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServerList schema 401 - Unauthorized Empty HTTP method POST Description create a KubeAPIServer Table 17.3. 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 17.4. Body parameters Parameter Type Description body KubeAPIServer schema Table 17.5. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServer schema 201 - Created KubeAPIServer schema 202 - Accepted KubeAPIServer schema 401 - Unauthorized Empty 17.2.2. /apis/operator.openshift.io/v1/kubeapiservers/{name} Table 17.6. Global path parameters Parameter Type Description name string name of the KubeAPIServer HTTP method DELETE Description delete a KubeAPIServer Table 17.7. 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 17.8. HTTP responses HTTP code Reponse body 200 - OK Status schema 202 - Accepted Status schema 401 - Unauthorized Empty HTTP method GET Description read the specified KubeAPIServer Table 17.9. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServer schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified KubeAPIServer Table 17.10. 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 17.11. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServer schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified KubeAPIServer Table 17.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 17.13. Body parameters Parameter Type Description body KubeAPIServer schema Table 17.14. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServer schema 201 - Created KubeAPIServer schema 401 - Unauthorized Empty 17.2.3. /apis/operator.openshift.io/v1/kubeapiservers/{name}/status Table 17.15. Global path parameters Parameter Type Description name string name of the KubeAPIServer HTTP method GET Description read status of the specified KubeAPIServer Table 17.16. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServer schema 401 - Unauthorized Empty HTTP method PATCH Description partially update status of the specified KubeAPIServer Table 17.17. 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 17.18. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServer schema 401 - Unauthorized Empty HTTP method PUT Description replace status of the specified KubeAPIServer Table 17.19. 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 17.20. Body parameters Parameter Type Description body KubeAPIServer schema Table 17.21. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServer schema 201 - Created KubeAPIServer schema 401 - Unauthorized Empty	null	https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/operator_apis/kubeapiserver-operator-openshift-io-v1
Making open source more inclusive	Making open source more inclusive Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright's message .	null	https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.18/html/monitoring_openshift_data_foundation/making-open-source-more-inclusive
Chapter 3. Red Hat support for cloud-init	Chapter 3. Red Hat support for cloud-init Red Hat supports the cloud-init utility, cloud-init modules, and default directories and files across various Red Hat products. 3.1. cloud-init significant directories and files By using directories and files in the following table, you can perform tasks such as: Configuring cloud-init Finding information about your configuration after cloud-init has run Examining log files Finding templates Depending on your scenario and datasource, there can be additional files and directories important to your configuration. Table 3.1. cloud-init directories and files Directory or File Description /etc/cloud/cloud.cfg The cloud.cfg file includes the basic cloud-init configuration and lets you know in what phase each module runs. /etc/cloud/cloud.cfg.d The cloud.cfg.d directory is where you can add additional directives for cloud-init . /var/lib/cloud When cloud-init runs, it creates a directory layout under /var/lib/cloud . The layout includes directories and files that give specifics on your instance configuration. /usr/share/doc/cloud-init/examples The examples directory includes multiple examples. You can use them to help model your own directives. /etc/cloud/templates This directory includes templates that you can enable in cloud-init for certain scenarios. The templates provide direction for enabling. /var/log/cloud-init.log The cloud-init.log file provides log information helpful for debugging. /run/cloud-init The /run/cloud-init directory includes logged information about your datasource and the ds-identify script. 3.2. Red Hat products that use cloud-init You can use cloud-init with these Red Hat products: Red Hat Virtualization. Once you install cloud-init on a VM, you can create a template and leverage cloud-init functions for all VMs created from that template. Refer to Using Cloud-Init to Automate the Configuration of Virtual Machines for information about using cloud-init with VMs. Red Hat OpenStack Platform. You can use cloud-init to help configure images for OpenStack. Refer to the Instances and Images Guide for more information. Red Hat Satellite. You can use cloud-init with Red Hat Satellite. Refer to Preparing Cloud-init Images in Red Hat Virtualization for more information. Red Hat OpenShift. You can use cloud-init when you create VMs for OpenShift. Refer to Creating Virtual Machines for more information. 3.3. Red Hat supports these cloud-init modules Red Hat supports most cloud-init modules. Individual modules can contain multiple configuration options. In the following table, you can find all of the cloud-init modules that Red Hat currently supports and provides a brief description and the default module frequency. Refer to Modules in the cloud-init Documentation section for complete descriptions and options for these modules. Table 3.2. Supported cloud-init modules cloud-init Module Description Default Module Frequency bootcmd Runs commands early in the boot process per always ca_certs Adds CA certificates per instance debug Enables or disables output of internal information to assist with debugging per instance disable_ec2_metadata Enables or disables the AWS EC2 metadata per always disk_setup Configures simple partition tables and file systems per instance final_message Specifies the output message once cloud-init completes per always foo Example shows module structure (Module does nothing) per instance growpart Resizes partitions to fill the available disk space per always keys_to_console Allows controls of fingerprints and keys that can be written to the console per instance landscape Installs and configures a landscape client per instance locale Configures the system locale and applies it system-wide per instance mcollective Installs, configures, and starts mcollective per instance migrator Moves old versions of cloud-init to newer versions per always mounts Configures mount points and swap files per instance phone_home Posts data to a remote host after boot completes per instance power_state_change Completes shutdown and reboot after all configuration modules have run per instance puppet Installs and configures puppet per instance resizefs Resizes a file system to use all available space on a partition per always resolv_conf Configures resolv.conf per instance rh_subscription Registers a Red Hat Enterprise Linux system per instance rightscale_userdata Adds support for RightScale configuration hooks to cloud-init per instance rsyslog Configures remote system logging using rsyslog per instance runcmd Runs arbitrary commands per instance salt_minion Installs, configures, and starts salt minion per instance scripts_per_boot Runs per boot scripts per always scripts_per_instance Runs per instance scripts per instance scripts_per_once Runs scripts once per once scripts_user Runs user scripts per instance scripts_vendor Runs vendor scripts per instance seed_random Provides random seed data per instance set_hostname Sets host name and fully qualified domain name (FQDN) per always set_passwords Sets user passwords and enables or disables SSH password authentication per instance ssh_authkey_fingerprints Logs fingerprints of user SSH keys per instance ssh_import_id Imports SSH keys per instance ssh Configures SSH, and host and authorized SSH keys per instance timezone Sets the system time zone per instance update_etc_hosts Updates /etc/hosts per always update_hostname Updates host name and FQDN per always users_groups Configures users and groups per instance write_files Writes arbitrary files per instance yum_add_repo Adds yum repository configuration to the system per always The following list of modules is not supported by Red Hat: Table 3.3. Modules not supported Module apt_configure apt_pipeline byobu chef emit_upstart grub_dpkg ubuntu_init_switch 3.4. The default cloud.cfg file The /etc/cloud/cloud.cfg file lists the modules comprising the basic configuration for cloud-init . The modules in the file are the default modules for cloud-init . You can configure the modules for your environment or remove modules you do not need. Modules that are included in cloud.cfg do not necessarily do anything by being listed in the file. You need to configure them individually if you want them to perform actions during one of the cloud-init phases. The cloud.cfg file provides the chronology for running individual modules. You can add additional modules to cloud.cfg as long as Red Hat supports the modules you want to add. The default contents of the file for Red Hat Enterprise Linux (RHEL) are as follows: Note Modules run in the order given in cloud.cfg . You typically do not change this order. The cloud.cfg directives can be overridden by user data. When running cloud-init manually, you can override cloud.cfg with command line options. Each module includes its own configuration options, where you can add specific information. To ensure optimal functionality of the configuration, prefer using module names with underscores ( _ ) rather than dashes ( - ). 1 Specifies the default user for the system. Refer to Users and Groups for more information. 2 Enables or disables root login. Refer to Authorized Keys for more information. 3 Specifies whether ssh is configured to accept password authentication. Refer to Set Passwords for more information. 4 Configures mount points; must be a list containing six values. Refer to Mounts for more information. 5 Specifies whether to remove default host SSH keys. Refer to Host Keys for more information. 6 Specifies key types to generate. Refer to Host Keys for more information. Note that for RHEL 8.4 and earlier, the default value of this line is ~ . 7 cloud-init runs at multiple stages of boot. Set this option so that cloud-init can log all stages to its log file. Find more information about this option in the cloud-config.txt file in the usr/share/doc/cloud-init/examples directory. 8 Enables or disables VMware vSphere customization 9 The modules in this section are services that run when the cloud-init service starts, early in the boot process. 10 These modules run during cloud-init configuration, after initial boot. 11 These modules run in the final phase of cloud-init , after the configuration finishes. 12 Specifies details about the default user. Refer to Users and Groups for more information. 13 Specifies the distribution 14 Specifies the main directory that contains cloud-init -specific subdirectories. Refer to Directory layout for more information. 15 Specifies where templates reside 16 The name of the SSH service Additional resources Modules 3.5. The cloud.cfg.d directory cloud-init acts upon directives that you provide and configure. Typically, those directives are included in the cloud.cfg.d directory. Note While you can configure modules by adding user data directives within the cloud.cfg file, as a best practice consider leaving cloud.cfg unmodified. Add your directives to the /etc/cloud/cloud.cfg.d directory. Adding directives to this directory can make future modifications and upgrades easier. There are multiple ways to add directives. You can include directives in a file named .cfg , which includes the heading #cloud-config . Typically, the directory would contain multiple cfg files. There are other options for adding directives, for example, you can add a user data script. Refer to User-Data Formats for more information. Additional resources Cloud config examples 3.6. The default 05_logging.cfg file The 05_logging.cfg file sets logging information for cloud-init . The /etc/cloud/cloud.cfg.d directory includes this file, along with other cloud-init directives that you add. cloud-init uses the logging configuration in 05_logging.cfg by default. The default contents of the file for Red Hat Enterprise Linux (RHEL) are as follows: Additional resources Logging 3.7. The cloud-init /var/lib/cloud directory layout When cloud-init first runs, it creates a directory layout that includes information about your instance and cloud-init configuration. The directory can include optional directories, such as /scripts/vendor . The following is a sample directory layout for cloud-init : Additional resources Directory layout	[ "users: 1 - default disable_root: true 2 resize_rootfs_tmp: /dev ssh_pwauth: false 3 mount_default_fields: [~, ~, 'auto', 'defaults,nofail,x-systemd.requires=cloud-init.service', '0', '2'] 4 ssh_deletekeys: true 5 ssh_genkeytypes: ['rsa', 'ecdsa', 'ed25519'] 6 syslog_fix_perms: ~ 7 disable_vmware_customization: false 8 cloud_init_modules: 9 - migrator - seed_random - bootcmd - write_files - growpart - resizefs - disk_setup - mounts - set_hostname - update_hostname - update_etc_hosts - ca_certs - rsyslog - users_groups - ssh cloud_config_modules: 10 - ssh_import_id - locale - set_passwords - rh_subscription - spacewalk - yum_add_repo - ntp - timezone - disable_ec2_metadata - runcmd cloud_final_modules: 11 - package_update_upgrade_install - write_files_deferred - puppet - chef - ansible - mcollective - salt_minion - reset_rmc - rightscale_userdata - scripts_vendor - scripts_per_once - scripts_per_boot - scripts_per_instance - scripts_user - ssh_authkey_fingerprints - keys_to_console - install_hotplug - phone_home - final_message - power_state_change system_info: default_user: 12 name: cloud-user lock_passwd: true gecos: Cloud User groups: [adm, systemd-journal] sudo: [\"ALL=(ALL) NOPASSWD:ALL\"] shell: /bin/bash distro: rhel 13 network: renderers: ['sysconfig', 'eni', 'netplan', 'network-manager', 'networkd'] paths: cloud_dir: /var/lib/cloud 14 templates_dir: /etc/cloud/templates 15 ssh_svcname: sshd 16 vim:syntax=yaml", "## This yaml formatted config file handles setting ## logger information. The values that are necessary to be set ## are seen at the bottom. The top '_log' are only used to remove ## redundancy in a syslog and fallback-to-file case. ## ## The 'log_cfgs' entry defines a list of logger configs ## Each entry in the list is tried, and the first one that ## works is used. If a log_cfg list entry is an array, it will ## be joined with '\\n'. _log: - &log_base \| [loggers] keys=root,cloudinit [handlers] keys=consoleHandler,cloudLogHandler [formatters] keys=simpleFormatter,arg0Formatter [logger_root] level=DEBUG handlers=consoleHandler,cloudLogHandler [logger_cloudinit] level=DEBUG qualname=cloudinit handlers= propagate=1 [handler_consoleHandler] class=StreamHandler level=WARNING formatter=arg0Formatter args=(sys.stderr,) [formatter_arg0Formatter] format=%(asctime)s - %(filename)s[%(levelname)s]: %(message)s [formatter_simpleFormatter] format=[CLOUDINIT] %(filename)s[%(levelname)s]: %(message)s - &log_file \| [handler_cloudLogHandler] class=FileHandler level=DEBUG formatter=arg0Formatter args=('/var/log/cloud-init.log',) - &log_syslog \| [handler_cloudLogHandler] class=handlers.SysLogHandler level=DEBUG formatter=simpleFormatter args=(\"/dev/log\", handlers.SysLogHandler.LOG_USER) log_cfgs: Array entries in this list will be joined into a string that defines the configuration. # If you want logs to go to syslog, uncomment the following line. - [ log_base, log_syslog ] # The default behavior is to just log to a file. This mechanism that does not depend on a system service to operate. - [ log_base, log_file ] A file path can also be used. - /etc/log.conf This tells cloud-init to redirect its stdout and stderr to 'tee -a /var/log/cloud-init-output.log' so the user can see output there without needing to look on the console. output: {all: '\| tee -a /var/log/cloud-init-output.log'}", "/var/lib/cloud/ - data/ - instance-id - previous-instance-id - previous-datasource - previous-hostname - result.json - set-hostname - status.json - handlers/ - instance - boot-finished - cloud-config.txt - datasource - handlers/ - obj.pkl - scripts/ - sem/ - user-data.txt - user-data.txt.i - vendor-data.txt - vendor-data.txt.i - instances/ f111ee00-0a4a-4eea-9c17-3fa164739c55/ - boot-finished - cloud-config.txt - datasource - handlers/ - obj.pkl - scripts/ - sem/ - user-data.txt - user-data.txt.i - vendor-data.txt - vendor-data.txt.i - scripts/ - per-boot/ - per-instance/ - per-once/ - vendor/ - seed/ - sem/ - config_scripts_per_once.once" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/8/html/configuring_and_managing_cloud-init_for_rhel_8/red-hat-support-for-cloud-init_cloud-content
Chapter 3. Metrics	Chapter 3. Metrics 3.1. Metrics in the Block and File dashboard You can navigate to the Block and File dashboard in the OpenShift Web Console as follows: Click Storage Data Foundation . In the Status card of the Overview tab, click Storage System and then click the storage system link from the pop up that appears. Click the Block and File tab. The following cards on the Block and File dashboard provide the metrics based on deployment mode (internal or external): Details card The Details card shows the following: Service name Cluster name The name of the Provider on which the system runs, for example, AWS , VSphere , None for Bare metal. Mode (deployment mode as either Internal or External) OpenShift Data Foundation operator version In-transit encryption (shows whether the encryption is enabled or disabled) Storage Efficiency card This card shows the compression ratio that represents a compressible data effectiveness metric, which includes all the compression-enabled pools. This card also shows the savings metric that represents the actual disk capacity saved, which includes all the compression-enabled pools and associated replicas. Inventory card The Inventory card shows the total number of active nodes, disks, pools, storage classes, PVCs, and deployments backed by OpenShift Data Foundation provisioner. Note For external mode, the number of nodes will be 0 by default as there are no dedicated nodes for OpenShift Data Foundation. Status card This card shows whether the cluster is up and running without any errors or is experiencing some issues. For internal mode, Data Resiliency indicates the status of data re-balancing in Ceph across the replicas. When the internal mode cluster is in a warning or error state, the Alerts section is shown along with the relevant alerts. For external mode, Data Resiliency and alerts are not displayed Raw Capacity card This card shows the total raw storage capacity, which includes replication on the cluster. Used legend indicates space used raw storage capacity on the cluster Available legend indicates the available raw storage capacity on the cluster Note This card is not applicable for external mode clusters. Requested Capacity This card shows the actual amount of non-replicated data stored in the cluster and its distribution. You can choose between Projects, Storage Classes, Pods, and Peristent Volume Claims from the drop-down list on the top of the card. You need to select a namespace for the Persistent Volume Claims option. These options are for filtering the data shown in the graph. The graph displays the requested capacity for only the top five entities based on usage. The aggregate requested capacity of the remaining entities is displayed as Other. Option Display Projects The aggregated capacity of each project which is using the OpenShift Data Foundation and how much is being used. Storage Classes The aggregate capacity which is based on the OpenShift Data Foundation based storage classes. Pods All the pods that are trying to use the PVC that are backed by OpenShift Data Foundation provisioner. PVCs All the PVCs in the namespace that you selected from the dropdown list and that are mounted on to an active pod. PVCs that are not attached to pods are not included. For external mode, see the Capacity breakdown card . Capacity breakdown card This card is only applicable for external mode clusters. In this card, you can view a graphic breakdown of capacity per project, storage classes, and pods. You can choose between Projects, Storage Classes, and Pods from the drop-down menu on the top of the card. These options are for filtering the data shown in the graph. The graph displays the used capacity for only the top five entities based on usage. The aggregate usage of the remaining entities is displayed as Other . Utilization card The card shows used capacity, input/output operations per second, latency, throughput, and recovery information for the internal mode cluster. For external mode, this card shows only the used and requested capacity details for that cluster. Activity card This card shows the current and the past activities of the OpenShift Data Foundation cluster. The card is separated into two sections: Ongoing : Displays the progress of ongoing activities related to rebuilding of data resiliency and upgrading of OpenShift Data Foundation operator. Recent Events : Displays the list of events that happened in the openshift-storage namespace. 3.2. Metrics in the Object dashboard You can navigate to the Object dashboard in the OpenShift Web Console as follows: Click Storage Data Foundation . In the Status card of the Overview tab, click Storage System and then click the storage system link from the pop up that appears. Click the Object tab. The following metrics are available in the Object dashboard: Details card This card shows the following information: Service Name : The Multicloud Object Gateway (MCG) service name. System Name : The Multicloud Object Gateway and RADOS Object Gateway system names. The Multicloud Object Gateway system name is also a hyperlink to the MCG management user interface. Provider : The name of the provider on which the system runs (example: AWS , VSphere , None for Baremetal) Version : OpenShift Data Foundation operator version. Storage Efficiency card In this card you can view how the MCG optimizes the consumption of the storage backend resources through deduplication and compression and provides you with a calculated efficiency ratio (application data vs logical data) and an estimated savings figure (how many bytes the MCG did not send to the storage provider) based on capacity of bare metal and cloud based storage and egress of cloud based storage. Buckets card Buckets are containers maintained by the MCG and RADOS Object Gateway to store data on behalf of the applications. These buckets are created and accessed through object bucket claims (OBCs). A specific policy can be applied to a bucket to customize data placement, data spill-over, data resiliency, capacity quotas, and so on. In this card, information about object buckets (OB) and object bucket claims (OBCs) is shown separately. OB includes all the buckets that are created using S3 or the user interface (UI) and OBC includes all the buckets created using YAMLs or the command line interface (CLI). The number displayed on the left of the bucket type is the total count of OBs or OBCs. The number displayed on the right shows the error count and is visible only when the error count is greater than zero. You can click on the number to see the list of buckets that has the warning or error status. Resource Providers card This card displays a list of all Multicloud Object Gateway and RADOS Object Gateway resources that are currently in use. Those resources are used to store data according to the buckets policies and can be a cloud-based resource or a bare metal resource. Status card This card shows whether the system and its services are running without any issues. When the system is in a warning or error state, the alerts section is shown and the relevant alerts are displayed there. Click the alert links beside each alert for more information about the issue. For information about health checks, see Cluster health . If multiple object storage services are available in the cluster, click the service type (such as Object Service or Data Resiliency ) to see the state of the individual services. Data resiliency in the status card indicates if there is any resiliency issue regarding the data stored through the Multicloud Object Gateway and RADOS Object Gateway. Capacity breakdown card In this card you can visualize how applications consume the object storage through the Multicloud Object Gateway and RADOS Object Gateway. You can use the Service Type drop-down to view the capacity breakdown for the Multicloud Gateway and Object Gateway separately. When viewing the Multicloud Object Gateway, you can use the Break By drop-down to filter the results in the graph by either Projects or Bucket Class . Performance card In this card, you can view the performance of the Multicloud Object Gateway or RADOS Object Gateway. Use the Service Type drop-down to choose which you would like to view. For Multicloud Object Gateway accounts, you can view the I/O operations and logical used capacity. For providers, you can view I/O operation, physical and logical usage, and egress. The following tables explain the different metrics that you can view based on your selection from the drop-down menus on the top of the card: Table 3.1. Indicators for Multicloud Object Gateway Consumer types Metrics Chart display Accounts I/O operations Displays read and write I/O operations for the top five consumers. The total reads and writes of all the consumers is displayed at the bottom. This information helps you monitor the throughput demand (IOPS) per application or account. Accounts Logical Used Capacity Displays total logical usage of each account for the top five consumers. This helps you monitor the throughput demand per application or account. Providers I/O operations Displays the count of I/O operations generated by the MCG when accessing the storage backend hosted by the provider. This helps you understand the traffic in the cloud so that you can improve resource allocation according to the I/O pattern, thereby optimizing the cost. Providers Physical vs Logical usage Displays the data consumption in the system by comparing the physical usage with the logical usage per provider. This helps you control the storage resources and devise a placement strategy in line with your usage characteristics and your performance requirements while potentially optimizing your costs. Providers Egress The amount of data the MCG retrieves from each provider (read bandwidth originated with the applications). This helps you understand the traffic in the cloud to improve resource allocation according to the egress pattern, thereby optimizing the cost. For the RADOS Object Gateway, you can use the Metric drop-down to view the Latency or Bandwidth . Latency : Provides a visual indication of the average GET/PUT latency imbalance across RADOS Object Gateway instances. Bandwidth : Provides a visual indication of the sum of GET/PUT bandwidth across RADOS Object Gateway instances. Activity card This card displays what activities are happening or have recently happened in the OpenShift Data Foundation cluster. The card is separated into two sections: Ongoing : Displays the progress of ongoing activities related to rebuilding of data resiliency and upgrading of OpenShift Data Foundation operator. Recent Events : Displays the list of events that happened in the openshift-storage namespace. 3.3. Pool metrics The Pool metrics dashboard provides information to ensure efficient data consumption, and how to enable or disable compression if less effective. Viewing pool metrics To view the pool list: Click Storage Data Foundation . In the Storage systems tab, select the storage system and then click BlockPools . When you click on a pool name, the following cards on each Pool dashboard is displayed along with the metrics based on deployment mode (internal or external): Details card The Details card shows the following: Pool Name Volume type Replicas Status card This card shows whether the pool is up and running without any errors or is experiencing some issues. Mirroring card When the mirroring option is enabled, this card shows the mirroring status, image health, and last checked time-stamp. The mirroring metrics are displayed when cluster level mirroring is enabled. The metrics help to prevent disaster recovery failures and notify of any discrepancies so that the data is kept intact. The mirroring card shows high-level information such as: Mirroring state as either enabled or disabled for the particular pool. Status of all images under the pool as replicating successfully or not. Percentage of images that are replicating and not replicating. Inventory card The Inventory card shows the number of storage classes and Persistent Volume Claims. Compression card This card shows the compression status as enabled or disabled. It also displays the storage efficiency details as follows: Compression eligibility that indicates what portion of written compression-eligible data is compressible (per ceph parameters) Compression ratio of compression-eligible data Compression savings provides the total savings (including replicas) of compression-eligible data For information on how to enable or disable compression for an existing pool, see Updating an existing pool . Raw Capacity card This card shows the total raw storage capacity which includes replication on the cluster. Used legend indicates storage capacity used by the pool Available legend indicates the available raw storage capacity on the cluster Performance card In this card, you can view the usage of I/O operations and throughput demand per application or account. The graph indicates the average latency or bandwidth across the instances. 3.4. Network File System metrics The Network File System (NFS) metrics dashboard provides enhanced observability for NFS mounts such as the following: Mount point for any exported NFS shares Number of client mounts A breakdown statistics of the clients that are connected to help determine internal versus the external client mounts Grace period status of the Ganesha server Health statuses of the Ganesha server Prerequisites OpenShift Container Platform is installed and you have administrative access to OpenShift Web Console. Ensure that NFS is enabled. Procedure You can navigate to the Network file system dashboard in the OpenShift Web Console as follows: Click Storage Data Foundation . In the Status card of the Overview tab, click Storage System and then click the storage system link from the pop up that appears. Click the Network file system tab. This tab is available only when NFS is enabled. Note When you enable or disable NFS from the command-line interface, you must perform a hard refresh to display or hide the Network file system tab in the dashboard. The following NFS metrics are displayed: Status Card This card shows the status of the server based on the total number of active worker threads. Non-zero threads specify healthy status. Throughput Card This card shows the throughput of the server, which is the summation of the total request bytes and total response bytes for both read and write operations of the server. Top client Card This card shows the throughput of clients, which is the summation of the total of the response bytes sent by a client and the total request bytes by a client for both read and write operations. It shows the top three of such clients. 3.5. Enabling metadata on RBD and CephFS volumes You can set the persistent volume claim (PVC), persistent volume (PV), and Namespace names in the RADOS block device (RBD) and CephFS volumes for monitoring purposes. This enables you to read the RBD and CephFS metadata to identify the mapping between the OpenShift Container Platform and RBD and CephFS volumes. To enable RADOS block device (RBD) and CephFS volume metadata feature, you need to set the CSI_ENABLE_METADATA variable in the rook-ceph-operator-config configmap . By default, this feature is disabled. If you enable the feature after upgrading from a version, the existing PVCs will not contain the metadata. Also, when you enable the metadata feature, the PVCs that were created before enabling will not have the metadata. Prerequisites Ensure to install ocs_operator and create a storagecluster for the operator. Ensure that the storagecluster is in Ready state. Procedure Edit the rook-ceph operator ConfigMap to mark CSI_ENABLE_METADATA to true . Wait for the respective CSI CephFS plugin provisioner pods and CSI RBD plugin pods to reach the Running state. Note Ensure that the setmetadata variable is automatically set after the metadata feature is enabled. This variable should not be available when the metadata feature is disabled. Verification steps To verify the metadata for RBD PVC: Create a PVC. Check the status of the PVC. Verify the metadata in the Red Hat Ceph Storage command-line interface (CLI). For information about how to access the Red Hat Ceph Storage CLI, see the How to access Red Hat Ceph Storage CLI in Red Hat OpenShift Data Foundation environment article. There are four metadata on this image: To verify the metadata for RBD clones: Create a clone. Check the status of the clone. Verify the metadata in the Red Hat Ceph Storage command-line interface (CLI). For information about how to access the Red Hat Ceph Storage CLI, see the How to access Red Hat Ceph Storage CLI in Red Hat OpenShift Data Foundation environment article. To verify the metadata for RBD Snapshots: Create a snapshot. Check the status of the snapshot. Verify the metadata in the Red Hat Ceph Storage command-line interface (CLI). For information about how to access the Red Hat Ceph Storage CLI, see the How to access Red Hat Ceph Storage CLI in Red Hat OpenShift Data Foundation environment article. Verify the metadata for RBD Restore: Restore a volume snapshot. Check the status of the restored volume snapshot. Verify the metadata in the Red Hat Ceph Storage command-line interface (CLI). For information about how to access the Red Hat Ceph Storage CLI, see the How to access Red Hat Ceph Storage CLI in Red Hat OpenShift Data Foundation environment article. To verify the metadata for CephFS PVC: Create a PVC. Check the status of the PVC. Verify the metadata in the Red Hat Ceph Storage command-line interface (CLI). For information about how to access the Red Hat Ceph Storage CLI, see the How to access Red Hat Ceph Storage CLI in Red Hat OpenShift Data Foundation environment article. To verify the metadata for CephFS clone: Create a clone. Check the status of the clone. Verify the metadata in the Red Hat Ceph Storage command-line interface (CLI). For information about how to access the Red Hat Ceph Storage CLI, see the How to access Red Hat Ceph Storage CLI in Red Hat OpenShift Data Foundation environment article. To verify the metadata for CephFS volume snapshot: Create a volume snapshot. Check the status of the volume snapshot. Verify the metadata in the Red Hat Ceph Storage command-line interface (CLI). For information about how to access the Red Hat Ceph Storage CLI, see the How to access Red Hat Ceph Storage CLI in Red Hat OpenShift Data Foundation environment article. To verify the metadata of the CephFS Restore: Restore a volume snapshot. Check the status of the restored volume snapshot. Verify the metadata in the Red Hat Ceph Storage command-line interface (CLI). For information about how to access the Red Hat Ceph Storage CLI, see the How to access Red Hat Ceph Storage CLI in Red Hat OpenShift Data Foundation environment article.	[ "oc get storagecluster NAME AGE PHASE EXTERNAL CREATED AT VERSION ocs-storagecluster 57m Ready 2022-08-30T06:52:58Z 4.12.0", "oc patch cm rook-ceph-operator-config -n openshift-storage -p USD'data:\\n \"CSI_ENABLE_METADATA\": \"true\"' configmap/rook-ceph-operator-config patched", "oc get pods \| grep csi csi-cephfsplugin-b8d6c 2/2 Running 0 56m csi-cephfsplugin-bnbg9 2/2 Running 0 56m csi-cephfsplugin-kqdw4 2/2 Running 0 56m csi-cephfsplugin-provisioner-7dcd78bb9b-q6dxb 5/5 Running 0 56m csi-cephfsplugin-provisioner-7dcd78bb9b-zc4q5 5/5 Running 0 56m csi-rbdplugin-776dl 3/3 Running 0 56m csi-rbdplugin-ffl52 3/3 Running 0 56m csi-rbdplugin-jx9mz 3/3 Running 0 56m csi-rbdplugin-provisioner-5f6d766b6c-694fx 6/6 Running 0 56m csi-rbdplugin-provisioner-5f6d766b6c-vzv45 6/6 Running 0 56m", "cat <<EOF \| oc create -f - apiVersion: v1 kind: PersistentVolumeClaim metadata: name: rbd-pvc spec: accessModes: - ReadWriteOnce resources: requests: storage: 1Gi storageClassName: ocs-storagecluster-ceph-rbd EOF", "oc get pvc \| grep rbd-pvc rbd-pvc Bound pvc-30628fa8-2966-499c-832d-a6a3a8ebc594 1Gi RWO ocs-storagecluster-ceph-rbd 32s", "[sh-4.x]USD rbd ls ocs-storagecluster-cephblockpool csi-vol-7d67bfad-2842-11ed-94bd-0a580a830012 csi-vol-ed5ce27b-2842-11ed-94bd-0a580a830012 [sh-4.x]USD rbd image-meta ls ocs-storagecluster-cephblockpool/csi-vol-ed5ce27b-2842-11ed-94bd-0a580a830012", "Key Value csi.ceph.com/cluster/name 6cd7a18d-7363-4830-ad5c-f7b96927f026 csi.storage.k8s.io/pv/name pvc-30628fa8-2966-499c-832d-a6a3a8ebc594 csi.storage.k8s.io/pvc/name rbd-pvc csi.storage.k8s.io/pvc/namespace openshift-storage", "cat <<EOF \| oc create -f - apiVersion: v1 kind: PersistentVolumeClaim metadata: name: rbd-pvc-clone spec: storageClassName: ocs-storagecluster-ceph-rbd dataSource: name: rbd-pvc kind: PersistentVolumeClaim accessModes: - ReadWriteOnce resources: requests: storage: 1Gi EOF", "oc get pvc \| grep rbd-pvc rbd-pvc Bound pvc-30628fa8-2966-499c-832d-a6a3a8ebc594 1Gi RWO ocs-storagecluster-ceph-rbd 15m rbd-pvc-clone Bound pvc-0d72afda-f433-4d46-a7f1-a5fcb3d766e0 1Gi RWO ocs-storagecluster-ceph-rbd 52s", "[sh-4.x]USD rbd ls ocs-storagecluster-cephblockpool csi-vol-063b982d-2845-11ed-94bd-0a580a830012 csi-vol-063b982d-2845-11ed-94bd-0a580a830012-temp csi-vol-7d67bfad-2842-11ed-94bd-0a580a830012 csi-vol-ed5ce27b-2842-11ed-94bd-0a580a830012 [sh-4.x]USD rbd image-meta ls ocs-storagecluster-cephblockpool/csi-vol-063b982d-2845-11ed-94bd-0a580a830012 There are 4 metadata on this image: Key Value csi.ceph.com/cluster/name 6cd7a18d-7363-4830-ad5c-f7b96927f026 csi.storage.k8s.io/pv/name pvc-0d72afda-f433-4d46-a7f1-a5fcb3d766e0 csi.storage.k8s.io/pvc/name rbd-pvc-clone csi.storage.k8s.io/pvc/namespace openshift-storage", "cat <<EOF \| oc create -f - apiVersion: snapshot.storage.k8s.io/v1 kind: VolumeSnapshot metadata: name: rbd-pvc-snapshot spec: volumeSnapshotClassName: ocs-storagecluster-rbdplugin-snapclass source: persistentVolumeClaimName: rbd-pvc EOF volumesnapshot.snapshot.storage.k8s.io/rbd-pvc-snapshot created", "oc get volumesnapshot NAME READYTOUSE SOURCEPVC SOURCESNAPSHOTCONTENT RESTORESIZE SNAPSHOTCLASS SNAPSHOTCONTENT CREATIONTIME AGE rbd-pvc-snapshot true rbd-pvc 1Gi ocs-storagecluster-rbdplugin-snapclass snapcontent-b992b782-7174-4101-8fe3-e6e478eb2c8f 17s 18s", "[sh-4.x]USD rbd ls ocs-storagecluster-cephblockpool csi-snap-a1e24408-2848-11ed-94bd-0a580a830012 csi-vol-063b982d-2845-11ed-94bd-0a580a830012 csi-vol-063b982d-2845-11ed-94bd-0a580a830012-temp csi-vol-7d67bfad-2842-11ed-94bd-0a580a830012 csi-vol-ed5ce27b-2842-11ed-94bd-0a580a830012 [sh-4.x]USD rbd image-meta ls ocs-storagecluster-cephblockpool/csi-snap-a1e24408-2848-11ed-94bd-0a580a830012 There are 4 metadata on this image: Key Value csi.ceph.com/cluster/name 6cd7a18d-7363-4830-ad5c-f7b96927f026 csi.storage.k8s.io/volumesnapshot/name rbd-pvc-snapshot csi.storage.k8s.io/volumesnapshot/namespace openshift-storage csi.storage.k8s.io/volumesnapshotcontent/name snapcontent-b992b782-7174-4101-8fe3-e6e478eb2c8f", "cat <<EOF \| oc create -f - apiVersion: v1 kind: PersistentVolumeClaim metadata: name: rbd-pvc-restore spec: storageClassName: ocs-storagecluster-ceph-rbd dataSource: name: rbd-pvc-snapshot kind: VolumeSnapshot apiGroup: snapshot.storage.k8s.io accessModes: - ReadWriteOnce resources: requests: storage: 1Gi EOF persistentvolumeclaim/rbd-pvc-restore created", "oc get pvc \| grep rbd db-noobaa-db-pg-0 Bound pvc-615e2027-78cd-4ea2-a341-fdedd50c5208 50Gi RWO ocs-storagecluster-ceph-rbd 51m rbd-pvc Bound pvc-30628fa8-2966-499c-832d-a6a3a8ebc594 1Gi RWO ocs-storagecluster-ceph-rbd 47m rbd-pvc-clone Bound pvc-0d72afda-f433-4d46-a7f1-a5fcb3d766e0 1Gi RWO ocs-storagecluster-ceph-rbd 32m rbd-pvc-restore Bound pvc-f900e19b-3924-485c-bb47-01b84c559034 1Gi RWO ocs-storagecluster-ceph-rbd 111s", "[sh-4.x]USD rbd ls ocs-storagecluster-cephblockpool csi-snap-a1e24408-2848-11ed-94bd-0a580a830012 csi-vol-063b982d-2845-11ed-94bd-0a580a830012 csi-vol-063b982d-2845-11ed-94bd-0a580a830012-temp csi-vol-5f6e0737-2849-11ed-94bd-0a580a830012 csi-vol-7d67bfad-2842-11ed-94bd-0a580a830012 csi-vol-ed5ce27b-2842-11ed-94bd-0a580a830012 [sh-4.x]USD rbd image-meta ls ocs-storagecluster-cephblockpool/csi-vol-5f6e0737-2849-11ed-94bd-0a580a830012 There are 4 metadata on this image: Key Value csi.ceph.com/cluster/name 6cd7a18d-7363-4830-ad5c-f7b96927f026 csi.storage.k8s.io/pv/name pvc-f900e19b-3924-485c-bb47-01b84c559034 csi.storage.k8s.io/pvc/name rbd-pvc-restore csi.storage.k8s.io/pvc/namespace openshift-storage", "cat <<EOF \| oc create -f - apiVersion: v1 kind: PersistentVolumeClaim metadata: name: cephfs-pvc spec: accessModes: - ReadWriteOnce resources: requests: storage: 1Gi storageClassName: ocs-storagecluster-cephfs EOF", "get pvc \| grep cephfs cephfs-pvc Bound pvc-4151128c-86f0-468b-b6e7-5fdfb51ba1b9 1Gi RWO ocs-storagecluster-cephfs 11s", "ceph fs volume ls [ { \"name\": \"ocs-storagecluster-cephfilesystem\" } ] ceph fs subvolumegroup ls ocs-storagecluster-cephfilesystem [ { \"name\": \"csi\" } ] ceph fs subvolume ls ocs-storagecluster-cephfilesystem --group_name csi [ { \"name\": \"csi-vol-25266061-284c-11ed-95e0-0a580a810215\" } ] ceph fs subvolume metadata ls ocs-storagecluster-cephfilesystem csi-vol-25266061-284c-11ed-95e0-0a580a810215 --group_name=csi --format=json { \"csi.ceph.com/cluster/name\": \"6cd7a18d-7363-4830-ad5c-f7b96927f026\", \"csi.storage.k8s.io/pv/name\": \"pvc-4151128c-86f0-468b-b6e7-5fdfb51ba1b9\", \"csi.storage.k8s.io/pvc/name\": \"cephfs-pvc\", \"csi.storage.k8s.io/pvc/namespace\": \"openshift-storage\" }", "cat <<EOF \| oc create -f - apiVersion: v1 kind: PersistentVolumeClaim metadata: name: cephfs-pvc-clone spec: storageClassName: ocs-storagecluster-cephfs dataSource: name: cephfs-pvc kind: PersistentVolumeClaim accessModes: - ReadWriteMany resources: requests: storage: 1Gi EOF persistentvolumeclaim/cephfs-pvc-clone created", "oc get pvc \| grep cephfs cephfs-pvc Bound pvc-4151128c-86f0-468b-b6e7-5fdfb51ba1b9 1Gi RWO ocs-storagecluster-cephfs 9m5s cephfs-pvc-clone Bound pvc-3d4c4e78-f7d5-456a-aa6e-4da4a05ca4ce 1Gi RWX ocs-storagecluster-cephfs 20s", "[rook@rook-ceph-tools-c99fd8dfc-6sdbg /]USD ceph fs subvolume ls ocs-storagecluster-cephfilesystem --group_name csi [ { \"name\": \"csi-vol-5ea23eb0-284d-11ed-95e0-0a580a810215\" }, { \"name\": \"csi-vol-25266061-284c-11ed-95e0-0a580a810215\" } ] [rook@rook-ceph-tools-c99fd8dfc-6sdbg /]USD ceph fs subvolume metadata ls ocs-storagecluster-cephfilesystem csi-vol-5ea23eb0-284d-11ed-95e0-0a580a810215 --group_name=csi --format=json { \"csi.ceph.com/cluster/name\": \"6cd7a18d-7363-4830-ad5c-f7b96927f026\", \"csi.storage.k8s.io/pv/name\": \"pvc-3d4c4e78-f7d5-456a-aa6e-4da4a05ca4ce\", \"csi.storage.k8s.io/pvc/name\": \"cephfs-pvc-clone\", \"csi.storage.k8s.io/pvc/namespace\": \"openshift-storage\" }", "cat <<EOF \| oc create -f - apiVersion: snapshot.storage.k8s.io/v1 kind: VolumeSnapshot metadata: name: cephfs-pvc-snapshot spec: volumeSnapshotClassName: ocs-storagecluster-cephfsplugin-snapclass source: persistentVolumeClaimName: cephfs-pvc EOF volumesnapshot.snapshot.storage.k8s.io/cephfs-pvc-snapshot created", "oc get volumesnapshot NAME READYTOUSE SOURCEPVC SOURCESNAPSHOTCONTENT RESTORESIZE SNAPSHOTCLASS SNAPSHOTCONTENT CREATIONTIME AGE cephfs-pvc-snapshot true cephfs-pvc 1Gi ocs-storagecluster-cephfsplugin-snapclass snapcontent-f0f17463-d13b-4e13-b44e-6340bbb3bee0 9s 9s", "ceph fs subvolume snapshot ls ocs-storagecluster-cephfilesystem csi-vol-25266061-284c-11ed-95e0-0a580a810215 --group_name csi [ { \"name\": \"csi-snap-06336f4e-284e-11ed-95e0-0a580a810215\" } ] ceph fs subvolume snapshot metadata ls ocs-storagecluster-cephfilesystem csi-vol-25266061-284c-11ed-95e0-0a580a810215 csi-snap-06336f4e-284e-11ed-95e0-0a580a810215 --group_name=csi --format=json { \"csi.ceph.com/cluster/name\": \"6cd7a18d-7363-4830-ad5c-f7b96927f026\", \"csi.storage.k8s.io/volumesnapshot/name\": \"cephfs-pvc-snapshot\", \"csi.storage.k8s.io/volumesnapshot/namespace\": \"openshift-storage\", \"csi.storage.k8s.io/volumesnapshotcontent/name\": \"snapcontent-f0f17463-d13b-4e13-b44e-6340bbb3bee0\" }", "cat <<EOF \| oc create -f - apiVersion: v1 kind: PersistentVolumeClaim metadata: name: cephfs-pvc-restore spec: storageClassName: ocs-storagecluster-cephfs dataSource: name: cephfs-pvc-snapshot kind: VolumeSnapshot apiGroup: snapshot.storage.k8s.io accessModes: - ReadWriteMany resources: requests: storage: 1Gi EOF persistentvolumeclaim/cephfs-pvc-restore created", "oc get pvc \| grep cephfs cephfs-pvc Bound pvc-4151128c-86f0-468b-b6e7-5fdfb51ba1b9 1Gi RWO ocs-storagecluster-cephfs 29m cephfs-pvc-clone Bound pvc-3d4c4e78-f7d5-456a-aa6e-4da4a05ca4ce 1Gi RWX ocs-storagecluster-cephfs 20m cephfs-pvc-restore Bound pvc-43d55ea1-95c0-42c8-8616-4ee70b504445 1Gi RWX ocs-storagecluster-cephfs 21s", "ceph fs subvolume ls ocs-storagecluster-cephfilesystem --group_name csi [ { \"name\": \"csi-vol-3536db13-2850-11ed-95e0-0a580a810215\" }, { \"name\": \"csi-vol-5ea23eb0-284d-11ed-95e0-0a580a810215\" }, { \"name\": \"csi-vol-25266061-284c-11ed-95e0-0a580a810215\" } ] ceph fs subvolume metadata ls ocs-storagecluster-cephfilesystem csi-vol-3536db13-2850-11ed-95e0-0a580a810215 --group_name=csi --format=json { \"csi.ceph.com/cluster/name\": \"6cd7a18d-7363-4830-ad5c-f7b96927f026\", \"csi.storage.k8s.io/pv/name\": \"pvc-43d55ea1-95c0-42c8-8616-4ee70b504445\", \"csi.storage.k8s.io/pvc/name\": \"cephfs-pvc-restore\", \"csi.storage.k8s.io/pvc/namespace\": \"openshift-storage\" }" ]	https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.14/html/monitoring_openshift_data_foundation/metrics
Chapter 4. Testing and troubleshooting autoscaling	Chapter 4. Testing and troubleshooting autoscaling Use the Orchestration service (heat) to automatically scale instances up and down based on threshold definitions. To troubleshoot your environment, you can look for errors in the log files and history records. 4.1. Testing automatic scaling up of instances You can use the Orchestration service (heat) to scale instances automatically based on the cpu_alarm_high threshold definition. When the CPU use reaches a value defined in the threshold parameter, another instance starts up to balance the load. The threshold value in the template.yaml file is set to 80%. Procedure Log in to the host environment as the stack user. For standalone environments set the OS_CLOUD environment variable: [stack@standalone ~]USD export OS_CLOUD=standalone For director environments source the stackrc file: [stack@undercloud ~]USD source ~/stackrc Log in to the instance: USD ssh -i ~/mykey.pem [email protected] Run multiple dd commands to generate the load: [instance ~]USD sudo dd if=/dev/zero of=/dev/null & [instance ~]USD sudo dd if=/dev/zero of=/dev/null & [instance ~]USD sudo dd if=/dev/zero of=/dev/null & Exit from the running instance and return to the host. After you run the dd commands, you can expect to have 100% CPU use in the instance. Verify that the alarm has been triggered: USD openstack alarm list +--------------------------------------+--------------------------------------------+-------------------------------------+-------+----------+---------+ \| alarm_id \| type \| name \| state \| severity \| enabled \| +--------------------------------------+--------------------------------------------+-------------------------------------+-------+----------+---------+ \| 022f707d-46cc-4d39-a0b2-afd2fc7ab86a \| gnocchi_aggregation_by_resources_threshold \| example-cpu_alarm_high-odj77qpbld7j \| alarm \| low \| True \| \| 46ed2c50-e05a-44d8-b6f6-f1ebd83af913 \| gnocchi_aggregation_by_resources_threshold \| example-cpu_alarm_low-m37jvnm56x2t \| ok \| low \| True \| +--------------------------------------+--------------------------------------------+-------------------------------------+-------+----------+---------+ After approximately 60 seconds, Orchestration starts another instance and adds it to the group. To verify that an instance has been created, enter the following command: USD openstack server list +--------------------------------------+-------------------------------------------------------+--------+------------+-------------+---------------------------------------+ \| ID \| Name \| Status \| Task State \| Power State \| Networks \| +--------------------------------------+-------------------------------------------------------+--------+------------+-------------+---------------------------------------+ \| 477ee1af-096c-477c-9a3f-b95b0e2d4ab5 \| ex-3gax-4urpikl5koff-yrxk3zxzfmpf-server-2hde4tp4trnk \| ACTIVE \| - \| Running \| internal1=10.10.10.13, 192.168.122.17 \| \| e1524f65-5be6-49e4-8501-e5e5d812c612 \| ex-3gax-5f3a4og5cwn2-png47w3u2vjd-server-vaajhuv4mj3j \| ACTIVE \| - \| Running \| internal1=10.10.10.9, 192.168.122.8 \| +--------------------------------------+-------------------------------------------------------+--------+------------+-------------+---------------------------------------+ After another short period of time, observe that the Orchestration service has autoscaled to three instances. The configuration is set to a maximum of three instances. Verify there are three instances: USD openstack server list +--------------------------------------+-------------------------------------------------------+--------+------------+-------------+---------------------------------------+ \| ID \| Name \| Status \| Task State \| Power State \| Networks \| +--------------------------------------+-------------------------------------------------------+--------+------------+-------------+---------------------------------------+ \| 477ee1af-096c-477c-9a3f-b95b0e2d4ab5 \| ex-3gax-4urpikl5koff-yrxk3zxzfmpf-server-2hde4tp4trnk \| ACTIVE \| - \| Running \| internal1=10.10.10.13, 192.168.122.17 \| \| e1524f65-5be6-49e4-8501-e5e5d812c612 \| ex-3gax-5f3a4og5cwn2-png47w3u2vjd-server-vaajhuv4mj3j \| ACTIVE \| - \| Running \| internal1=10.10.10.9, 192.168.122.8 \| \| 6c88179e-c368-453d-a01a-555eae8cd77a \| ex-3gax-fvxz3tr63j4o-36fhftuja3bw-server-rhl4sqkjuy5p \| ACTIVE \| - \| Running \| internal1=10.10.10.5, 192.168.122.5 \| +--------------------------------------+-------------------------------------------------------+--------+------------+-------------+---------------------------------------+ 4.2. Testing automatic scaling down of instances You can use the Orchestration service (heat) to automatically scale down instances based on the cpu_alarm_low threshold. In this example, the instances are scaled down when CPU use is below 5%. Procedure From within the workload instance, terminate the running dd processes and observe Orchestration begin to scale the instances back down. Log in to the host environment as the stack user. For standalone environments set the OS_CLOUD environment variable: [stack@standalone ~]USD export OS_CLOUD=standalone For director environments source the stackrc file: [stack@undercloud ~]USD source ~/stackrc When you stop the dd processes, this triggers the cpu_alarm_low event alarm. As a result, Orchestration begins to automatically scale down and remove the instances. Verify that the corresponding alarm has triggered: After a few minutes, Orchestration continually reduce the number of instances to the minimum value defined in the min_size parameter of the scaleup_group definition. In this scenario, the min_size parameter is set to 1 . 4.3. Troubleshooting for autoscaling If your environment is not working properly, you can look for errors in the log files and history records. Procedure Log in to the host environment as the stack user. For standalone environments set the OS_CLOUD environment variable: [stack@standalone ~]USD export OS_CLOUD=standalone For director environments source the stackrc file: [stack@undercloud ~]USD source ~/stackrc To retrieve information on state transitions, list the stack event records: USD openstack stack event list example 2017-03-06 11:12:43Z [example]: CREATE_IN_PROGRESS Stack CREATE started 2017-03-06 11:12:43Z [example.scaleup_group]: CREATE_IN_PROGRESS state changed 2017-03-06 11:13:04Z [example.scaleup_group]: CREATE_COMPLETE state changed 2017-03-06 11:13:04Z [example.scaledown_policy]: CREATE_IN_PROGRESS state changed 2017-03-06 11:13:05Z [example.scaleup_policy]: CREATE_IN_PROGRESS state changed 2017-03-06 11:13:05Z [example.scaledown_policy]: CREATE_COMPLETE state changed 2017-03-06 11:13:05Z [example.scaleup_policy]: CREATE_COMPLETE state changed 2017-03-06 11:13:05Z [example.cpu_alarm_low]: CREATE_IN_PROGRESS state changed 2017-03-06 11:13:05Z [example.cpu_alarm_high]: CREATE_IN_PROGRESS state changed 2017-03-06 11:13:06Z [example.cpu_alarm_low]: CREATE_COMPLETE state changed 2017-03-06 11:13:07Z [example.cpu_alarm_high]: CREATE_COMPLETE state changed 2017-03-06 11:13:07Z [example]: CREATE_COMPLETE Stack CREATE completed successfully 2017-03-06 11:19:34Z [example.scaleup_policy]: SIGNAL_COMPLETE alarm state changed from alarm to alarm (Remaining as alarm due to 1 samples outside threshold, most recent: 95.4080102993) 2017-03-06 11:25:43Z [example.scaleup_policy]: SIGNAL_COMPLETE alarm state changed from alarm to alarm (Remaining as alarm due to 1 samples outside threshold, most recent: 95.8869217299) 2017-03-06 11:33:25Z [example.scaledown_policy]: SIGNAL_COMPLETE alarm state changed from ok to alarm (Transition to alarm due to 1 samples outside threshold, most recent: 2.73931707966) 2017-03-06 11:39:15Z [example.scaledown_policy]: SIGNAL_COMPLETE alarm state changed from alarm to alarm (Remaining as alarm due to 1 samples outside threshold, most recent: 2.78110858552) Read the alarm history log: USD openstack alarm-history show 022f707d-46cc-4d39-a0b2-afd2fc7ab86a +----------------------------+------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------+ \| timestamp \| type \| detail \| event_id \| +----------------------------+------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------+ \| 2017-03-06T11:32:35.510000 \| state transition \| {"transition_reason": "Transition to ok due to 1 samples inside threshold, most recent: \| 25e0e70b-3eda-466e-abac-42d9cf67e704 \| \| \| \| 2.73931707966", "state": "ok"} \| \| \| 2017-03-06T11:17:35.403000 \| state transition \| {"transition_reason": "Transition to alarm due to 1 samples outside threshold, most recent: \| 8322f62c-0d0a-4dc0-9279-435510f81039 \| \| \| \| 95.0964497325", "state": "alarm"} \| \| \| 2017-03-06T11:15:35.723000 \| state transition \| {"transition_reason": "Transition to ok due to 1 samples inside threshold, most recent: \| 1503bd81-7eba-474e-b74e-ded8a7b630a1 \| \| \| \| 3.59330523447", "state": "ok"} \| \| \| 2017-03-06T11:13:06.413000 \| creation \| {"alarm_actions": ["trust+http://fca6e27e3d524ed68abdc0fd576aa848:[email protected]:8004/v1/fd \| 224f15c0-b6f1-4690-9a22-0c1d236e65f6 \| \| \| \| 1c345135be4ee587fef424c241719d/stacks/example/d9ef59ed-b8f8-4e90-bd9b- \| \| \| \| \| ae87e73ef6e2/resources/scaleup_policy/signal"], "user_id": "a85f83b7f7784025b6acdc06ef0a8fd8", \| \| \| \| \| "name": "example-cpu_alarm_high-odj77qpbld7j", "state": "insufficient data", "timestamp": \| \| \| \| \| "2017-03-06T11:13:06.413455", "description": "Scale up if CPU > 80%", "enabled": true, \| \| \| \| \| "state_timestamp": "2017-03-06T11:13:06.413455", "rule": {"evaluation_periods": 1, "metric": \| \| \| \| \| "cpu_util", "aggregation_method": "mean", "granularity": 300, "threshold": 80.0, "query": "{\"=\": \| \| \| \| \| {\"server_group\": \"d9ef59ed-b8f8-4e90-bd9b-ae87e73ef6e2\"}}", "comparison_operator": "gt", \| \| \| \| \| "resource_type": "instance"}, "alarm_id": "022f707d-46cc-4d39-a0b2-afd2fc7ab86a", \| \| \| \| \| "time_constraints": [], "insufficient_data_actions": null, "repeat_actions": true, "ok_actions": \| \| \| \| \| null, "project_id": "fd1c345135be4ee587fef424c241719d", "type": \| \| \| \| \| "gnocchi_aggregation_by_resources_threshold", "severity": "low"} \| \| +----------------------------+------------------+-----------------------------------------------------------------------------------------------------+------------------------------------- To view the records of scale-out or scale-down operations that heat collects for the existing stack, you can use the awk command to parse the heat-engine.log : USD awk '/Stack UPDATE started/,/Stack CREATE completed successfully/ {print USD0}' /var/log/containers/heat/heat-engine.log To view aodh-related information, examine the evaluator.log : USD grep -i alarm /var/log/containers/aodh/evaluator.log \| grep -i transition 4.4. Using CPU telemetry values for autoscaling threshold when using rate:mean aggregration When using the OS::Heat::Autoscaling heat orchestration template (HOT) and setting a threshold value for CPU, the value is expressed in nanoseconds of CPU time which is a dynamic value based on the number of virtual CPUs allocated to the instance workload. In this reference guide we'll explore how to calculate and express the CPU nanosecond value as a percentage when using the Gnocchi rate:mean aggregration method. 4.4.1. Calculating CPU telemetry values as a percentage CPU telemetry is stored in Gnocchi (OpenStack time-series data store) as CPU utilization in nanoseconds. When using CPU telemetry to define autoscaling thresholds it is useful to express the values as a percentage of CPU utilization since that is more natural when defining the threshold values. When defining the scaling policies used as part of an autoscaling group, we can take our desired threshold defined as a percentage and calculate the required threshold value in nanoseconds which is used in the policy definitions. Value (ns) Granularity (s) Percentage 60000000000 60 100 54000000000 60 90 48000000000 60 80 42000000000 60 70 36000000000 60 60 30000000000 60 50 24000000000 60 40 18000000000 60 30 12000000000 60 20 6000000000 60 10 4.4.2. Displaying instance workload vCPU as a percentage You can display the gnocchi-stored CPU telemetry data as a percentage rather than the nanosecond values for instances by using the openstack metric aggregates command. Prerequisites Create a heat stack using the autoscaling group resource that results in an instance workload. Procedure Login to your OpenStack environment as the cloud adminstrator. Retrieve the ID of the autoscaling group heat stack: USD openstack stack show vnf -c id -c stack_status +--------------+--------------------------------------+ \| Field \| Value \| +--------------+--------------------------------------+ \| id \| e0a15cee-34d1-418a-ac79-74ad07585730 \| \| stack_status \| CREATE_COMPLETE \| +--------------+--------------------------------------+ Set the value of the stack ID to an environment variable: USD export STACK_ID=USD(openstack stack show vnf -c id -f value) Return the metrics as an aggregate by resource type instance (server ID) with the value calculated as a percentage. The aggregate is returned as a value of nanoseconds of CPU time. We divide that number by 1000000000 to get the value in seconds. We then divide the value by our granularity, which in this example is 60 seconds. That value is then converted to a percentage by multiplying by 100. Finally, we divide the total value by the number of vCPU provided by the flavor assigned to the instance, in this example a value of 2 vCPU, providing us a value expressed as a percentage of CPU time: USD openstack metric aggregates --resource-type instance --sort-column timestamp --sort-descending '(/ (* (/ (/ (metric cpu rate:mean) 1000000000) 60) 100) 2)' server_group="USDSTACK_ID" +----------------------------------------------------+---------------------------+-------------+--------------------+ \| name \| timestamp \| granularity \| value \| +----------------------------------------------------+---------------------------+-------------+--------------------+ \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T21:03:00+00:00 \| 60.0 \| 3.158333333333333 \| \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T21:02:00+00:00 \| 60.0 \| 2.6333333333333333 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T21:02:00+00:00 \| 60.0 \| 2.533333333333333 \| \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T21:01:00+00:00 \| 60.0 \| 2.833333333333333 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T21:01:00+00:00 \| 60.0 \| 3.0833333333333335 \| \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T21:00:00+00:00 \| 60.0 \| 13.450000000000001 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T21:00:00+00:00 \| 60.0 \| 2.45 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T21:00:00+00:00 \| 60.0 \| 2.6166666666666667 \| \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T20:59:00+00:00 \| 60.0 \| 60.583333333333336 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:59:00+00:00 \| 60.0 \| 2.35 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T20:59:00+00:00 \| 60.0 \| 2.525 \| \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T20:58:00+00:00 \| 60.0 \| 71.35833333333333 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:58:00+00:00 \| 60.0 \| 3.025 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T20:58:00+00:00 \| 60.0 \| 9.3 \| \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T20:57:00+00:00 \| 60.0 \| 66.19166666666668 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:57:00+00:00 \| 60.0 \| 2.275 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T20:57:00+00:00 \| 60.0 \| 56.31666666666667 \| \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T20:56:00+00:00 \| 60.0 \| 59.50833333333333 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:56:00+00:00 \| 60.0 \| 2.375 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T20:56:00+00:00 \| 60.0 \| 63.949999999999996 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:55:00+00:00 \| 60.0 \| 15.558333333333335 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T20:55:00+00:00 \| 60.0 \| 93.85 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:54:00+00:00 \| 60.0 \| 59.54999999999999 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T20:54:00+00:00 \| 60.0 \| 61.23333333333334 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:53:00+00:00 \| 60.0 \| 74.73333333333333 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:52:00+00:00 \| 60.0 \| 57.86666666666667 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:51:00+00:00 \| 60.0 \| 60.416666666666664 \| +----------------------------------------------------+---------------------------+-------------+--------------------+ 4.4.3. Retrieving available telemetry for an instance workload Retrieve the available telemetry for an instance workload and express the vCPU utilization as a percentage. Prerequisites Create a heat stack using the autoscaling group resource that results in an instance workload. Procedure Login to your OpenStack environment as the cloud adminstrator. Retrieve the ID of the autoscaling group heat stack: USD openstack stack show vnf -c id -c stack_status +--------------+--------------------------------------+ \| Field \| Value \| +--------------+--------------------------------------+ \| id \| e0a15cee-34d1-418a-ac79-74ad07585730 \| \| stack_status \| CREATE_COMPLETE \| +--------------+--------------------------------------+ Set the value of the stack ID to an environment variable: USD export STACK_ID=USD(openstack stack show vnf -c id -f value) Retrieve the ID of the workload instance you want to return data for. We are using the server list long form and filtering for instances that are part of our autoscaling group: USD openstack server list --long --fit-width \| grep "metering.server_group='USDSTACK_ID'" \| bc1811de-48ed-44c1-ae22-c01f36d6cb02 \| vn-xlfb4jb-yhbq6fkk2kec-qsu2lr47zigs-vnf-y27wuo25ce4e \| ACTIVE \| None \| Running \| private=192.168.100.139, 192.168.25.179 \| fedora36 \| d21f1aaa-0077-4313-8a46-266c39b705c1 \| m1.small \| 692533fe-0912-417e-b706-5d085449db53 \| nova \| standalone.localdomain \| metering.server_group='e0a15cee-34d1-418a-ac79-74ad07585730' \| Set the instance ID for one of the returned instance workload names: USD INSTANCE_NAME='vn-xlfb4jb-yhbq6fkk2kec-qsu2lr47zigs-vnf-y27wuo25ce4e' ; export INSTANCE_ID=USD(openstack server list --name USDINSTANCE_NAME -c ID -f value) Verify metrics have been stored for the instance resource ID. If no metrics are available it's possible not enough time has elapsed since the instance was created. If enough time has elapsed, you can check the logs for the data collection service in /var/log/containers/ceilometer/ and logs for the time-series database service gnocchi in /var/log/containers/gnocchi/ : USD openstack metric resource show --column metrics USDINSTANCE_ID +---------+---------------------------------------------------------------------+ \| Field \| Value \| +---------+---------------------------------------------------------------------+ \| metrics \| compute.instance.booting.time: 57ca241d-764b-4c58-aa32-35760d720b08 \| \| \| cpu: d7767d7f-b10c-4124-8893-679b2e5d2ccd \| \| \| disk.ephemeral.size: 038b11db-0598-4cfd-9f8d-4ba6b725375b \| \| \| disk.root.size: 843f8998-e644-41f6-8635-e7c99e28859e \| \| \| memory.usage: 1e554370-05ac-4107-98d8-9330265db750 \| \| \| memory: fbd50c0e-90fa-4ad9-b0df-f7361ceb4e38 \| \| \| vcpus: 0629743e-6baa-4e22-ae93-512dc16bac85 \| +---------+---------------------------------------------------------------------+ Verify there are available measures for the resource metric and note the granularity value as we'll use it when running the openstack metric aggregates command: USD openstack metric measures show --resource-id USDINSTANCE_ID --aggregation rate:mean cpu +---------------------------+-------------+---------------+ \| timestamp \| granularity \| value \| +---------------------------+-------------+---------------+ \| 2022-11-08T14:12:00+00:00 \| 60.0 \| 71920000000.0 \| \| 2022-11-08T14:13:00+00:00 \| 60.0 \| 88920000000.0 \| \| 2022-11-08T14:14:00+00:00 \| 60.0 \| 76130000000.0 \| \| 2022-11-08T14:15:00+00:00 \| 60.0 \| 17640000000.0 \| \| 2022-11-08T14:16:00+00:00 \| 60.0 \| 3330000000.0 \| \| 2022-11-08T14:17:00+00:00 \| 60.0 \| 2450000000.0 \| ... Retrieve the number of vCPU cores applied to the workload instance by reviewing the configured flavor for the instance workload: USD openstack server show USDINSTANCE_ID -cflavor -f value m1.small (692533fe-0912-417e-b706-5d085449db53) USD openstack flavor show 692533fe-0912-417e-b706-5d085449db53 -c vcpus -f value 2 Return the metrics as an aggregate by resource type instance (server ID) with the value calculated as a percentage. The aggregate is returned as a value of nanoseconds of CPU time. We divide that number by 1000000000 to get the value in seconds. We then divide the value by our granularity, which in this example is 60 seconds (as previously retrieved with openstack metric measures show command). That value is then converted to a percentage by multiplying by 100. Finally, we divide the total value by the number of vCPU provided by the flavor assigned to the instance, in this example a value of 2 vCPU, providing us a value expressed as a percentage of CPU time: USD openstack metric aggregates --resource-type instance --sort-column timestamp --sort-descending '(/ (* (/ (/ (metric cpu rate:mean) 1000000000) 60) 100) 2)' id=USDINSTANCE_ID +----------------------------------------------------+---------------------------+-------------+--------------------+ \| name \| timestamp \| granularity \| value \| +----------------------------------------------------+---------------------------+-------------+--------------------+ \| bc1811de-48ed-44c1-ae22-c01f36d6cb02/cpu/rate:mean \| 2022-11-08T14:26:00+00:00 \| 60.0 \| 2.45 \| \| bc1811de-48ed-44c1-ae22-c01f36d6cb02/cpu/rate:mean \| 2022-11-08T14:25:00+00:00 \| 60.0 \| 11.075 \| \| bc1811de-48ed-44c1-ae22-c01f36d6cb02/cpu/rate:mean \| 2022-11-08T14:24:00+00:00 \| 60.0 \| 61.3 \| \| bc1811de-48ed-44c1-ae22-c01f36d6cb02/cpu/rate:mean \| 2022-11-08T14:23:00+00:00 \| 60.0 \| 74.78333333333332 \| \| bc1811de-48ed-44c1-ae22-c01f36d6cb02/cpu/rate:mean \| 2022-11-08T14:22:00+00:00 \| 60.0 \| 55.383333333333326 \| ...	[ "[stack@standalone ~]USD export OS_CLOUD=standalone", "[stack@undercloud ~]USD source ~/stackrc", "ssh -i ~/mykey.pem [email protected]", "[instance ~]USD sudo dd if=/dev/zero of=/dev/null & [instance ~]USD sudo dd if=/dev/zero of=/dev/null & [instance ~]USD sudo dd if=/dev/zero of=/dev/null &", "openstack alarm list +--------------------------------------+--------------------------------------------+-------------------------------------+-------+----------+---------+ \| alarm_id \| type \| name \| state \| severity \| enabled \| +--------------------------------------+--------------------------------------------+-------------------------------------+-------+----------+---------+ \| 022f707d-46cc-4d39-a0b2-afd2fc7ab86a \| gnocchi_aggregation_by_resources_threshold \| example-cpu_alarm_high-odj77qpbld7j \| alarm \| low \| True \| \| 46ed2c50-e05a-44d8-b6f6-f1ebd83af913 \| gnocchi_aggregation_by_resources_threshold \| example-cpu_alarm_low-m37jvnm56x2t \| ok \| low \| True \| +--------------------------------------+--------------------------------------------+-------------------------------------+-------+----------+---------+", "openstack server list +--------------------------------------+-------------------------------------------------------+--------+------------+-------------+---------------------------------------+ \| ID \| Name \| Status \| Task State \| Power State \| Networks \| +--------------------------------------+-------------------------------------------------------+--------+------------+-------------+---------------------------------------+ \| 477ee1af-096c-477c-9a3f-b95b0e2d4ab5 \| ex-3gax-4urpikl5koff-yrxk3zxzfmpf-server-2hde4tp4trnk \| ACTIVE \| - \| Running \| internal1=10.10.10.13, 192.168.122.17 \| \| e1524f65-5be6-49e4-8501-e5e5d812c612 \| ex-3gax-5f3a4og5cwn2-png47w3u2vjd-server-vaajhuv4mj3j \| ACTIVE \| - \| Running \| internal1=10.10.10.9, 192.168.122.8 \| +--------------------------------------+-------------------------------------------------------+--------+------------+-------------+---------------------------------------+", "openstack server list +--------------------------------------+-------------------------------------------------------+--------+------------+-------------+---------------------------------------+ \| ID \| Name \| Status \| Task State \| Power State \| Networks \| +--------------------------------------+-------------------------------------------------------+--------+------------+-------------+---------------------------------------+ \| 477ee1af-096c-477c-9a3f-b95b0e2d4ab5 \| ex-3gax-4urpikl5koff-yrxk3zxzfmpf-server-2hde4tp4trnk \| ACTIVE \| - \| Running \| internal1=10.10.10.13, 192.168.122.17 \| \| e1524f65-5be6-49e4-8501-e5e5d812c612 \| ex-3gax-5f3a4og5cwn2-png47w3u2vjd-server-vaajhuv4mj3j \| ACTIVE \| - \| Running \| internal1=10.10.10.9, 192.168.122.8 \| \| 6c88179e-c368-453d-a01a-555eae8cd77a \| ex-3gax-fvxz3tr63j4o-36fhftuja3bw-server-rhl4sqkjuy5p \| ACTIVE \| - \| Running \| internal1=10.10.10.5, 192.168.122.5 \| +--------------------------------------+-------------------------------------------------------+--------+------------+-------------+---------------------------------------+", "killall dd", "[stack@standalone ~]USD export OS_CLOUD=standalone", "[stack@undercloud ~]USD source ~/stackrc", "openstack alarm list +--------------------------------------+--------------------------------------------+-------------------------------------+-------+----------+---------+ \| alarm_id \| type \| name \| state \| severity \| enabled \| +--------------------------------------+--------------------------------------------+-------------------------------------+-------+----------+---------+ \| 022f707d-46cc-4d39-a0b2-afd2fc7ab86a \| gnocchi_aggregation_by_resources_threshold \| example-cpu_alarm_high-odj77qpbld7j \| ok \| low \| True \| \| 46ed2c50-e05a-44d8-b6f6-f1ebd83af913 \| gnocchi_aggregation_by_resources_threshold \| example-cpu_alarm_low-m37jvnm56x2t \| alarm \| low \| True \| +--------------------------------------+--------------------------------------------+-------------------------------------+-------+----------+---------+", "[stack@standalone ~]USD export OS_CLOUD=standalone", "[stack@undercloud ~]USD source ~/stackrc", "openstack stack event list example 2017-03-06 11:12:43Z [example]: CREATE_IN_PROGRESS Stack CREATE started 2017-03-06 11:12:43Z [example.scaleup_group]: CREATE_IN_PROGRESS state changed 2017-03-06 11:13:04Z [example.scaleup_group]: CREATE_COMPLETE state changed 2017-03-06 11:13:04Z [example.scaledown_policy]: CREATE_IN_PROGRESS state changed 2017-03-06 11:13:05Z [example.scaleup_policy]: CREATE_IN_PROGRESS state changed 2017-03-06 11:13:05Z [example.scaledown_policy]: CREATE_COMPLETE state changed 2017-03-06 11:13:05Z [example.scaleup_policy]: CREATE_COMPLETE state changed 2017-03-06 11:13:05Z [example.cpu_alarm_low]: CREATE_IN_PROGRESS state changed 2017-03-06 11:13:05Z [example.cpu_alarm_high]: CREATE_IN_PROGRESS state changed 2017-03-06 11:13:06Z [example.cpu_alarm_low]: CREATE_COMPLETE state changed 2017-03-06 11:13:07Z [example.cpu_alarm_high]: CREATE_COMPLETE state changed 2017-03-06 11:13:07Z [example]: CREATE_COMPLETE Stack CREATE completed successfully 2017-03-06 11:19:34Z [example.scaleup_policy]: SIGNAL_COMPLETE alarm state changed from alarm to alarm (Remaining as alarm due to 1 samples outside threshold, most recent: 95.4080102993) 2017-03-06 11:25:43Z [example.scaleup_policy]: SIGNAL_COMPLETE alarm state changed from alarm to alarm (Remaining as alarm due to 1 samples outside threshold, most recent: 95.8869217299) 2017-03-06 11:33:25Z [example.scaledown_policy]: SIGNAL_COMPLETE alarm state changed from ok to alarm (Transition to alarm due to 1 samples outside threshold, most recent: 2.73931707966) 2017-03-06 11:39:15Z [example.scaledown_policy]: SIGNAL_COMPLETE alarm state changed from alarm to alarm (Remaining as alarm due to 1 samples outside threshold, most recent: 2.78110858552)", "openstack alarm-history show 022f707d-46cc-4d39-a0b2-afd2fc7ab86a +----------------------------+------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------+ \| timestamp \| type \| detail \| event_id \| +----------------------------+------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------+ \| 2017-03-06T11:32:35.510000 \| state transition \| {\"transition_reason\": \"Transition to ok due to 1 samples inside threshold, most recent: \| 25e0e70b-3eda-466e-abac-42d9cf67e704 \| \| \| \| 2.73931707966\", \"state\": \"ok\"} \| \| \| 2017-03-06T11:17:35.403000 \| state transition \| {\"transition_reason\": \"Transition to alarm due to 1 samples outside threshold, most recent: \| 8322f62c-0d0a-4dc0-9279-435510f81039 \| \| \| \| 95.0964497325\", \"state\": \"alarm\"} \| \| \| 2017-03-06T11:15:35.723000 \| state transition \| {\"transition_reason\": \"Transition to ok due to 1 samples inside threshold, most recent: \| 1503bd81-7eba-474e-b74e-ded8a7b630a1 \| \| \| \| 3.59330523447\", \"state\": \"ok\"} \| \| \| 2017-03-06T11:13:06.413000 \| creation \| {\"alarm_actions\": [\"trust+http://fca6e27e3d524ed68abdc0fd576aa848:[email protected]:8004/v1/fd \| 224f15c0-b6f1-4690-9a22-0c1d236e65f6 \| \| \| \| 1c345135be4ee587fef424c241719d/stacks/example/d9ef59ed-b8f8-4e90-bd9b- \| \| \| \| \| ae87e73ef6e2/resources/scaleup_policy/signal\"], \"user_id\": \"a85f83b7f7784025b6acdc06ef0a8fd8\", \| \| \| \| \| \"name\": \"example-cpu_alarm_high-odj77qpbld7j\", \"state\": \"insufficient data\", \"timestamp\": \| \| \| \| \| \"2017-03-06T11:13:06.413455\", \"description\": \"Scale up if CPU > 80%\", \"enabled\": true, \| \| \| \| \| \"state_timestamp\": \"2017-03-06T11:13:06.413455\", \"rule\": {\"evaluation_periods\": 1, \"metric\": \| \| \| \| \| \"cpu_util\", \"aggregation_method\": \"mean\", \"granularity\": 300, \"threshold\": 80.0, \"query\": \"{\\\"=\\\": \| \| \| \| \| {\\\"server_group\\\": \\\"d9ef59ed-b8f8-4e90-bd9b-ae87e73ef6e2\\\"}}\", \"comparison_operator\": \"gt\", \| \| \| \| \| \"resource_type\": \"instance\"}, \"alarm_id\": \"022f707d-46cc-4d39-a0b2-afd2fc7ab86a\", \| \| \| \| \| \"time_constraints\": [], \"insufficient_data_actions\": null, \"repeat_actions\": true, \"ok_actions\": \| \| \| \| \| null, \"project_id\": \"fd1c345135be4ee587fef424c241719d\", \"type\": \| \| \| \| \| \"gnocchi_aggregation_by_resources_threshold\", \"severity\": \"low\"} \| \| +----------------------------+------------------+-----------------------------------------------------------------------------------------------------+-------------------------------------", "awk '/Stack UPDATE started/,/Stack CREATE completed successfully/ {print USD0}' /var/log/containers/heat/heat-engine.log", "grep -i alarm /var/log/containers/aodh/evaluator.log \| grep -i transition", "openstack stack show vnf -c id -c stack_status +--------------+--------------------------------------+ \| Field \| Value \| +--------------+--------------------------------------+ \| id \| e0a15cee-34d1-418a-ac79-74ad07585730 \| \| stack_status \| CREATE_COMPLETE \| +--------------+--------------------------------------+", "export STACK_ID=USD(openstack stack show vnf -c id -f value)", "openstack metric aggregates --resource-type instance --sort-column timestamp --sort-descending '(/ (* (/ (/ (metric cpu rate:mean) 1000000000) 60) 100) 2)' server_group=\"USDSTACK_ID\" +----------------------------------------------------+---------------------------+-------------+--------------------+ \| name \| timestamp \| granularity \| value \| +----------------------------------------------------+---------------------------+-------------+--------------------+ \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T21:03:00+00:00 \| 60.0 \| 3.158333333333333 \| \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T21:02:00+00:00 \| 60.0 \| 2.6333333333333333 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T21:02:00+00:00 \| 60.0 \| 2.533333333333333 \| \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T21:01:00+00:00 \| 60.0 \| 2.833333333333333 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T21:01:00+00:00 \| 60.0 \| 3.0833333333333335 \| \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T21:00:00+00:00 \| 60.0 \| 13.450000000000001 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T21:00:00+00:00 \| 60.0 \| 2.45 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T21:00:00+00:00 \| 60.0 \| 2.6166666666666667 \| \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T20:59:00+00:00 \| 60.0 \| 60.583333333333336 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:59:00+00:00 \| 60.0 \| 2.35 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T20:59:00+00:00 \| 60.0 \| 2.525 \| \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T20:58:00+00:00 \| 60.0 \| 71.35833333333333 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:58:00+00:00 \| 60.0 \| 3.025 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T20:58:00+00:00 \| 60.0 \| 9.3 \| \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T20:57:00+00:00 \| 60.0 \| 66.19166666666668 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:57:00+00:00 \| 60.0 \| 2.275 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T20:57:00+00:00 \| 60.0 \| 56.31666666666667 \| \| 61bfb555-9efb-46f1-8559-08dec90f94ed/cpu/rate:mean \| 2022-11-07T20:56:00+00:00 \| 60.0 \| 59.50833333333333 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:56:00+00:00 \| 60.0 \| 2.375 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T20:56:00+00:00 \| 60.0 \| 63.949999999999996 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:55:00+00:00 \| 60.0 \| 15.558333333333335 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T20:55:00+00:00 \| 60.0 \| 93.85 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:54:00+00:00 \| 60.0 \| 59.54999999999999 \| \| 199b0cb9-6ed6-4410-9073-0fb2e7842b65/cpu/rate:mean \| 2022-11-07T20:54:00+00:00 \| 60.0 \| 61.23333333333334 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:53:00+00:00 \| 60.0 \| 74.73333333333333 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:52:00+00:00 \| 60.0 \| 57.86666666666667 \| \| a95ab818-fbe8-4acd-9f7b-58e24ade6393/cpu/rate:mean \| 2022-11-07T20:51:00+00:00 \| 60.0 \| 60.416666666666664 \| +----------------------------------------------------+---------------------------+-------------+--------------------+", "openstack stack show vnf -c id -c stack_status +--------------+--------------------------------------+ \| Field \| Value \| +--------------+--------------------------------------+ \| id \| e0a15cee-34d1-418a-ac79-74ad07585730 \| \| stack_status \| CREATE_COMPLETE \| +--------------+--------------------------------------+", "export STACK_ID=USD(openstack stack show vnf -c id -f value)", "openstack server list --long --fit-width \| grep \"metering.server_group='USDSTACK_ID'\" \| bc1811de-48ed-44c1-ae22-c01f36d6cb02 \| vn-xlfb4jb-yhbq6fkk2kec-qsu2lr47zigs-vnf-y27wuo25ce4e \| ACTIVE \| None \| Running \| private=192.168.100.139, 192.168.25.179 \| fedora36 \| d21f1aaa-0077-4313-8a46-266c39b705c1 \| m1.small \| 692533fe-0912-417e-b706-5d085449db53 \| nova \| standalone.localdomain \| metering.server_group='e0a15cee-34d1-418a-ac79-74ad07585730' \|", "INSTANCE_NAME='vn-xlfb4jb-yhbq6fkk2kec-qsu2lr47zigs-vnf-y27wuo25ce4e' ; export INSTANCE_ID=USD(openstack server list --name USDINSTANCE_NAME -c ID -f value)", "openstack metric resource show --column metrics USDINSTANCE_ID +---------+---------------------------------------------------------------------+ \| Field \| Value \| +---------+---------------------------------------------------------------------+ \| metrics \| compute.instance.booting.time: 57ca241d-764b-4c58-aa32-35760d720b08 \| \| \| cpu: d7767d7f-b10c-4124-8893-679b2e5d2ccd \| \| \| disk.ephemeral.size: 038b11db-0598-4cfd-9f8d-4ba6b725375b \| \| \| disk.root.size: 843f8998-e644-41f6-8635-e7c99e28859e \| \| \| memory.usage: 1e554370-05ac-4107-98d8-9330265db750 \| \| \| memory: fbd50c0e-90fa-4ad9-b0df-f7361ceb4e38 \| \| \| vcpus: 0629743e-6baa-4e22-ae93-512dc16bac85 \| +---------+---------------------------------------------------------------------+", "openstack metric measures show --resource-id USDINSTANCE_ID --aggregation rate:mean cpu +---------------------------+-------------+---------------+ \| timestamp \| granularity \| value \| +---------------------------+-------------+---------------+ \| 2022-11-08T14:12:00+00:00 \| 60.0 \| 71920000000.0 \| \| 2022-11-08T14:13:00+00:00 \| 60.0 \| 88920000000.0 \| \| 2022-11-08T14:14:00+00:00 \| 60.0 \| 76130000000.0 \| \| 2022-11-08T14:15:00+00:00 \| 60.0 \| 17640000000.0 \| \| 2022-11-08T14:16:00+00:00 \| 60.0 \| 3330000000.0 \| \| 2022-11-08T14:17:00+00:00 \| 60.0 \| 2450000000.0 \|", "openstack server show USDINSTANCE_ID -cflavor -f value m1.small (692533fe-0912-417e-b706-5d085449db53) openstack flavor show 692533fe-0912-417e-b706-5d085449db53 -c vcpus -f value 2", "openstack metric aggregates --resource-type instance --sort-column timestamp --sort-descending '(/ (* (/ (/ (metric cpu rate:mean) 1000000000) 60) 100) 2)' id=USDINSTANCE_ID +----------------------------------------------------+---------------------------+-------------+--------------------+ \| name \| timestamp \| granularity \| value \| +----------------------------------------------------+---------------------------+-------------+--------------------+ \| bc1811de-48ed-44c1-ae22-c01f36d6cb02/cpu/rate:mean \| 2022-11-08T14:26:00+00:00 \| 60.0 \| 2.45 \| \| bc1811de-48ed-44c1-ae22-c01f36d6cb02/cpu/rate:mean \| 2022-11-08T14:25:00+00:00 \| 60.0 \| 11.075 \| \| bc1811de-48ed-44c1-ae22-c01f36d6cb02/cpu/rate:mean \| 2022-11-08T14:24:00+00:00 \| 60.0 \| 61.3 \| \| bc1811de-48ed-44c1-ae22-c01f36d6cb02/cpu/rate:mean \| 2022-11-08T14:23:00+00:00 \| 60.0 \| 74.78333333333332 \| \| bc1811de-48ed-44c1-ae22-c01f36d6cb02/cpu/rate:mean \| 2022-11-08T14:22:00+00:00 \| 60.0 \| 55.383333333333326 \|" ]	https://docs.redhat.com/en/documentation/red_hat_openstack_platform/17.0/html/autoscaling_for_instances/assembly_testing-and-troubleshooting-autoscaling_assembly_testing-and-troubleshooting-autoscaling
Chapter 8. OpenShift Connector overview	Chapter 8. OpenShift Connector overview OpenShift Connector, also referred to as Visual Studio Code OpenShift Connector for Red Hat OpenShift, is a plug-in for CodeReady Workspaces that provides a method for interacting with Red Hat OpenShift 3 or 4 clusters. OpenShift Connector makes it possible to create, build, and debug applications in the CodeReady Workspaces IDE and then deploy the applications directly to a running OpenShift cluster. OpenShift Connector is a GUI for the OpenShift Do ( odo ) utility, which aggregates OpenShift CLI ( oc ) commands into compact units. As such, OpenShift Connector helps new developers who do not have OpenShift background with creating applications and running them on the cloud. Rather than using several oc commands, the user creates a new component or service by selecting a preconfigured template, such as a Project, an Application, or a Service, and then deploys it as an OpenShift Component to their cluster. This section provides information about installing, enabling, and basic use of the OpenShift Connector plug-in. Section 8.1, "Features of OpenShift Connector" Section 8.2, "Installing OpenShift Connector in CodeReady Workspaces" Section 8.3, "Authenticating with OpenShift Connector from CodeReady Workspaces when the OpenShift OAuth service does not authenticate the CodeReady Workspaces instance" Section 8.4, "Creating Components with OpenShift Connector in CodeReady Workspaces" Section 8.5, "Connecting source code from GitHub to an OpenShift Component using OpenShift Connector" 8.1. Features of OpenShift Connector The OpenShift Connector plug-in enables the user create, deploy, and push OpenShift Components to an OpenShift Cluster in a GUI. When used in CodeReady Workspaces, the OpenShift Connector GUI provides the following benefits to its users: Cluster management Logging in to clusters using: Authentication tokens Username and password Auto-login feature when CodeReady Workspaces is authenticated with the OpenShift OAuth service Switching contexts between different .kube/config entries directly from the extension view. Viewing and managing OpenShift resources as build and deployment. configurations from the Explorer view. Development Connecting to a local or hosted OpenShift cluster directly from CodeReady Workspaces. Quickly updating the cluster with your changes. Creating Components, Services, and Routes on the connected cluster. Adding storage directly to a component from the extension itself. Deployment Deploying to OpenShift clusters with a single click directly from CodeReady Workspaces. Navigating to the multiple Routes, created to access the deployed application. Deploying multiple interlinked Components and Services directly on the cluster. Pushing and watching component changes from the CodeReady Workspaces IDE. Streaming logs directly on the integrated terminal view of CodeReady Workspaces. Monitoring Working with OpenShift resources directly from the CodeReady Workspaces IDE. Starting and resuming build and deployment configurations. Viewing and following logs for deployments, Pods, and containers. 8.2. Installing OpenShift Connector in CodeReady Workspaces OpenShift Connector is a plug-in designed to create basic OpenShift Components, using CodeReady Workspaces as the editor, and to deploy the Component to an OpenShift cluster. To visually verify that the plug-in is available in your instance, see whether the OpenShift icon is displayed in the CodeReady Workspaces left menu. To install and enable OpenShift Connector in a CodeReady Workspaces instance, use instructions in this section. Prerequisites A running instance of Red Hat CodeReady Workspaces. To install an instance of Red Hat CodeReady Workspaces, see https://access.redhat.com/documentation/en-us/red_hat_codeready_workspaces/2.15/html-single/installation_guide/index#installing-che.adoc . Procedure Install OpenShift Connector in CodeReady Workspaces by adding it as an extension in the CodeReady Workspaces Plugins panel. Open the CodeReady Workspaces Plugins panel by pressing Ctrl + Shift + J or by navigating to View Plugins . Search for vscode-openshift-connector , and click the Install button. Restart the workspace for the changes to take effect. The dedicated OpenShift Application Explorer icon is added to the left panel. 8.3. Authenticating with OpenShift Connector from CodeReady Workspaces when the OpenShift OAuth service does not authenticate the CodeReady Workspaces instance This section describes how to authenticate with an OpenShift cluster when the OpenShift OAuth service does not authenticate the CodeReady Workspaces instance. It enables the user to develop and push Components from CodeReady Workspaces to the OpenShift instance that contains CodeReady Workspaces. Note When the OpenShift OAuth service authenticates the CodeReady Workspaces instance, the OpenShift Connector plug-in automatically establishes the authentication with the OpenShift instance containing CodeReady Workspaces. OpenShift Connector offers the following methods for logging in to the OpenShift Cluster from the CodeReady Workspaces instance: Using the notification asking to log in to the OpenShift instance containing CodeReady Workspaces. Using the Log in to the cluster button. Using the Command Palette. Note OpenShift Connector plug-in requires manual connecting to the target cluster. The OpenShift Connector plug-in logs in to the cluster as inClusterUser . If this user does not have manage project permission, this error message appears when creating a project using OpenShift Application Explorer: Failed to create Project with error 'Error: Command failed: "/tmp/vscode-unpacked/redhat.vscode-openshift -connector.latest.qvkozqtkba.openshift-connector-0.1.4-523.vsix/extension/out/tools/linux/odo" project create test-project [✗] projectrequests.project.openshift.io is forbidden To work around this issue: Log out from the local cluster. Log in to OpenShift cluster using the OpenShift user's credentials. Prerequisites A running instance of CodeReady Workspaces. See https://access.redhat.com/documentation/en-us/red_hat_codeready_workspaces/2.15/html-single/installation_guide/index#installing-che.adoc . A CodeReady Workspaces workspace is available. See Chapter 3, Developer workspaces . The OpenShift Connector plug-in is available. See Section 8.2, "Installing OpenShift Connector in CodeReady Workspaces" . The OpenShift OAuth provider is available only for the auto-login to the OpenShift instance containing CodeReady Workspaces. See https://access.redhat.com/documentation/en-us/red_hat_codeready_workspaces/2.15/html-single/administration_guide/index#configuring-openshift-oauth.adoc . Procedure In the left panel, click the OpenShift Application Explorer icon. In the OpenShift Connector panel, log in using the OpenShift Application Explorer. Use one of the following methods: Click the Log in to cluster button in the top left corner of the pane. Press F1 to open the Command Palette, or navigate to View > Find Command in the top menu. Search for OpenShift: Log in to cluster and press Enter . If a You are already logged in a cluster. message appears, click Yes . Select the method to log in to the cluster: Credentials or Token , and follow the login instructions. Note To authenticate with a token, the required token information is in the upper right corner of the main OpenShift Container Platform screen, under <User name> > Copy Login Command . 8.4. Creating Components with OpenShift Connector in CodeReady Workspaces In the context of OpenShift, Components and Services are basic structures that need to be stored in Application, which is a part of the OpenShift project that organizes deployable assets into virtual folders for better readability. This chapter describes how to create OpenShift Components in the CodeReady Workspaces using the OpenShift Connector plug-in and push them to an OpenShift cluster. Prerequisites A running instance of CodeReady Workspaces. To install an instance of CodeReady Workspaces, see https://access.redhat.com/documentation/en-us/red_hat_codeready_workspaces/2.15/html-single/installation_guide/index#installing-che.adoc . The user is logged in to an OpenShift cluster using the OpenShift Connector plug-in. Procedure In the OpenShift Connector panel, right-click the row with the red OpenShift icon and select New Project . Enter a name for your project. Right-click the created project and select New Component . When prompted, enter the name for a new OpenShift Application in which the component can be stored. The following options of source for your component are displayed: Git Repository This prompts you to specify a Git repository URL and select the intended revision of the runtime. Binary File This prompts you to select a file from the file explorer. Workspace Directory This prompts you to select a folder from the file explorer. Enter the name for the component. Select the component type. Select the component type version. The component is created. Right-click the component, select New URL , and enter a name of your choice. The component is ready to be pushed to the OpenShift cluster. To do so, right-click the component and select Push . The component is deployed to the cluster. Use a right-click for selecting additional actions, such as debugging and opening in a browser, which requires the exposure of the port 8080 . 8.5. Connecting source code from GitHub to an OpenShift Component using OpenShift Connector When the user has a Git-stored source code that is wanted for further development, it is more efficient to deploy it directly from the Git repository into the OpenShift Connector Component. This chapter describes how to obtain the content from the Git repository and connect it with a CodeReady Workspaces-developed OpenShift Component. Prerequisites Have a running CodeReady Workspaces workspace. Be logged in to the OpenShift cluster using the OpenShift Connector. Procedure To make changes to your GitHub component, clone the repository into CodeReady Workspaces to obtain this source code: In the CodeReady Workspaces main screen, open the Command Palette by pressing F1 . Type the Git Clone command in the Command Palette and press Enter . Provide the GitHub URL and select the destination for the deployment. Add source-code files to your Project using the Add to workspace button. For additional information about cloning Git repository, see: Section 2.2.2, "Accessing a Git repository using HTTPS" .	null	https://docs.redhat.com/en/documentation/red_hat_codeready_workspaces/2.15/html/end-user_guide/openshift-connector-overview_crw
Providing feedback on Red Hat documentation	Providing feedback on Red Hat documentation We appreciate and prioritize your feedback regarding our documentation. Provide as much detail as possible, so that your request can be quickly addressed. Prerequisites You are logged in to the Red Hat Customer Portal. Procedure To provide feedback, perform the following steps: Click the following link: Create Issue Describe the issue or enhancement in the Summary text box. Provide details about the issue or requested enhancement in the Description text box. Type your name in the Reporter text box. Click the Create button. This action creates a documentation ticket and routes it to the appropriate documentation team. Thank you for taking the time to provide feedback.	null	https://docs.redhat.com/en/documentation/red_hat_insights/1-latest/html/assessing_and_monitoring_rhel_resource_optimization_with_insights_for_red_hat_enterprise_linux_with_fedramp/proc-providing-feedback-on-redhat-documentation
2.2. Host Security Recommended Practices for Red Hat Enterprise Linux	2.2. Host Security Recommended Practices for Red Hat Enterprise Linux With host security being such a critical part of a secure virtualization infrastructure, the following recommended practices should serve as a starting point for securing a Red Hat Enterprise Linux host system: Run only the services necessary to support the use and management of your guest systems. If you need to provide additional services, such as file or print services, you should consider running those services on a Red Hat Enterprise Linux guest. Limit direct access to the system to only those users who have a need to manage the system. Consider disallowing shared root access and instead use tools such as sudo to grant privileged access to administrators based on their administrative roles. Ensure that SELinux is configured properly for your installation and is operating in enforcing mode. Besides being a good security practice, the advanced virtualization security functionality provided by sVirt relies on SELinux. Refer to Chapter 4, sVirt for more information on SELinux and sVirt. Ensure that auditing is enabled on the host system and that libvirt is configured to emit audit records. When auditing is enabled, libvirt will generate audit records for changes to guest configuration as well start/stop events which help you track the guest's state. In addition to the standard audit log inspection tools, the libvirt audit events can also be viewed using the specialized auvirt tool. Ensure that any remote management of the system takes place only over secured network channels. Tools such as SSH and network protocols such as TLS or SSL provide both authentication and data encryption to help ensure that only approved administrators can manage the system remotely. Ensure that the firewall is configured properly for your installation and is activated at boot. Only those network ports needed for the use and management of the system should be allowed. Refrain from granting guests direct access to entire disks or block devices (for example, /dev/sdb ); instead, use partitions (for example, /dev/sdb1 ) or LVM volumes for guest storage. Ensure that staff have adequate training and knowledge in virtual environments. Warning Attaching a USB device, Physical Function or physical device when SR-IOV is not available to a virtual machine could provide access to the device which is sufficient enough to overwrite that device's firmware. This presents a potential security issue by which an attacker could overwrite the device's firmware with malicious code and cause problems when moving the device between virtual machines or at host boot time. It is advised to use SR-IOV Virtual Function device assignment where applicable. Note The objective of this guide is to explain the unique security-related challenges, vulnerabilities, and solutions that are present in most virtualized environments, and the recommended method of addressing them. However, there are a number of recommended practices to follow when securing a Red Hat Enterprise Linux system that apply regardless of whether the system is a standalone, virtualization host, or guest instance. These recommended practices include procedures such as system updates, password security, encryption, and firewall configuration. This information is discussed in more detail in the Red Hat Enterprise Linux Security Guide . 2.2.1. Special Considerations for Public Cloud Operators Public cloud service providers are exposed to a number of security risks beyond that of the traditional virtualization user. Virtual guest isolation, both between the host and guest as well as between guests, is critical due to the threat of malicious guests and the requirements on customer data confidentiality and integrity across the virtualization infrastructure. In addition to the Red Hat Enterprise Linux virtualization recommended practices previously listed, public cloud operators should also consider the following items: Disallow any direct hardware access from the guest. PCI, USB, FireWire, Thunderbolt, eSATA and other device passthrough mechanisms not only make management difficult, but often rely on the underlying hardware to enforce separation between the guests. Isolate the cloud operator's private management network from the customer guest network, and customer networks from one another, so that: the guests cannot access the host systems over the network. one customer cannot access another customer's guest systems directly via the cloud provider's internal network.	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/virtualization_security_guide/sect-virtualization_security_guide-host_security-host_security_recommended_practices_for_red_hat_enterprise_linux
9.10. Balloon Driver	9.10. Balloon Driver The balloon driver allows guests to express to the hypervisor how much memory they require. The balloon driver allows the host to efficiently allocate and memory to the guest and allow free memory to be allocated to other guests and processes. Guests using the balloon driver can mark sections of the guest's RAM as not in use (balloon inflation). The hypervisor can free the memory and use the memory for other host processes or other guests on that host. When the guest requires the freed memory again, the hypervisor can reallocate RAM to the guest (balloon deflation).	null	https://docs.redhat.com/en/documentation/red_hat_virtualization/4.4/html/technical_reference/balloon_driver
Chapter 1. Planning Red Hat Gluster Storage Installation	Chapter 1. Planning Red Hat Gluster Storage Installation This chapter outlines the minimum hardware and software installation requirements for a successful installation, configuration, and operation of a Red Hat Gluster Storage Server environment. 1.1. About Red Hat Gluster Storage Red Hat Gluster Storage is a software-only, scale-out storage that provides flexible and affordable unstructured data storage for the enterprise. Red Hat Gluster Storage 3.5 provides new opportunities to unify data storage and infrastructure, increase performance, and improve availability and manageability in order to meet a broader set of an organization's storage challenges and requirements. GlusterFS, a key building block of Red Hat Gluster Storage, is based on a stackable user space design and can deliver exceptional performance for diverse workloads. GlusterFS aggregates various storage servers over network interconnects into one large parallel network file system. The POSIX compatible GlusterFS servers, which use XFS file system format to store data on disks, can be accessed using industry standard access protocols including NFS and CIFS. Red Hat Gluster Storage can be deployed in the private cloud or datacenter using Red Hat Gluster Storage Server for On-Premise. Red Hat Gluster Storage can be installed on commodity servers or virtual machines and storage hardware resulting in a powerful, massively scalable, and highly available NAS environment. Additionally, Red Hat Gluster Storage can be deployed in the public cloud using Red Hat Gluster Storage Server for Public Cloud, for example, within the Amazon Web Services (AWS) cloud. It delivers all the features and functionality possible in a private cloud or datacenter to the public cloud by providing massively scalable and highly available NAS in the cloud. Red Hat Gluster Storage Server for On-Premise Red Hat Gluster Storage Server for On-Premise enables enterprises to treat physical storage as a virtualized, scalable, and centrally managed pool of storage by using commodity server and storage hardware. Red Hat Gluster Storage Server for Public Cloud Red Hat Gluster Storage Server for Public Cloud packages GlusterFS as an Amazon Machine Image (AMI) for deploying scalable NAS in the AWS public cloud. This powerful storage server provides a highly available, scalable, virtualized, and centrally managed pool of storage for Amazon users. Storage node A storage node can be a physical server, a virtual machine, or a public cloud machine image running one instance of Red Hat Gluster Storage.	null	https://docs.redhat.com/en/documentation/red_hat_gluster_storage/3.5/html/installation_guide/chap-planning_red_hat_storage_installation
Chapter 15. Uninstalling a cluster on GCP	Chapter 15. Uninstalling a cluster on GCP You can remove a cluster that you deployed to Google Cloud Platform (GCP). 15.1. Removing a cluster that uses installer-provisioned infrastructure You can remove a cluster that uses installer-provisioned infrastructure from your cloud. Note After uninstallation, check your cloud provider for any resources not removed properly, especially with User Provisioned Infrastructure (UPI) clusters. There might be resources that the installer did not create or that the installer is unable to access. For example, some Google Cloud resources require IAM permissions in shared VPC host projects, or there might be unused health checks that must be deleted . Prerequisites You have a copy of the installation program that you used to deploy the cluster. You have the files that the installation program generated when you created your cluster. Procedure From the directory that contains the installation program on the computer that you used to install the cluster, run the following command: USD ./openshift-install destroy cluster \ --dir <installation_directory> --log-level info 1 2 1 For <installation_directory> , specify the path to the directory that you stored the installation files in. 2 To view different details, specify warn , debug , or error instead of info . Note You must specify the directory that contains the cluster definition files for your cluster. The installation program requires the metadata.json file in this directory to delete the cluster. Optional: Delete the <installation_directory> directory and the OpenShift Container Platform installation program. 15.2. Deleting Google Cloud Platform resources with the Cloud Credential Operator utility After uninstalling an OpenShift Container Platform cluster that uses short-term credentials managed outside the cluster, you can use the CCO utility ( ccoctl ) to remove the Google Cloud Platform (GCP) resources that ccoctl created during installation. Prerequisites Extract and prepare the ccoctl binary. Uninstall an OpenShift Container Platform cluster on GCP that uses short-term credentials. Procedure Set a USDRELEASE_IMAGE variable with the release image from your installation file by running the following command: USD RELEASE_IMAGE=USD(./openshift-install version \| awk '/release image/ {print USD3}') Extract the list of CredentialsRequest custom resources (CRs) from the OpenShift Container Platform release image by running the following command: USD oc adm release extract \ --from=USDRELEASE_IMAGE \ --credentials-requests \ --included \ 1 --to=<path_to_directory_for_credentials_requests> 2 1 The --included parameter includes only the manifests that your specific cluster configuration requires. 2 Specify the path to the directory where you want to store the CredentialsRequest objects. If the specified directory does not exist, this command creates it. Delete the GCP resources that ccoctl created by running the following command: USD ccoctl gcp delete \ --name=<name> \ 1 --project=<gcp_project_id> \ 2 --credentials-requests-dir=<path_to_credentials_requests_directory> \ --force-delete-custom-roles 3 1 <name> matches the name that was originally used to create and tag the cloud resources. 2 <gcp_project_id> is the GCP project ID in which to delete cloud resources. 3 Optional: This parameter deletes the custom roles that the ccoctl utility creates during installation. GCP does not permanently delete custom roles immediately. For more information, see GCP documentation about deleting a custom role . Verification To verify that the resources are deleted, query GCP. For more information, refer to GCP documentation.	[ "./openshift-install destroy cluster --dir <installation_directory> --log-level info 1 2", "RELEASE_IMAGE=USD(./openshift-install version \| awk '/release image/ {print USD3}')", "oc adm release extract --from=USDRELEASE_IMAGE --credentials-requests --included \\ 1 --to=<path_to_directory_for_credentials_requests> 2", "ccoctl gcp delete --name=<name> \\ 1 --project=<gcp_project_id> \\ 2 --credentials-requests-dir=<path_to_credentials_requests_directory> --force-delete-custom-roles 3" ]	https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/installing_on_gcp/uninstalling-cluster-gcp
4.5.6. Logging Configuration	4.5.6. Logging Configuration Clicking on the Logging tab displays the Logging Configuration page, which provides an interface for configuring logging settings. You can configure the following settings for global logging configuration: Checking Log Debugging Messages enables debugging messages in the log file. Checking Log Messages to Syslog enables messages to syslog . You can select the Syslog Message Facility and the Syslog Message Priority . The Syslog Message Priority setting indicates that messages at the selected level and higher are sent to syslog . Checking Log Messages to Log File enables messages to the log file. You can specify the Log File Path name. The logfile message priority setting indicates that messages at the selected level and higher are written to the log file. You can override the global logging settings for specific daemons by selecting one of the daemons listed beneath the Daemon-specific Logging Overrides heading at the bottom of the Logging Configuration page. After selecting the daemon, you can check whether to log the debugging messages for that particular daemon. You can also specify the syslog and log file settings for that daemon. Click Apply for the logging configuration changes you have specified to take effect.	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/cluster_administration/s1-config-logging-conga-CA
Chapter 10. Subscription [operators.coreos.com/v1alpha1]	Chapter 10. Subscription [operators.coreos.com/v1alpha1] Description Subscription keeps operators up to date by tracking changes to Catalogs. Type object Required metadata spec 10.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's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata spec object SubscriptionSpec defines an Application that can be installed status object 10.1.1. .spec Description SubscriptionSpec defines an Application that can be installed Type object Required name source sourceNamespace Property Type Description channel string config object SubscriptionConfig contains configuration specified for a subscription. installPlanApproval string Approval is the user approval policy for an InstallPlan. It must be one of "Automatic" or "Manual". name string source string sourceNamespace string startingCSV string 10.1.2. .spec.config Description SubscriptionConfig contains configuration specified for a subscription. Type object Property Type Description affinity object If specified, overrides the pod's scheduling constraints. nil sub-attributes will not override the original values in the pod.spec for those sub-attributes. Use empty object ({}) to erase original sub-attribute values. annotations object (string) Annotations is an unstructured key value map stored with each Deployment, Pod, APIService in the Operator. Typically, annotations may be set by external tools to store and retrieve arbitrary metadata. Use this field to pre-define annotations that OLM should add to each of the Subscription's deployments, pods, and apiservices. env array Env is a list of environment variables to set in the container. Cannot be updated. env[] object EnvVar represents an environment variable present in a Container. envFrom array EnvFrom is a list of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Immutable. envFrom[] object EnvFromSource represents the source of a set of ConfigMaps nodeSelector object (string) NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ resources object Resources represents compute resources required by this container. Immutable. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ selector object Selector is the label selector for pods to be configured. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels. tolerations array Tolerations are the pod's tolerations. tolerations[] object The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>. volumeMounts array List of VolumeMounts to set in the container. volumeMounts[] object VolumeMount describes a mounting of a Volume within a container. volumes array List of Volumes to set in the podSpec. volumes[] object Volume represents a named volume in a pod that may be accessed by any container in the pod. 10.1.3. .spec.config.affinity Description If specified, overrides the pod's scheduling constraints. nil sub-attributes will not override the original values in the pod.spec for those sub-attributes. Use empty object ({}) to erase original sub-attribute values. Type object Property Type Description nodeAffinity object Describes node affinity scheduling rules for the pod. podAffinity object Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). podAntiAffinity object Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). 10.1.4. .spec.config.affinity.nodeAffinity Description Describes node affinity scheduling rules for the pod. Type object Property Type Description preferredDuringSchedulingIgnoredDuringExecution array The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. preferredDuringSchedulingIgnoredDuringExecution[] object An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). requiredDuringSchedulingIgnoredDuringExecution object If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. 10.1.5. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution Description The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. Type array 10.1.6. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). Type object Required preference weight Property Type Description preference object A node selector term, associated with the corresponding weight. weight integer Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. 10.1.7. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference Description A node selector term, associated with the corresponding weight. Type object Property Type Description matchExpressions array A list of node selector requirements by node's labels. matchExpressions[] object A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. matchFields array A list of node selector requirements by node's fields. matchFields[] object A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. 10.1.8. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions Description A list of node selector requirements by node's labels. Type array 10.1.9. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] Description A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string The label key that the selector applies to. operator string Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. values array (string) An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. 10.1.10. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields Description A list of node selector requirements by node's fields. Type array 10.1.11. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] Description A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string The label key that the selector applies to. operator string Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. values array (string) An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. 10.1.12. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution Description If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. Type object Required nodeSelectorTerms Property Type Description nodeSelectorTerms array Required. A list of node selector terms. The terms are ORed. nodeSelectorTerms[] object A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. 10.1.13. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms Description Required. A list of node selector terms. The terms are ORed. Type array 10.1.14. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] Description A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. Type object Property Type Description matchExpressions array A list of node selector requirements by node's labels. matchExpressions[] object A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. matchFields array A list of node selector requirements by node's fields. matchFields[] object A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. 10.1.15. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions Description A list of node selector requirements by node's labels. Type array 10.1.16. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] Description A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string The label key that the selector applies to. operator string Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. values array (string) An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. 10.1.17. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields Description A list of node selector requirements by node's fields. Type array 10.1.18. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] Description A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string The label key that the selector applies to. operator string Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. values array (string) An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. 10.1.19. .spec.config.affinity.podAffinity Description Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). Type object Property Type Description preferredDuringSchedulingIgnoredDuringExecution array The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. preferredDuringSchedulingIgnoredDuringExecution[] object The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) requiredDuringSchedulingIgnoredDuringExecution array If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. requiredDuringSchedulingIgnoredDuringExecution[] object Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running 10.1.20. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution Description The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. Type array 10.1.21. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) Type object Required podAffinityTerm weight Property Type Description podAffinityTerm object Required. A pod affinity term, associated with the corresponding weight. weight integer weight associated with matching the corresponding podAffinityTerm, in the range 1-100. 10.1.22. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Description Required. A pod affinity term, associated with the corresponding weight. Type object Required topologyKey Property Type Description labelSelector object A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods. matchLabelKeys array (string) MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. mismatchLabelKeys array (string) MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. namespaceSelector object A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. namespaces array (string) namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". topologyKey string This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. 10.1.23. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Description A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods. Type object Property Type Description matchExpressions array matchExpressions is a list of label selector requirements. The requirements are ANDed. matchExpressions[] object A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. matchLabels object (string) matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. 10.1.24. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 10.1.25. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Description A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string key is the label key that the selector applies to. operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. values array (string) values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. 10.1.26. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector Description A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. Type object Property Type Description matchExpressions array matchExpressions is a list of label selector requirements. The requirements are ANDed. matchExpressions[] object A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. matchLabels object (string) matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. 10.1.27. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 10.1.28. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] Description A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string key is the label key that the selector applies to. operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. values array (string) values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. 10.1.29. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution Description If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. Type array 10.1.30. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Description Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running Type object Required topologyKey Property Type Description labelSelector object A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods. matchLabelKeys array (string) MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. mismatchLabelKeys array (string) MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. namespaceSelector object A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. namespaces array (string) namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". topologyKey string This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. 10.1.31. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Description A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods. Type object Property Type Description matchExpressions array matchExpressions is a list of label selector requirements. The requirements are ANDed. matchExpressions[] object A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. matchLabels object (string) matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. 10.1.32. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 10.1.33. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Description A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string key is the label key that the selector applies to. operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. values array (string) values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. 10.1.34. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector Description A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. Type object Property Type Description matchExpressions array matchExpressions is a list of label selector requirements. The requirements are ANDed. matchExpressions[] object A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. matchLabels object (string) matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. 10.1.35. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 10.1.36. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] Description A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string key is the label key that the selector applies to. operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. values array (string) values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. 10.1.37. .spec.config.affinity.podAntiAffinity Description Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). Type object Property Type Description preferredDuringSchedulingIgnoredDuringExecution array The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. preferredDuringSchedulingIgnoredDuringExecution[] object The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) requiredDuringSchedulingIgnoredDuringExecution array If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. requiredDuringSchedulingIgnoredDuringExecution[] object Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running 10.1.38. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution Description The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. Type array 10.1.39. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) Type object Required podAffinityTerm weight Property Type Description podAffinityTerm object Required. A pod affinity term, associated with the corresponding weight. weight integer weight associated with matching the corresponding podAffinityTerm, in the range 1-100. 10.1.40. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Description Required. A pod affinity term, associated with the corresponding weight. Type object Required topologyKey Property Type Description labelSelector object A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods. matchLabelKeys array (string) MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. mismatchLabelKeys array (string) MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. namespaceSelector object A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. namespaces array (string) namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". topologyKey string This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. 10.1.41. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Description A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods. Type object Property Type Description matchExpressions array matchExpressions is a list of label selector requirements. The requirements are ANDed. matchExpressions[] object A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. matchLabels object (string) matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. 10.1.42. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 10.1.43. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Description A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string key is the label key that the selector applies to. operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. values array (string) values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. 10.1.44. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector Description A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. Type object Property Type Description matchExpressions array matchExpressions is a list of label selector requirements. The requirements are ANDed. matchExpressions[] object A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. matchLabels object (string) matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. 10.1.45. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 10.1.46. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] Description A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string key is the label key that the selector applies to. operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. values array (string) values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. 10.1.47. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution Description If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. Type array 10.1.48. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Description Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running Type object Required topologyKey Property Type Description labelSelector object A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods. matchLabelKeys array (string) MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. mismatchLabelKeys array (string) MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. namespaceSelector object A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. namespaces array (string) namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". topologyKey string This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. 10.1.49. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Description A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods. Type object Property Type Description matchExpressions array matchExpressions is a list of label selector requirements. The requirements are ANDed. matchExpressions[] object A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. matchLabels object (string) matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. 10.1.50. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 10.1.51. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Description A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string key is the label key that the selector applies to. operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. values array (string) values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. 10.1.52. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector Description A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. Type object Property Type Description matchExpressions array matchExpressions is a list of label selector requirements. The requirements are ANDed. matchExpressions[] object A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. matchLabels object (string) matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. 10.1.53. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 10.1.54. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] Description A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string key is the label key that the selector applies to. operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. values array (string) values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. 10.1.55. .spec.config.env Description Env is a list of environment variables to set in the container. Cannot be updated. Type array 10.1.56. .spec.config.env[] Description EnvVar represents an environment variable present in a Container. Type object Required name Property Type Description name string Name of the environment variable. Must be a C_IDENTIFIER. value string Variable references USD(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double are reduced to a single USD, which allows for escaping the USD(VAR_NAME) syntax: i.e. "(VAR_NAME)" will produce the string literal "USD(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". valueFrom object Source for the environment variable's value. Cannot be used if value is not empty. 10.1.57. .spec.config.env[].valueFrom Description Source for the environment variable's value. Cannot be used if value is not empty. Type object Property Type Description configMapKeyRef object Selects a key of a ConfigMap. fieldRef object Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'] , metadata.annotations['<KEY>'] , spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. resourceFieldRef object Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. secretKeyRef object Selects a key of a secret in the pod's namespace 10.1.58. .spec.config.env[].valueFrom.configMapKeyRef Description Selects a key of a ConfigMap. Type object Required key Property Type Description key string The key to select. name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? optional boolean Specify whether the ConfigMap or its key must be defined 10.1.59. .spec.config.env[].valueFrom.fieldRef Description Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'] , metadata.annotations['<KEY>'] , spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. Type object Required fieldPath Property Type Description apiVersion string Version of the schema the FieldPath is written in terms of, defaults to "v1". fieldPath string Path of the field to select in the specified API version. 10.1.60. .spec.config.env[].valueFrom.resourceFieldRef Description Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. Type object Required resource Property Type Description containerName string Container name: required for volumes, optional for env vars divisor integer-or-string Specifies the output format of the exposed resources, defaults to "1" resource string Required: resource to select 10.1.61. .spec.config.env[].valueFrom.secretKeyRef Description Selects a key of a secret in the pod's namespace Type object Required key Property Type Description key string The key of the secret to select from. Must be a valid secret key. name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? optional boolean Specify whether the Secret or its key must be defined 10.1.62. .spec.config.envFrom Description EnvFrom is a list of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Immutable. Type array 10.1.63. .spec.config.envFrom[] Description EnvFromSource represents the source of a set of ConfigMaps Type object Property Type Description configMapRef object The ConfigMap to select from prefix string An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. secretRef object The Secret to select from 10.1.64. .spec.config.envFrom[].configMapRef Description The ConfigMap to select from Type object Property Type Description name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? optional boolean Specify whether the ConfigMap must be defined 10.1.65. .spec.config.envFrom[].secretRef Description The Secret to select from Type object Property Type Description name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? optional boolean Specify whether the Secret must be defined 10.1.66. .spec.config.resources Description Resources represents compute resources required by this container. Immutable. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ Type object Property Type Description claims array Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. claims[] object ResourceClaim references one entry in PodSpec.ResourceClaims. limits integer-or-string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ requests integer-or-string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ 10.1.67. .spec.config.resources.claims Description Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. Type array 10.1.68. .spec.config.resources.claims[] Description ResourceClaim references one entry in PodSpec.ResourceClaims. Type object Required name Property Type Description name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. 10.1.69. .spec.config.selector Description Selector is the label selector for pods to be configured. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels. Type object Property Type Description matchExpressions array matchExpressions is a list of label selector requirements. The requirements are ANDed. matchExpressions[] object A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. matchLabels object (string) matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. 10.1.70. .spec.config.selector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 10.1.71. .spec.config.selector.matchExpressions[] Description A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string key is the label key that the selector applies to. operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. values array (string) values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. 10.1.72. .spec.config.tolerations Description Tolerations are the pod's tolerations. Type array 10.1.73. .spec.config.tolerations[] Description The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>. Type object Property Type Description effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. 10.1.74. .spec.config.volumeMounts Description List of VolumeMounts to set in the container. Type array 10.1.75. .spec.config.volumeMounts[] Description VolumeMount describes a mounting of a Volume within a container. Type object Required mountPath name Property Type Description mountPath string Path within the container at which the volume should be mounted. Must not contain ':'. mountPropagation string mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. name string This must match the Name of a Volume. readOnly boolean Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. subPath string Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). subPathExpr string Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references USD(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. 10.1.76. .spec.config.volumes Description List of Volumes to set in the podSpec. Type array 10.1.77. .spec.config.volumes[] Description Volume represents a named volume in a pod that may be accessed by any container in the pod. Type object Required name Property Type Description awsElasticBlockStore object awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore azureDisk object azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. azureFile object azureFile represents an Azure File Service mount on the host and bind mount to the pod. cephfs object cephFS represents a Ceph FS mount on the host that shares a pod's lifetime cinder object cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md configMap object configMap represents a configMap that should populate this volume csi object csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). downwardAPI object downwardAPI represents downward API about the pod that should populate this volume emptyDir object emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir ephemeral object ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time. fc object fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. flexVolume object flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. flocker object flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running gcePersistentDisk object gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk gitRepo object gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. glusterfs object glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md hostPath object hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write. iscsi object iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md name string name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names nfs object nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs persistentVolumeClaim object persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims photonPersistentDisk object photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine portworxVolume object portworxVolume represents a portworx volume attached and mounted on kubelets host machine projected object projected items for all in one resources secrets, configmaps, and downward API quobyte object quobyte represents a Quobyte mount on the host that shares a pod's lifetime rbd object rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md scaleIO object scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. secret object secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret storageos object storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. vsphereVolume object vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine 10.1.78. .spec.config.volumes[].awsElasticBlockStore Description awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore Type object Required volumeID Property Type Description fsType string fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine partition integer partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). readOnly boolean readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore volumeID string volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore 10.1.79. .spec.config.volumes[].azureDisk Description azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Type object Required diskName diskURI Property Type Description cachingMode string cachingMode is the Host Caching mode: None, Read Only, Read Write. diskName string diskName is the Name of the data disk in the blob storage diskURI string diskURI is the URI of data disk in the blob storage fsType string fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. kind string kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared readOnly boolean readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. 10.1.80. .spec.config.volumes[].azureFile Description azureFile represents an Azure File Service mount on the host and bind mount to the pod. Type object Required secretName shareName Property Type Description readOnly boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. secretName string secretName is the name of secret that contains Azure Storage Account Name and Key shareName string shareName is the azure share Name 10.1.81. .spec.config.volumes[].cephfs Description cephFS represents a Ceph FS mount on the host that shares a pod's lifetime Type object Required monitors Property Type Description monitors array (string) monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it path string path is Optional: Used as the mounted root, rather than the full Ceph tree, default is / readOnly boolean readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it secretFile string secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it secretRef object secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it user string user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it 10.1.82. .spec.config.volumes[].cephfs.secretRef Description secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it Type object Property Type Description name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? 10.1.83. .spec.config.volumes[].cinder Description cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md Type object Required volumeID Property Type Description fsType string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md readOnly boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md secretRef object secretRef is optional: points to a secret object containing parameters used to connect to OpenStack. volumeID string volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md 10.1.84. .spec.config.volumes[].cinder.secretRef Description secretRef is optional: points to a secret object containing parameters used to connect to OpenStack. Type object Property Type Description name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? 10.1.85. .spec.config.volumes[].configMap Description configMap represents a configMap that should populate this volume Type object Property Type Description defaultMode integer defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. items array items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. items[] object Maps a string key to a path within a volume. name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? optional boolean optional specify whether the ConfigMap or its keys must be defined 10.1.86. .spec.config.volumes[].configMap.items Description items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. Type array 10.1.87. .spec.config.volumes[].configMap.items[] Description Maps a string key to a path within a volume. Type object Required key path Property Type Description key string key is the key to project. mode integer mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. path string path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. 10.1.88. .spec.config.volumes[].csi Description csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). Type object Required driver Property Type Description driver string driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. fsType string fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. nodePublishSecretRef object nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. readOnly boolean readOnly specifies a read-only configuration for the volume. Defaults to false (read/write). volumeAttributes object (string) volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. 10.1.89. .spec.config.volumes[].csi.nodePublishSecretRef Description nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. Type object Property Type Description name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? 10.1.90. .spec.config.volumes[].downwardAPI Description downwardAPI represents downward API about the pod that should populate this volume Type object Property Type Description defaultMode integer Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. items array Items is a list of downward API volume file items[] object DownwardAPIVolumeFile represents information to create the file containing the pod field 10.1.91. .spec.config.volumes[].downwardAPI.items Description Items is a list of downward API volume file Type array 10.1.92. .spec.config.volumes[].downwardAPI.items[] Description DownwardAPIVolumeFile represents information to create the file containing the pod field Type object Required path Property Type Description fieldRef object Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. mode integer Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. path string Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' resourceFieldRef object Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. 10.1.93. .spec.config.volumes[].downwardAPI.items[].fieldRef Description Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. Type object Required fieldPath Property Type Description apiVersion string Version of the schema the FieldPath is written in terms of, defaults to "v1". fieldPath string Path of the field to select in the specified API version. 10.1.94. .spec.config.volumes[].downwardAPI.items[].resourceFieldRef Description Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. Type object Required resource Property Type Description containerName string Container name: required for volumes, optional for env vars divisor integer-or-string Specifies the output format of the exposed resources, defaults to "1" resource string Required: resource to select 10.1.95. .spec.config.volumes[].emptyDir Description emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir Type object Property Type Description medium string medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir sizeLimit integer-or-string sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir 10.1.96. .spec.config.volumes[].ephemeral Description ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time. Type object Property Type Description volumeClaimTemplate object Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil. 10.1.97. .spec.config.volumes[].ephemeral.volumeClaimTemplate Description Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil. Type object Required spec Property Type Description metadata object May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. spec object The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. 10.1.98. .spec.config.volumes[].ephemeral.volumeClaimTemplate.metadata Description May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. Type object 10.1.99. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec Description The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. Type object Property Type Description accessModes array (string) accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 dataSource object dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource. dataSourceRef object dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. resources object resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources selector object selector is a label query over volumes to consider for binding. storageClassName string storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 volumeAttributesClassName string volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled. volumeMode string volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. volumeName string volumeName is the binding reference to the PersistentVolume backing this claim. 10.1.100. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource Description dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource. Type object Required kind name Property Type Description apiGroup string APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. kind string Kind is the type of resource being referenced name string Name is the name of resource being referenced 10.1.101. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef Description dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. Type object Required kind name Property Type Description apiGroup string APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. kind string Kind is the type of resource being referenced name string Name is the name of resource being referenced namespace string Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled. 10.1.102. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.resources Description resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources Type object Property Type Description limits integer-or-string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ requests integer-or-string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ 10.1.103. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector Description selector is a label query over volumes to consider for binding. Type object Property Type Description matchExpressions array matchExpressions is a list of label selector requirements. The requirements are ANDed. matchExpressions[] object A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. matchLabels object (string) matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. 10.1.104. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 10.1.105. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[] Description A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string key is the label key that the selector applies to. operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. values array (string) values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. 10.1.106. .spec.config.volumes[].fc Description fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. Type object Property Type Description fsType string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine lun integer lun is Optional: FC target lun number readOnly boolean readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. targetWWNs array (string) targetWWNs is Optional: FC target worldwide names (WWNs) wwids array (string) wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. 10.1.107. .spec.config.volumes[].flexVolume Description flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Type object Required driver Property Type Description driver string driver is the name of the driver to use for this volume. fsType string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. options object (string) options is Optional: this field holds extra command options if any. readOnly boolean readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. secretRef object secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. 10.1.108. .spec.config.volumes[].flexVolume.secretRef Description secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. Type object Property Type Description name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? 10.1.109. .spec.config.volumes[].flocker Description flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running Type object Property Type Description datasetName string datasetName is Name of the dataset stored as metadata name on the dataset for Flocker should be considered as deprecated datasetUUID string datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset 10.1.110. .spec.config.volumes[].gcePersistentDisk Description gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Type object Required pdName Property Type Description fsType string fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine partition integer partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk pdName string pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk readOnly boolean readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk 10.1.111. .spec.config.volumes[].gitRepo Description gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. Type object Required repository Property Type Description directory string directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. repository string repository is the URL revision string revision is the commit hash for the specified revision. 10.1.112. .spec.config.volumes[].glusterfs Description glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md Type object Required endpoints path Property Type Description endpoints string endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod path string path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod readOnly boolean readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod 10.1.113. .spec.config.volumes[].hostPath Description hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write. Type object Required path Property Type Description path string path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath type string type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath 10.1.114. .spec.config.volumes[].iscsi Description iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md Type object Required iqn lun targetPortal Property Type Description chapAuthDiscovery boolean chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication chapAuthSession boolean chapAuthSession defines whether support iSCSI Session CHAP authentication fsType string fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine initiatorName string initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection. iqn string iqn is the target iSCSI Qualified Name. iscsiInterface string iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). lun integer lun represents iSCSI Target Lun number. portals array (string) portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). readOnly boolean readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. secretRef object secretRef is the CHAP Secret for iSCSI target and initiator authentication targetPortal string targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). 10.1.115. .spec.config.volumes[].iscsi.secretRef Description secretRef is the CHAP Secret for iSCSI target and initiator authentication Type object Property Type Description name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? 10.1.116. .spec.config.volumes[].nfs Description nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs Type object Required path server Property Type Description path string path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs readOnly boolean readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs server string server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs 10.1.117. .spec.config.volumes[].persistentVolumeClaim Description persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims Type object Required claimName Property Type Description claimName string claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims readOnly boolean readOnly Will force the ReadOnly setting in VolumeMounts. Default false. 10.1.118. .spec.config.volumes[].photonPersistentDisk Description photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine Type object Required pdID Property Type Description fsType string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. pdID string pdID is the ID that identifies Photon Controller persistent disk 10.1.119. .spec.config.volumes[].portworxVolume Description portworxVolume represents a portworx volume attached and mounted on kubelets host machine Type object Required volumeID Property Type Description fsType string fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. readOnly boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. volumeID string volumeID uniquely identifies a Portworx volume 10.1.120. .spec.config.volumes[].projected Description projected items for all in one resources secrets, configmaps, and downward API Type object Property Type Description defaultMode integer defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. sources array sources is the list of volume projections sources[] object Projection that may be projected along with other supported volume types 10.1.121. .spec.config.volumes[].projected.sources Description sources is the list of volume projections Type array 10.1.122. .spec.config.volumes[].projected.sources[] Description Projection that may be projected along with other supported volume types Type object Property Type Description clusterTrustBundle object ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time. configMap object configMap information about the configMap data to project downwardAPI object downwardAPI information about the downwardAPI data to project secret object secret information about the secret data to project serviceAccountToken object serviceAccountToken is information about the serviceAccountToken data to project 10.1.123. .spec.config.volumes[].projected.sources[].clusterTrustBundle Description ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time. Type object Required path Property Type Description labelSelector object Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything". name string Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector. optional boolean If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles. path string Relative path from the volume root to write the bundle. signerName string Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated. 10.1.124. .spec.config.volumes[].projected.sources[].clusterTrustBundle.labelSelector Description Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything". Type object Property Type Description matchExpressions array matchExpressions is a list of label selector requirements. The requirements are ANDed. matchExpressions[] object A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. matchLabels object (string) matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. 10.1.125. .spec.config.volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 10.1.126. .spec.config.volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[] Description A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string key is the label key that the selector applies to. operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. values array (string) values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. 10.1.127. .spec.config.volumes[].projected.sources[].configMap Description configMap information about the configMap data to project Type object Property Type Description items array items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. items[] object Maps a string key to a path within a volume. name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? optional boolean optional specify whether the ConfigMap or its keys must be defined 10.1.128. .spec.config.volumes[].projected.sources[].configMap.items Description items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. Type array 10.1.129. .spec.config.volumes[].projected.sources[].configMap.items[] Description Maps a string key to a path within a volume. Type object Required key path Property Type Description key string key is the key to project. mode integer mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. path string path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. 10.1.130. .spec.config.volumes[].projected.sources[].downwardAPI Description downwardAPI information about the downwardAPI data to project Type object Property Type Description items array Items is a list of DownwardAPIVolume file items[] object DownwardAPIVolumeFile represents information to create the file containing the pod field 10.1.131. .spec.config.volumes[].projected.sources[].downwardAPI.items Description Items is a list of DownwardAPIVolume file Type array 10.1.132. .spec.config.volumes[].projected.sources[].downwardAPI.items[] Description DownwardAPIVolumeFile represents information to create the file containing the pod field Type object Required path Property Type Description fieldRef object Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. mode integer Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. path string Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' resourceFieldRef object Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. 10.1.133. .spec.config.volumes[].projected.sources[].downwardAPI.items[].fieldRef Description Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. Type object Required fieldPath Property Type Description apiVersion string Version of the schema the FieldPath is written in terms of, defaults to "v1". fieldPath string Path of the field to select in the specified API version. 10.1.134. .spec.config.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef Description Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. Type object Required resource Property Type Description containerName string Container name: required for volumes, optional for env vars divisor integer-or-string Specifies the output format of the exposed resources, defaults to "1" resource string Required: resource to select 10.1.135. .spec.config.volumes[].projected.sources[].secret Description secret information about the secret data to project Type object Property Type Description items array items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. items[] object Maps a string key to a path within a volume. name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? optional boolean optional field specify whether the Secret or its key must be defined 10.1.136. .spec.config.volumes[].projected.sources[].secret.items Description items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. Type array 10.1.137. .spec.config.volumes[].projected.sources[].secret.items[] Description Maps a string key to a path within a volume. Type object Required key path Property Type Description key string key is the key to project. mode integer mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. path string path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. 10.1.138. .spec.config.volumes[].projected.sources[].serviceAccountToken Description serviceAccountToken is information about the serviceAccountToken data to project Type object Required path Property Type Description audience string audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. expirationSeconds integer expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. path string path is the path relative to the mount point of the file to project the token into. 10.1.139. .spec.config.volumes[].quobyte Description quobyte represents a Quobyte mount on the host that shares a pod's lifetime Type object Required registry volume Property Type Description group string group to map volume access to Default is no group readOnly boolean readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. registry string registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes tenant string tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin user string user to map volume access to Defaults to serivceaccount user volume string volume is a string that references an already created Quobyte volume by name. 10.1.140. .spec.config.volumes[].rbd Description rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md Type object Required image monitors Property Type Description fsType string fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine image string image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it keyring string keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it monitors array (string) monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it pool string pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it readOnly boolean readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it secretRef object secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it user string user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it 10.1.141. .spec.config.volumes[].rbd.secretRef Description secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it Type object Property Type Description name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? 10.1.142. .spec.config.volumes[].scaleIO Description scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Type object Required gateway secretRef system Property Type Description fsType string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". gateway string gateway is the host address of the ScaleIO API Gateway. protectionDomain string protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. readOnly boolean readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. secretRef object secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. sslEnabled boolean sslEnabled Flag enable/disable SSL communication with Gateway, default false storageMode string storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. storagePool string storagePool is the ScaleIO Storage Pool associated with the protection domain. system string system is the name of the storage system as configured in ScaleIO. volumeName string volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source. 10.1.143. .spec.config.volumes[].scaleIO.secretRef Description secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. Type object Property Type Description name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? 10.1.144. .spec.config.volumes[].secret Description secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret Type object Property Type Description defaultMode integer defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. items array items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. items[] object Maps a string key to a path within a volume. optional boolean optional field specify whether the Secret or its keys must be defined secretName string secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret 10.1.145. .spec.config.volumes[].secret.items Description items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. Type array 10.1.146. .spec.config.volumes[].secret.items[] Description Maps a string key to a path within a volume. Type object Required key path Property Type Description key string key is the key to project. mode integer mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. path string path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. 10.1.147. .spec.config.volumes[].storageos Description storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. Type object Property Type Description fsType string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. readOnly boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. secretRef object secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. volumeName string volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. volumeNamespace string volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. 10.1.148. .spec.config.volumes[].storageos.secretRef Description secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. Type object Property Type Description name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? 10.1.149. .spec.config.volumes[].vsphereVolume Description vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine Type object Required volumePath Property Type Description fsType string fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. storagePolicyID string storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. storagePolicyName string storagePolicyName is the storage Policy Based Management (SPBM) profile name. volumePath string volumePath is the path that identifies vSphere volume vmdk 10.1.150. .status Description Type object Required lastUpdated Property Type Description catalogHealth array CatalogHealth contains the Subscription's view of its relevant CatalogSources' status. It is used to determine SubscriptionStatusConditions related to CatalogSources. catalogHealth[] object SubscriptionCatalogHealth describes the health of a CatalogSource the Subscription knows about. conditions array Conditions is a list of the latest available observations about a Subscription's current state. conditions[] object SubscriptionCondition represents the latest available observations of a Subscription's state. currentCSV string CurrentCSV is the CSV the Subscription is progressing to. installPlanGeneration integer InstallPlanGeneration is the current generation of the installplan installPlanRef object InstallPlanRef is a reference to the latest InstallPlan that contains the Subscription's current CSV. installedCSV string InstalledCSV is the CSV currently installed by the Subscription. installplan object Install is a reference to the latest InstallPlan generated for the Subscription. DEPRECATED: InstallPlanRef lastUpdated string LastUpdated represents the last time that the Subscription status was updated. reason string Reason is the reason the Subscription was transitioned to its current state. state string State represents the current state of the Subscription 10.1.151. .status.catalogHealth Description CatalogHealth contains the Subscription's view of its relevant CatalogSources' status. It is used to determine SubscriptionStatusConditions related to CatalogSources. Type array 10.1.152. .status.catalogHealth[] Description SubscriptionCatalogHealth describes the health of a CatalogSource the Subscription knows about. Type object Required catalogSourceRef healthy lastUpdated Property Type Description catalogSourceRef object CatalogSourceRef is a reference to a CatalogSource. healthy boolean Healthy is true if the CatalogSource is healthy; false otherwise. lastUpdated string LastUpdated represents the last time that the CatalogSourceHealth changed 10.1.153. .status.catalogHealth[].catalogSourceRef Description CatalogSourceRef is a reference to a CatalogSource. Type object Property Type Description apiVersion string API version of the referent. fieldPath string If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. kind string Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names namespace string Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ resourceVersion string Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency uid string UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids 10.1.154. .status.conditions Description Conditions is a list of the latest available observations about a Subscription's current state. Type array 10.1.155. .status.conditions[] Description SubscriptionCondition represents the latest available observations of a Subscription's state. Type object Required status type Property Type Description lastHeartbeatTime string LastHeartbeatTime is the last time we got an update on a given condition lastTransitionTime string LastTransitionTime is the last time the condition transit from one status to another message string Message is a human-readable message indicating details about last transition. reason string Reason is a one-word CamelCase reason for the condition's last transition. status string Status is the status of the condition, one of True, False, Unknown. type string Type is the type of Subscription condition. 10.1.156. .status.installPlanRef Description InstallPlanRef is a reference to the latest InstallPlan that contains the Subscription's current CSV. Type object Property Type Description apiVersion string API version of the referent. fieldPath string If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. kind string Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names namespace string Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ resourceVersion string Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency uid string UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids 10.1.157. .status.installplan Description Install is a reference to the latest InstallPlan generated for the Subscription. DEPRECATED: InstallPlanRef Type object Required apiVersion kind name uuid Property Type Description apiVersion string kind string name string uuid string UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated. 10.2. API endpoints The following API endpoints are available: /apis/operators.coreos.com/v1alpha1/subscriptions GET : list objects of kind Subscription /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions DELETE : delete collection of Subscription GET : list objects of kind Subscription POST : create a Subscription /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name} DELETE : delete a Subscription GET : read the specified Subscription PATCH : partially update the specified Subscription PUT : replace the specified Subscription /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name}/status GET : read status of the specified Subscription PATCH : partially update status of the specified Subscription PUT : replace status of the specified Subscription 10.2.1. /apis/operators.coreos.com/v1alpha1/subscriptions HTTP method GET Description list objects of kind Subscription Table 10.1. HTTP responses HTTP code Reponse body 200 - OK SubscriptionList schema 401 - Unauthorized Empty 10.2.2. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions HTTP method DELETE Description delete collection of Subscription Table 10.2. HTTP responses HTTP code Reponse body 200 - OK Status schema 401 - Unauthorized Empty HTTP method GET Description list objects of kind Subscription Table 10.3. HTTP responses HTTP code Reponse body 200 - OK SubscriptionList schema 401 - Unauthorized Empty HTTP method POST Description create a Subscription Table 10.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 10.5. Body parameters Parameter Type Description body Subscription schema Table 10.6. HTTP responses HTTP code Reponse body 200 - OK Subscription schema 201 - Created Subscription schema 202 - Accepted Subscription schema 401 - Unauthorized Empty 10.2.3. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name} Table 10.7. Global path parameters Parameter Type Description name string name of the Subscription HTTP method DELETE Description delete a Subscription Table 10.8. 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 10.9. HTTP responses HTTP code Reponse body 200 - OK Status schema 202 - Accepted Status schema 401 - Unauthorized Empty HTTP method GET Description read the specified Subscription Table 10.10. HTTP responses HTTP code Reponse body 200 - OK Subscription schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified Subscription Table 10.11. 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 10.12. HTTP responses HTTP code Reponse body 200 - OK Subscription schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified Subscription Table 10.13. 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 10.14. Body parameters Parameter Type Description body Subscription schema Table 10.15. HTTP responses HTTP code Reponse body 200 - OK Subscription schema 201 - Created Subscription schema 401 - Unauthorized Empty 10.2.4. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name}/status Table 10.16. Global path parameters Parameter Type Description name string name of the Subscription HTTP method GET Description read status of the specified Subscription Table 10.17. HTTP responses HTTP code Reponse body 200 - OK Subscription schema 401 - Unauthorized Empty HTTP method PATCH Description partially update status of the specified Subscription Table 10.18. 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 10.19. HTTP responses HTTP code Reponse body 200 - OK Subscription schema 401 - Unauthorized Empty HTTP method PUT Description replace status of the specified Subscription Table 10.20. 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 10.21. Body parameters Parameter Type Description body Subscription schema Table 10.22. HTTP responses HTTP code Reponse body 200 - OK Subscription schema 201 - Created Subscription schema 401 - Unauthorized Empty	null	https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/operatorhub_apis/subscription-operators-coreos-com-v1alpha1
Managing Red Hat Gluster Storage using RHV Administration Portal	Managing Red Hat Gluster Storage using RHV Administration Portal Red Hat Hyperconverged Infrastructure for Virtualization 1.8 Perform common Red Hat Gluster Storage management tasks in the Administration Portal Laura Bailey [email protected]	null	https://docs.redhat.com/en/documentation/red_hat_hyperconverged_infrastructure_for_virtualization/1.8/html/managing_red_hat_gluster_storage_using_rhv_administration_portal/index
Chapter 17. KubeAPIServer [operator.openshift.io/v1]	Chapter 17. KubeAPIServer [operator.openshift.io/v1] Description KubeAPIServer provides information to configure an operator to manage kube-apiserver. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). Type object Required spec 17.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's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata spec object spec is the specification of the desired behavior of the Kubernetes API Server status object status is the most recently observed status of the Kubernetes API Server 17.1.1. .spec Description spec is the specification of the desired behavior of the Kubernetes API Server Type object Property Type Description failedRevisionLimit integer failedRevisionLimit is the number of failed static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default) forceRedeploymentReason string forceRedeploymentReason can be used to force the redeployment of the operand by providing a unique string. This provides a mechanism to kick a previously failed deployment and provide a reason why you think it will work this time instead of failing again on the same config. logLevel string logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal". managementState string managementState indicates whether and how the operator should manage the component observedConfig `` observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator operatorLogLevel string operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal". succeededRevisionLimit integer succeededRevisionLimit is the number of successful static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default) unsupportedConfigOverrides `` unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster. 17.1.2. .status Description status is the most recently observed status of the Kubernetes API Server Type object Property Type Description conditions array conditions is a list of conditions and their status conditions[] object OperatorCondition is just the standard condition fields. generations array generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction. generations[] object GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made. latestAvailableRevision integer latestAvailableRevision is the deploymentID of the most recent deployment latestAvailableRevisionReason string latestAvailableRevisionReason describe the detailed reason for the most recent deployment nodeStatuses array nodeStatuses track the deployment values and errors across individual nodes nodeStatuses[] object NodeStatus provides information about the current state of a particular node managed by this operator. observedGeneration integer observedGeneration is the last generation change you've dealt with readyReplicas integer readyReplicas indicates how many replicas are ready and at the desired state serviceAccountIssuers array serviceAccountIssuers tracks history of used service account issuers. The item without expiration time represents the currently used service account issuer. The other items represents service account issuers that were used previously and are still being trusted. The default expiration for the items is set by the platform and it defaults to 24h. see: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#service-account-token-volume-projection serviceAccountIssuers[] object version string version is the level this availability applies to 17.1.3. .status.conditions Description conditions is a list of conditions and their status Type array 17.1.4. .status.conditions[] Description OperatorCondition is just the standard condition fields. Type object Property Type Description lastTransitionTime string message string reason string status string type string 17.1.5. .status.generations Description generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction. Type array 17.1.6. .status.generations[] Description GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made. Type object Property Type Description group string group is the group of the thing you're tracking hash string hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps lastGeneration integer lastGeneration is the last generation of the workload controller involved name string name is the name of the thing you're tracking namespace string namespace is where the thing you're tracking is resource string resource is the resource type of the thing you're tracking 17.1.7. .status.nodeStatuses Description nodeStatuses track the deployment values and errors across individual nodes Type array 17.1.8. .status.nodeStatuses[] Description NodeStatus provides information about the current state of a particular node managed by this operator. Type object Property Type Description currentRevision integer currentRevision is the generation of the most recently successful deployment lastFailedCount integer lastFailedCount is how often the installer pod of the last failed revision failed. lastFailedReason string lastFailedReason is a machine readable failure reason string. lastFailedRevision integer lastFailedRevision is the generation of the deployment we tried and failed to deploy. lastFailedRevisionErrors array (string) lastFailedRevisionErrors is a list of human readable errors during the failed deployment referenced in lastFailedRevision. lastFailedTime string lastFailedTime is the time the last failed revision failed the last time. lastFallbackCount integer lastFallbackCount is how often a fallback to a revision happened. nodeName string nodeName is the name of the node targetRevision integer targetRevision is the generation of the deployment we're trying to apply 17.1.9. .status.serviceAccountIssuers Description serviceAccountIssuers tracks history of used service account issuers. The item without expiration time represents the currently used service account issuer. The other items represents service account issuers that were used previously and are still being trusted. The default expiration for the items is set by the platform and it defaults to 24h. see: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#service-account-token-volume-projection Type array 17.1.10. .status.serviceAccountIssuers[] Description Type object Property Type Description expirationTime string expirationTime is the time after which this service account issuer will be pruned and removed from the trusted list of service account issuers. name string name is the name of the service account issuer --- 17.2. API endpoints The following API endpoints are available: /apis/operator.openshift.io/v1/kubeapiservers DELETE : delete collection of KubeAPIServer GET : list objects of kind KubeAPIServer POST : create a KubeAPIServer /apis/operator.openshift.io/v1/kubeapiservers/{name} DELETE : delete a KubeAPIServer GET : read the specified KubeAPIServer PATCH : partially update the specified KubeAPIServer PUT : replace the specified KubeAPIServer /apis/operator.openshift.io/v1/kubeapiservers/{name}/status GET : read status of the specified KubeAPIServer PATCH : partially update status of the specified KubeAPIServer PUT : replace status of the specified KubeAPIServer 17.2.1. /apis/operator.openshift.io/v1/kubeapiservers HTTP method DELETE Description delete collection of KubeAPIServer Table 17.1. HTTP responses HTTP code Reponse body 200 - OK Status schema 401 - Unauthorized Empty HTTP method GET Description list objects of kind KubeAPIServer Table 17.2. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServerList schema 401 - Unauthorized Empty HTTP method POST Description create a KubeAPIServer Table 17.3. 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 17.4. Body parameters Parameter Type Description body KubeAPIServer schema Table 17.5. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServer schema 201 - Created KubeAPIServer schema 202 - Accepted KubeAPIServer schema 401 - Unauthorized Empty 17.2.2. /apis/operator.openshift.io/v1/kubeapiservers/{name} Table 17.6. Global path parameters Parameter Type Description name string name of the KubeAPIServer HTTP method DELETE Description delete a KubeAPIServer Table 17.7. 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 17.8. HTTP responses HTTP code Reponse body 200 - OK Status schema 202 - Accepted Status schema 401 - Unauthorized Empty HTTP method GET Description read the specified KubeAPIServer Table 17.9. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServer schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified KubeAPIServer Table 17.10. 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 17.11. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServer schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified KubeAPIServer Table 17.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 17.13. Body parameters Parameter Type Description body KubeAPIServer schema Table 17.14. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServer schema 201 - Created KubeAPIServer schema 401 - Unauthorized Empty 17.2.3. /apis/operator.openshift.io/v1/kubeapiservers/{name}/status Table 17.15. Global path parameters Parameter Type Description name string name of the KubeAPIServer HTTP method GET Description read status of the specified KubeAPIServer Table 17.16. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServer schema 401 - Unauthorized Empty HTTP method PATCH Description partially update status of the specified KubeAPIServer Table 17.17. 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 17.18. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServer schema 401 - Unauthorized Empty HTTP method PUT Description replace status of the specified KubeAPIServer Table 17.19. 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 17.20. Body parameters Parameter Type Description body KubeAPIServer schema Table 17.21. HTTP responses HTTP code Reponse body 200 - OK KubeAPIServer schema 201 - Created KubeAPIServer schema 401 - Unauthorized Empty	null	https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/operator_apis/kubeapiserver-operator-openshift-io-v1
Appendix A. OCF Return Codes	Appendix A. OCF Return Codes This appendix describes the OCF return codes and how they are interpreted by Pacemaker. The first thing the cluster does when an agent returns a code is to check the return code against the expected result. If the result does not match the expected value, then the operation is considered to have failed, and recovery action is initiated. For any invocation, resource agents must exit with a defined return code that informs the caller of the outcome of the invoked action. There are three types of failure recovery, as described in Table A.1, "Types of Recovery Performed by the Cluster" . Table A.1. Types of Recovery Performed by the Cluster Type Description Action Taken by the Cluster soft A transient error occurred. Restart the resource or move it to a new location . hard A non-transient error that may be specific to the current node occurred. Move the resource elsewhere and prevent it from being retried on the current node. fatal A non-transient error that will be common to all cluster nodes occurred (for example, a bad configuration was specified). Stop the resource and prevent it from being started on any cluster node. Table A.2, "OCF Return Codes" provides The OCF return codes and the type of recovery the cluster will initiate when a failure code is received. Note that even actions that return 0 (OCF alias OCF_SUCCESS ) can be considered to have failed, if 0 was not the expected return value. Table A.2. OCF Return Codes Return Code OCF Label Description 0 OCF_SUCCESS The action completed successfully. This is the expected return code for any successful start, stop, promote, and demote command. Type if unexpected: soft 1 OCF_ERR_GENERIC The action returned a generic error. Type: soft The resource manager will attempt to recover the resource or move it to a new location. 2 OCF_ERR_ARGS The resource's configuration is not valid on this machine. For example, it refers to a location not found on the node. Type: hard The resource manager will move the resource elsewhere and prevent it from being retried on the current node 3 OCF_ERR_UNIMPLEMENTED The requested action is not implemented. Type: hard 4 OCF_ERR_PERM The resource agent does not have sufficient privileges to complete the task. This may be due, for example, to the agent not being able to open a certain file, to listen on a specific socket, or to write to a directory. Type: hard Unless specifically configured otherwise, the resource manager will attempt to recover a resource which failed with this error by restarting the resource on a different node (where the permission problem may not exist). 5 OCF_ERR_INSTALLED A required component is missing on the node where the action was executed. This may be due to a required binary not being executable, or a vital configuration file being unreadable. Type: hard Unless specifically configured otherwise, the resource manager will attempt to recover a resource which failed with this error by restarting the resource on a different node (where the required files or binaries may be present). 6 OCF_ERR_CONFIGURED The resource's configuration on the local node is invalid. Type: fatal When this code is returned, Pacemaker will prevent the resource from running on any node in the cluster, even if the service configuraiton is valid on some other node. 7 OCF_NOT_RUNNING The resource is safely stopped. This implies that the resource has either gracefully shut down, or has never been started. Type if unexpected: soft The cluster will not attempt to stop a resource that returns this for any action. 8 OCF_RUNNING_MASTER The resource is running in master mode. Type if unexpected: soft 9 OCF_FAILED_MASTER The resource is in master mode but has failed. Type: soft The resource will be demoted, stopped and then started (and possibly promoted) again. other N/A Custom error code.	null	https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/high_availability_add-on_reference/ap-ha-ocfcodes-HARR
Chapter 7. Installing a private cluster on IBM Cloud	Chapter 7. Installing a private cluster on IBM Cloud In OpenShift Container Platform version 4.14, you can install a private cluster into an existing VPC. The installation program provisions the rest of the required infrastructure, which you can further customize. To customize the installation, you modify parameters in the install-config.yaml file before you install the cluster. 7.1. Prerequisites You reviewed details about the OpenShift Container Platform installation and update processes. You read the documentation on selecting a cluster installation method and preparing it for users . You configured an IBM Cloud(R) account to host the cluster. If you use a firewall, you configured it to allow the sites that your cluster requires access to. You configured the ccoctl utility before you installed the cluster. For more information, see Configuring IAM for IBM Cloud(R) . 7.2. Private clusters You can deploy a private OpenShift Container Platform cluster that does not expose external endpoints. Private clusters are accessible from only an internal network and are not visible to the internet. By default, OpenShift Container Platform is provisioned to use publicly-accessible DNS and endpoints. A private cluster sets the DNS, Ingress Controller, and API server to private when you deploy your cluster. This means that the cluster resources are only accessible from your internal network and are not visible to the internet. Important If the cluster has any public subnets, load balancer services created by administrators might be publicly accessible. To ensure cluster security, verify that these services are explicitly annotated as private. To deploy a private cluster, you must: Use existing networking that meets your requirements. Your cluster resources might be shared between other clusters on the network. Create a DNS zone using IBM Cloud(R) DNS Services and specify it as the base domain of the cluster. For more information, see "Using IBM Cloud(R) DNS Services to configure DNS resolution". Deploy from a machine that has access to: The API services for the cloud to which you provision. The hosts on the network that you provision. The internet to obtain installation media. You can use any machine that meets these access requirements and follows your company's guidelines. For example, this machine can be a bastion host on your cloud network or a machine that has access to the network through a VPN. 7.3. Private clusters in IBM Cloud To create a private cluster on IBM Cloud(R), you must provide an existing private VPC and subnets to host the cluster. The installation program must also be able to resolve the DNS records that the cluster requires. The installation program configures the Ingress Operator and API server for only internal traffic. The cluster still requires access to internet to access the IBM Cloud(R) APIs. The following items are not required or created when you install a private cluster: Public subnets Public network load balancers, which support public ingress A public DNS zone that matches the baseDomain for the cluster The installation program does use the baseDomain that you specify to create a private DNS zone and the required records for the cluster. The cluster is configured so that the Operators do not create public records for the cluster and all cluster machines are placed in the private subnets that you specify. 7.3.1. Limitations Private clusters on IBM Cloud(R) are subject only to the limitations associated with the existing VPC that was used for cluster deployment. 7.4. About using a custom VPC In OpenShift Container Platform 4.14, you can deploy a cluster into the subnets of an existing IBM(R) Virtual Private Cloud (VPC). Deploying OpenShift Container Platform into an existing VPC can help you avoid limit constraints in new accounts or more easily abide by the operational constraints that your company's guidelines set. If you cannot obtain the infrastructure creation permissions that are required to create the VPC yourself, use this installation option. Because the installation program cannot know what other components are in your existing subnets, it cannot choose subnet CIDRs and so forth. You must configure networking for the subnets to which you will install the cluster. 7.4.1. Requirements for using your VPC You must correctly configure the existing VPC and its subnets before you install the cluster. The installation program does not create the following components: NAT gateways Subnets Route tables VPC network The installation program cannot: Subdivide network ranges for the cluster to use Set route tables for the subnets Set VPC options like DHCP Note The installation program requires that you use the cloud-provided DNS server. Using a custom DNS server is not supported and causes the installation to fail. 7.4.2. VPC validation The VPC and all of the subnets must be in an existing resource group. The cluster is deployed to this resource group. As part of the installation, specify the following in the install-config.yaml file: The name of the resource group The name of VPC The subnets for control plane machines and compute machines To ensure that the subnets that you provide are suitable, the installation program confirms the following: All of the subnets that you specify exist. For each availability zone in the region, you specify: One subnet for control plane machines. One subnet for compute machines. The machine CIDR that you specified contains the subnets for the compute machines and control plane machines. Note Subnet IDs are not supported. 7.4.3. Isolation between clusters If you deploy OpenShift Container Platform to an existing network, the isolation of cluster services is reduced in the following ways: You can install multiple OpenShift Container Platform clusters in the same VPC. ICMP ingress is allowed to the entire network. TCP port 22 ingress (SSH) is allowed to the entire network. Control plane TCP 6443 ingress (Kubernetes API) is allowed to the entire network. Control plane TCP 22623 ingress (MCS) is allowed to the entire network. 7.5. Internet access for OpenShift Container Platform In OpenShift Container Platform 4.14, you require access to the internet to install your cluster. You must have internet access to: Access OpenShift Cluster Manager to download the installation program and perform subscription management. If the cluster has internet access and you do not disable Telemetry, that service automatically entitles your cluster. Access Quay.io to obtain the packages that are required to install your cluster. Obtain the packages that are required to perform cluster updates. Important If your cluster cannot have direct internet access, you can perform a restricted network installation on some types of infrastructure that you provision. During that process, you download the required content and use it to populate a mirror registry with the installation packages. With some installation types, the environment that you install your cluster in will not require internet access. Before you update the cluster, you update the content of the mirror registry. 7.6. Generating a key pair for cluster node SSH access During an OpenShift Container Platform installation, you can provide an SSH public key to the installation program. The key is passed to the Red Hat Enterprise Linux CoreOS (RHCOS) nodes through their Ignition config files and is used to authenticate SSH access to the nodes. The key is added to the ~/.ssh/authorized_keys list for the core user on each node, which enables password-less authentication. After the key is passed to the nodes, you can use the key pair to SSH in to the RHCOS nodes as the user core . To access the nodes through SSH, the private key identity must be managed by SSH for your local user. If you want to SSH in to your cluster nodes to perform installation debugging or disaster recovery, you must provide the SSH public key during the installation process. The ./openshift-install gather command also requires the SSH public key to be in place on the cluster nodes. Important Do not skip this procedure in production environments, where disaster recovery and debugging is required. Note You must use a local key, not one that you configured with platform-specific approaches such as AWS key pairs . Procedure If you do not have an existing SSH key pair on your local machine to use for authentication onto your cluster nodes, create one. For example, on a computer that uses a Linux operating system, run the following command: USD ssh-keygen -t ed25519 -N '' -f <path>/<file_name> 1 1 Specify the path and file name, such as ~/.ssh/id_ed25519 , of the new SSH key. If you have an existing key pair, ensure your public key is in the your ~/.ssh directory. Note If you plan to install an OpenShift Container Platform cluster that uses the RHEL cryptographic libraries that have been submitted to NIST for FIPS 140-2/140-3 Validation on only the x86_64 , ppc64le , and s390x architectures, do not create a key that uses the ed25519 algorithm. Instead, create a key that uses the rsa or ecdsa algorithm. View the public SSH key: USD cat <path>/<file_name>.pub For example, run the following to view the ~/.ssh/id_ed25519.pub public key: USD cat ~/.ssh/id_ed25519.pub Add the SSH private key identity to the SSH agent for your local user, if it has not already been added. SSH agent management of the key is required for password-less SSH authentication onto your cluster nodes, or if you want to use the ./openshift-install gather command. Note On some distributions, default SSH private key identities such as ~/.ssh/id_rsa and ~/.ssh/id_dsa are managed automatically. If the ssh-agent process is not already running for your local user, start it as a background task: USD eval "USD(ssh-agent -s)" Example output Agent pid 31874 Note If your cluster is in FIPS mode, only use FIPS-compliant algorithms to generate the SSH key. The key must be either RSA or ECDSA. Add your SSH private key to the ssh-agent : USD ssh-add <path>/<file_name> 1 1 Specify the path and file name for your SSH private key, such as ~/.ssh/id_ed25519 Example output Identity added: /home/<you>/<path>/<file_name> (<computer_name>) steps When you install OpenShift Container Platform, provide the SSH public key to the installation program. 7.7. Obtaining the installation program Before you install OpenShift Container Platform, download the installation file on a bastion host on your cloud network or a machine that has access to the to the network through a VPN. For more information about private cluster installation requirements, see "Private clusters". Prerequisites You have a machine that runs Linux, for example Red Hat Enterprise Linux (RHEL) 8, with at least 1.2 GB of local disk space. Procedure Go to the Cluster Type page on the Red Hat Hybrid Cloud Console. If you have a Red Hat account, log in with your credentials. If you do not, create an account. Select your infrastructure provider from the Run it yourself section of the page. Select your host operating system and architecture from the dropdown menus under OpenShift Installer and click Download Installer . Place the downloaded file in the directory where you want to store the installation configuration files. Important The installation program creates several files on the computer that you use to install your cluster. You must keep the installation program and the files that the installation program creates after you finish installing the cluster. Both of the files are required to delete the cluster. Deleting the files created by the installation program does not remove your cluster, even if the cluster failed during installation. To remove your cluster, complete the OpenShift Container Platform uninstallation procedures for your specific cloud provider. Extract the installation program. For example, on a computer that uses a Linux operating system, run the following command: USD tar -xvf openshift-install-linux.tar.gz Download your installation pull secret from Red Hat OpenShift Cluster Manager . This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for OpenShift Container Platform components. Tip Alternatively, you can retrieve the installation program from the Red Hat Customer Portal , where you can specify a version of the installation program to download. However, you must have an active subscription to access this page. 7.8. Exporting the API key You must set the API key you created as a global variable; the installation program ingests the variable during startup to set the API key. Prerequisites You have created either a user API key or service ID API key for your IBM Cloud(R) account. Procedure Export your API key for your account as a global variable: USD export IC_API_KEY=<api_key> Important You must set the variable name exactly as specified; the installation program expects the variable name to be present during startup. 7.9. Manually creating the installation configuration file When installing a private OpenShift Container Platform cluster, you must manually generate the installation configuration file. Prerequisites You have an SSH public key on your local machine to provide to the installation program. The key will be used for SSH authentication onto your cluster nodes for debugging and disaster recovery. You have obtained the OpenShift Container Platform installation program and the pull secret for your cluster. Procedure Create an installation directory to store your required installation assets in: USD mkdir <installation_directory> Important You must create a directory. Some installation assets, like bootstrap X.509 certificates have short expiration intervals, so you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier OpenShift Container Platform version. Customize the sample install-config.yaml file template that is provided and save it in the <installation_directory> . Note You must name this configuration file install-config.yaml . Back up the install-config.yaml file so that you can use it to install multiple clusters. Important The install-config.yaml file is consumed during the step of the installation process. You must back it up now. Additional resources Installation configuration parameters for IBM Cloud(R) 7.9.1. Minimum resource requirements for cluster installation Each cluster machine must meet the following minimum requirements: Table 7.1. Minimum resource requirements Machine Operating System vCPU Virtual RAM Storage Input/Output Per Second (IOPS) Bootstrap RHCOS 4 16 GB 100 GB 300 Control plane RHCOS 4 16 GB 100 GB 300 Compute RHCOS 2 8 GB 100 GB 300 Note As of OpenShift Container Platform version 4.13, RHCOS is based on RHEL version 9.2, which updates the micro-architecture requirements. The following list contains the minimum instruction set architectures (ISA) that each architecture requires: x86-64 architecture requires x86-64-v2 ISA ARM64 architecture requires ARMv8.0-A ISA IBM Power architecture requires Power 9 ISA s390x architecture requires z14 ISA For more information, see RHEL Architectures . If an instance type for your platform meets the minimum requirements for cluster machines, it is supported to use in OpenShift Container Platform. Additional resources Optimizing storage 7.9.2. Tested instance types for IBM Cloud The following IBM Cloud(R) instance types have been tested with OpenShift Container Platform. Example 7.1. Machine series bx2-8x32 bx2d-4x16 bx3d-4x20 cx2-8x16 cx2d-4x8 cx3d-8x20 gx2-8x64x1v100 gx3-16x80x1l4 mx2-8x64 mx2d-4x32 mx3d-2x20 ox2-4x32 ox2-8x64 ux2d-2x56 vx2d-4x56 7.9.3. Sample customized install-config.yaml file for IBM Cloud You can customize the install-config.yaml file to specify more details about your OpenShift Container Platform cluster's platform or modify the values of the required parameters. Important This sample YAML file is provided for reference only. You must obtain your install-config.yaml file by using the installation program and then modify it. apiVersion: v1 baseDomain: example.com 1 controlPlane: 2 3 hyperthreading: Enabled 4 name: master platform: ibmcloud: {} replicas: 3 compute: 5 6 - hyperthreading: Enabled 7 name: worker platform: ibmcloud: {} replicas: 3 metadata: name: test-cluster 8 networking: clusterNetwork: - cidr: 10.128.0.0/14 9 hostPrefix: 23 machineNetwork: - cidr: 10.0.0.0/16 10 networkType: OVNKubernetes 11 serviceNetwork: - 172.30.0.0/16 platform: ibmcloud: region: eu-gb 12 resourceGroupName: eu-gb-example-network-rg 13 networkResourceGroupName: eu-gb-example-existing-network-rg 14 vpcName: eu-gb-example-network-1 15 controlPlaneSubnets: 16 - eu-gb-example-network-1-cp-eu-gb-1 - eu-gb-example-network-1-cp-eu-gb-2 - eu-gb-example-network-1-cp-eu-gb-3 computeSubnets: 17 - eu-gb-example-network-1-compute-eu-gb-1 - eu-gb-example-network-1-compute-eu-gb-2 - eu-gb-example-network-1-compute-eu-gb-3 credentialsMode: Manual publish: Internal 18 pullSecret: '{"auths": ...}' 19 fips: false 20 sshKey: ssh-ed25519 AAAA... 21 1 8 12 19 Required. 2 5 If you do not provide these parameters and values, the installation program provides the default value. 3 6 The controlPlane section is a single mapping, but the compute section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the compute section must begin with a hyphen, - , and the first line of the controlPlane section must not. Only one control plane pool is used. 4 7 Enables or disables simultaneous multithreading, also known as Hyper-Threading. By default, simultaneous multithreading is enabled to increase the performance of your machines' cores. You can disable it by setting the parameter value to Disabled . If you disable simultaneous multithreading in some cluster machines, you must disable it in all cluster machines. Important If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance. Use larger machine types, such as n1-standard-8 , for your machines if you disable simultaneous multithreading. 9 The machine CIDR must contain the subnets for the compute machines and control plane machines. 10 The CIDR must contain the subnets defined in platform.ibmcloud.controlPlaneSubnets and platform.ibmcloud.computeSubnets . 11 The cluster network plugin to install. The supported values are OVNKubernetes and OpenShiftSDN . The default value is OVNKubernetes . 13 The name of an existing resource group. All installer-provisioned cluster resources are deployed to this resource group. If undefined, a new resource group is created for the cluster. 14 Specify the name of the resource group that contains the existing virtual private cloud (VPC). The existing VPC and subnets should be in this resource group. The cluster will be installed to this VPC. 15 Specify the name of an existing VPC. 16 Specify the name of the existing subnets to which to deploy the control plane machines. The subnets must belong to the VPC that you specified. Specify a subnet for each availability zone in the region. 17 Specify the name of the existing subnets to which to deploy the compute machines. The subnets must belong to the VPC that you specified. Specify a subnet for each availability zone in the region. 18 How to publish the user-facing endpoints of your cluster. Set publish to Internal to deploy a private cluster. The default value is External . 20 Enables or disables FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the Red Hat Enterprise Linux CoreOS (RHCOS) machines that OpenShift Container Platform runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with RHCOS instead. Important When running Red Hat Enterprise Linux (RHEL) or Red Hat Enterprise Linux CoreOS (RHCOS) booted in FIPS mode, OpenShift Container Platform core components use the RHEL cryptographic libraries that have been submitted to NIST for FIPS 140-2/140-3 Validation on only the x86_64, ppc64le, and s390x architectures. 21 Optional: provide the sshKey value that you use to access the machines in your cluster. Note For production OpenShift Container Platform clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your ssh-agent process uses. 7.9.4. Configuring the cluster-wide proxy during installation Production environments can deny direct access to the internet and instead have an HTTP or HTTPS proxy available. You can configure a new OpenShift Container Platform cluster to use a proxy by configuring the proxy settings in the install-config.yaml file. Prerequisites You have an existing install-config.yaml file. You reviewed the sites that your cluster requires access to and determined whether any of them need to bypass the proxy. By default, all cluster egress traffic is proxied, including calls to hosting cloud provider APIs. You added sites to the Proxy object's spec.noProxy field to bypass the proxy if necessary. Note The Proxy object status.noProxy field is populated with the values of the networking.machineNetwork[].cidr , networking.clusterNetwork[].cidr , and networking.serviceNetwork[] fields from your installation configuration. For installations on Amazon Web Services (AWS), Google Cloud Platform (GCP), Microsoft Azure, and Red Hat OpenStack Platform (RHOSP), the Proxy object status.noProxy field is also populated with the instance metadata endpoint ( 169.254.169.254 ). Procedure Edit your install-config.yaml file and add the proxy settings. For example: apiVersion: v1 baseDomain: my.domain.com proxy: httpProxy: http://<username>:<pswd>@<ip>:<port> 1 httpsProxy: https://<username>:<pswd>@<ip>:<port> 2 noProxy: example.com 3 additionalTrustBundle: \| 4 -----BEGIN CERTIFICATE----- <MY_TRUSTED_CA_CERT> -----END CERTIFICATE----- additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> 5 1 A proxy URL to use for creating HTTP connections outside the cluster. The URL scheme must be http . 2 A proxy URL to use for creating HTTPS connections outside the cluster. 3 A comma-separated list of destination domain names, IP addresses, or other network CIDRs to exclude from proxying. Preface a domain with . to match subdomains only. For example, .y.com matches x.y.com , but not y.com . Use * to bypass the proxy for all destinations. 4 If provided, the installation program generates a config map that is named user-ca-bundle in the openshift-config namespace that contains one or more additional CA certificates that are required for proxying HTTPS connections. The Cluster Network Operator then creates a trusted-ca-bundle config map that merges these contents with the Red Hat Enterprise Linux CoreOS (RHCOS) trust bundle, and this config map is referenced in the trustedCA field of the Proxy object. The additionalTrustBundle field is required unless the proxy's identity certificate is signed by an authority from the RHCOS trust bundle. 5 Optional: The policy to determine the configuration of the Proxy object to reference the user-ca-bundle config map in the trustedCA field. The allowed values are Proxyonly and Always . Use Proxyonly to reference the user-ca-bundle config map only when http/https proxy is configured. Use Always to always reference the user-ca-bundle config map. The default value is Proxyonly . Note The installation program does not support the proxy readinessEndpoints field. Note If the installer times out, restart and then complete the deployment by using the wait-for command of the installer. For example: USD ./openshift-install wait-for install-complete --log-level debug Save the file and reference it when installing OpenShift Container Platform. The installation program creates a cluster-wide proxy that is named cluster that uses the proxy settings in the provided install-config.yaml file. If no proxy settings are provided, a cluster Proxy object is still created, but it will have a nil spec . Note Only the Proxy object named cluster is supported, and no additional proxies can be created. 7.10. Manually creating IAM Installing the cluster requires that the Cloud Credential Operator (CCO) operate in manual mode. While the installation program configures the CCO for manual mode, you must specify the identity and access management secrets for you cloud provider. You can use the Cloud Credential Operator (CCO) utility ( ccoctl ) to create the required IBM Cloud(R) resources. Prerequisites You have configured the ccoctl binary. You have an existing install-config.yaml file. Procedure Edit the install-config.yaml configuration file so that it contains the credentialsMode parameter set to Manual . Example install-config.yaml configuration file apiVersion: v1 baseDomain: cluster1.example.com credentialsMode: Manual 1 compute: - architecture: amd64 hyperthreading: Enabled 1 This line is added to set the credentialsMode parameter to Manual . To generate the manifests, run the following command from the directory that contains the installation program: USD ./openshift-install create manifests --dir <installation_directory> From the directory that contains the installation program, set a USDRELEASE_IMAGE variable with the release image from your installation file by running the following command: USD RELEASE_IMAGE=USD(./openshift-install version \| awk '/release image/ {print USD3}') Extract the list of CredentialsRequest custom resources (CRs) from the OpenShift Container Platform release image by running the following command: USD oc adm release extract \ --from=USDRELEASE_IMAGE \ --credentials-requests \ --included \ 1 --install-config=<path_to_directory_with_installation_configuration>/install-config.yaml \ 2 --to=<path_to_directory_for_credentials_requests> 3 1 The --included parameter includes only the manifests that your specific cluster configuration requires. 2 Specify the location of the install-config.yaml file. 3 Specify the path to the directory where you want to store the CredentialsRequest objects. If the specified directory does not exist, this command creates it. This command creates a YAML file for each CredentialsRequest object. Sample CredentialsRequest object apiVersion: cloudcredential.openshift.io/v1 kind: CredentialsRequest metadata: labels: controller-tools.k8s.io: "1.0" name: openshift-image-registry-ibmcos namespace: openshift-cloud-credential-operator spec: secretRef: name: installer-cloud-credentials namespace: openshift-image-registry providerSpec: apiVersion: cloudcredential.openshift.io/v1 kind: IBMCloudProviderSpec policies: - attributes: - name: serviceName value: cloud-object-storage roles: - crn:v1:bluemix:public:iam::::role:Viewer - crn:v1:bluemix:public:iam::::role:Operator - crn:v1:bluemix:public:iam::::role:Editor - crn:v1:bluemix:public:iam::::serviceRole:Reader - crn:v1:bluemix:public:iam::::serviceRole:Writer - attributes: - name: resourceType value: resource-group roles: - crn:v1:bluemix:public:iam::::role:Viewer Create the service ID for each credential request, assign the policies defined, create an API key, and generate the secret: USD ccoctl ibmcloud create-service-id \ --credentials-requests-dir=<path_to_credential_requests_directory> \ 1 --name=<cluster_name> \ 2 --output-dir=<installation_directory> \ 3 --resource-group-name=<resource_group_name> 4 1 Specify the directory containing the files for the component CredentialsRequest objects. 2 Specify the name of the OpenShift Container Platform cluster. 3 Optional: Specify the directory in which you want the ccoctl utility to create objects. By default, the utility creates objects in the directory in which the commands are run. 4 Optional: Specify the name of the resource group used for scoping the access policies. Note If your cluster uses Technology Preview features that are enabled by the TechPreviewNoUpgrade feature set, you must include the --enable-tech-preview parameter. If an incorrect resource group name is provided, the installation fails during the bootstrap phase. To find the correct resource group name, run the following command: USD grep resourceGroupName <installation_directory>/manifests/cluster-infrastructure-02-config.yml Verification Ensure that the appropriate secrets were generated in your cluster's manifests directory. 7.11. Deploying the cluster You can install OpenShift Container Platform on a compatible cloud platform. Important You can run the create cluster command of the installation program only once, during initial installation. Prerequisites You have configured an account with the cloud platform that hosts your cluster. You have the OpenShift Container Platform installation program and the pull secret for your cluster. You have verified that the cloud provider account on your host has the correct permissions to deploy the cluster. An account with incorrect permissions causes the installation process to fail with an error message that displays the missing permissions. Procedure Change to the directory that contains the installation program and initialize the cluster deployment: USD ./openshift-install create cluster --dir <installation_directory> \ 1 --log-level=info 2 1 For <installation_directory> , specify the location of your customized ./install-config.yaml file. 2 To view different installation details, specify warn , debug , or error instead of info . Verification When the cluster deployment completes successfully: The terminal displays directions for accessing your cluster, including a link to the web console and credentials for the kubeadmin user. Credential information also outputs to <installation_directory>/.openshift_install.log . Important Do not delete the installation program or the files that the installation program creates. Both are required to delete the cluster. Example output ... INFO Install complete! INFO To access the cluster as the system:admin user when using 'oc', run 'export KUBECONFIG=/home/myuser/install_dir/auth/kubeconfig' INFO Access the OpenShift web-console here: https://console-openshift-console.apps.mycluster.example.com INFO Login to the console with user: "kubeadmin", and password: "password" INFO Time elapsed: 36m22s Important The Ignition config files that the installation program generates contain certificates that expire after 24 hours, which are then renewed at that time. If the cluster is shut down before renewing the certificates and the cluster is later restarted after the 24 hours have elapsed, the cluster automatically recovers the expired certificates. The exception is that you must manually approve the pending node-bootstrapper certificate signing requests (CSRs) to recover kubelet certificates. See the documentation for Recovering from expired control plane certificates for more information. It is recommended that you use Ignition config files within 12 hours after they are generated because the 24-hour certificate rotates from 16 to 22 hours after the cluster is installed. By using the Ignition config files within 12 hours, you can avoid installation failure if the certificate update runs during installation. 7.12. Installing the OpenShift CLI by downloading the binary You can install the OpenShift CLI ( oc ) to interact with OpenShift Container Platform from a command-line interface. You can install oc on Linux, Windows, or macOS. Important If you installed an earlier version of oc , you cannot use it to complete all of the commands in OpenShift Container Platform 4.14. Download and install the new version of oc . Installing the OpenShift CLI on Linux You can install the OpenShift CLI ( oc ) binary on Linux by using the following procedure. Procedure Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal. Select the architecture from the Product Variant drop-down list. Select the appropriate version from the Version drop-down list. Click Download Now to the OpenShift v4.14 Linux Client entry and save the file. Unpack the archive: USD tar xvf <file> Place the oc binary in a directory that is on your PATH . To check your PATH , execute the following command: USD echo USDPATH Verification After you install the OpenShift CLI, it is available using the oc command: USD oc <command> Installing the OpenShift CLI on Windows You can install the OpenShift CLI ( oc ) binary on Windows by using the following procedure. Procedure Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal. Select the appropriate version from the Version drop-down list. Click Download Now to the OpenShift v4.14 Windows Client entry and save the file. Unzip the archive with a ZIP program. Move the oc binary to a directory that is on your PATH . To check your PATH , open the command prompt and execute the following command: C:\> path Verification After you install the OpenShift CLI, it is available using the oc command: C:\> oc <command> Installing the OpenShift CLI on macOS You can install the OpenShift CLI ( oc ) binary on macOS by using the following procedure. Procedure Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal. Select the appropriate version from the Version drop-down list. Click Download Now to the OpenShift v4.14 macOS Client entry and save the file. Note For macOS arm64, choose the OpenShift v4.14 macOS arm64 Client entry. Unpack and unzip the archive. Move the oc binary to a directory on your PATH. To check your PATH , open a terminal and execute the following command: USD echo USDPATH Verification Verify your installation by using an oc command: USD oc <command> 7.13. Logging in to the cluster by using the CLI You can log in to your cluster as a default system user by exporting the cluster kubeconfig file. The kubeconfig file contains information about the cluster that is used by the CLI to connect a client to the correct cluster and API server. The file is specific to a cluster and is created during OpenShift Container Platform installation. Prerequisites You deployed an OpenShift Container Platform cluster. You installed the oc CLI. Procedure Export the kubeadmin credentials: USD export KUBECONFIG=<installation_directory>/auth/kubeconfig 1 1 For <installation_directory> , specify the path to the directory that you stored the installation files in. Verify you can run oc commands successfully using the exported configuration: USD oc whoami Example output system:admin Additional resources Accessing the web console 7.14. Telemetry access for OpenShift Container Platform In OpenShift Container Platform 4.14, the Telemetry service, which runs by default to provide metrics about cluster health and the success of updates, requires internet access. If your cluster is connected to the internet, Telemetry runs automatically, and your cluster is registered to OpenShift Cluster Manager . After you confirm that your OpenShift Cluster Manager inventory is correct, either maintained automatically by Telemetry or manually by using OpenShift Cluster Manager, use subscription watch to track your OpenShift Container Platform subscriptions at the account or multi-cluster level. Additional resources About remote health monitoring 7.15. steps Customize your cluster . If necessary, you can opt out of remote health reporting .	[ "ssh-keygen -t ed25519 -N '' -f <path>/<file_name> 1", "cat <path>/<file_name>.pub", "cat ~/.ssh/id_ed25519.pub", "eval \"USD(ssh-agent -s)\"", "Agent pid 31874", "ssh-add <path>/<file_name> 1", "Identity added: /home/<you>/<path>/<file_name> (<computer_name>)", "tar -xvf openshift-install-linux.tar.gz", "export IC_API_KEY=<api_key>", "mkdir <installation_directory>", "apiVersion: v1 baseDomain: example.com 1 controlPlane: 2 3 hyperthreading: Enabled 4 name: master platform: ibmcloud: {} replicas: 3 compute: 5 6 - hyperthreading: Enabled 7 name: worker platform: ibmcloud: {} replicas: 3 metadata: name: test-cluster 8 networking: clusterNetwork: - cidr: 10.128.0.0/14 9 hostPrefix: 23 machineNetwork: - cidr: 10.0.0.0/16 10 networkType: OVNKubernetes 11 serviceNetwork: - 172.30.0.0/16 platform: ibmcloud: region: eu-gb 12 resourceGroupName: eu-gb-example-network-rg 13 networkResourceGroupName: eu-gb-example-existing-network-rg 14 vpcName: eu-gb-example-network-1 15 controlPlaneSubnets: 16 - eu-gb-example-network-1-cp-eu-gb-1 - eu-gb-example-network-1-cp-eu-gb-2 - eu-gb-example-network-1-cp-eu-gb-3 computeSubnets: 17 - eu-gb-example-network-1-compute-eu-gb-1 - eu-gb-example-network-1-compute-eu-gb-2 - eu-gb-example-network-1-compute-eu-gb-3 credentialsMode: Manual publish: Internal 18 pullSecret: '{\"auths\": ...}' 19 fips: false 20 sshKey: ssh-ed25519 AAAA... 21", "apiVersion: v1 baseDomain: my.domain.com proxy: httpProxy: http://<username>:<pswd>@<ip>:<port> 1 httpsProxy: https://<username>:<pswd>@<ip>:<port> 2 noProxy: example.com 3 additionalTrustBundle: \| 4 -----BEGIN CERTIFICATE----- <MY_TRUSTED_CA_CERT> -----END CERTIFICATE----- additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> 5", "./openshift-install wait-for install-complete --log-level debug", "apiVersion: v1 baseDomain: cluster1.example.com credentialsMode: Manual 1 compute: - architecture: amd64 hyperthreading: Enabled", "./openshift-install create manifests --dir <installation_directory>", "RELEASE_IMAGE=USD(./openshift-install version \| awk '/release image/ {print USD3}')", "oc adm release extract --from=USDRELEASE_IMAGE --credentials-requests --included \\ 1 --install-config=<path_to_directory_with_installation_configuration>/install-config.yaml \\ 2 --to=<path_to_directory_for_credentials_requests> 3", "apiVersion: cloudcredential.openshift.io/v1 kind: CredentialsRequest metadata: labels: controller-tools.k8s.io: \"1.0\" name: openshift-image-registry-ibmcos namespace: openshift-cloud-credential-operator spec: secretRef: name: installer-cloud-credentials namespace: openshift-image-registry providerSpec: apiVersion: cloudcredential.openshift.io/v1 kind: IBMCloudProviderSpec policies: - attributes: - name: serviceName value: cloud-object-storage roles: - crn:v1:bluemix:public:iam::::role:Viewer - crn:v1:bluemix:public:iam::::role:Operator - crn:v1:bluemix:public:iam::::role:Editor - crn:v1:bluemix:public:iam::::serviceRole:Reader - crn:v1:bluemix:public:iam::::serviceRole:Writer - attributes: - name: resourceType value: resource-group roles: - crn:v1:bluemix:public:iam::::role:Viewer", "ccoctl ibmcloud create-service-id --credentials-requests-dir=<path_to_credential_requests_directory> \\ 1 --name=<cluster_name> \\ 2 --output-dir=<installation_directory> \\ 3 --resource-group-name=<resource_group_name> 4", "grep resourceGroupName <installation_directory>/manifests/cluster-infrastructure-02-config.yml", "./openshift-install create cluster --dir <installation_directory> \\ 1 --log-level=info 2", "INFO Install complete! INFO To access the cluster as the system:admin user when using 'oc', run 'export KUBECONFIG=/home/myuser/install_dir/auth/kubeconfig' INFO Access the OpenShift web-console here: https://console-openshift-console.apps.mycluster.example.com INFO Login to the console with user: \"kubeadmin\", and password: \"password\" INFO Time elapsed: 36m22s", "tar xvf <file>", "echo USDPATH", "oc <command>", "C:\\> path", "C:\\> oc <command>", "echo USDPATH", "oc <command>", "export KUBECONFIG=<installation_directory>/auth/kubeconfig 1", "oc whoami", "system:admin" ]	https://docs.redhat.com/en/documentation/openshift_container_platform/4.14/html/installing_on_ibm_cloud/installing-ibm-cloud-private
Chapter 15. Configuring API tokens	Chapter 15. Configuring API tokens Red Hat Advanced Cluster Security for Kubernetes (RHACS) requires API tokens for some system integrations, authentication processes, and system functions. You can configure tokens using the RHACS web interface. Note To prevent privilege escalation, when you create a new token, your role's permissions limit the permission you can assign to that token. For example, if you only have read permission for the Integration resource, you cannot create a token with write permission. If you want a custom role to create tokens for other users to use, you must assign the required permissions to that custom role. Use short-lived tokens for machine-to-machine communication, such as CI/CD pipelines, scripts, and other automation. Also, use the roxctl central login command for human-to-machine communication, such as roxctl CLI or API access. The majority of cloud service providers support OIDC identity tokens, for example, Microsoft Entra ID, Google Cloud Identity Platform, and AWS Cognito. OIDC identity tokens issued by these services can be used for RHACS short-lived access. 15.1. Creating an API token Procedure In the RHACS portal, go to Platform Configuration Integrations . Scroll to the Authentication Tokens category, and then click API Token . Click Generate Token . Enter a name for the token and select a role that provides the required level of access (for example, Continuous Integration or Sensor Creator ). Click Generate . Important Copy the generated token and securely store it. You will not be able to view it again. Additional resources Using an authentication provider to authenticate with roxctl Configuring short-lived access Using Azure Entra ID service principals for machine to machine auth with RHACS 15.2. About API token expiration API tokens expire one year from the creation date. RHACS alerts you in the web interface and by sending log messages to Central when a token will expire in less than one week. The log message process runs once an hour. Once a day, the process lists the tokens that are expiring and creates a log message for each one. Log messages are issued once a day and appear in Central logs. Logs have the format as shown in the following example: Warn: API Token [token name] (ID [token ID]) will expire in less than X days. You can change the default settings for the log message process by configuring the environment variables shown in the following table: Environment variable Default value Description ROX_TOKEN_EXPIRATION_NOTIFIER_INTERVAL 1h (1 hour) The frequency at which the log message background loop that lists tokens and creates the logs will run. ROX_TOKEN_EXPIRATION_NOTIFIER_BACKOFF_INTERVAL 24h (1 day) The frequency at which the loop lists tokens and issues notifications. ROX_TOKEN_EXPIRATION_DETECTION_WINDOW 168h (1 week) The time period before expiration of the token that will cause the notification to be generated.	[ "Warn: API Token [token name] (ID [token ID]) will expire in less than X days." ]	https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_security_for_kubernetes/4.7/html/configuring/configure-api-token
Chapter 95. MongoDB	Chapter 95. MongoDB Both producer and consumer are supported According to Wikipedia: "NoSQL is a movement promoting a loosely defined class of non-relational data stores that break with a long history of relational databases and ACID guarantees." NoSQL solutions have grown in popularity in the last few years, and major extremely-used sites and services such as Facebook, LinkedIn, Twitter, etc. are known to use them extensively to achieve scalability and agility. Basically, NoSQL solutions differ from traditional RDBMS (Relational Database Management Systems) in that they don't use SQL as their query language and generally don't offer ACID-like transactional behaviour nor relational data. Instead, they are designed around the concept of flexible data structures and schemas (meaning that the traditional concept of a database table with a fixed schema is dropped), extreme scalability on commodity hardware and blazing-fast processing. MongoDB is a very popular NoSQL solution and the camel-mongodb component integrates Camel with MongoDB allowing you to interact with MongoDB collections both as a producer (performing operations on the collection) and as a consumer (consuming documents from a MongoDB collection). MongoDB revolves around the concepts of documents (not as is office documents, but rather hierarchical data defined in JSON/BSON) and collections. This component page will assume you are familiar with them. Otherwise, visit http://www.mongodb.org/ . Note The MongoDB Camel component uses Mongo Java Driver 4.x. 95.1. Dependencies When using mongodb with Red Hat build of Camel Spring Boot make sure to use the following Maven dependency to have support for auto configuration: <dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-mongodb-starter</artifactId> </dependency> 95.2. URI format 95.3. Configuring Options Camel components are configured on two levels: Component level Endpoint level 95.3.1. Component Level Options The component level is the highest level. The configurations you define at this level are inherited by all the endpoints. For example, a component can have security settings, credentials for authentication, urls for network connection, and so on. Since components typically have pre-configured defaults for the most common cases, you may need to only configure a few component options, or maybe none at all. You can configure components with Component DSL in a configuration file (application.properties\|yaml), or directly with Java code. 95.3.2. Endpoint Level Options At the Endpoint level you have many options, which you can use to configure what you want the endpoint to do. The options are categorized according to whether the endpoint is used as a consumer (from) or as a producer (to) or used for both. You can configure endpoints directly in the endpoint URI as path and query parameters. You can also use Endpoint DSL and DataFormat DSL as type safe ways of configuring endpoints and data formats in Java. When configuring options, use Property Placeholders for urls, port numbers, sensitive information, and other settings. Placeholders allows you to externalize the configuration from your code, giving you more flexible and reusable code. 95.4. Component Options The MongoDB component supports 4 options, which are listed below. Name Description Default Type mongoConnection (common) Autowired Shared client used for connection. All endpoints generated from the component will share this connection client. MongoClient bridgeErrorHandler (consumer) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. false boolean lazyStartProducer (producer) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false boolean autowiredEnabled (advanced) Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. true boolean 95.5. Endpoint Options The MongoDB endpoint is configured using URI syntax: with the following path and query parameters: 95.5.1. Path Parameters (1 parameters) Name Description Default Type connectionBean (common) Required Sets the connection bean reference used to lookup a client for connecting to a database. String 95.5.2. Query Parameters (27 parameters) Name Description Default Type collection (common) Sets the name of the MongoDB collection to bind to this endpoint. String collectionIndex (common) Sets the collection index (JSON FORMAT : \\{ field1 : order1, field2 : order2}). String createCollection (common) Create collection during initialisation if it doesn't exist. Default is true. true boolean database (common) Sets the name of the MongoDB database to target. String hosts (common) Host address of mongodb server in host:port format. It's possible also use more than one address, as comma separated list of hosts: host1:port1,host2:port2. If hosts parameter is specified, provided connectionBean is ignored. String mongoConnection (common) Sets the connection bean used as a client for connecting to a database. MongoClient operation (common) Sets the operation this endpoint will execute against MongoDB. Enum values: findById findOneByQuery findAll findDistinct insert save update remove bulkWrite aggregate getDbStats getColStats count command MongoDbOperation outputType (common) Convert the output of the producer to the selected type : DocumentList Document or MongoIterable. DocumentList or MongoIterable applies to findAll and aggregate. Document applies to all other operations. Enum values: DocumentList Document MongoIterable MongoDbOutputType bridgeErrorHandler (consumer) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. false boolean consumerType (consumer) Consumer type. String exceptionHandler (consumer (advanced)) To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. ExceptionHandler exchangePattern (consumer (advanced)) Sets the exchange pattern when the consumer creates an exchange. Enum values: InOnly InOut InOptionalOut ExchangePattern lazyStartProducer (producer) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false boolean cursorRegenerationDelay (advanced) MongoDB tailable cursors will block until new data arrives. If no new data is inserted, after some time the cursor will be automatically freed and closed by the MongoDB server. The client is expected to regenerate the cursor if needed. This value specifies the time to wait before attempting to fetch a new cursor, and if the attempt fails, how long before the attempt is made. Default value is 1000ms. 1000 long dynamicity (advanced) Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties. Can be used to override at runtime the database and collection specified on the otherwise static endpoint URI. It is disabled by default to boost performance. Enabling it will take a minimal performance hit. false boolean readPreference (advanced) Configure how MongoDB clients route read operations to the members of a replica set. Possible values are PRIMARY, PRIMARY_PREFERRED, SECONDARY, SECONDARY_PREFERRED or NEAREST. Enum values: PRIMARY PRIMARY_PREFERRED SECONDARY SECONDARY_PREFERRED NEAREST PRIMARY String writeConcern (advanced) Configure the connection bean with the level of acknowledgment requested from MongoDB for write operations to a standalone mongod, replicaset or cluster. Possible values are ACKNOWLEDGED, W1, W2, W3, UNACKNOWLEDGED, JOURNALED or MAJORITY. Enum values: ACKNOWLEDGED W1 W2 W3 UNACKNOWLEDGED JOURNALED MAJORITY ACKNOWLEDGED String writeResultAsHeader (advanced) In write operations, it determines whether instead of returning WriteResult as the body of the OUT message, we transfer the IN message to the OUT and attach the WriteResult as a header. false boolean streamFilter (changeStream) Filter condition for change streams consumer. String password (security) User password for mongodb connection. String username (security) Username for mongodb connection. String persistentId (tail) One tail tracking collection can host many trackers for several tailable consumers. To keep them separate, each tracker should have its own unique persistentId. String persistentTailTracking (tail) Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts. The time the system is up, the endpoint will recover the cursor from the point where it last stopped slurping records. false boolean tailTrackCollection (tail) Collection where tail tracking information will be persisted. If not specified, MongoDbTailTrackingConfig#DEFAULT_COLLECTION will be used by default. String tailTrackDb (tail) Indicates what database the tail tracking mechanism will persist to. If not specified, the current database will be picked by default. Dynamicity will not be taken into account even if enabled, i.e. the tail tracking database will not vary past endpoint initialisation. String tailTrackField (tail) Field where the last tracked value will be placed. If not specified, MongoDbTailTrackingConfig#DEFAULT_FIELD will be used by default. String tailTrackIncreasingField (tail) Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField greater than lastValue (possibly recovered from persistent tail tracking). Can be of type Integer, Date, String, etc. NOTE: No support for dot notation at the current time, so the field should be at the top level of the document. String 95.6. Configuration of database in Spring XML The following Spring XML creates a bean defining the connection to a MongoDB instance. Since mongo java driver 3, the WriteConcern and readPreference options are not dynamically modifiable. They are defined in the mongoClient object <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:mongo="http://www.springframework.org/schema/data/mongo" xsi:schemaLocation="http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/data/mongo http://www.springframework.org/schema/data/mongo/spring-mongo.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"> <mongo:mongo-client id="mongoBean" host="USD{mongo.url}" port="USD{mongo.port}" credentials="USD{mongo.user}:USD{mongo.pass}@USD{mongo.dbname}"> <mongo:client-options write-concern="NORMAL" /> </mongo:mongo-client> </beans> 95.7. Sample route The following route defined in Spring XML executes the operation getDbStats on a collection. Get DB stats for specified collection <route> <from uri="direct:start" /> <!-- using bean 'mongoBean' defined above --> <to uri="mongodb:mongoBean?database=USD{mongodb.database}&collection=USD{mongodb.collection}&operation=getDbStats" /> <to uri="direct:result" /> </route> 95.8. MongoDB operations - producer endpoints 95.8.1. Query operations 95.8.1.1. findById This operation retrieves only one element from the collection whose _id field matches the content of the IN message body. The incoming object can be anything that has an equivalent to a Bson type. See http://bsonspec.org/spec.html and http://www.mongodb.org/display/DOCS/Java+Types . from("direct:findById") .to("mongodb:myDb?database=flights&collection=tickets&operation=findById") .to("mock:resultFindById"); Please, note that the default _id is treated by Mongo as and ObjectId type, so you may need to convert it properly. from("direct:findById") .convertBodyTo(ObjectId.class) .to("mongodb:myDb?database=flights&collection=tickets&operation=findById") .to("mock:resultFindById"); Note Supports optional parameters This operation supports projection operators. See Specifying a fields filter (projection) . 95.8.1.2. findOneByQuery Retrieve the first element from a collection matching a MongoDB query selector. If the CamelMongoDbCriteria header is set, then its value is used as the query selector . If the CamelMongoDbCriteria header is null , then the IN message body is used as the query selector. In both cases, the query selector should be of type Bson or convertible to Bson (for instance, a JSON string or HashMap ). See Type conversions for more info. Create query selectors using the Filters provided by the MongoDB Driver. 95.8.1.3. Example without a query selector (returns the first document in a collection) from("direct:findOneByQuery") .to("mongodb:myDb?database=flights&collection=tickets&operation=findOneByQuery") .to("mock:resultFindOneByQuery"); 95.8.1.4. Example with a query selector (returns the first matching document in a collection): from("direct:findOneByQuery") .setHeader(MongoDbConstants.CRITERIA, constant(Filters.eq("name", "Raul Kripalani"))) .to("mongodb:myDb?database=flights&collection=tickets&operation=findOneByQuery") .to("mock:resultFindOneByQuery"); Note Supports optional parameters This operation supports projection operators and sort clauses. See Specifying a fields filter (projection) , Specifying a sort clause. 95.8.1.5. findAll The findAll operation returns all documents matching a query, or none at all, in which case all documents contained in the collection are returned. The query object is extracted CamelMongoDbCriteria header . if the CamelMongoDbCriteria header is null the query object is extracted message body, i.e. it should be of type Bson or convertible to Bson . It can be a JSON String or a Hashmap. See Type conversions for more info. 95.8.1.5.1. Example without a query selector (returns all documents in a collection) from("direct:findAll") .to("mongodb:myDb?database=flights&collection=tickets&operation=findAll") .to("mock:resultFindAll"); 95.8.1.5.2. Example with a query selector (returns all matching documents in a collection) from("direct:findAll") .setHeader(MongoDbConstants.CRITERIA, Filters.eq("name", "Raul Kripalani")) .to("mongodb:myDb?database=flights&collection=tickets&operation=findAll") .to("mock:resultFindAll"); Paging and efficient retrieval is supported via the following headers: Header key Quick constant Description (extracted from MongoDB API doc) Expected type CamelMongoDbNumToSkip MongoDbConstants.NUM_TO_SKIP Discards a given number of elements at the beginning of the cursor. int/Integer CamelMongoDbLimit MongoDbConstants.LIMIT Limits the number of elements returned. int/Integer CamelMongoDbBatchSize MongoDbConstants.BATCH_SIZE Limits the number of elements returned in one batch. A cursor typically fetches a batch of result objects and store them locally. If batchSize is positive, it represents the size of each batch of objects retrieved. It can be adjusted to optimize performance and limit data transfer. If batchSize is negative, it will limit of number objects returned, that fit within the max batch size limit (usually 4MB), and cursor will be closed. For example if batchSize is -10, then the server will return a maximum of 10 documents and as many as can fit in 4MB, then close the cursor. Note that this feature is different from limit() in that documents must fit within a maximum size, and it removes the need to send a request to close the cursor server-side. The batch size can be changed even after a cursor is iterated, in which case the setting will apply on the batch retrieval. int/Integer CamelMongoDbAllowDiskUse MongoDbConstants.ALLOW_DISK_USE Sets allowDiskUse MongoDB flag. This is supported since MongoDB Server 4.3.1. Using this header with older MongoDB Server version can cause query to fail. boolean/Boolean 95.8.1.5.3. Example with option outputType=MongoIterable and batch size from("direct:findAll") .setHeader(MongoDbConstants.BATCH_SIZE).constant(10) .setHeader(MongoDbConstants.CRITERIA, constant(Filters.eq("name", "Raul Kripalani"))) .to("mongodb:myDb?database=flights&collection=tickets&operation=findAll&outputType=MongoIterable") .to("mock:resultFindAll"); The findAll operation will also return the following OUT headers to enable you to iterate through result pages if you are using paging: Header key Quick constant Description (extracted from MongoDB API doc) Data type CamelMongoDbResultTotalSize MongoDbConstants.RESULT_TOTAL_SIZE Number of objects matching the query. This does not take limit/skip into consideration. int/Integer CamelMongoDbResultPageSize MongoDbConstants.RESULT_PAGE_SIZE Number of objects matching the query. This does not take limit/skip into consideration. int/Integer Note Supports optional parameters This operation supports projection operators and sort clauses. See Specifying a fields filter (projection) , Specifying a sort clause. 95.8.1.6. count Returns the total number of objects in a collection, returning a Long as the OUT message body. The following example will count the number of records in the "dynamicCollectionName" collection. Notice how dynamicity is enabled, and as a result, the operation will not run against the "notableScientists" collection, but against the "dynamicCollectionName" collection. // from("direct:count").to("mongodb:myDb?database=tickets&collection=flights&operation=count&dynamicity=true"); Long result = template.requestBodyAndHeader("direct:count", "irrelevantBody", MongoDbConstants.COLLECTION, "dynamicCollectionName"); assertTrue("Result is not of type Long", result instanceof Long); You can provide a query The query object is extracted CamelMongoDbCriteria header . if the CamelMongoDbCriteria header is null the query object is extracted message body, i.e. it should be of type Bson or convertible to Bson ., and operation will return the amount of documents matching this criteria. Document query = ... Long count = template.requestBodyAndHeader("direct:count", query, MongoDbConstants.COLLECTION, "dynamicCollectionName"); 95.8.1.7. Specifying a fields filter (projection) Query operations will, by default, return the matching objects in their entirety (with all their fields). If your documents are large and you only require retrieving a subset of their fields, you can specify a field filter in all query operations, simply by setting the relevant Bson (or type convertible to Bson , such as a JSON String, Map, etc.) on the CamelMongoDbFieldsProjection header, constant shortcut: MongoDbConstants.FIELDS_PROJECTION . Here is an example that uses MongoDB's Projections to simplify the creation of Bson. It retrieves all fields except _id and boringField : // route: from("direct:findAll").to("mongodb:myDb?database=flights&collection=tickets&operation=findAll") Bson fieldProjection = Projection.exclude("_id", "boringField"); Object result = template.requestBodyAndHeader("direct:findAll", ObjectUtils.NULL, MongoDbConstants.FIELDS_PROJECTION, fieldProjection); Here is an example that uses MongoDB's Projections to simplify the creation of Bson. It retrieves all fields except _id and boringField : // route: from("direct:findAll").to("mongodb:myDb?database=flights&collection=tickets&operation=findAll") Bson fieldProjection = Projection.exclude("_id", "boringField"); Object result = template.requestBodyAndHeader("direct:findAll", ObjectUtils.NULL, MongoDbConstants.FIELDS_PROJECTION, fieldProjection); 95.8.1.8. Specifying a sort clause There is a often a requirement to fetch the min/max record from a collection based on sorting by a particular field that uses MongoDB's Sorts to simplify the creation of Bson. It retrieves all fields except _id and boringField : // route: from("direct:findAll").to("mongodb:myDb?database=flights&collection=tickets&operation=findAll") Bson sorts = Sorts.descending("_id"); Object result = template.requestBodyAndHeader("direct:findAll", ObjectUtils.NULL, MongoDbConstants.SORT_BY, sorts); In a Camel route the SORT_BY header can be used with the findOneByQuery operation to achieve the same result. If the FIELDS_PROJECTION header is also specified the operation will return a single field/value pair that can be passed directly to another component (for example, a parameterized MyBatis SELECT query). This example demonstrates fetching the temporally newest document from a collection and reducing the result to a single field, based on the documentTimestamp field: .from("direct:someTriggeringEvent") .setHeader(MongoDbConstants.SORT_BY).constant(Sorts.descending("documentTimestamp")) .setHeader(MongoDbConstants.FIELDS_PROJECTION).constant(Projection.include("documentTimestamp")) .setBody().constant("{}") .to("mongodb:myDb?database=local&collection=myDemoCollection&operation=findOneByQuery") .to("direct:aMyBatisParameterizedSelect"); 95.8.2. Create/update operations 95.8.2.1. insert Inserts an new object into the MongoDB collection, taken from the IN message body. Type conversion is attempted to turn it into Document or a List . Two modes are supported: single insert and multiple insert. For multiple insert, the endpoint will expect a List, Array or Collections of objects of any type, as long as they are - or can be converted to - Document . Example: from("direct:insert") .to("mongodb:myDb?database=flights&collection=tickets&operation=insert"); The operation will return a WriteResult, and depending on the WriteConcern or the value of the invokeGetLastError option, getLastError() would have been called already or not. If you want to access the ultimate result of the write operation, you need to retrieve the CommandResult by calling getLastError() or getCachedLastError() on the WriteResult . Then you can verify the result by calling CommandResult.ok() , CommandResult.getErrorMessage() and/or CommandResult.getException() . Note that the new object's _id must be unique in the collection. If you don't specify the value, MongoDB will automatically generate one for you. But if you do specify it and it is not unique, the insert operation will fail (and for Camel to notice, you will need to enable invokeGetLastError or set a WriteConcern that waits for the write result). This is not a limitation of the component, but it is how things work in MongoDB for higher throughput. If you are using a custom _id , you are expected to ensure at the application level that is unique (and this is a good practice too). OID(s) of the inserted record(s) is stored in the message header under CamelMongoOid key ( MongoDbConstants.OID constant). The value stored is org.bson.types.ObjectId for single insert or java.util.List<org.bson.types.ObjectId> if multiple records have been inserted. In MongoDB Java Driver 3.x the insertOne and insertMany operation return void. The Camel insert operation return the Document or List of Documents inserted. Note that each Documents are Updated by a new OID if need. 95.8.2.2. save The save operation is equivalent to an upsert (UPdate, inSERT) operation, where the record will be updated, and if it doesn't exist, it will be inserted, all in one atomic operation. MongoDB will perform the matching based on the _id field. Beware that in case of an update, the object is replaced entirely and the usage of MongoDB's USDmodifiers is not permitted. Therefore, if you want to manipulate the object if it already exists, you have two options: perform a query to retrieve the entire object first along with all its fields (may not be efficient), alter it inside Camel and then save it. use the update operation with USDmodifiers , which will execute the update at the server-side instead. You can enable the upsert flag, in which case if an insert is required, MongoDB will apply the USDmodifiers to the filter query object and insert the result. If the document to be saved does not contain the _id attribute, the operation will be an insert, and the new _id created will be placed in the CamelMongoOid header. For example: from("direct:insert") .to("mongodb:myDb?database=flights&collection=tickets&operation=save"); // route: from("direct:insert").to("mongodb:myDb?database=flights&collection=tickets&operation=save"); org.bson.Document docForSave = new org.bson.Document(); docForSave.put("key", "value"); Object result = template.requestBody("direct:insert", docForSave); 95.8.2.3. update Update one or multiple records on the collection. Requires a filter query and a update rules. You can define the filter using MongoDBConstants.CRITERIA header as Bson and define the update rules as Bson in Body. Note Update after enrich While defining the filter by using MongoDBConstants.CRITERIA header as Bson to query mongodb before you do update, you should notice you need to remove it from the resulting camel exchange during aggregation if you use enrich pattern with a aggregation strategy and then apply mongodb update. If you don't remove this header during aggregation and/or redefine MongoDBConstants.CRITERIA header before sending camel exchange to mongodb producer endpoint, you may end up with invalid camel exchange payload while updating mongodb. The second way Require a List<Bson> as the IN message body containing exactly 2 elements: Element 1 (index 0) ⇒ filter query ⇒ determines what objects will be affected, same as a typical query object Element 2 (index 1) ⇒ update rules ⇒ how matched objects will be updated. All modifier operations from MongoDB are supported. Note Multiupdates By default, MongoDB will only update 1 object even if multiple objects match the filter query. To instruct MongoDB to update all matching records, set the CamelMongoDbMultiUpdate IN message header to true . A header with key CamelMongoDbRecordsAffected will be returned ( MongoDbConstants.RECORDS_AFFECTED constant) with the number of records updated (copied from WriteResult.getN() ). Supports the following IN message headers: Header key Quick constant Description (extracted from MongoDB API doc) Expected type CamelMongoDbMultiUpdate MongoDbConstants.MULTIUPDATE If the update should be applied to all objects matching. See http://www.mongodb.org/display/DOCS/Atomic+Operations boolean/Boolean CamelMongoDbUpsert MongoDbConstants.UPSERT If the database should create the element if it does not exist boolean/Boolean For example, the following will update all records whose filterField field equals true by setting the value of the "scientist" field to "Darwin": // route: from("direct:update").to("mongodb:myDb?database=science&collection=notableScientists&operation=update"); List<Bson> body = new ArrayList<>(); Bson filterField = Filters.eq("filterField", true); body.add(filterField); BsonDocument updateObj = new BsonDocument().append("USDset", new BsonDocument("scientist", new BsonString("Darwin"))); body.add(updateObj); Object result = template.requestBodyAndHeader("direct:update", body, MongoDbConstants.MULTIUPDATE, true); // route: from("direct:update").to("mongodb:myDb?database=science&collection=notableScientists&operation=update"); Maps<String, Object> headers = new HashMap<>(2); headers.add(MongoDbConstants.MULTIUPDATE, true); headers.add(MongoDbConstants.FIELDS_FILTER, Filters.eq("filterField", true)); String updateObj = Updates.set("scientist", "Darwin");; Object result = template.requestBodyAndHeaders("direct:update", updateObj, headers); // route: from("direct:update").to("mongodb:myDb?database=science&collection=notableScientists&operation=update"); String updateObj = "[{\"filterField\": true}, {\"USDset\", {\"scientist\", \"Darwin\"}}]"; Object result = template.requestBodyAndHeader("direct:update", updateObj, MongoDbConstants.MULTIUPDATE, true); 95.8.3. Delete operations 95.8.3.1. remove Remove matching records from the collection. The IN message body will act as the removal filter query, and is expected to be of type DBObject or a type convertible to it. The following example will remove all objects whose field 'conditionField' equals true, in the science database, notableScientists collection: // route: from("direct:remove").to("mongodb:myDb?database=science&collection=notableScientists&operation=remove"); Bson conditionField = Filters.eq("conditionField", true); Object result = template.requestBody("direct:remove", conditionField); A header with key CamelMongoDbRecordsAffected is returned ( MongoDbConstants.RECORDS_AFFECTED constant) with type int , containing the number of records deleted (copied from WriteResult.getN() ). 95.8.4. Bulk Write Operations 95.8.4.1. bulkWrite Performs write operations in bulk with controls for order of execution. Requires a List<WriteModel<Document>> as the IN message body containing commands for insert, update, and delete operations. The following example will insert a new scientist "Pierre Curie", update record with id "5" by setting the value of the "scientist" field to "Marie Curie" and delete record with id "3" : // route: from("direct:bulkWrite").to("mongodb:myDb?database=science&collection=notableScientists&operation=bulkWrite"); List<WriteModel<Document>> bulkOperations = Arrays.asList( new InsertOneModel<>(new Document("scientist", "Pierre Curie")), new UpdateOneModel<>(new Document("_id", "5"), new Document("USDset", new Document("scientist", "Marie Curie"))), new DeleteOneModel<>(new Document("_id", "3"))); BulkWriteResult result = template.requestBody("direct:bulkWrite", bulkOperations, BulkWriteResult.class); By default, operations are executed in order and interrupted on the first write error without processing any remaining write operations in the list. To instruct MongoDB to continue to process remaining write operations in the list, set the CamelMongoDbBulkOrdered IN message header to false . Unordered operations are executed in parallel and this behavior is not guaranteed. Header key Quick constant Description (extracted from MongoDB API doc) Expected type CamelMongoDbBulkOrdered MongoDbConstants.BULK_ORDERED Perform an ordered or unordered operation execution. Defaults to true. boolean/Boolean 95.8.5. Other operations 95.8.5.1. aggregate Perform a aggregation with the given pipeline contained in the body. Aggregations could be long and heavy operations. Use with care. // route: from("direct:aggregate").to("mongodb:myDb?database=science&collection=notableScientists&operation=aggregate"); List<Bson> aggregate = Arrays.asList(match(or(eq("scientist", "Darwin"), eq("scientist", group("USDscientist", sum("count", 1))); from("direct:aggregate") .setBody().constant(aggregate) .to("mongodb:myDb?database=science&collection=notableScientists&operation=aggregate") .to("mock:resultAggregate"); Supports the following IN message headers: Header key Quick constant Description (extracted from MongoDB API doc) Expected type CamelMongoDbBatchSize MongoDbConstants.BATCH_SIZE Sets the number of documents to return per batch. int/Integer CamelMongoDbAllowDiskUse MongoDbConstants.ALLOW_DISK_USE Enable aggregation pipeline stages to write data to temporary files. boolean/Boolean By default a List of all results is returned. This can be heavy on memory depending on the size of the results. A safer alternative is to set your outputType=MongoIterable. The Processor will see an iterable in the message body allowing it to step through the results one by one. Thus setting a batch size and returning an iterable allows for efficient retrieval and processing of the result. An example would look like: List<Bson> aggregate = Arrays.asList(match(or(eq("scientist", "Darwin"), eq("scientist", group("USDscientist", sum("count", 1))); from("direct:aggregate") .setHeader(MongoDbConstants.BATCH_SIZE).constant(10) .setBody().constant(aggregate) .to("mongodb:myDb?database=science&collection=notableScientists&operation=aggregate&outputType=MongoIterable") .split(body()) .streaming() .to("mock:resultAggregate"); Note that calling .split(body()) is enough to send the entries down the route one-by-one, however it would still load all the entries into memory first. Calling .streaming() is thus required to load data into memory by batches. 95.8.5.2. getDbStats Equivalent of running the db.stats() command in the MongoDB shell, which displays useful statistic figures about the database. For example: Usage example: // from("direct:getDbStats").to("mongodb:myDb?database=flights&collection=tickets&operation=getDbStats"); Object result = template.requestBody("direct:getDbStats", "irrelevantBody"); assertTrue("Result is not of type Document", result instanceof Document); The operation will return a data structure similar to the one displayed in the shell, in the form of a Document in the OUT message body. 95.8.5.3. getColStats Equivalent of running the db.collection.stats() command in the MongoDB shell, which displays useful statistic figures about the collection. For example: Usage example: // from("direct:getColStats").to("mongodb:myDb?database=flights&collection=tickets&operation=getColStats"); Object result = template.requestBody("direct:getColStats", "irrelevantBody"); assertTrue("Result is not of type Document", result instanceof Document); The operation will return a data structure similar to the one displayed in the shell, in the form of a Document in the OUT message body. 95.8.5.4. command Run the body as a command on database. Useful for admin operation as getting host information, replication or sharding status. Collection parameter is not use for this operation. // route: from("command").to("mongodb:myDb?database=science&operation=command"); DBObject commandBody = new BasicDBObject("hostInfo", "1"); Object result = template.requestBody("direct:command", commandBody); 95.8.6. Dynamic operations An Exchange can override the endpoint's fixed operation by setting the CamelMongoDbOperation header, defined by the MongoDbConstants.OPERATION_HEADER constant. The values supported are determined by the MongoDbOperation enumeration and match the accepted values for the operation parameter on the endpoint URI. For example: // from("direct:insert").to("mongodb:myDb?database=flights&collection=tickets&operation=insert"); Object result = template.requestBodyAndHeader("direct:insert", "irrelevantBody", MongoDbConstants.OPERATION_HEADER, "count"); assertTrue("Result is not of type Long", result instanceof Long); 95.9. Consumers There are several types of consumers: Tailable Cursor Consumer Change Streams Consumer 95.9.1. Tailable Cursor Consumer MongoDB offers a mechanism to instantaneously consume ongoing data from a collection, by keeping the cursor open just like the tail -f command of *nix systems. This mechanism is significantly more efficient than a scheduled poll, due to the fact that the server pushes new data to the client as it becomes available, rather than making the client ping back at scheduled intervals to fetch new data. It also reduces otherwise redundant network traffic. There is only one requisite to use tailable cursors: the collection must be a "capped collection", meaning that it will only hold N objects, and when the limit is reached, MongoDB flushes old objects in the same order they were originally inserted. For more information, please refer to http://www.mongodb.org/display/DOCS/Tailable+Cursors . The Camel MongoDB component implements a tailable cursor consumer, making this feature available for you to use in your Camel routes. As new objects are inserted, MongoDB will push them as Document in natural order to your tailable cursor consumer, who will transform them to an Exchange and will trigger your route logic. 95.10. How the tailable cursor consumer works To turn a cursor into a tailable cursor, a few special flags are to be signalled to MongoDB when first generating the cursor. Once created, the cursor will then stay open and will block upon calling the MongoCursor.() method until new data arrives. However, the MongoDB server reserves itself the right to kill your cursor if new data doesn't appear after an indeterminate period. If you are interested to continue consuming new data, you have to regenerate the cursor. And to do so, you will have to remember the position where you left off or else you will start consuming from the top again. The Camel MongoDB tailable cursor consumer takes care of all these tasks for you. You will just need to provide the key to some field in your data of increasing nature, which will act as a marker to position your cursor every time it is regenerated, e.g. a timestamp, a sequential ID, etc. It can be of any datatype supported by MongoDB. Date, Strings and Integers are found to work well. We call this mechanism "tail tracking" in the context of this component. The consumer will remember the last value of this field and whenever the cursor is to be regenerated, it will run the query with a filter like: increasingField > lastValue , so that only unread data is consumed. Setting the increasing field: Set the key of the increasing field on the endpoint URI tailTrackingIncreasingField option. In Camel 2.10, it must be a top-level field in your data, as nested navigation for this field is not yet supported. That is, the "timestamp" field is okay, but "nested.timestamp" will not work. Please open a ticket in the Camel JIRA if you do require support for nested increasing fields. Cursor regeneration delay: One thing to note is that if new data is not already available upon initialisation, MongoDB will kill the cursor instantly. Since we don't want to overwhelm the server in this case, a cursorRegenerationDelay option has been introduced (with a default value of 1000ms.), which you can modify to suit your needs. An example: from("mongodb:myDb?database=flights&collection=cancellations&tailTrackIncreasingField=departureTime") .id("tailableCursorConsumer1") .autoStartup(false) .to("mock:test"); The above route will consume from the "flights.cancellations" capped collection, using "departureTime" as the increasing field, with a default regeneration cursor delay of 1000ms. 95.11. Persistent tail tracking Standard tail tracking is volatile and the last value is only kept in memory. However, in practice you will need to restart your Camel container every now and then, but your last value would then be lost and your tailable cursor consumer would start consuming from the top again, very likely sending duplicate records into your route. To overcome this situation, you can enable the persistent tail tracking feature to keep track of the last consumed increasing value in a special collection inside your MongoDB database too. When the consumer initialises again, it will restore the last tracked value and continue as if nothing happened. The last read value is persisted on two occasions: every time the cursor is regenerated and when the consumer shuts down. We may consider persisting at regular intervals too in the future (flush every 5 seconds) for added robustness if the demand is there. To request this feature, please open a ticket in the Camel JIRA. 95.12. Enabling persistent tail tracking To enable this function, set at least the following options on the endpoint URI: persistentTailTracking option to true persistentId option to a unique identifier for this consumer, so that the same collection can be reused across many consumers Additionally, you can set the tailTrackDb , tailTrackCollection and tailTrackField options to customise where the runtime information will be stored. Refer to the endpoint options table at the top of this page for descriptions of each option. For example, the following route will consume from the "flights.cancellations" capped collection, using "departureTime" as the increasing field, with a default regeneration cursor delay of 1000ms, with persistent tail tracking turned on, and persisting under the "cancellationsTracker" id on the "flights.camelTailTracking", storing the last processed value under the "lastTrackingValue" field ( camelTailTracking and lastTrackingValue are defaults). from("mongodb:myDb?database=flights&collection=cancellations&tailTrackIncreasingField=departureTime&persistentTailTracking=true" + "&persistentId=cancellationsTracker") .id("tailableCursorConsumer2") .autoStartup(false) .to("mock:test"); Below is another example identical to the one above, but where the persistent tail tracking runtime information will be stored under the "trackers.camelTrackers" collection, in the "lastProcessedDepartureTime" field: from("mongodb:myDb?database=flights&collection=cancellations&tailTrackIncreasingField=departureTime&persistentTailTracking=true" + "&persistentId=cancellationsTracker&tailTrackDb=trackers&tailTrackCollection=camelTrackers" + "&tailTrackField=lastProcessedDepartureTime") .id("tailableCursorConsumer3") .autoStartup(false) .to("mock:test"); 95.12.1. Change Streams Consumer Change Streams allow applications to access real-time data changes without the complexity and risk of tailing the MongoDB oplog. Applications can use change streams to subscribe to all data changes on a collection and immediately react to them. Because change streams use the aggregation framework, applications can also filter for specific changes or transform the notifications at will. The exchange body will contain the full document of any change. To configure Change Streams Consumer you need to specify consumerType , database , collection and optional JSON property streamFilter to filter events. That JSON property is standard MongoDB USDmatch aggregation. It could be easily specified using XML DSL configuration: <route id="filterConsumer"> <from uri="mongodb:myDb?consumerType=changeStreams&database=flights&collection=tickets&streamFilter={ 'USDmatch':{'USDor':[{'fullDocument.stringValue': 'specificValue'}]} }"/> <to uri="mock:test"/> </route> Java configuration: from("mongodb:myDb?consumerType=changeStreams&database=flights&collection=tickets&streamFilter={ 'USDmatch':{'USDor':[{'fullDocument.stringValue': 'specificValue'}]} }") .to("mock:test"); Note You can externalize the streamFilter value into a property placeholder which allows the endpoint URI parameters to be cleaner and easier to read. The changeStreams consumer type will also return the following OUT headers: Header key Quick constant Description (extracted from MongoDB API doc) Data type CamelMongoDbStreamOperationType MongoDbConstants.STREAM_OPERATION_TYPE The type of operation that occurred. Can be any of the following values: insert, delete, replace, update, drop, rename, dropDatabase, invalidate. String _id MongoDbConstants.MONGO_ID A document that contains the _id of the document created or modified by the insert, replace, delete, update operations (i.e. CRUD operations). For sharded collections, also displays the full shard key for the document. The _id field is not repeated if it is already a part of the shard key. ObjectId 95.13. Type conversions The MongoDbBasicConverters type converter included with the camel-mongodb component provides the following conversions: Name From type To type How? fromMapToDocument Map Document constructs a new Document via the new Document(Map m) constructor. fromDocumentToMap Document Map Document already implements Map . fromStringToDocument String Document uses com.mongodb.Document.parse(String s) . fromStringToObjectId String ObjectId constructs a new ObjectId via the new ObjectId(s) fromFileToDocument File Document uses fromInputStreamToDocument under the hood fromInputStreamToDocument InputStream Document converts the inputstream bytes to a Document fromStringToList String List<Bson> uses org.bson.codecs.configuration.CodecRegistries to convert to BsonArray then to List<Bson>. This type converter is auto-discovered, so you don't need to configure anything manually. 95.14. Spring Boot Auto-Configuration The component supports 5 options, which are listed below. Name Description Default Type camel.component.mongodb.autowired-enabled Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. true Boolean camel.component.mongodb.bridge-error-handler Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. false Boolean camel.component.mongodb.enabled Whether to enable auto configuration of the mongodb component. This is enabled by default. Boolean camel.component.mongodb.lazy-start-producer Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false Boolean camel.component.mongodb.mongo-connection Shared client used for connection. All endpoints generated from the component will share this connection client. The option is a com.mongodb.client.MongoClient type. MongoClient	[ "<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-mongodb-starter</artifactId> </dependency>", "mongodb:connectionBean?database=databaseName&collection=collectionName&operation=operationName[&moreOptions...]", "mongodb:connectionBean", "<beans xmlns=\"http://www.springframework.org/schema/beans\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:context=\"http://www.springframework.org/schema/context\" xmlns:mongo=\"http://www.springframework.org/schema/data/mongo\" xsi:schemaLocation=\"http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/data/mongo http://www.springframework.org/schema/data/mongo/spring-mongo.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd\"> <mongo:mongo-client id=\"mongoBean\" host=\"USD{mongo.url}\" port=\"USD{mongo.port}\" credentials=\"USD{mongo.user}:USD{mongo.pass}@USD{mongo.dbname}\"> <mongo:client-options write-concern=\"NORMAL\" /> </mongo:mongo-client> </beans>", "<route> <from uri=\"direct:start\" /> <!-- using bean 'mongoBean' defined above --> <to uri=\"mongodb:mongoBean?database=USD{mongodb.database}&collection=USD{mongodb.collection}&operation=getDbStats\" /> <to uri=\"direct:result\" /> </route>", "from(\"direct:findById\") .to(\"mongodb:myDb?database=flights&collection=tickets&operation=findById\") .to(\"mock:resultFindById\");", "from(\"direct:findById\") .convertBodyTo(ObjectId.class) .to(\"mongodb:myDb?database=flights&collection=tickets&operation=findById\") .to(\"mock:resultFindById\");", "from(\"direct:findOneByQuery\") .to(\"mongodb:myDb?database=flights&collection=tickets&operation=findOneByQuery\") .to(\"mock:resultFindOneByQuery\");", "from(\"direct:findOneByQuery\") .setHeader(MongoDbConstants.CRITERIA, constant(Filters.eq(\"name\", \"Raul Kripalani\"))) .to(\"mongodb:myDb?database=flights&collection=tickets&operation=findOneByQuery\") .to(\"mock:resultFindOneByQuery\");", "from(\"direct:findAll\") .to(\"mongodb:myDb?database=flights&collection=tickets&operation=findAll\") .to(\"mock:resultFindAll\");", "from(\"direct:findAll\") .setHeader(MongoDbConstants.CRITERIA, Filters.eq(\"name\", \"Raul Kripalani\")) .to(\"mongodb:myDb?database=flights&collection=tickets&operation=findAll\") .to(\"mock:resultFindAll\");", "from(\"direct:findAll\") .setHeader(MongoDbConstants.BATCH_SIZE).constant(10) .setHeader(MongoDbConstants.CRITERIA, constant(Filters.eq(\"name\", \"Raul Kripalani\"))) .to(\"mongodb:myDb?database=flights&collection=tickets&operation=findAll&outputType=MongoIterable\") .to(\"mock:resultFindAll\");", "// from(\"direct:count\").to(\"mongodb:myDb?database=tickets&collection=flights&operation=count&dynamicity=true\"); Long result = template.requestBodyAndHeader(\"direct:count\", \"irrelevantBody\", MongoDbConstants.COLLECTION, \"dynamicCollectionName\"); assertTrue(\"Result is not of type Long\", result instanceof Long);", "Document query = Long count = template.requestBodyAndHeader(\"direct:count\", query, MongoDbConstants.COLLECTION, \"dynamicCollectionName\");", "// route: from(\"direct:findAll\").to(\"mongodb:myDb?database=flights&collection=tickets&operation=findAll\") Bson fieldProjection = Projection.exclude(\"_id\", \"boringField\"); Object result = template.requestBodyAndHeader(\"direct:findAll\", ObjectUtils.NULL, MongoDbConstants.FIELDS_PROJECTION, fieldProjection);", "// route: from(\"direct:findAll\").to(\"mongodb:myDb?database=flights&collection=tickets&operation=findAll\") Bson fieldProjection = Projection.exclude(\"_id\", \"boringField\"); Object result = template.requestBodyAndHeader(\"direct:findAll\", ObjectUtils.NULL, MongoDbConstants.FIELDS_PROJECTION, fieldProjection);", "// route: from(\"direct:findAll\").to(\"mongodb:myDb?database=flights&collection=tickets&operation=findAll\") Bson sorts = Sorts.descending(\"_id\"); Object result = template.requestBodyAndHeader(\"direct:findAll\", ObjectUtils.NULL, MongoDbConstants.SORT_BY, sorts);", ".from(\"direct:someTriggeringEvent\") .setHeader(MongoDbConstants.SORT_BY).constant(Sorts.descending(\"documentTimestamp\")) .setHeader(MongoDbConstants.FIELDS_PROJECTION).constant(Projection.include(\"documentTimestamp\")) .setBody().constant(\"{}\") .to(\"mongodb:myDb?database=local&collection=myDemoCollection&operation=findOneByQuery\") .to(\"direct:aMyBatisParameterizedSelect\");", "from(\"direct:insert\") .to(\"mongodb:myDb?database=flights&collection=tickets&operation=insert\");", "from(\"direct:insert\") .to(\"mongodb:myDb?database=flights&collection=tickets&operation=save\");", "// route: from(\"direct:insert\").to(\"mongodb:myDb?database=flights&collection=tickets&operation=save\"); org.bson.Document docForSave = new org.bson.Document(); docForSave.put(\"key\", \"value\"); Object result = template.requestBody(\"direct:insert\", docForSave);", "// route: from(\"direct:update\").to(\"mongodb:myDb?database=science&collection=notableScientists&operation=update\"); List<Bson> body = new ArrayList<>(); Bson filterField = Filters.eq(\"filterField\", true); body.add(filterField); BsonDocument updateObj = new BsonDocument().append(\"USDset\", new BsonDocument(\"scientist\", new BsonString(\"Darwin\"))); body.add(updateObj); Object result = template.requestBodyAndHeader(\"direct:update\", body, MongoDbConstants.MULTIUPDATE, true);", "// route: from(\"direct:update\").to(\"mongodb:myDb?database=science&collection=notableScientists&operation=update\"); Maps<String, Object> headers = new HashMap<>(2); headers.add(MongoDbConstants.MULTIUPDATE, true); headers.add(MongoDbConstants.FIELDS_FILTER, Filters.eq(\"filterField\", true)); String updateObj = Updates.set(\"scientist\", \"Darwin\");; Object result = template.requestBodyAndHeaders(\"direct:update\", updateObj, headers);", "// route: from(\"direct:update\").to(\"mongodb:myDb?database=science&collection=notableScientists&operation=update\"); String updateObj = \"[{\\\"filterField\\\": true}, {\\\"USDset\\\", {\\\"scientist\\\", \\\"Darwin\\\"}}]\"; Object result = template.requestBodyAndHeader(\"direct:update\", updateObj, MongoDbConstants.MULTIUPDATE, true);", "// route: from(\"direct:remove\").to(\"mongodb:myDb?database=science&collection=notableScientists&operation=remove\"); Bson conditionField = Filters.eq(\"conditionField\", true); Object result = template.requestBody(\"direct:remove\", conditionField);", "// route: from(\"direct:bulkWrite\").to(\"mongodb:myDb?database=science&collection=notableScientists&operation=bulkWrite\"); List<WriteModel<Document>> bulkOperations = Arrays.asList( new InsertOneModel<>(new Document(\"scientist\", \"Pierre Curie\")), new UpdateOneModel<>(new Document(\"_id\", \"5\"), new Document(\"USDset\", new Document(\"scientist\", \"Marie Curie\"))), new DeleteOneModel<>(new Document(\"_id\", \"3\"))); BulkWriteResult result = template.requestBody(\"direct:bulkWrite\", bulkOperations, BulkWriteResult.class);", "// route: from(\"direct:aggregate\").to(\"mongodb:myDb?database=science&collection=notableScientists&operation=aggregate\"); List<Bson> aggregate = Arrays.asList(match(or(eq(\"scientist\", \"Darwin\"), eq(\"scientist\", group(\"USDscientist\", sum(\"count\", 1))); from(\"direct:aggregate\") .setBody().constant(aggregate) .to(\"mongodb:myDb?database=science&collection=notableScientists&operation=aggregate\") .to(\"mock:resultAggregate\");", "List<Bson> aggregate = Arrays.asList(match(or(eq(\"scientist\", \"Darwin\"), eq(\"scientist\", group(\"USDscientist\", sum(\"count\", 1))); from(\"direct:aggregate\") .setHeader(MongoDbConstants.BATCH_SIZE).constant(10) .setBody().constant(aggregate) .to(\"mongodb:myDb?database=science&collection=notableScientists&operation=aggregate&outputType=MongoIterable\") .split(body()) .streaming() .to(\"mock:resultAggregate\");", "> db.stats(); { \"db\" : \"test\", \"collections\" : 7, \"objects\" : 719, \"avgObjSize\" : 59.73296244784423, \"dataSize\" : 42948, \"storageSize\" : 1000058880, \"numExtents\" : 9, \"indexes\" : 4, \"indexSize\" : 32704, \"fileSize\" : 1275068416, \"nsSizeMB\" : 16, \"ok\" : 1 }", "// from(\"direct:getDbStats\").to(\"mongodb:myDb?database=flights&collection=tickets&operation=getDbStats\"); Object result = template.requestBody(\"direct:getDbStats\", \"irrelevantBody\"); assertTrue(\"Result is not of type Document\", result instanceof Document);", "> db.camelTest.stats(); { \"ns\" : \"test.camelTest\", \"count\" : 100, \"size\" : 5792, \"avgObjSize\" : 57.92, \"storageSize\" : 20480, \"numExtents\" : 2, \"nindexes\" : 1, \"lastExtentSize\" : 16384, \"paddingFactor\" : 1, \"flags\" : 1, \"totalIndexSize\" : 8176, \"indexSizes\" : { \"_id_\" : 8176 }, \"ok\" : 1 }", "// from(\"direct:getColStats\").to(\"mongodb:myDb?database=flights&collection=tickets&operation=getColStats\"); Object result = template.requestBody(\"direct:getColStats\", \"irrelevantBody\"); assertTrue(\"Result is not of type Document\", result instanceof Document);", "// route: from(\"command\").to(\"mongodb:myDb?database=science&operation=command\"); DBObject commandBody = new BasicDBObject(\"hostInfo\", \"1\"); Object result = template.requestBody(\"direct:command\", commandBody);", "// from(\"direct:insert\").to(\"mongodb:myDb?database=flights&collection=tickets&operation=insert\"); Object result = template.requestBodyAndHeader(\"direct:insert\", \"irrelevantBody\", MongoDbConstants.OPERATION_HEADER, \"count\"); assertTrue(\"Result is not of type Long\", result instanceof Long);", "from(\"mongodb:myDb?database=flights&collection=cancellations&tailTrackIncreasingField=departureTime\") .id(\"tailableCursorConsumer1\") .autoStartup(false) .to(\"mock:test\");", "from(\"mongodb:myDb?database=flights&collection=cancellations&tailTrackIncreasingField=departureTime&persistentTailTracking=true\" + \"&persistentId=cancellationsTracker\") .id(\"tailableCursorConsumer2\") .autoStartup(false) .to(\"mock:test\");", "from(\"mongodb:myDb?database=flights&collection=cancellations&tailTrackIncreasingField=departureTime&persistentTailTracking=true\" + \"&persistentId=cancellationsTracker&tailTrackDb=trackers&tailTrackCollection=camelTrackers\" + \"&tailTrackField=lastProcessedDepartureTime\") .id(\"tailableCursorConsumer3\") .autoStartup(false) .to(\"mock:test\");", "<route id=\"filterConsumer\"> <from uri=\"mongodb:myDb?consumerType=changeStreams&database=flights&collection=tickets&streamFilter={ 'USDmatch':{'USDor':[{'fullDocument.stringValue': 'specificValue'}]} }\"/> <to uri=\"mock:test\"/> </route>", "from(\"mongodb:myDb?consumerType=changeStreams&database=flights&collection=tickets&streamFilter={ 'USDmatch':{'USDor':[{'fullDocument.stringValue': 'specificValue'}]} }\") .to(\"mock:test\");" ]	https://docs.redhat.com/en/documentation/red_hat_build_of_apache_camel/4.4/html/red_hat_build_of_apache_camel_for_spring_boot_reference/csb-camel-mongodb-component-starter
Chapter 6. Configuring a network bridge	Chapter 6. Configuring a network bridge A network bridge is a link-layer device which forwards traffic between networks based on a table of MAC addresses. The bridge builds the MAC addresses table by listening to network traffic and thereby learning what hosts are connected to each network. For example, you can use a software bridge on a Red Hat Enterprise Linux host to emulate a hardware bridge or in virtualization environments, to integrate virtual machines (VM) to the same network as the host. A bridge requires a network device in each network the bridge should connect. When you configure a bridge, the bridge is called controller and the devices it uses ports . You can create bridges on different types of devices, such as: Physical and virtual Ethernet devices Network bonds Network teams VLAN devices Due to the IEEE 802.11 standard which specifies the use of 3-address frames in Wi-Fi for the efficient use of airtime, you cannot configure a bridge over Wi-Fi networks operating in Ad-Hoc or Infrastructure modes. 6.1. Configuring a network bridge by using nmcli To configure a network bridge on the command line, use the nmcli utility. Prerequisites Two or more physical or virtual network devices are installed on the server. To use Ethernet devices as ports of the bridge, the physical or virtual Ethernet devices must be installed on the server. To use team, bond, or VLAN devices as ports of the bridge, you can either create these devices while you create the bridge or you can create them in advance as described in: Configuring a network team by using nmcli Configuring a network bond by using nmcli Configuring VLAN tagging by using nmcli Procedure Create a bridge interface: This command creates a bridge named bridge0 , enter: Display the network interfaces, and note the names of the interfaces you want to add to the bridge: In this example: enp7s0 and enp8s0 are not configured. To use these devices as ports, add connection profiles in the step. bond0 and bond1 have existing connection profiles. To use these devices as ports, modify their profiles in the step. Assign the interfaces to the bridge. If the interfaces you want to assign to the bridge are not configured, create new connection profiles for them: These commands create profiles for enp7s0 and enp8s0 , and add them to the bridge0 connection. If you want to assign an existing connection profile to the bridge: Set the master parameter of these connections to bridge0 : These commands assign the existing connection profiles named bond0 and bond1 to the bridge0 connection. Reactivate the connections: Configure the IPv4 settings: If you plan to use this bridge device as a port of other devices, enter: To use DHCP, no action is required. To set a static IPv4 address, network mask, default gateway, and DNS server to the bridge0 connection, enter: Configure the IPv6 settings: If you plan to use this bridge device as a port of other devices, enter: To use stateless address autoconfiguration (SLAAC), no action is required. To set a static IPv6 address, network mask, default gateway, and DNS server to the bridge0 connection, enter: Optional: Configure further properties of the bridge. For example, to set the Spanning Tree Protocol (STP) priority of bridge0 to 16384 , enter: By default, STP is enabled. Activate the connection: Verify that the ports are connected, and the CONNECTION column displays the port's connection name: When you activate any port of the connection, NetworkManager also activates the bridge, but not the other ports of it. You can configure that Red Hat Enterprise Linux enables all ports automatically when the bridge is enabled: Enable the connection.autoconnect-slaves parameter of the bridge connection: Reactivate the bridge: Verification Use the ip utility to display the link status of Ethernet devices that are ports of a specific bridge: Use the bridge utility to display the status of Ethernet devices that are ports of any bridge device: To display the status for a specific Ethernet device, use the bridge link show dev <ethernet_device_name> command. Additional resources bridge(8) and nm-settings(5) man pages on your system NetworkManager duplicates a connection after restart of NetworkManager service (Red Hat Knowledgebase) How to configure a bridge with VLAN information? (Red Hat Knowledgebase) 6.2. Configuring a network bridge by using the RHEL web console Use the RHEL web console to configure a network bridge if you prefer to manage network settings using a web browser-based interface. Prerequisites Two or more physical or virtual network devices are installed on the server. To use Ethernet devices as ports of the bridge, the physical or virtual Ethernet devices must be installed on the server. To use team, bond, or VLAN devices as ports of the bridge, you can either create these devices while you create the bridge or you can create them in advance as described in: Configuring a network team using the RHEL web console Configuring a network bond by using the RHEL web console Configuring VLAN tagging by using the RHEL web console You have installed the RHEL 8 web console. You have enabled the cockpit service. Your user account is allowed to log in to the web console. For instructions, see Installing and enabling the web console . Procedure Log in to the RHEL 8 web console. For details, see Logging in to the web console . Select the Networking tab in the navigation on the left side of the screen. Click Add bridge in the Interfaces section. Enter the name of the bridge device you want to create. Select the interfaces that should be ports of the bridge. Optional: Enable the Spanning tree protocol (STP) feature to avoid bridge loops and broadcast radiation. Click Apply . By default, the bridge uses a dynamic IP address. If you want to set a static IP address: Click the name of the bridge in the Interfaces section. Click Edit to the protocol you want to configure. Select Manual to Addresses , and enter the IP address, prefix, and default gateway. In the DNS section, click the + button, and enter the IP address of the DNS server. Repeat this step to set multiple DNS servers. In the DNS search domains section, click the + button, and enter the search domain. If the interface requires static routes, configure them in the Routes section. Click Apply Verification Select the Networking tab in the navigation on the left side of the screen, and check if there is incoming and outgoing traffic on the interface: 6.3. Configuring a network bridge by using nmtui The nmtui application provides a text-based user interface for NetworkManager. You can use nmtui to configure a network bridge on a host without a graphical interface. Note In nmtui : Navigate by using the cursor keys. Press a button by selecting it and hitting Enter . Select and clear checkboxes by using Space . To return to the screen, use ESC . Prerequisites Two or more physical or virtual network devices are installed on the server. To use Ethernet devices as ports of the bridge, the physical or virtual Ethernet devices must be installed on the server. Procedure If you do not know the network device names on which you want configure a network bridge, display the available devices: Start nmtui : Select Edit a connection , and press Enter . Press Add . Select Bridge from the list of network types, and press Enter . Optional: Enter a name for the NetworkManager profile to be created. On hosts with multiple profiles, a meaningful name makes it easier to identify the purpose of a profile. Enter the bridge device name to be created into the Device field. Add ports to the bridge to be created: Press Add to the Slaves list. Select the type of the interface you want to add as port to the bridge, for example, Ethernet . Optional: Enter a name for the NetworkManager profile to be created for this bridge port. Enter the port's device name into the Device field. Press OK to return to the window with the bridge settings. Figure 6.1. Adding an Ethernet device as port to a bridge Repeat these steps to add more ports to the bridge. Depending on your environment, configure the IP address settings in the IPv4 configuration and IPv6 configuration areas accordingly. For this, press the button to these areas, and select: Disabled , if the bridge does not require an IP address. Automatic , if a DHCP server or stateless address autoconfiguration (SLAAC) dynamically assigns an IP address to the bridge. Manual , if the network requires static IP address settings. In this case, you must fill further fields: Press Show to the protocol you want to configure to display additional fields. Press Add to Addresses , and enter the IP address and the subnet mask in Classless Inter-Domain Routing (CIDR) format. If you do not specify a subnet mask, NetworkManager sets a /32 subnet mask for IPv4 addresses and /64 for IPv6 addresses. Enter the address of the default gateway. Press Add to DNS servers , and enter the DNS server address. Press Add to Search domains , and enter the DNS search domain. Figure 6.2. Example of a bridge connection without IP address settings Press OK to create and automatically activate the new connection. Press Back to return to the main menu. Select Quit , and press Enter to close the nmtui application. Verification Use the ip utility to display the link status of Ethernet devices that are ports of a specific bridge: Use the bridge utility to display the status of Ethernet devices that are ports of any bridge device: To display the status for a specific Ethernet device, use the bridge link show dev <ethernet_device_name> command. 6.4. Configuring a network bridge by using nm-connection-editor If you use Red Hat Enterprise Linux with a graphical interface, you can configure network bridges using the nm-connection-editor application. Note that nm-connection-editor can add only new ports to a bridge. To use an existing connection profile as a port, create the bridge using the nmcli utility as described in Configuring a network bridge by using nmcli . Prerequisites Two or more physical or virtual network devices are installed on the server. To use Ethernet devices as ports of the bridge, the physical or virtual Ethernet devices must be installed on the server. To use team, bond, or VLAN devices as ports of the bridge, ensure that these devices are not already configured. Procedure Open a terminal, and enter nm-connection-editor : Click the + button to add a new connection. Select the Bridge connection type, and click Create . On the Bridge tab: Optional: Set the name of the bridge interface in the Interface name field. Click the Add button to create a new connection profile for a network interface and adding the profile as a port to the bridge. Select the connection type of the interface. For example, select Ethernet for a wired connection. Optional: Set a connection name for the port device. If you create a connection profile for an Ethernet device, open the Ethernet tab, and select in the Device field the network interface you want to add as a port to the bridge. If you selected a different device type, configure it accordingly. Click Save . Repeat the step for each interface you want to add to the bridge. Optional: Configure further bridge settings, such as Spanning Tree Protocol (STP) options. Configure the IP address settings on both the IPv4 Settings and IPv6 Settings tabs: If you plan to use this bridge device as a port of other devices, set the Method field to Disabled . To use DHCP, leave the Method field at its default, Automatic (DHCP) . To use static IP settings, set the Method field to Manual and fill the fields accordingly: Click Save . Close nm-connection-editor . Verification Use the ip utility to display the link status of Ethernet devices that are ports of a specific bridge. Use the bridge utility to display the status of Ethernet devices that are ports in any bridge device: To display the status for a specific Ethernet device, use the bridge link show dev ethernet_device_name command. Additional resources Configuring a network bond by using nm-connection-editor Configuring a network team by using nm-connection-editor Configuring VLAN tagging by using nm-connection-editor Configuring NetworkManager to avoid using a specific profile to provide a default gateway How to configure a bridge with VLAN information? (Red Hat Knowledgebase) 6.5. Configuring a network bridge by using nmstatectl Use the nmstatectl utility to configure a network bridge through the Nmstate API. The Nmstate API ensures that, after setting the configuration, the result matches the configuration file. If anything fails, nmstatectl automatically rolls back the changes to avoid leaving the system in an incorrect state. Depending on your environment, adjust the YAML file accordingly. For example, to use different devices than Ethernet adapters in the bridge, adapt the base-iface attribute and type attributes of the ports you use in the bridge. Prerequisites Two or more physical or virtual network devices are installed on the server. To use Ethernet devices as ports in the bridge, the physical or virtual Ethernet devices must be installed on the server. To use team, bond, or VLAN devices as ports in the bridge, set the interface name in the port list, and define the corresponding interfaces. The nmstate package is installed. Procedure Create a YAML file, for example ~/create-bridge.yml , with the following content: --- interfaces: - name: bridge0 type: linux-bridge state: up ipv4: enabled: true address: - ip: 192.0.2.1 prefix-length: 24 dhcp: false ipv6: enabled: true address: - ip: 2001:db8:1::1 prefix-length: 64 autoconf: false dhcp: false bridge: options: stp: enabled: true port: - name: enp1s0 - name: enp7s0 - name: enp1s0 type: ethernet state: up - name: enp7s0 type: ethernet state: up routes: config: - destination: 0.0.0.0/0 -hop-address: 192.0.2.254 -hop-interface: bridge0 - destination: ::/0 -hop-address: 2001:db8:1::fffe -hop-interface: bridge0 dns-resolver: config: search: - example.com server: - 192.0.2.200 - 2001:db8:1::ffbb These settings define a network bridge with the following settings: Network interfaces in the bridge: enp1s0 and enp7s0 Spanning Tree Protocol (STP): Enabled Static IPv4 address: 192.0.2.1 with the /24 subnet mask Static IPv6 address: 2001:db8:1::1 with the /64 subnet mask IPv4 default gateway: 192.0.2.254 IPv6 default gateway: 2001:db8:1::fffe IPv4 DNS server: 192.0.2.200 IPv6 DNS server: 2001:db8:1::ffbb DNS search domain: example.com Apply the settings to the system: Verification Display the status of the devices and connections: Display all settings of the connection profile: Display the connection settings in YAML format: Additional resources nmstatectl(8) man page on your system /usr/share/doc/nmstate/examples/ directory How to configure a bridge with VLAN information? (Red Hat Knowledgebase) 6.6. Configuring a network bridge by using the network RHEL system role You can connect multiple networks on layer 2 of the Open Systems Interconnection (OSI) model by creating a network bridge. To configure a bridge, create a connection profile in NetworkManager. By using Ansible and the network RHEL system role, you can automate this process and remotely configure connection profiles on the hosts defined in a playbook. You can use the network RHEL system role to configure a bridge and, if a connection profile for the bridge's parent device does not exist, the role can create it as well. Note If you want to assign IP addresses, gateways, and DNS settings to a bridge, configure them on the bridge and not on its ports. Prerequisites You have prepared the control node and the managed nodes You are logged in to the control node as a user who can run playbooks on the managed nodes. The account you use to connect to the managed nodes has sudo permissions on them. Two or more physical or virtual network devices are installed on the server. Procedure Create a playbook file, for example ~/playbook.yml , with the following content: --- - name: Configure the network hosts: managed-node-01.example.com tasks: - name: Bridge connection profile with two Ethernet ports ansible.builtin.include_role: name: rhel-system-roles.network vars: network_connections: # Bridge profile - name: bridge0 type: bridge interface_name: bridge0 ip: dhcp4: yes auto6: yes state: up # Port profile for the 1st Ethernet device - name: bridge0-port1 interface_name: enp7s0 type: ethernet controller: bridge0 port_type: bridge state: up # Port profile for the 2nd Ethernet device - name: bridge0-port2 interface_name: enp8s0 type: ethernet controller: bridge0 port_type: bridge state: up The settings specified in the example playbook include the following: type: <profile_type> Sets the type of the profile to create. The example playbook creates three connection profiles: One for the bridge and two for the Ethernet devices. dhcp4: yes Enables automatic IPv4 address assignment from DHCP, PPP, or similar services. auto6: yes Enables IPv6 auto-configuration. By default, NetworkManager uses Router Advertisements. If the router announces the managed flag, NetworkManager requests an IPv6 address and prefix from a DHCPv6 server. For details about all variables used in the playbook, see the /usr/share/ansible/roles/rhel-system-roles.network/README.md file on the control node. Validate the playbook syntax: Note that this command only validates the syntax and does not protect against a wrong but valid configuration. Run the playbook: Verification Display the link status of Ethernet devices that are ports of a specific bridge: Display the status of Ethernet devices that are ports of any bridge device: Additional resources /usr/share/ansible/roles/rhel-system-roles.network/README.md file /usr/share/doc/rhel-system-roles/network/ directory	[ "nmcli connection add type bridge con-name bridge0 ifname bridge0", "nmcli device status DEVICE TYPE STATE CONNECTION enp7s0 ethernet disconnected -- enp8s0 ethernet disconnected -- bond0 bond connected bond0 bond1 bond connected bond1", "nmcli connection add type ethernet slave-type bridge con-name bridge0-port1 ifname enp7s0 master bridge0 nmcli connection add type ethernet slave-type bridge con-name bridge0-port2 ifname enp8s0 master bridge0", "nmcli connection modify bond0 master bridge0 nmcli connection modify bond1 master bridge0", "nmcli connection up bond0 nmcli connection up bond1", "nmcli connection modify bridge0 ipv4.method disabled", "nmcli connection modify bridge0 ipv4.addresses '192.0.2.1/24' ipv4.gateway '192.0.2.254' ipv4.dns '192.0.2.253' ipv4.dns-search 'example.com' ipv4.method manual", "nmcli connection modify bridge0 ipv6.method disabled", "nmcli connection modify bridge0 ipv6.addresses '2001:db8:1::1/64' ipv6.gateway '2001:db8:1::fffe' ipv6.dns '2001:db8:1::fffd' ipv6.dns-search 'example.com' ipv6.method manual", "nmcli connection modify bridge0 bridge.priority '16384'", "nmcli connection up bridge0", "nmcli device DEVICE TYPE STATE CONNECTION enp7s0 ethernet connected bridge0-port1 enp8s0 ethernet connected bridge0-port2", "nmcli connection modify bridge0 connection.autoconnect-slaves 1", "nmcli connection up bridge0", "ip link show master bridge0 3: enp7s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel master bridge0 state UP mode DEFAULT group default qlen 1000 link/ether 52:54:00:62:61:0e brd ff:ff:ff:ff:ff:ff 4: enp8s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel master bridge0 state UP mode DEFAULT group default qlen 1000 link/ether 52:54:00:9e:f1:ce brd ff:ff:ff:ff:ff:ff", "bridge link show 3: enp7s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 master bridge0 state forwarding priority 32 cost 100 4: enp8s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 master bridge0 state listening priority 32 cost 100 5: enp9s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 master bridge1 state forwarding priority 32 cost 100 6: enp11s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 master bridge1 state blocking priority 32 cost 100", "nmcli device status DEVICE TYPE STATE CONNECTION enp7s0 ethernet unavailable -- enp8s0 ethernet unavailable --", "nmtui", "ip link show master bridge0 3: enp7s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel master bridge0 state UP mode DEFAULT group default qlen 1000 link/ether 52:54:00:62:61:0e brd ff:ff:ff:ff:ff:ff 4: enp8s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel master bridge0 state UP mode DEFAULT group default qlen 1000 link/ether 52:54:00:9e:f1:ce brd ff:ff:ff:ff:ff:ff", "bridge link show 3: enp7s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 master bridge0 state forwarding priority 32 cost 100 4: enp8s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 master bridge0 state listening priority 32 cost 100", "nm-connection-editor", "ip link show master bridge0 3: enp7s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel master bridge0 state UP mode DEFAULT group default qlen 1000 link/ether 52:54:00:62:61:0e brd ff:ff:ff:ff:ff:ff 4: enp8s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel master bridge0 state UP mode DEFAULT group default qlen 1000 link/ether 52:54:00:9e:f1:ce brd ff:ff:ff:ff:ff:ff", "bridge link show 3: enp7s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 master bridge0 state forwarding priority 32 cost 100 4: enp8s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 master bridge0 state listening priority 32 cost 100 5: enp9s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 master bridge1 state forwarding priority 32 cost 100 6: enp11s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 master bridge1 state blocking priority 32 cost 100", "--- interfaces: - name: bridge0 type: linux-bridge state: up ipv4: enabled: true address: - ip: 192.0.2.1 prefix-length: 24 dhcp: false ipv6: enabled: true address: - ip: 2001:db8:1::1 prefix-length: 64 autoconf: false dhcp: false bridge: options: stp: enabled: true port: - name: enp1s0 - name: enp7s0 - name: enp1s0 type: ethernet state: up - name: enp7s0 type: ethernet state: up routes: config: - destination: 0.0.0.0/0 next-hop-address: 192.0.2.254 next-hop-interface: bridge0 - destination: ::/0 next-hop-address: 2001:db8:1::fffe next-hop-interface: bridge0 dns-resolver: config: search: - example.com server: - 192.0.2.200 - 2001:db8:1::ffbb", "nmstatectl apply ~/create-bridge.yml", "nmcli device status DEVICE TYPE STATE CONNECTION bridge0 bridge connected bridge0", "nmcli connection show bridge0 connection.id: bridge0_ connection.uuid: e2cc9206-75a2-4622-89cf-1252926060a9 connection.stable-id: -- connection.type: bridge connection.interface-name: bridge0", "nmstatectl show bridge0", "--- - name: Configure the network hosts: managed-node-01.example.com tasks: - name: Bridge connection profile with two Ethernet ports ansible.builtin.include_role: name: rhel-system-roles.network vars: network_connections: # Bridge profile - name: bridge0 type: bridge interface_name: bridge0 ip: dhcp4: yes auto6: yes state: up # Port profile for the 1st Ethernet device - name: bridge0-port1 interface_name: enp7s0 type: ethernet controller: bridge0 port_type: bridge state: up # Port profile for the 2nd Ethernet device - name: bridge0-port2 interface_name: enp8s0 type: ethernet controller: bridge0 port_type: bridge state: up", "ansible-playbook --syntax-check ~/playbook.yml", "ansible-playbook ~/playbook.yml", "ansible managed-node-01.example.com -m command -a 'ip link show master bridge0' managed-node-01.example.com \| CHANGED \| rc=0 >> 3: enp7s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel master bridge0 state UP mode DEFAULT group default qlen 1000 link/ether 52:54:00:62:61:0e brd ff:ff:ff:ff:ff:ff 4: enp8s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel master bridge0 state UP mode DEFAULT group default qlen 1000 link/ether 52:54:00:9e:f1:ce brd ff:ff:ff:ff:ff:ff", "ansible managed-node-01.example.com -m command -a 'bridge link show' managed-node-01.example.com \| CHANGED \| rc=0 >> 3: enp7s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 master bridge0 state forwarding priority 32 cost 100 4: enp8s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 master bridge0 state listening priority 32 cost 100" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/8/html/configuring_and_managing_networking/configuring-a-network-bridge_configuring-and-managing-networking
3.4. Adding a Custom Boot Message	3.4. Adding a Custom Boot Message Optionally, modify /tftpboot/linux-install/msgs/boot.msg to use a custom boot message.	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/4/html/system_administration_guide/pxe_network_installations-adding_a_custom_boot_message
Chapter 1. Preparing to install on a single node	Chapter 1. Preparing to install on a single node 1.1. Prerequisites You reviewed details about the OpenShift Container Platform installation and update processes. You have read the documentation on selecting a cluster installation method and preparing it for users . 1.2. About OpenShift on a single node You can create a single-node cluster with standard installation methods. OpenShift Container Platform on a single node is a specialized installation that requires the creation of a special Ignition configuration file. The primary use case is for edge computing workloads, including intermittent connectivity, portable clouds, and 5G radio access networks (RAN) close to a base station. The major tradeoff with an installation on a single node is the lack of high availability. Important The use of OpenShiftSDN with single-node OpenShift is not supported. OVN-Kubernetes is the default network plugin for single-node OpenShift deployments. 1.3. Requirements for installing OpenShift on a single node Installing OpenShift Container Platform on a single node alleviates some of the requirements for high availability and large scale clusters. However, you must address the following requirements: Administration host: You must have a computer to prepare the ISO, to create the USB boot drive, and to monitor the installation. Note For the ppc64le platform, the host should prepare the ISO, but does not need to create the USB boot drive. The ISO can be mounted to PowerVM directly. Note ISO is not required for IBM Z(R) installations. CPU Architecture: Installing OpenShift Container Platform on a single node supports x86_64 , arm64 , ppc64le , and s390x CPU architectures. Supported platforms: Installing OpenShift Container Platform on a single node is supported on bare metal and Certified third-party hypervisors . In most cases, you must specify the platform.none: {} parameter in the install-config.yaml configuration file. The following list shows the only exceptions and the corresponding parameter to specify in the install-config.yaml configuration file: Amazon Web Services (AWS), where you use platform=aws Google Cloud Platform (GCP), where you use platform=gcp Microsoft Azure, where you use platform=azure Production-grade server: Installing OpenShift Container Platform on a single node requires a server with sufficient resources to run OpenShift Container Platform services and a production workload. Table 1.1. Minimum resource requirements Profile vCPU Memory Storage Minimum 8 vCPUs 16 GB of RAM 120 GB Note One vCPU equals one physical core. However, if you enable simultaneous multithreading (SMT), or Hyper-Threading, use the following formula to calculate the number of vCPUs that represent one physical core: (threads per core x cores) x sockets = vCPUs Adding Operators during the installation process might increase the minimum resource requirements. The server must have a Baseboard Management Controller (BMC) when booting with virtual media. Note BMC is not supported on IBM Z(R) and IBM Power(R). Networking: The server must have access to the internet or access to a local registry if it is not connected to a routable network. The server must have a DHCP reservation or a static IP address for the Kubernetes API, ingress route, and cluster node domain names. You must configure the DNS to resolve the IP address to each of the following fully qualified domain names (FQDN): Table 1.2. Required DNS records Usage FQDN Description Kubernetes API api.<cluster_name>.<base_domain> Add a DNS A/AAAA or CNAME record. This record must be resolvable by both clients external to the cluster and within the cluster. Internal API api-int.<cluster_name>.<base_domain> Add a DNS A/AAAA or CNAME record when creating the ISO manually. This record must be resolvable by nodes within the cluster. Ingress route *.apps.<cluster_name>.<base_domain> Add a wildcard DNS A/AAAA or CNAME record that targets the node. This record must be resolvable by both clients external to the cluster and within the cluster. Important Without persistent IP addresses, communications between the apiserver and etcd might fail.	null	https://docs.redhat.com/en/documentation/openshift_container_platform_installation/4.16/html/installing_on_a_single_node/preparing-to-install-sno
Preface	Preface Making open source more inclusive Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright's message .	null	https://docs.redhat.com/en/documentation/red_hat_build_of_apache_camel/4.0/html/getting_started_with_red_hat_build_of_apache_camel_for_spring_boot/pr01
Chapter 8. Windows node upgrades	Chapter 8. Windows node upgrades You can ensure your Windows nodes have the latest updates by upgrading the Windows Machine Config Operator (WMCO). 8.1. Windows Machine Config Operator upgrades When a new version of the Windows Machine Config Operator (WMCO) is released that is compatible with the current cluster version, the Operator is upgraded based on the upgrade channel and subscription approval strategy it was installed with when using the Operator Lifecycle Manager (OLM). The WMCO upgrade results in the Kubernetes components in the Windows machine being upgraded. Note If you are upgrading to a new version of the WMCO and want to use cluster monitoring, you must have the openshift.io/cluster-monitoring=true label present in the WMCO namespace. If you add the label to a pre-existing WMCO namespace, and there are already Windows nodes configured, restart the WMCO pod to allow monitoring graphs to display. For a non-disruptive upgrade, the WMCO terminates the Windows machines configured by the version of the WMCO and recreates them using the current version. This is done by deleting the Machine object, which results in the drain and deletion of the Windows node. To facilitate an upgrade, the WMCO adds a version annotation to all the configured nodes. During an upgrade, a mismatch in version annotation results in the deletion and recreation of a Windows machine. To have minimal service disruptions during an upgrade, the WMCO only updates one Windows machine at a time. After the update, it is recommended that you set the spec.os.name.windows parameter in your workload pods. The WMCO uses this field to authoritatively identify the pod operating system for validation and is used to enforce Windows-specific pod security context constraints (SCCs). Important The WMCO is only responsible for updating Kubernetes components, not for Windows operating system updates. You provide the Windows image when creating the VMs; therefore, you are responsible for providing an updated image. You can provide an updated Windows image by changing the image configuration in the MachineSet spec. For more information on Operator upgrades using the Operator Lifecycle Manager (OLM), see Updating installed Operators .	null	https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/windows_container_support_for_openshift/windows-node-upgrades
Appendix B. Event Codes	Appendix B. Event Codes This table lists all event codes. Table B.1. Event codes Code Name Severity Message 0 UNASSIGNED Info 1 VDC_START Info Starting oVirt Engine. 2 VDC_STOP Info Stopping oVirt Engine. 12 VDS_FAILURE Error Host USD{VdsName} is non responsive. 13 VDS_DETECTED Info Status of host USD{VdsName} was set to USD{HostStatus}. 14 VDS_RECOVER Info Host USD{VdsName} is rebooting. 15 VDS_MAINTENANCE Normal Host USD{VdsName} was switched to Maintenance Mode. 16 VDS_ACTIVATE Info Activation of host USD{VdsName} initiated by USD{UserName}. 17 VDS_MAINTENANCE_FAILED Error Failed to switch Host USD{VdsName} to Maintenance mode. 18 VDS_ACTIVATE_FAILED Error Failed to activate Host USD{VdsName}.(User: USD{UserName}). 19 VDS_RECOVER_FAILED Error Host USD{VdsName} failed to recover. 20 USER_VDS_START Info Host USD{VdsName} was started by USD{UserName}. 21 USER_VDS_STOP Info Host USD{VdsName} was stopped by USD{UserName}. 22 IRS_FAILURE Error Failed to access Storage on Host USD{VdsName}. 23 VDS_LOW_DISK_SPACE Warning Warning, Low disk space. Host USD{VdsName} has less than USD{DiskSpace} MB of free space left on: USD{Disks}. 24 VDS_LOW_DISK_SPACE_ERROR Error Critical, Low disk space. Host USD{VdsName} has less than USD{DiskSpace} MB of free space left on: USD{Disks}. Low disk space might cause an issue upgrading this host. 25 VDS_NO_SELINUX_ENFORCEMENT Warning Host USD{VdsName} does not enforce SELinux. Current status: USD{Mode} 26 IRS_DISK_SPACE_LOW Warning Warning, Low disk space. USD{StorageDomainName} domain has USD{DiskSpace} GB of free space. 27 VDS_STATUS_CHANGE_FAILED_DUE_TO_STOP_SPM_FAILURE Warning Failed to change status of host USD{VdsName} due to a failure to stop the spm. 28 VDS_PROVISION Warning Installing OS on Host USD{VdsName} using Hostgroup USD{HostGroupName}. 29 USER_ADD_VM_TEMPLATE_SUCCESS Info Template USD{VmTemplateName} was created successfully. 31 USER_VDC_LOGOUT Info User USD{UserName} connected from 'USD{SourceIP}' using session 'USD{SessionID}' logged out. 32 USER_RUN_VM Info VM USD{VmName} started on Host USD{VdsName} 33 USER_STOP_VM Info VM USD{VmName} powered off by USD{UserName} (Host: USD{VdsName})USD{OptionalReason}. 34 USER_ADD_VM Info VM USD{VmName} was created by USD{UserName}. 35 USER_UPDATE_VM Info VM USD{VmName} configuration was updated by USD{UserName}. 36 USER_ADD_VM_TEMPLATE_FAILURE Error Failed creating Template USD{VmTemplateName}. 37 USER_ADD_VM_STARTED Info VM USD{VmName} creation was initiated by USD{UserName}. 38 USER_CHANGE_DISK_VM Info CD USD{DiskName} was inserted to VM USD{VmName} by USD{UserName}. 39 USER_PAUSE_VM Info VM USD{VmName} was suspended by USD{UserName} (Host: USD{VdsName}). 40 USER_RESUME_VM Info VM USD{VmName} was resumed by USD{UserName} (Host: USD{VdsName}). 41 USER_VDS_RESTART Info Host USD{VdsName} was restarted by USD{UserName}. 42 USER_ADD_VDS Info Host USD{VdsName} was added by USD{UserName}. 43 USER_UPDATE_VDS Info Host USD{VdsName} configuration was updated by USD{UserName}. 44 USER_REMOVE_VDS Info Host USD{VdsName} was removed by USD{UserName}. 45 USER_CREATE_SNAPSHOT Info Snapshot 'USD{SnapshotName}' creation for VM 'USD{VmName}' was initiated by USD{UserName}. 46 USER_TRY_BACK_TO_SNAPSHOT Info Snapshot-Preview USD{SnapshotName} for VM USD{VmName} was initiated by USD{UserName}. 47 USER_RESTORE_FROM_SNAPSHOT Info VM USD{VmName} restored from Snapshot by USD{UserName}. 48 USER_ADD_VM_TEMPLATE Info Creation of Template USD{VmTemplateName} from VM USD{VmName} was initiated by USD{UserName}. 49 USER_UPDATE_VM_TEMPLATE Info Template USD{VmTemplateName} configuration was updated by USD{UserName}. 50 USER_REMOVE_VM_TEMPLATE Info Removal of Template USD{VmTemplateName} was initiated by USD{UserName}. 51 USER_ADD_VM_TEMPLATE_FINISHED_SUCCESS Info Creation of Template USD{VmTemplateName} from VM USD{VmName} has been completed. 52 USER_ADD_VM_TEMPLATE_FINISHED_FAILURE Error Failed to complete creation of Template USD{VmTemplateName} from VM USD{VmName}. 53 USER_ADD_VM_FINISHED_SUCCESS Info VM USD{VmName} creation has been completed. 54 USER_FAILED_RUN_VM Error Failed to run VM USD{VmName}USD{DueToError} (User: USD{UserName}). 55 USER_FAILED_PAUSE_VM Error Failed to suspend VM USD{VmName} (Host: USD{VdsName}, User: USD{UserName}). 56 USER_FAILED_STOP_VM Error Failed to power off VM USD{VmName} (Host: USD{VdsName}, User: USD{UserName}). 57 USER_FAILED_ADD_VM Error Failed to create VM USD{VmName} (User: USD{UserName}). 58 USER_FAILED_UPDATE_VM Error Failed to update VM USD{VmName} (User: USD{UserName}). 59 USER_FAILED_REMOVE_VM Error 60 USER_ADD_VM_FINISHED_FAILURE Error Failed to complete VM USD{VmName} creation. 61 VM_DOWN Info VM USD{VmName} is down. USD{ExitMessage} 62 VM_MIGRATION_START Info Migration started (VM: USD{VmName}, Source: USD{VdsName}, Destination: USD{DestinationVdsName}, User: USD{UserName}). USD{OptionalReason} 63 VM_MIGRATION_DONE Info Migration completed (VM: USD{VmName}, Source: USD{VdsName}, Destination: USD{DestinationVdsName}, Duration: USD{Duration}, Total: USD{TotalDuration}, Actual downtime: USD{ActualDowntime}) 64 VM_MIGRATION_ABORT Error Migration failed: USD{MigrationError} (VM: USD{VmName}, Source: USD{VdsName}). 65 VM_MIGRATION_FAILED Error Migration failedUSD{DueToMigrationError} (VM: USD{VmName}, Source: USD{VdsName}). 66 VM_FAILURE Error VM USD{VmName} cannot be found on Host USD{VdsName}. 67 VM_MIGRATION_START_SYSTEM_INITIATED Info Migration initiated by system (VM: USD{VmName}, Source: USD{VdsName}, Destination: USD{DestinationVdsName}, Reason: USD{OptionalReason}). 68 USER_CREATE_SNAPSHOT_FINISHED_SUCCESS Info Snapshot 'USD{SnapshotName}' creation for VM 'USD{VmName}' has been completed. 69 USER_CREATE_SNAPSHOT_FINISHED_FAILURE Error Failed to complete snapshot 'USD{SnapshotName}' creation for VM 'USD{VmName}'. 70 USER_RUN_VM_AS_STATELESS_FINISHED_FAILURE Error Failed to complete starting of VM USD{VmName}. 71 USER_TRY_BACK_TO_SNAPSHOT_FINISH_SUCCESS Info Snapshot-Preview USD{SnapshotName} for VM USD{VmName} has been completed. 72 MERGE_SNAPSHOTS_ON_HOST Info Merging snapshots (USD{SourceSnapshot} into USD{DestinationSnapshot}) of disk USD{Disk} on host USD{VDS} 73 USER_INITIATED_SHUTDOWN_VM Info VM shutdown initiated by USD{UserName} on VM USD{VmName} (Host: USD{VdsName})USD{OptionalReason}. 74 USER_FAILED_SHUTDOWN_VM Error Failed to initiate shutdown on VM USD{VmName} (Host: USD{VdsName}, User: USD{UserName}). 75 VDS_SOFT_RECOVER Info Soft fencing on host USD{VdsName} was successful. 76 USER_STOPPED_VM_INSTEAD_OF_SHUTDOWN Info VM USD{VmName} was powered off ungracefully by USD{UserName} (Host: USD{VdsName})USD{OptionalReason}. 77 USER_FAILED_STOPPING_VM_INSTEAD_OF_SHUTDOWN Error Failed to power off VM USD{VmName} (Host: USD{VdsName}, User: USD{UserName}). 78 USER_ADD_DISK_TO_VM Info Add-Disk operation of USD{DiskAlias} was initiated on VM USD{VmName} by USD{UserName}. 79 USER_FAILED_ADD_DISK_TO_VM Error Add-Disk operation failed on VM USD{VmName} (User: USD{UserName}). 80 USER_REMOVE_DISK_FROM_VM Info Disk was removed from VM USD{VmName} by USD{UserName}. 81 USER_FAILED_REMOVE_DISK_FROM_VM Error Failed to remove Disk from VM USD{VmName} (User: USD{UserName}). 88 USER_UPDATE_VM_DISK Info VM USD{VmName} USD{DiskAlias} disk was updated by USD{UserName}. 89 USER_FAILED_UPDATE_VM_DISK Error Failed to update VM USD{VmName} disk USD{DiskAlias} (User: USD{UserName}). 90 VDS_FAILED_TO_GET_HOST_HARDWARE_INFO Warning Could not get hardware information for host USD{VdsName} 94 USER_COMMIT_RESTORE_FROM_SNAPSHOT_START Info Committing a Snapshot-Preview for VM USD{VmName} was initialized by USD{UserName}. 95 USER_COMMIT_RESTORE_FROM_SNAPSHOT_FINISH_SUCCESS Info Committing a Snapshot-Preview for VM USD{VmName} has been completed. 96 USER_COMMIT_RESTORE_FROM_SNAPSHOT_FINISH_FAILURE Error Failed to commit Snapshot-Preview for VM USD{VmName}. 97 USER_ADD_DISK_TO_VM_FINISHED_SUCCESS Info The disk USD{DiskAlias} was successfully added to VM USD{VmName}. 98 USER_ADD_DISK_TO_VM_FINISHED_FAILURE Error Add-Disk operation failed to complete on VM USD{VmName}. 99 USER_TRY_BACK_TO_SNAPSHOT_FINISH_FAILURE Error Failed to complete Snapshot-Preview USD{SnapshotName} for VM USD{VmName}. 100 USER_RESTORE_FROM_SNAPSHOT_FINISH_SUCCESS Info VM USD{VmName} restoring from Snapshot has been completed. 101 USER_RESTORE_FROM_SNAPSHOT_FINISH_FAILURE Error Failed to complete restoring from Snapshot of VM USD{VmName}. 102 USER_FAILED_CHANGE_DISK_VM Error Failed to change disk in VM USD{VmName} (Host: USD{VdsName}, User: USD{UserName}). 103 USER_FAILED_RESUME_VM Error Failed to resume VM USD{VmName} (Host: USD{VdsName}, User: USD{UserName}). 104 USER_FAILED_ADD_VDS Error Failed to add Host USD{VdsName} (User: USD{UserName}). 105 USER_FAILED_UPDATE_VDS Error Failed to update Host USD{VdsName} (User: USD{UserName}). 106 USER_FAILED_REMOVE_VDS Error Failed to remove Host USD{VdsName} (User: USD{UserName}). 107 USER_FAILED_VDS_RESTART Error Failed to restart Host USD{VdsName}, (User: USD{UserName}). 108 USER_FAILED_ADD_VM_TEMPLATE Error Failed to initiate creation of Template USD{VmTemplateName} from VM USD{VmName} (User: USD{UserName}). 109 USER_FAILED_UPDATE_VM_TEMPLATE Error Failed to update Template USD{VmTemplateName} (User: USD{UserName}). 110 USER_FAILED_REMOVE_VM_TEMPLATE Error Failed to initiate removal of Template USD{VmTemplateName} (User: USD{UserName}). 111 USER_STOP_SUSPENDED_VM Info Suspended VM USD{VmName} has had its save state cleared by USD{UserName}USD{OptionalReason}. 112 USER_STOP_SUSPENDED_VM_FAILED Error Failed to power off suspended VM USD{VmName} (User: USD{UserName}). 113 USER_REMOVE_VM_FINISHED Info VM USD{VmName} was successfully removed. 115 USER_FAILED_TRY_BACK_TO_SNAPSHOT Error Failed to preview Snapshot USD{SnapshotName} for VM USD{VmName} (User: USD{UserName}). 116 USER_FAILED_RESTORE_FROM_SNAPSHOT Error Failed to restore VM USD{VmName} from Snapshot (User: USD{UserName}). 117 USER_FAILED_CREATE_SNAPSHOT Error Failed to create Snapshot USD{SnapshotName} for VM USD{VmName} (User: USD{UserName}). 118 USER_FAILED_VDS_START Error Failed to start Host USD{VdsName}, (User: USD{UserName}). 119 VM_DOWN_ERROR Error VM USD{VmName} is down with error. USD{ExitMessage}. 120 VM_MIGRATION_TO_SERVER_FAILED Error Migration failedUSD{DueToMigrationError} (VM: USD{VmName}, Source: USD{VdsName}, Destination: USD{DestinationVdsName}). 121 SYSTEM_VDS_RESTART Info Host USD{VdsName} was restarted by the engine. 122 SYSTEM_FAILED_VDS_RESTART Error A restart initiated by the engine to Host USD{VdsName} has failed. 123 VDS_SLOW_STORAGE_RESPONSE_TIME Warning Slow storage response time on Host USD{VdsName}. 124 VM_IMPORT Info Started VM import of USD{ImportedVmName} (User: USD{UserName}) 125 VM_IMPORT_FAILED Error Failed to import VM USD{ImportedVmName} (User: USD{UserName}) 126 VM_NOT_RESPONDING Warning VM USD{VmName} is not responding. 127 VDS_RUN_IN_NO_KVM_MODE Error Host USD{VdsName} running without virtualization hardware acceleration 128 VM_MIGRATION_TRYING_RERUN Warning Failed to migrate VM USD{VmName} to Host USD{DestinationVdsName}USD{DueToMigrationError}. Trying to migrate to another Host. 129 VM_CLEARED Info Unused 130 USER_SUSPEND_VM_FINISH_FAILURE_WILL_TRY_AGAIN Error Failed to complete suspending of VM USD{VmName}, will try again. 131 USER_EXPORT_VM Info VM USD{VmName} exported to USD{ExportPath} by USD{UserName} 132 USER_EXPORT_VM_FAILED Error Failed to export VM USD{VmName} to USD{ExportPath} (User: USD{UserName}) 133 USER_EXPORT_TEMPLATE Info Template USD{VmTemplateName} exported to USD{ExportPath} by USD{UserName} 134 USER_EXPORT_TEMPLATE_FAILED Error Failed to export Template USD{VmTemplateName} to USD{ExportPath} (User: USD{UserName}) 135 TEMPLATE_IMPORT Info Started Template import of USD{ImportedVmTemplateName} (User: USD{UserName}) 136 TEMPLATE_IMPORT_FAILED Error Failed to import Template USD{ImportedVmTemplateName} (User: USD{UserName}) 137 USER_FAILED_VDS_STOP Error Failed to stop Host USD{VdsName}, (User: USD{UserName}). 138 VM_PAUSED_ENOSPC Error VM USD{VmName} has been paused due to no Storage space error. 139 VM_PAUSED_ERROR Error VM USD{VmName} has been paused due to unknown storage error. 140 VM_MIGRATION_FAILED_DURING_MOVE_TO_MAINTENANCE Error Migration failedUSD{DueToMigrationError} while Host is in 'preparing for maintenance' state.\n Consider manual intervention\: stopping/migrating Vms as Host's state will not\n turn to maintenance while VMs are still running on it.(VM: USD{VmName}, Source: USD{VdsName}, Destination: USD{DestinationVdsName}). 141 VDS_VERSION_NOT_SUPPORTED_FOR_CLUSTER Error Host USD{VdsName} is installed with VDSM version (USD{VdsSupportedVersions}) and cannot join cluster USD{ClusterName} which is compatible with VDSM versions USD{CompatibilityVersion}. 142 VM_SET_TO_UNKNOWN_STATUS Warning VM USD{VmName} was set to the Unknown status. 143 VM_WAS_SET_DOWN_DUE_TO_HOST_REBOOT_OR_MANUAL_FENCE Info Vm USD{VmName} was shut down due to USD{VdsName} host reboot or manual fence 144 VM_IMPORT_INFO Info Value of field USD{FieldName} of imported VM USD{VmName} is USD{FieldValue}. The field is reset to the default value 145 VM_PAUSED_EIO Error VM USD{VmName} has been paused due to storage I/O problem. 146 VM_PAUSED_EPERM Error VM USD{VmName} has been paused due to storage permissions problem. 147 VM_POWER_DOWN_FAILED Warning Shutdown of VM USD{VmName} failed. 148 VM_MEMORY_UNDER_GUARANTEED_VALUE Error VM USD{VmName} on host USD{VdsName} was guaranteed USD{MemGuaranteed} MB but currently has USD{MemActual} MB 149 USER_ADD Info User 'USD{NewUserName}' was added successfully to the system. 150 USER_INITIATED_RUN_VM Info Starting VM USD{VmName} was initiated by USD{UserName}. 151 USER_INITIATED_RUN_VM_FAILED Warning Failed to run VM USD{VmName} on Host USD{VdsName}. 152 USER_RUN_VM_ON_NON_DEFAULT_VDS Warning Guest USD{VmName} started on Host USD{VdsName}. (Default Host parameter was ignored - assigned Host was not available). 153 USER_STARTED_VM Info VM USD{VmName} was started by USD{UserName} (Host: USD{VdsName}). 154 VDS_CLUSTER_VERSION_NOT_SUPPORTED Error Host USD{VdsName} is compatible with versions (USD{VdsSupportedVersions}) and cannot join Cluster USD{ClusterName} which is set to version USD{CompatibilityVersion}. 155 VDS_ARCHITECTURE_NOT_SUPPORTED_FOR_CLUSTER Error Host USD{VdsName} has architecture USD{VdsArchitecture} and cannot join Cluster USD{ClusterName} which has architecture USD{ClusterArchitecture}. 156 CPU_TYPE_UNSUPPORTED_IN_THIS_CLUSTER_VERSION Error Host USD{VdsName} moved to Non-Operational state as host CPU type is not supported in this cluster compatibility version or is not supported at all 157 USER_REBOOT_VM Info User USD{UserName} initiated reboot of VM USD{VmName}. 158 USER_FAILED_REBOOT_VM Error Failed to reboot VM USD{VmName} (User: USD{UserName}). 159 USER_FORCE_SELECTED_SPM Info Host USD{VdsName} was force selected by USD{UserName} 160 USER_ACCOUNT_DISABLED_OR_LOCKED Error User USD{UserName} cannot login, as it got disabled or locked. Please contact the system administrator. 161 VM_CANCEL_MIGRATION Info Migration cancelled (VM: USD{VmName}, Source: USD{VdsName}, User: USD{UserName}). 162 VM_CANCEL_MIGRATION_FAILED Error Failed to cancel migration for VM: USD{VmName} 163 VM_STATUS_RESTORED Info VM USD{VmName} status was restored to USD{VmStatus}. 164 VM_SET_TICKET Info User USD{UserName} initiated console session for VM USD{VmName} 165 VM_SET_TICKET_FAILED Error User USD{UserName} failed to initiate a console session for VM USD{VmName} 166 VM_MIGRATION_NO_VDS_TO_MIGRATE_TO Warning No available host was found to migrate VM USD{VmName} to. 167 VM_CONSOLE_CONNECTED Info User USD{UserName} is connected to VM USD{VmName}. 168 VM_CONSOLE_DISCONNECTED Info User USD{UserName} got disconnected from VM USD{VmName}. 169 VM_FAILED_TO_PRESTART_IN_POOL Warning Cannot pre-start VM in pool 'USD{VmPoolName}'. The system will continue trying. 170 USER_CREATE_LIVE_SNAPSHOT_FINISHED_FAILURE Warning Failed to create live snapshot 'USD{SnapshotName}' for VM 'USD{VmName}'. VM restart is recommended. Note that using the created snapshot might cause data inconsistency. 171 USER_RUN_VM_AS_STATELESS_WITH_DISKS_NOT_ALLOWING_SNAPSHOT Warning VM USD{VmName} was run as stateless with one or more of disks that do not allow snapshots (User:USD{UserName}). 172 USER_REMOVE_VM_FINISHED_WITH_ILLEGAL_DISKS Warning VM USD{VmName} has been removed, but the following disks could not be removed: USD{DisksNames}. These disks will appear in the main disks tab in illegal state, please remove manually when possible. 173 USER_CREATE_LIVE_SNAPSHOT_NO_MEMORY_FAILURE Error Failed to save memory as part of Snapshot USD{SnapshotName} for VM USD{VmName} (User: USD{UserName}). 174 VM_IMPORT_FROM_CONFIGURATION_EXECUTED_SUCCESSFULLY Info VM USD{VmName} has been successfully imported from the given configuration. 175 VM_IMPORT_FROM_CONFIGURATION_ATTACH_DISKS_FAILED Warning VM USD{VmName} has been imported from the given configuration but the following disk(s) failed to attach: USD{DiskAliases}. 176 VM_BALLOON_DRIVER_ERROR Error The Balloon driver on VM USD{VmName} on host USD{VdsName} is requested but unavailable. 177 VM_BALLOON_DRIVER_UNCONTROLLED Error The Balloon device on VM USD{VmName} on host USD{VdsName} is inflated but the device cannot be controlled (guest agent is down). 178 VM_MEMORY_NOT_IN_RECOMMENDED_RANGE Warning VM USD{VmName} was configured with USD{VmMemInMb}MiB of memory while the recommended value range is USD{VmMinMemInMb}MiB - USD{VmMaxMemInMb}MiB 179 USER_INITIATED_RUN_VM_AND_PAUSE Info Starting in paused mode VM USD{VmName} was initiated by USD{UserName}. 180 TEMPLATE_IMPORT_FROM_CONFIGURATION_SUCCESS Info Template USD{VmTemplateName} has been successfully imported from the given configuration. 181 TEMPLATE_IMPORT_FROM_CONFIGURATION_FAILED Error Failed to import Template USD{VmTemplateName} from the given configuration. 182 USER_FAILED_ATTACH_USER_TO_VM Error Failed to attach User USD{AdUserName} to VM USD{VmName} (User: USD{UserName}). 183 USER_ATTACH_TAG_TO_TEMPLATE Info Tag USD{TagName} was attached to Templates(s) USD{TemplatesNames} by USD{UserName}. 184 USER_ATTACH_TAG_TO_TEMPLATE_FAILED Error Failed to attach Tag USD{TagName} to Templates(s) USD{TemplatesNames} (User: USD{UserName}). 185 USER_DETACH_TEMPLATE_FROM_TAG Info Tag USD{TagName} was detached from Template(s) USD{TemplatesNames} by USD{UserName}. 186 USER_DETACH_TEMPLATE_FROM_TAG_FAILED Error Failed to detach Tag USD{TagName} from TEMPLATE(s) USD{TemplatesNames} (User: USD{UserName}). 187 VDS_STORAGE_CONNECTION_FAILED_BUT_LAST_VDS Error Failed to connect Host USD{VdsName} to Data Center, due to connectivity errors with the Storage. Host USD{VdsName} will remain in Up state (but inactive), as it is the last Host in the Data Center, to enable manual intervention by the Administrator. 188 VDS_STORAGES_CONNECTION_FAILED Error Failed to connect Host USD{VdsName} to the Storage Domains USD{failedStorageDomains}. 189 VDS_STORAGE_VDS_STATS_FAILED Error Host USD{VdsName} reports about one of the Active Storage Domains as Problematic. 190 UPDATE_OVF_FOR_STORAGE_DOMAIN_FAILED Warning Failed to update VMs/Templates OVF data for Storage Domain USD{StorageDomainName} in Data Center USD{StoragePoolName}. 191 CREATE_OVF_STORE_FOR_STORAGE_DOMAIN_FAILED Warning Failed to create OVF store disk for Storage Domain USD{StorageDomainName}.\n The Disk with the id USD{DiskId} might be removed manually for automatic attempt to create new one. \n OVF updates won't be attempted on the created disk. 192 CREATE_OVF_STORE_FOR_STORAGE_DOMAIN_INITIATE_FAILED Warning Failed to create OVF store disk for Storage Domain USD{StorageDomainName}. \n OVF data won't be updated meanwhile for that domain. 193 DELETE_OVF_STORE_FOR_STORAGE_DOMAIN_FAILED Warning Failed to delete the OVF store disk for Storage Domain USD{StorageDomainName}.\n In order to detach the domain please remove it manually or try to detach the domain again for another attempt. 194 VM_CANCEL_CONVERSION Info Conversion cancelled (VM: USD{VmName}, Source: USD{VdsName}, User: USD{UserName}). 195 VM_CANCEL_CONVERSION_FAILED Error Failed to cancel conversion for VM: USD{VmName} 196 VM_RECOVERED_FROM_PAUSE_ERROR Normal VM USD{VmName} has recovered from paused back to up. 197 SYSTEM_SSH_HOST_RESTART Info Host USD{VdsName} was restarted using SSH by the engine. 198 SYSTEM_FAILED_SSH_HOST_RESTART Error A restart using SSH initiated by the engine to Host USD{VdsName} has failed. 199 USER_UPDATE_OVF_STORE Info OVF_STORE for domain USD{StorageDomainName} was updated by USD{UserName}. 200 IMPORTEXPORT_GET_VMS_INFO_FAILED Error Failed to retrieve VM/Templates information from export domain USD{StorageDomainName} 201 IRS_DISK_SPACE_LOW_ERROR Error Critical, Low disk space. USD{StorageDomainName} domain has USD{DiskSpace} GB of free space. 202 IMPORTEXPORT_GET_EXTERNAL_VMS_INFO_FAILED Error Failed to retrieve VMs information from external server USD{URL} 204 IRS_HOSTED_ON_VDS Info Storage Pool Manager runs on Host USD{VdsName} (Address: USD{ServerIp}), Data Center USD{StoragePoolName}. 205 PROVIDER_ADDED Info Provider USD{ProviderName} was added. (User: USD{UserName}) 206 PROVIDER_ADDITION_FAILED Error Failed to add provider USD{ProviderName}. (User: USD{UserName}) 207 PROVIDER_UPDATED Info Provider USD{ProviderName} was updated. (User: USD{UserName}) 208 PROVIDER_UPDATE_FAILED Error Failed to update provider USD{ProviderName}. (User: USD{UserName}) 209 PROVIDER_REMOVED Info Provider USD{ProviderName} was removed. (User: USD{UserName}) 210 PROVIDER_REMOVAL_FAILED Error Failed to remove provider USD{ProviderName}. (User: USD{UserName}) 213 PROVIDER_CERTIFICATE_IMPORTED Info Certificate for provider USD{ProviderName} was imported. (User: USD{UserName}) 214 PROVIDER_CERTIFICATE_IMPORT_FAILED Error Failed importing Certificate for provider USD{ProviderName}. (User: USD{UserName}) 215 PROVIDER_SYNCHRONIZED Info 216 PROVIDER_SYNCHRONIZED_FAILED Error Failed to synchronize networks of Provider USD{ProviderName}. 217 PROVIDER_SYNCHRONIZED_PERFORMED Info Networks of Provider USD{ProviderName} were successfully synchronized. 218 PROVIDER_SYNCHRONIZED_PERFORMED_FAILED Error Networks of Provider USD{ProviderName} were incompletely synchronized. 219 PROVIDER_SYNCHRONIZED_DISABLED Error Failed to synchronize networks of Provider USD{ProviderName}, because the authentication information of the provider is invalid. Automatic synchronization is deactivated for this Provider. 250 USER_UPDATE_VM_CLUSTER_DEFAULT_HOST_CLEARED Info USD{VmName} cluster was updated by USD{UserName}, Default host was reset to auto assign. 251 USER_REMOVE_VM_TEMPLATE_FINISHED Info Removal of Template USD{VmTemplateName} has been completed. 252 SYSTEM_FAILED_UPDATE_VM Error Failed to Update VM USD{VmName} that was initiated by system. 253 SYSTEM_UPDATE_VM Info VM USD{VmName} configuration was updated by system. 254 VM_ALREADY_IN_REQUESTED_STATUS Info VM USD{VmName} is already USD{VmStatus}, USD{Action} was skipped. User: USD{UserName}. 302 USER_ADD_VM_POOL_WITH_VMS Info VM Pool USD{VmPoolName} (containing USD{VmsCount} VMs) was created by USD{UserName}. 303 USER_ADD_VM_POOL_WITH_VMS_FAILED Error Failed to create VM Pool USD{VmPoolName} (User: USD{UserName}). 304 USER_REMOVE_VM_POOL Info VM Pool USD{VmPoolName} was removed by USD{UserName}. 305 USER_REMOVE_VM_POOL_FAILED Error Failed to remove VM Pool USD{VmPoolName} (User: USD{UserName}). 306 USER_ADD_VM_TO_POOL Info VM USD{VmName} was added to VM Pool USD{VmPoolName} by USD{UserName}. 307 USER_ADD_VM_TO_POOL_FAILED Error Failed to add VM USD{VmName} to VM Pool USD{VmPoolName}(User: USD{UserName}). 308 USER_REMOVE_VM_FROM_POOL Info VM USD{VmName} was removed from VM Pool USD{VmPoolName} by USD{UserName}. 309 USER_REMOVE_VM_FROM_POOL_FAILED Error Failed to remove VM USD{VmName} from VM Pool USD{VmPoolName} (User: USD{UserName}). 310 USER_ATTACH_USER_TO_POOL Info User USD{AdUserName} was attached to VM Pool USD{VmPoolName} by USD{UserName}. 311 USER_ATTACH_USER_TO_POOL_FAILED Error Failed to attach User USD{AdUserName} to VM Pool USD{VmPoolName} (User: USD{UserName}). 312 USER_DETACH_USER_FROM_POOL Info User USD{AdUserName} was detached from VM Pool USD{VmPoolName} by USD{UserName}. 313 USER_DETACH_USER_FROM_POOL_FAILED Error Failed to detach User USD{AdUserName} from VM Pool USD{VmPoolName} (User: USD{UserName}). 314 USER_UPDATE_VM_POOL Info VM Pool USD{VmPoolName} configuration was updated by USD{UserName}. 315 USER_UPDATE_VM_POOL_FAILED Error Failed to update VM Pool USD{VmPoolName} configuration (User: USD{UserName}). 316 USER_ATTACH_USER_TO_VM_FROM_POOL Info Attaching User USD{AdUserName} to VM USD{VmName} in VM Pool USD{VmPoolName} was initiated by USD{UserName}. 317 USER_ATTACH_USER_TO_VM_FROM_POOL_FAILED Error Failed to attach User USD{AdUserName} to VM from VM Pool USD{VmPoolName} (User: USD{UserName}). 318 USER_ATTACH_USER_TO_VM_FROM_POOL_FINISHED_SUCCESS Info User USD{AdUserName} successfully attached to VM USD{VmName} in VM Pool USD{VmPoolName}. 319 USER_ATTACH_USER_TO_VM_FROM_POOL_FINISHED_FAILURE Error Failed to attach user USD{AdUserName} to VM USD{VmName} in VM Pool USD{VmPoolName}. 320 USER_ADD_VM_POOL_WITH_VMS_ADD_VDS_FAILED Error Pool USD{VmPoolName} Created, but some Vms failed to create (User: USD{UserName}). 321 USER_REMOVE_VM_POOL_INITIATED Info VM Pool USD{VmPoolName} removal was initiated by USD{UserName}. 325 USER_REMOVE_ADUSER Info User USD{AdUserName} was removed by USD{UserName}. 326 USER_FAILED_REMOVE_ADUSER Error Failed to remove User USD{AdUserName} (User: USD{UserName}). 327 USER_FAILED_ADD_ADUSER Warning Failed to add User 'USD{NewUserName}' to the system. 342 USER_REMOVE_SNAPSHOT Info Snapshot 'USD{SnapshotName}' deletion for VM 'USD{VmName}' was initiated by USD{UserName}. 343 USER_FAILED_REMOVE_SNAPSHOT Error Failed to remove Snapshot USD{SnapshotName} for VM USD{VmName} (User: USD{UserName}). 344 USER_UPDATE_VM_POOL_WITH_VMS Info VM Pool USD{VmPoolName} was updated by USD{UserName}, USD{VmsCount} VMs were added. 345 USER_UPDATE_VM_POOL_WITH_VMS_FAILED Error Failed to update VM Pool USD{VmPoolName}(User: USD{UserName}). 346 USER_PASSWORD_CHANGED Info Password changed successfully for USD{UserName} 347 USER_PASSWORD_CHANGE_FAILED Error Failed to change password. (User: USD{UserName}) 348 USER_CLEAR_UNKNOWN_VMS Info All VMs' status on Non Responsive Host USD{VdsName} were changed to 'Down' by USD{UserName} 349 USER_FAILED_CLEAR_UNKNOWN_VMS Error Failed to clear VMs' status on Non Responsive Host USD{VdsName}. (User: USD{UserName}). 350 USER_ADD_BOOKMARK Info Bookmark USD{BookmarkName} was added by USD{UserName}. 351 USER_ADD_BOOKMARK_FAILED Error Failed to add bookmark: USD{BookmarkName} (User: USD{UserName}). 352 USER_UPDATE_BOOKMARK Info Bookmark USD{BookmarkName} was updated by USD{UserName}. 353 USER_UPDATE_BOOKMARK_FAILED Error Failed to update bookmark: USD{BookmarkName} (User: USD{UserName}) 354 USER_REMOVE_BOOKMARK Info Bookmark USD{BookmarkName} was removed by USD{UserName}. 355 USER_REMOVE_BOOKMARK_FAILED Error Failed to remove bookmark USD{BookmarkName} (User: USD{UserName}) 356 USER_REMOVE_SNAPSHOT_FINISHED_SUCCESS Info Snapshot 'USD{SnapshotName}' deletion for VM 'USD{VmName}' has been completed. 357 USER_REMOVE_SNAPSHOT_FINISHED_FAILURE Error Failed to delete snapshot 'USD{SnapshotName}' for VM 'USD{VmName}'. 358 USER_VM_POOL_MAX_SUBSEQUENT_FAILURES_REACHED Warning Not all VMs where successfully created in VM Pool USD{VmPoolName}. 359 USER_REMOVE_SNAPSHOT_FINISHED_FAILURE_PARTIAL_SNAPSHOT Warning Due to partial snapshot removal, Snapshot 'USD{SnapshotName}' of VM 'USD{VmName}' now contains only the following disks: 'USD{DiskAliases}'. 360 USER_DETACH_USER_FROM_VM Info User USD{AdUserName} was detached from VM USD{VmName} by USD{UserName}. 361 USER_FAILED_DETACH_USER_FROM_VM Error Failed to detach User USD{AdUserName} from VM USD{VmName} (User: USD{UserName}). 362 USER_REMOVE_SNAPSHOT_FINISHED_FAILURE_BASE_IMAGE_NOT_FOUND Error Failed to merge images of snapshot 'USD{SnapshotName}': base volume 'USD{BaseVolumeId}' is missing. This may have been caused by a failed attempt to remove the parent snapshot; if this is the case, please retry deletion of the parent snapshot before deleting this one. 370 USER_EXTEND_DISK_SIZE_FAILURE Error Failed to extend size of the disk 'USD{DiskAlias}' to USD{NewSize} GB, User: USD{UserName}. 371 USER_EXTEND_DISK_SIZE_SUCCESS Info Size of the disk 'USD{DiskAlias}' was successfully updated to USD{NewSize} GB by USD{UserName}. 372 USER_EXTEND_DISK_SIZE_UPDATE_VM_FAILURE Warning Failed to update VM 'USD{VmName}' with the new volume size. VM restart is recommended. 373 USER_REMOVE_DISK_SNAPSHOT Info Disk 'USD{DiskAlias}' from Snapshot(s) 'USD{Snapshots}' of VM 'USD{VmName}' deletion was initiated by USD{UserName}. 374 USER_FAILED_REMOVE_DISK_SNAPSHOT Error Failed to delete Disk 'USD{DiskAlias}' from Snapshot(s) USD{Snapshots} of VM USD{VmName} (User: USD{UserName}). 375 USER_REMOVE_DISK_SNAPSHOT_FINISHED_SUCCESS Info Disk 'USD{DiskAlias}' from Snapshot(s) 'USD{Snapshots}' of VM 'USD{VmName}' deletion has been completed (User: USD{UserName}). 376 USER_REMOVE_DISK_SNAPSHOT_FINISHED_FAILURE Error Failed to complete deletion of Disk 'USD{DiskAlias}' from snapshot(s) 'USD{Snapshots}' of VM 'USD{VmName}' (User: USD{UserName}). 377 USER_EXTENDED_DISK_SIZE Info Extending disk 'USD{DiskAlias}' to USD{NewSize} GB was initiated by USD{UserName}. 378 USER_REGISTER_DISK_FINISHED_SUCCESS Info Disk 'USD{DiskAlias}' has been successfully registered as a floating disk. 379 USER_REGISTER_DISK_FINISHED_FAILURE Error Failed to register Disk 'USD{DiskAlias}'. 380 USER_EXTEND_DISK_SIZE_UPDATE_HOST_FAILURE Warning Failed to refresh volume size on host 'USD{VdsName}'. Please try the operation again. 381 USER_REGISTER_DISK_INITIATED Info Registering Disk 'USD{DiskAlias}' has been initiated. 382 USER_REDUCE_DISK_FINISHED_SUCCESS Info Disk 'USD{DiskAlias}' has been successfully reduced. 383 USER_REDUCE_DISK_FINISHED_FAILURE Error Failed to reduce Disk 'USD{DiskAlias}'. 400 USER_ATTACH_VM_TO_AD_GROUP Info Group USD{GroupName} was attached to VM USD{VmName} by USD{UserName}. 401 USER_ATTACH_VM_TO_AD_GROUP_FAILED Error Failed to attach Group USD{GroupName} to VM USD{VmName} (User: USD{UserName}). 402 USER_DETACH_VM_TO_AD_GROUP Info Group USD{GroupName} was detached from VM USD{VmName} by USD{UserName}. 403 USER_DETACH_VM_TO_AD_GROUP_FAILED Error Failed to detach Group USD{GroupName} from VM USD{VmName} (User: USD{UserName}). 404 USER_ATTACH_VM_POOL_TO_AD_GROUP Info Group USD{GroupName} was attached to VM Pool USD{VmPoolName} by USD{UserName}. 405 USER_ATTACH_VM_POOL_TO_AD_GROUP_FAILED Error Failed to attach Group USD{GroupName} to VM Pool USD{VmPoolName} (User: USD{UserName}). 406 USER_DETACH_VM_POOL_TO_AD_GROUP Info Group USD{GroupName} was detached from VM Pool USD{VmPoolName} by USD{UserName}. 407 USER_DETACH_VM_POOL_TO_AD_GROUP_FAILED Error Failed to detach Group USD{GroupName} from VM Pool USD{VmPoolName} (User: USD{UserName}). 408 USER_REMOVE_AD_GROUP Info Group USD{GroupName} was removed by USD{UserName}. 409 USER_REMOVE_AD_GROUP_FAILED Error Failed to remove group USD{GroupName} (User: USD{UserName}). 430 USER_UPDATE_TAG Info Tag USD{TagName} configuration was updated by USD{UserName}. 431 USER_UPDATE_TAG_FAILED Error Failed to update Tag USD{TagName} (User: USD{UserName}). 432 USER_ADD_TAG Info New Tag USD{TagName} was created by USD{UserName}. 433 USER_ADD_TAG_FAILED Error Failed to create Tag named USD{TagName} (User: USD{UserName}). 434 USER_REMOVE_TAG Info Tag USD{TagName} was removed by USD{UserName}. 435 USER_REMOVE_TAG_FAILED Error Failed to remove Tag USD{TagName} (User: USD{UserName}). 436 USER_ATTACH_TAG_TO_USER Info Tag USD{TagName} was attached to User(s) USD{AttachUsersNames} by USD{UserName}. 437 USER_ATTACH_TAG_TO_USER_FAILED Error Failed to attach Tag USD{TagName} to User(s) USD{AttachUsersNames} (User: USD{UserName}). 438 USER_ATTACH_TAG_TO_USER_GROUP Info Tag USD{TagName} was attached to Group(s) USD{AttachGroupsNames} by USD{UserName}. 439 USER_ATTACH_TAG_TO_USER_GROUP_FAILED Error Failed to attach Group(s) USD{AttachGroupsNames} to Tag USD{TagName} (User: USD{UserName}). 440 USER_ATTACH_TAG_TO_VM Info Tag USD{TagName} was attached to VM(s) USD{VmsNames} by USD{UserName}. 441 USER_ATTACH_TAG_TO_VM_FAILED Error Failed to attach Tag USD{TagName} to VM(s) USD{VmsNames} (User: USD{UserName}). 442 USER_ATTACH_TAG_TO_VDS Info Tag USD{TagName} was attached to Host(s) USD{VdsNames} by USD{UserName}. 443 USER_ATTACH_TAG_TO_VDS_FAILED Error Failed to attach Tag USD{TagName} to Host(s) USD{VdsNames} (User: USD{UserName}). 444 USER_DETACH_VDS_FROM_TAG Info Tag USD{TagName} was detached from Host(s) USD{VdsNames} by USD{UserName}. 445 USER_DETACH_VDS_FROM_TAG_FAILED Error Failed to detach Tag USD{TagName} from Host(s) USD{VdsNames} (User: USD{UserName}). 446 USER_DETACH_VM_FROM_TAG Info Tag USD{TagName} was detached from VM(s) USD{VmsNames} by USD{UserName}. 447 USER_DETACH_VM_FROM_TAG_FAILED Error Failed to detach Tag USD{TagName} from VM(s) USD{VmsNames} (User: USD{UserName}). 448 USER_DETACH_USER_FROM_TAG Info Tag USD{TagName} detached from User(s) USD{DetachUsersNames} by USD{UserName}. 449 USER_DETACH_USER_FROM_TAG_FAILED Error Failed to detach Tag USD{TagName} from User(s) USD{DetachUsersNames} (User: USD{UserName}). 450 USER_DETACH_USER_GROUP_FROM_TAG Info Tag USD{TagName} was detached from Group(s) USD{DetachGroupsNames} by USD{UserName}. 451 USER_DETACH_USER_GROUP_FROM_TAG_FAILED Error Failed to detach Tag USD{TagName} from Group(s) USD{DetachGroupsNames} (User: USD{UserName}). 452 USER_ATTACH_TAG_TO_USER_EXISTS Warning Tag USD{TagName} already attached to User(s) USD{AttachUsersNamesExists}. 453 USER_ATTACH_TAG_TO_USER_GROUP_EXISTS Warning Tag USD{TagName} already attached to Group(s) USD{AttachGroupsNamesExists}. 454 USER_ATTACH_TAG_TO_VM_EXISTS Warning Tag USD{TagName} already attached to VM(s) USD{VmsNamesExists}. 455 USER_ATTACH_TAG_TO_VDS_EXISTS Warning Tag USD{TagName} already attached to Host(s) USD{VdsNamesExists}. 456 USER_LOGGED_IN_VM Info User USD{GuestUser} logged in to VM USD{VmName}. 457 USER_LOGGED_OUT_VM Info User USD{GuestUser} logged out from VM USD{VmName}. 458 USER_LOCKED_VM Info User USD{GuestUser} locked VM USD{VmName}. 459 USER_UNLOCKED_VM Info User USD{GuestUser} unlocked VM USD{VmName}. 460 USER_ATTACH_TAG_TO_TEMPLATE_EXISTS Warning Tag USD{TagName} already attached to Template(s) USD{TemplatesNamesExists}. 467 UPDATE_TAGS_VM_DEFAULT_DISPLAY_TYPE Info Vm USD{VmName} tag default display type was updated 468 UPDATE_TAGS_VM_DEFAULT_DISPLAY_TYPE_FAILED Info Failed to update Vm USD{VmName} tag default display type 470 USER_ATTACH_VM_POOL_TO_AD_GROUP_INTERNAL Info Group USD{GroupName} was attached to VM Pool USD{VmPoolName}. 471 USER_ATTACH_VM_POOL_TO_AD_GROUP_FAILED_INTERNAL Error Failed to attach Group USD{GroupName} to VM Pool USD{VmPoolName}. 472 USER_ATTACH_USER_TO_POOL_INTERNAL Info User USD{AdUserName} was attached to VM Pool USD{VmPoolName}. 473 USER_ATTACH_USER_TO_POOL_FAILED_INTERNAL Error Failed to attach User USD{AdUserName} to VM Pool USD{VmPoolName} (User: USD{UserName}). 493 VDS_ALREADY_IN_REQUESTED_STATUS Warning Host USD{HostName} is already USD{AgentStatus}, Power Management USD{Operation} operation skipped. 494 VDS_MANUAL_FENCE_STATUS Info Manual fence for host USD{VdsName} was started. 495 VDS_MANUAL_FENCE_STATUS_FAILED Error Manual fence for host USD{VdsName} failed. 496 VDS_FENCE_STATUS Info Host USD{VdsName} power management was verified successfully. 497 VDS_FENCE_STATUS_FAILED Error Failed to verify Host USD{VdsName} power management. 498 VDS_APPROVE Info Host USD{VdsName} was successfully approved by user USD{UserName}. 499 VDS_APPROVE_FAILED Error Failed to approve Host USD{VdsName}. 500 VDS_FAILED_TO_RUN_VMS Error Host USD{VdsName} will be switched to Error status for USD{Time} minutes because it failed to run a VM. 501 USER_SUSPEND_VM Info Suspending VM USD{VmName} was initiated by User USD{UserName} (Host: USD{VdsName}). 502 USER_FAILED_SUSPEND_VM Error Failed to suspend VM USD{VmName} (Host: USD{VdsName}). 503 USER_SUSPEND_VM_OK Info VM USD{VmName} on Host USD{VdsName} is suspended. 504 VDS_INSTALL Info Host USD{VdsName} installed 505 VDS_INSTALL_FAILED Error Host USD{VdsName} installation failed. USD{FailedInstallMessage}. 506 VDS_INITIATED_RUN_VM Info Trying to restart VM USD{VmName} on Host USD{VdsName} 509 VDS_INSTALL_IN_PROGRESS Info Installing Host USD{VdsName}. USD{Message}. 510 VDS_INSTALL_IN_PROGRESS_WARNING Warning Host USD{VdsName} installation in progress . USD{Message}. 511 VDS_INSTALL_IN_PROGRESS_ERROR Error An error has occurred during installation of Host USD{VdsName}: USD{Message}. 512 USER_SUSPEND_VM_FINISH_SUCCESS Info Suspending VM USD{VmName} has been completed. 513 VDS_RECOVER_FAILED_VMS_UNKNOWN Error Host USD{VdsName} cannot be reached, VMs state on this host are marked as Unknown. 514 VDS_INITIALIZING Warning Host USD{VdsName} is initializing. Message: USD{ErrorMessage} 515 VDS_CPU_LOWER_THAN_CLUSTER Warning Host USD{VdsName} moved to Non-Operational state as host does not meet the cluster's minimum CPU level. Missing CPU features : USD{CpuFlags} 516 VDS_CPU_RETRIEVE_FAILED Warning Failed to determine Host USD{VdsName} CPU level - could not retrieve CPU flags. 517 VDS_SET_NONOPERATIONAL Info Host USD{VdsName} moved to Non-Operational state. 518 VDS_SET_NONOPERATIONAL_FAILED Error Failed to move Host USD{VdsName} to Non-Operational state. 519 VDS_SET_NONOPERATIONAL_NETWORK Warning Host USD{VdsName} does not comply with the cluster USD{ClusterName} networks, the following networks are missing on host: 'USD{Networks}' 520 USER_ATTACH_USER_TO_VM Info User USD{AdUserName} was attached to VM USD{VmName} by USD{UserName}. 521 USER_SUSPEND_VM_FINISH_FAILURE Error Failed to complete suspending of VM USD{VmName}. 522 VDS_SET_NONOPERATIONAL_DOMAIN Warning Host USD{VdsName} cannot access the Storage Domain(s) USD{StorageDomainNames} attached to the Data Center USD{StoragePoolName}. Setting Host state to Non-Operational. 523 VDS_SET_NONOPERATIONAL_DOMAIN_FAILED Error Host USD{VdsName} cannot access the Storage Domain(s) USD{StorageDomainNames} attached to the Data Center USD{StoragePoolName}. Failed to set Host state to Non-Operational. 524 VDS_DOMAIN_DELAY_INTERVAL Warning Storage domain USD{StorageDomainName} experienced a high latency of USD{Delay} seconds from host USD{VdsName}. This may cause performance and functional issues. Please consult your Storage Administrator. 525 VDS_INITIATED_RUN_AS_STATELESS_VM_NOT_YET_RUNNING Info Starting VM USD{VmName} as stateless was initiated. 528 USER_EJECT_VM_DISK Info CD was ejected from VM USD{VmName} by USD{UserName}. 530 VDS_MANUAL_FENCE_FAILED_CALL_FENCE_SPM Warning Manual fence did not revoke the selected SPM (USD{VdsName}) since the master storage domain\n was not active or could not use another host for the fence operation. 531 VDS_LOW_MEM Warning Available memory of host USD{HostName} in cluster USD{Cluster} [USD{AvailableMemory} MB] is under defined threshold [USD{Threshold} MB]. 532 VDS_HIGH_MEM_USE Warning Used memory of host USD{HostName} in cluster USD{Cluster} [USD{UsedMemory}%] exceeded defined threshold [USD{Threshold}%]. 533 VDS_HIGH_NETWORK_USE Warning 534 VDS_HIGH_CPU_USE Warning Used CPU of host USD{HostName} [USD{UsedCpu}%] exceeded defined threshold [USD{Threshold}%]. 535 VDS_HIGH_SWAP_USE Warning Used swap memory of host USD{HostName} [USD{UsedSwap}%] exceeded defined threshold [USD{Threshold}%]. 536 VDS_LOW_SWAP Warning Available swap memory of host USD{HostName} [USD{AvailableSwapMemory} MB] is under defined threshold [USD{Threshold} MB]. 537 VDS_INITIATED_RUN_VM_AS_STATELESS Info VM USD{VmName} was restarted on Host USD{VdsName} as stateless 538 USER_RUN_VM_AS_STATELESS Info VM USD{VmName} started on Host USD{VdsName} as stateless 539 VDS_AUTO_FENCE_STATUS Info Auto fence for host USD{VdsName} was started. 540 VDS_AUTO_FENCE_STATUS_FAILED Error Auto fence for host USD{VdsName} failed. 541 VDS_AUTO_FENCE_FAILED_CALL_FENCE_SPM Warning Auto fence did not revoke the selected SPM (USD{VdsName}) since the master storage domain\n was not active or could not use another host for the fence operation. 550 VDS_PACKAGES_IN_PROGRESS Info Package update Host USD{VdsName}. USD{Message}. 551 VDS_PACKAGES_IN_PROGRESS_WARNING Warning Host USD{VdsName} update packages in progress . USD{Message}. 552 VDS_PACKAGES_IN_PROGRESS_ERROR Error Failed to update packages Host USD{VdsName}. USD{Message}. 555 USER_MOVE_TAG Info Tag USD{TagName} was moved from USD{OldParnetTagName} to USD{NewParentTagName} by USD{UserName}. 556 USER_MOVE_TAG_FAILED Error Failed to move Tag USD{TagName} from USD{OldParnetTagName} to USD{NewParentTagName} (User: USD{UserName}). 560 VDS_ANSIBLE_INSTALL_STARTED Info Ansible host-deploy playbook execution has started on host USD{VdsName}. 561 VDS_ANSIBLE_INSTALL_FINISHED Info Ansible host-deploy playbook execution has successfully finished on host USD{VdsName}. 562 VDS_ANSIBLE_HOST_REMOVE_STARTED Info Ansible host-remove playbook execution started on host USD{VdsName}. 563 VDS_ANSIBLE_HOST_REMOVE_FINISHED Info Ansible host-remove playbook execution has successfully finished on host USD{VdsName}. For more details check log USD{LogFile} 564 VDS_ANSIBLE_HOST_REMOVE_FAILED Warning Ansible host-remove playbook execution failed on host USD{VdsName}. For more details please check log USD{LogFile} 565 VDS_ANSIBLE_HOST_REMOVE_EXECUTION_FAILED Info Ansible host-remove playbook execution failed on host USD{VdsName} with message: USD{Message} 600 USER_VDS_MAINTENANCE Info Host USD{VdsName} was switched to Maintenance mode by USD{UserName} (Reason: USD{Reason}). 601 CPU_FLAGS_NX_IS_MISSING Warning Host USD{VdsName} is missing the NX cpu flag. This flag can be enabled via the host BIOS. Please set Disable Execute (XD) for an Intel host, or No Execute (NX) for AMD. Please make sure to completely power off the host for this change to take effect. 602 USER_VDS_MAINTENANCE_MIGRATION_FAILED Warning Host USD{VdsName} cannot change into maintenance mode - not all Vms have been migrated successfully. Consider manual intervention: stopping/migrating Vms: USD{failedVms} (User: USD{UserName}). 603 VDS_SET_NONOPERATIONAL_IFACE_DOWN Warning Host USD{VdsName} moved to Non-Operational state because interfaces which are down are needed by required networks in the current cluster: 'USD{NicsWithNetworks}'. 604 VDS_TIME_DRIFT_ALERT Warning Host USD{VdsName} has time-drift of USD{Actual} seconds while maximum configured value is USD{Max} seconds. 605 PROXY_HOST_SELECTION Info Host USD{Proxy} from USD{Origin} was chosen as a proxy to execute fencing on Host USD{VdsName}. 606 HOST_REFRESHED_CAPABILITIES Info Successfully refreshed the capabilities of host USD{VdsName}. 607 HOST_REFRESH_CAPABILITIES_FAILED Error Failed to refresh the capabilities of host USD{VdsName}. 608 HOST_INTERFACE_HIGH_NETWORK_USE Warning Host USD{HostName} has network interface which exceeded the defined threshold [USD{Threshold}%] (USD{InterfaceName}: transmit rate[USD{TransmitRate}%], receive rate [USD{ReceiveRate}%]) 609 HOST_INTERFACE_STATE_UP Normal Interface USD{InterfaceName} on host USD{VdsName}, changed state to up 610 HOST_INTERFACE_STATE_DOWN Warning Interface USD{InterfaceName} on host USD{VdsName}, changed state to down 611 HOST_BOND_SLAVE_STATE_UP Normal Slave USD{SlaveName} of bond USD{BondName} on host USD{VdsName}, changed state to up 612 HOST_BOND_SLAVE_STATE_DOWN Warning Slave USD{SlaveName} of bond USD{BondName} on host USD{VdsName}, changed state to down 613 FENCE_KDUMP_LISTENER_IS_NOT_ALIVE Error Unable to determine if Kdump is in progress on host USD{VdsName}, because fence_kdump listener is not running. 614 KDUMP_FLOW_DETECTED_ON_VDS Info Kdump flow is in progress on host USD{VdsName}. 615 KDUMP_FLOW_NOT_DETECTED_ON_VDS Info Kdump flow is not in progress on host USD{VdsName}. 616 KDUMP_FLOW_FINISHED_ON_VDS Info Kdump flow finished on host USD{VdsName}. 617 KDUMP_DETECTION_NOT_CONFIGURED_ON_VDS Warning Kdump integration is enabled for host USD{VdsName}, but kdump is not configured properly on host. 618 HOST_REGISTRATION_FAILED_INVALID_CLUSTER Info No default or valid cluster was found, Host USD{VdsName} registration failed 619 HOST_PROTOCOL_INCOMPATIBLE_WITH_CLUSTER Warning Host USD{VdsName} uses not compatible protocol during activation (xmlrpc instead of jsonrpc). Please examine installation logs and VDSM logs for failures and reinstall the host. 620 USER_VDS_MAINTENANCE_WITHOUT_REASON Info Host USD{VdsName} was switched to Maintenance mode by USD{UserName}. 650 USER_UNDO_RESTORE_FROM_SNAPSHOT_START Info Undoing a Snapshot-Preview for VM USD{VmName} was initialized by USD{UserName}. 651 USER_UNDO_RESTORE_FROM_SNAPSHOT_FINISH_SUCCESS Info Undoing a Snapshot-Preview for VM USD{VmName} has been completed. 652 USER_UNDO_RESTORE_FROM_SNAPSHOT_FINISH_FAILURE Error Failed to undo Snapshot-Preview for VM USD{VmName}. 700 DISK_ALIGNMENT_SCAN_START Info Starting alignment scan of disk 'USD{DiskAlias}'. 701 DISK_ALIGNMENT_SCAN_FAILURE Warning Alignment scan of disk 'USD{DiskAlias}' failed. 702 DISK_ALIGNMENT_SCAN_SUCCESS Info Alignment scan of disk 'USD{DiskAlias}' is complete. 809 USER_ADD_CLUSTER Info Cluster USD{ClusterName} was added by USD{UserName} 810 USER_ADD_CLUSTER_FAILED Error Failed to add Host cluster (User: USD{UserName}) 811 USER_UPDATE_CLUSTER Info Host cluster USD{ClusterName} was updated by USD{UserName} 812 USER_UPDATE_CLUSTER_FAILED Error Failed to update Host cluster (User: USD{UserName}) 813 USER_REMOVE_CLUSTER Info Host cluster USD{ClusterName} was removed by USD{UserName} 814 USER_REMOVE_CLUSTER_FAILED Error Failed to remove Host cluster (User: USD{UserName}) 815 USER_VDC_LOGOUT_FAILED Error Failed to log out user USD{UserName} connected from 'USD{SourceIP}' using session 'USD{SessionID}'. 816 MAC_POOL_EMPTY Warning No MAC addresses left in the MAC Address Pool. 817 CERTIFICATE_FILE_NOT_FOUND Error Could not find oVirt Engine Certificate file. 818 RUN_VM_FAILED Error Cannot run VM USD{VmName} on Host USD{VdsName}. Error: USD{ErrMsg} 819 VDS_REGISTER_ERROR_UPDATING_HOST Error Host registration failed - cannot update Host Name for Host USD{VdsName2}. (Host: USD{VdsName1}) 820 VDS_REGISTER_ERROR_UPDATING_HOST_ALL_TAKEN Error Host registration failed - all available Host Names are taken. (Host: USD{VdsName1}) 821 VDS_REGISTER_HOST_IS_ACTIVE Error Host registration failed - cannot change Host Name of active Host USD{VdsName2}. (Host: USD{VdsName1}) 822 VDS_REGISTER_ERROR_UPDATING_NAME Error Host registration failed - cannot update Host Name for Host USD{VdsName2}. (Host: USD{VdsName1}) 823 VDS_REGISTER_ERROR_UPDATING_NAMES_ALL_TAKEN Error Host registration failed - all available Host Names are taken. (Host: USD{VdsName1}) 824 VDS_REGISTER_NAME_IS_ACTIVE Error Host registration failed - cannot change Host Name of active Host USD{VdsName2}. (Host: USD{VdsName1}) 825 VDS_REGISTER_AUTO_APPROVE_PATTERN Error Host registration failed - auto approve pattern error. (Host: USD{VdsName1}) 826 VDS_REGISTER_FAILED Error Host registration failed. (Host: USD{VdsName1}) 827 VDS_REGISTER_EXISTING_VDS_UPDATE_FAILED Error Host registration failed - cannot update existing Host. (Host: USD{VdsName1}) 828 VDS_REGISTER_SUCCEEDED Info Host USD{VdsName1} registered. 829 VM_MIGRATION_ON_CONNECT_CHECK_FAILED Error VM migration logic failed. (VM name: USD{VmName}) 830 VM_MIGRATION_ON_CONNECT_CHECK_SUCCEEDED Info Migration check failed to execute. 831 USER_VDC_SESSION_TERMINATED Info User USD{UserName} forcibly logged out user USD{TerminatedSessionUsername} connected from 'USD{SourceIP}' using session 'USD{SessionID}'. 832 USER_VDC_SESSION_TERMINATION_FAILED Error User USD{UserName} failed to forcibly log out user USD{TerminatedSessionUsername} connected from 'USD{SourceIP}' using session 'USD{SessionID}'. 833 MAC_ADDRESS_IS_IN_USE Warning Network Interface USD{IfaceName} has MAC address USD{MACAddr} which is in use. 834 VDS_REGISTER_EMPTY_ID Warning Host registration failed, empty host id (Host: USD{VdsHostName}) 835 SYSTEM_UPDATE_CLUSTER Info Host cluster USD{ClusterName} was updated by system 836 SYSTEM_UPDATE_CLUSTER_FAILED Info Failed to update Host cluster by system 837 MAC_ADDRESSES_POOL_NOT_INITIALIZED Warning Mac Address Pool is not initialized. USD{Message} 838 MAC_ADDRESS_IS_IN_USE_UNPLUG Warning Network Interface USD{IfaceName} has MAC address USD{MACAddr} which is in use, therefore it is being unplugged from VM USD{VmName}. 839 HOST_AVAILABLE_UPDATES_FAILED Error Failed to check for available updates on host USD{VdsName} with message 'USD{Message}'. 840 HOST_UPGRADE_STARTED Info Host USD{VdsName} upgrade was started (User: USD{UserName}). 841 HOST_UPGRADE_FAILED Error Failed to upgrade Host USD{VdsName} (User: USD{UserName}). 842 HOST_UPGRADE_FINISHED Info Host USD{VdsName} upgrade was completed successfully. 845 HOST_CERTIFICATION_IS_ABOUT_TO_EXPIRE Warning Host USD{VdsName} certification is about to expire at USD{ExpirationDate}. Please renew the host's certification. 846 ENGINE_CERTIFICATION_HAS_EXPIRED Info Engine's certification has expired at USD{ExpirationDate}. Please renew the engine's certification. 847 ENGINE_CERTIFICATION_IS_ABOUT_TO_EXPIRE Warning Engine's certification is about to expire at USD{ExpirationDate}. Please renew the engine's certification. 848 ENGINE_CA_CERTIFICATION_HAS_EXPIRED Info Engine's CA certification has expired at USD{ExpirationDate}. 849 ENGINE_CA_CERTIFICATION_IS_ABOUT_TO_EXPIRE Warning Engine's CA certification is about to expire at USD{ExpirationDate}. 850 USER_ADD_PERMISSION Info User/Group USD{SubjectName}, Namespace USD{Namespace}, Authorization provider: USD{Authz} was granted permission for Role USD{RoleName} on USD{VdcObjectType} USD{VdcObjectName}, by USD{UserName}. 851 USER_ADD_PERMISSION_FAILED Error User USD{UserName} failed to grant permission for Role USD{RoleName} on USD{VdcObjectType} USD{VdcObjectName} to User/Group USD{SubjectName}. 852 USER_REMOVE_PERMISSION Info User/Group USD{SubjectName} Role USD{RoleName} permission was removed from USD{VdcObjectType} USD{VdcObjectName} by USD{UserName} 853 USER_REMOVE_PERMISSION_FAILED Error User USD{UserName} failed to remove permission for Role USD{RoleName} from USD{VdcObjectType} USD{VdcObjectName} to User/Group USD{SubjectName} 854 USER_ADD_ROLE Info Role USD{RoleName} granted to USD{UserName} 855 USER_ADD_ROLE_FAILED Error Failed to grant role USD{RoleName} (User USD{UserName}) 856 USER_UPDATE_ROLE Info USD{UserName} Role was updated to the USD{RoleName} Role 857 USER_UPDATE_ROLE_FAILED Error Failed to update role USD{RoleName} to USD{UserName} 858 USER_REMOVE_ROLE Info Role USD{RoleName} removed from USD{UserName} 859 USER_REMOVE_ROLE_FAILED Error Failed to remove role USD{RoleName} (User USD{UserName}) 860 USER_ATTACHED_ACTION_GROUP_TO_ROLE Info Action group USD{ActionGroup} was attached to Role USD{RoleName} by USD{UserName} 861 USER_ATTACHED_ACTION_GROUP_TO_ROLE_FAILED Error Failed to attach Action group USD{ActionGroup} to Role USD{RoleName} (User: USD{UserName}) 862 USER_DETACHED_ACTION_GROUP_FROM_ROLE Info Action group USD{ActionGroup} was detached from Role USD{RoleName} by USD{UserName} 863 USER_DETACHED_ACTION_GROUP_FROM_ROLE_FAILED Error Failed to attach Action group USD{ActionGroup} to Role USD{RoleName} by USD{UserName} 864 USER_ADD_ROLE_WITH_ACTION_GROUP Info Role USD{RoleName} was added by USD{UserName} 865 USER_ADD_ROLE_WITH_ACTION_GROUP_FAILED Error Failed to add role USD{RoleName} 866 USER_ADD_SYSTEM_PERMISSION Info User/Group USD{SubjectName} was granted permission for Role USD{RoleName} on USD{VdcObjectType} by USD{UserName}. 867 USER_ADD_SYSTEM_PERMISSION_FAILED Error User USD{UserName} failed to grant permission for Role USD{RoleName} on USD{VdcObjectType} to User/Group USD{SubjectName}. 868 USER_REMOVE_SYSTEM_PERMISSION Info User/Group USD{SubjectName} Role USD{RoleName} permission was removed from USD{VdcObjectType} by USD{UserName} 869 USER_REMOVE_SYSTEM_PERMISSION_FAILED Error User USD{UserName} failed to remove permission for Role USD{RoleName} from USD{VdcObjectType} to User/Group USD{SubjectName} 870 USER_ADD_PROFILE Info Profile created for USD{UserName} 871 USER_ADD_PROFILE_FAILED Error Failed to create profile for USD{UserName} 872 USER_UPDATE_PROFILE Info Updated profile for USD{UserName} 873 USER_UPDATE_PROFILE_FAILED Error Failed to update profile for USD{UserName} 874 USER_REMOVE_PROFILE Info Removed profile for USD{UserName} 875 USER_REMOVE_PROFILE_FAILED Error Failed to remove profile for USD{UserName} 876 HOST_CERTIFICATION_IS_INVALID Error Host USD{VdsName} certification is invalid. The certification has no peer certificates. 877 HOST_CERTIFICATION_HAS_EXPIRED Info Host USD{VdsName} certification has expired at USD{ExpirationDate}. Please renew the host's certification. 878 ENGINE_CERTIFICATION_IS_ABOUT_TO_EXPIRE_ALERT Info Engine's certification is about to expire at USD{ExpirationDate}. Please renew the engine's certification. 879 HOST_CERTIFICATION_IS_ABOUT_TO_EXPIRE_ALERT Info Host USD{VdsName} certification is about to expire at USD{ExpirationDate}. Please renew the host's certification. 880 HOST_CERTIFICATION_ENROLLMENT_STARTED Normal Enrolling certificate for host USD{VdsName} was started (User: USD{UserName}). 881 HOST_CERTIFICATION_ENROLLMENT_FINISHED Normal Enrolling certificate for host USD{VdsName} was completed successfully (User: USD{UserName}). 882 HOST_CERTIFICATION_ENROLLMENT_FAILED Error Failed to enroll certificate for host USD{VdsName} (User: USD{UserName}). 883 ENGINE_CA_CERTIFICATION_IS_ABOUT_TO_EXPIRE_ALERT Info Engine's CA certification is about to expire at USD{ExpirationDate}. 884 HOST_AVAILABLE_UPDATES_STARTED Info Started to check for available updates on host USD{VdsName}. 885 HOST_AVAILABLE_UPDATES_FINISHED Info Check for available updates on host USD{VdsName} was completed successfully with message 'USD{Message}'. 886 HOST_AVAILABLE_UPDATES_PROCESS_IS_ALREADY_RUNNING Warning Failed to check for available updates on host USD{VdsName}: Another process is already running. 887 HOST_AVAILABLE_UPDATES_SKIPPED_UNSUPPORTED_STATUS Warning Failed to check for available updates on host USD{VdsName}: Unsupported host status. 890 HOST_UPGRADE_FINISHED_MANUAL_HA Warning Host USD{VdsName} upgrade was completed successfully, but the Hosted Engine HA service may still be in maintenance mode. If necessary, please correct this manually. 900 AD_COMPUTER_ACCOUNT_SUCCEEDED Info Account creation successful. 901 AD_COMPUTER_ACCOUNT_FAILED Error Account creation failed. 918 USER_FORCE_REMOVE_STORAGE_POOL Info Data Center USD{StoragePoolName} was forcibly removed by USD{UserName} 919 USER_FORCE_REMOVE_STORAGE_POOL_FAILED Error Failed to forcibly remove Data Center USD{StoragePoolName}. (User: USD{UserName}) 925 MAC_ADDRESS_IS_EXTERNAL Warning VM USD{VmName} has MAC address(es) USD{MACAddr}, which is/are out of its MAC pool definitions. 926 NETWORK_REMOVE_BOND Info Remove bond: USD{BondName} for Host: USD{VdsName} (User:USD{UserName}). 927 NETWORK_REMOVE_BOND_FAILED Error Failed to remove bond: USD{BondName} for Host: USD{VdsName} (User:USD{UserName}). 928 NETWORK_VDS_NETWORK_MATCH_CLUSTER Info Vds USD{VdsName} network match to cluster USD{ClusterName} 929 NETWORK_VDS_NETWORK_NOT_MATCH_CLUSTER Error Vds USD{VdsName} network does not match to cluster USD{ClusterName} 930 NETWORK_REMOVE_VM_INTERFACE Info Interface USD{InterfaceName} (USD{InterfaceType}) was removed from VM USD{VmName}. (User: USD{UserName}) 931 NETWORK_REMOVE_VM_INTERFACE_FAILED Error Failed to remove Interface USD{InterfaceName} (USD{InterfaceType}) from VM USD{VmName}. (User: USD{UserName}) 932 NETWORK_ADD_VM_INTERFACE Info Interface USD{InterfaceName} (USD{InterfaceType}) was added to VM USD{VmName}. (User: USD{UserName}) 933 NETWORK_ADD_VM_INTERFACE_FAILED Error Failed to add Interface USD{InterfaceName} (USD{InterfaceType}) to VM USD{VmName}. (User: USD{UserName}) 934 NETWORK_UPDATE_VM_INTERFACE Info Interface USD{InterfaceName} (USD{InterfaceType}) was updated for VM USD{VmName}. USD{LinkState} (User: USD{UserName}) 935 NETWORK_UPDATE_VM_INTERFACE_FAILED Error Failed to update Interface USD{InterfaceName} (USD{InterfaceType}) for VM USD{VmName}. (User: USD{UserName}) 936 NETWORK_ADD_TEMPLATE_INTERFACE Info Interface USD{InterfaceName} (USD{InterfaceType}) was added to Template USD{VmTemplateName}. (User: USD{UserName}) 937 NETWORK_ADD_TEMPLATE_INTERFACE_FAILED Error Failed to add Interface USD{InterfaceName} (USD{InterfaceType}) to Template USD{VmTemplateName}. (User: USD{UserName}) 938 NETWORK_REMOVE_TEMPLATE_INTERFACE Info Interface USD{InterfaceName} (USD{InterfaceType}) was removed from Template USD{VmTemplateName}. (User: USD{UserName}) 939 NETWORK_REMOVE_TEMPLATE_INTERFACE_FAILED Error Failed to remove Interface USD{InterfaceName} (USD{InterfaceType}) from Template USD{VmTemplateName}. (User: USD{UserName}) 940 NETWORK_UPDATE_TEMPLATE_INTERFACE Info Interface USD{InterfaceName} (USD{InterfaceType}) was updated for Template USD{VmTemplateName}. (User: USD{UserName}) 941 NETWORK_UPDATE_TEMPLATE_INTERFACE_FAILED Error Failed to update Interface USD{InterfaceName} (USD{InterfaceType}) for Template USD{VmTemplateName}. (User: USD{UserName}) 942 NETWORK_ADD_NETWORK Info Network USD{NetworkName} was added to Data Center: USD{StoragePoolName} 943 NETWORK_ADD_NETWORK_FAILED Error Failed to add Network USD{NetworkName} to Data Center: USD{StoragePoolName} 944 NETWORK_REMOVE_NETWORK Info Network USD{NetworkName} was removed from Data Center: USD{StoragePoolName} 945 NETWORK_REMOVE_NETWORK_FAILED Error Failed to remove Network USD{NetworkName} from Data Center: USD{StoragePoolName} 946 NETWORK_ATTACH_NETWORK_TO_CLUSTER Info Network USD{NetworkName} attached to Cluster USD{ClusterName} 947 NETWORK_ATTACH_NETWORK_TO_CLUSTER_FAILED Error Failed to attach Network USD{NetworkName} to Cluster USD{ClusterName} 948 NETWORK_DETACH_NETWORK_TO_CLUSTER Info Network USD{NetworkName} detached from Cluster USD{ClusterName} 949 NETWORK_DETACH_NETWORK_TO_CLUSTER_FAILED Error Failed to detach Network USD{NetworkName} from Cluster USD{ClusterName} 950 USER_ADD_STORAGE_POOL Info Data Center USD{StoragePoolName}, Compatibility Version USD{CompatibilityVersion} and Quota Type USD{QuotaEnforcementType} was added by USD{UserName} 951 USER_ADD_STORAGE_POOL_FAILED Error Failed to add Data Center USD{StoragePoolName}. (User: USD{UserName}) 952 USER_UPDATE_STORAGE_POOL Info Data Center USD{StoragePoolName} was updated by USD{UserName} 953 USER_UPDATE_STORAGE_POOL_FAILED Error Failed to update Data Center USD{StoragePoolName}. (User: USD{UserName}) 954 USER_REMOVE_STORAGE_POOL Info Data Center USD{StoragePoolName} was removed by USD{UserName} 955 USER_REMOVE_STORAGE_POOL_FAILED Error Failed to remove Data Center USD{StoragePoolName}. (User: USD{UserName}) 956 USER_ADD_STORAGE_DOMAIN Info Storage Domain USD{StorageDomainName} was added by USD{UserName} 957 USER_ADD_STORAGE_DOMAIN_FAILED Error Failed to add Storage Domain USD{StorageDomainName}. (User: USD{UserName}) 958 USER_UPDATE_STORAGE_DOMAIN Info Storage Domain USD{StorageDomainName} was updated by USD{UserName} 959 USER_UPDATE_STORAGE_DOMAIN_FAILED Error Failed to update Storage Domain USD{StorageDomainName}. (User: USD{UserName}) 960 USER_REMOVE_STORAGE_DOMAIN Info Storage Domain USD{StorageDomainName} was removed by USD{UserName} 961 USER_REMOVE_STORAGE_DOMAIN_FAILED Error Failed to remove Storage Domain USD{StorageDomainName}. (User: USD{UserName}) 962 USER_ATTACH_STORAGE_DOMAIN_TO_POOL Info Storage Domain USD{StorageDomainName} was attached to Data Center USD{StoragePoolName} by USD{UserName} 963 USER_ATTACH_STORAGE_DOMAIN_TO_POOL_FAILED Error Failed to attach Storage Domain USD{StorageDomainName} to Data Center USD{StoragePoolName}. (User: USD{UserName}) 964 USER_DETACH_STORAGE_DOMAIN_FROM_POOL Info Storage Domain USD{StorageDomainName} was detached from Data Center USD{StoragePoolName} by USD{UserName} 965 USER_DETACH_STORAGE_DOMAIN_FROM_POOL_FAILED Error Failed to detach Storage Domain USD{StorageDomainName} from Data Center USD{StoragePoolName}. (User: USD{UserName}) 966 USER_ACTIVATED_STORAGE_DOMAIN Info Storage Domain USD{StorageDomainName} (Data Center USD{StoragePoolName}) was activated by USD{UserName} 967 USER_ACTIVATE_STORAGE_DOMAIN_FAILED Error Failed to activate Storage Domain USD{StorageDomainName} (Data Center USD{StoragePoolName}) by USD{UserName} 968 USER_DEACTIVATED_STORAGE_DOMAIN Info Storage Domain USD{StorageDomainName} (Data Center USD{StoragePoolName}) was deactivated and has moved to 'Preparing for maintenance' until it will no longer be accessed by any Host of the Data Center. 969 USER_DEACTIVATE_STORAGE_DOMAIN_FAILED Error Failed to deactivate Storage Domain USD{StorageDomainName} (Data Center USD{StoragePoolName}). 970 SYSTEM_DEACTIVATED_STORAGE_DOMAIN Warning Storage Domain USD{StorageDomainName} (Data Center USD{StoragePoolName}) was deactivated by system because it's not visible by any of the hosts. 971 SYSTEM_DEACTIVATE_STORAGE_DOMAIN_FAILED Error Failed to deactivate Storage Domain USD{StorageDomainName} (Data Center USD{StoragePoolName}). 972 USER_EXTENDED_STORAGE_DOMAIN Info Storage USD{StorageDomainName} has been extended by USD{UserName}. Please wait for refresh. 973 USER_EXTENDED_STORAGE_DOMAIN_FAILED Error Failed to extend Storage Domain USD{StorageDomainName}. (User: USD{UserName}) 974 USER_REMOVE_VG Info Volume group USD{VgId} was removed by USD{UserName}. 975 USER_REMOVE_VG_FAILED Error Failed to remove Volume group USD{VgId}. (User: UserName) 976 USER_ACTIVATE_STORAGE_POOL Info Data Center USD{StoragePoolName} was activated. (User: USD{UserName}) 977 USER_ACTIVATE_STORAGE_POOL_FAILED Error Failed to activate Data Center USD{StoragePoolName}. (User: USD{UserName}) 978 SYSTEM_FAILED_CHANGE_STORAGE_POOL_STATUS Error Failed to change Data Center USD{StoragePoolName} status. 979 SYSTEM_CHANGE_STORAGE_POOL_STATUS_NO_HOST_FOR_SPM Error Fencing failed on Storage Pool Manager USD{VdsName} for Data Center USD{StoragePoolName}. Setting status to Non-Operational. 980 SYSTEM_CHANGE_STORAGE_POOL_STATUS_PROBLEMATIC Warning Invalid status on Data Center USD{StoragePoolName}. Setting status to Non Responsive. 981 USER_FORCE_REMOVE_STORAGE_DOMAIN Info Storage Domain USD{StorageDomainName} was forcibly removed by USD{UserName} 982 USER_FORCE_REMOVE_STORAGE_DOMAIN_FAILED Error Failed to forcibly remove Storage Domain USD{StorageDomainName}. (User: USD{UserName}) 983 RECONSTRUCT_MASTER_FAILED_NO_MASTER Warning No valid Data Storage Domains are available in Data Center USD{StoragePoolName} (please check your storage infrastructure). 984 RECONSTRUCT_MASTER_DONE Info Reconstruct Master Domain for Data Center USD{StoragePoolName} completed. 985 RECONSTRUCT_MASTER_FAILED Error Failed to Reconstruct Master Domain for Data Center USD{StoragePoolName}. 986 SYSTEM_CHANGE_STORAGE_POOL_STATUS_PROBLEMATIC_SEARCHING_NEW_SPM Warning Data Center is being initialized, please wait for initialization to complete. 987 SYSTEM_CHANGE_STORAGE_POOL_STATUS_PROBLEMATIC_WITH_ERROR Warning Invalid status on Data Center USD{StoragePoolName}. Setting Data Center status to Non Responsive (On host USD{VdsName}, Error: USD{Error}). 988 USER_CONNECT_HOSTS_TO_LUN_FAILED Error Failed to connect Host USD{VdsName} to device. (User: USD{UserName}) 989 SYSTEM_CHANGE_STORAGE_POOL_STATUS_PROBLEMATIC_FROM_NON_OPERATIONAL Info Try to recover Data Center USD{StoragePoolName}. Setting status to Non Responsive. 990 SYSTEM_MASTER_DOMAIN_NOT_IN_SYNC Warning Sync Error on Master Domain between Host USD{VdsName} and oVirt Engine. Domain: USD{StorageDomainName} is marked as Master in oVirt Engine database but not on the Storage side. Please consult with Support on how to fix this issue. 991 RECOVERY_STORAGE_POOL Info Data Center USD{StoragePoolName} was recovered by USD{UserName} 992 RECOVERY_STORAGE_POOL_FAILED Error Failed to recover Data Center USD{StoragePoolName} (User:USD{UserName}) 993 SYSTEM_CHANGE_STORAGE_POOL_STATUS_RESET_IRS Info Data Center USD{StoragePoolName} was reset. Setting status to Non Responsive (Elect new Storage Pool Manager). 994 CONNECT_STORAGE_SERVERS_FAILED Warning Failed to connect Host USD{VdsName} to Storage Servers 995 CONNECT_STORAGE_POOL_FAILED Warning Failed to connect Host USD{VdsName} to Storage Pool USD{StoragePoolName} 996 STORAGE_DOMAIN_ERROR Error The error message for connection USD{Connection} returned by VDSM was: USD{ErrorMessage} 997 REFRESH_REPOSITORY_IMAGE_LIST_FAILED Error Refresh image list failed for domain(s): USD{imageDomains}. Please check domain activity. 998 REFRESH_REPOSITORY_IMAGE_LIST_SUCCEEDED Info Refresh image list succeeded for domain(s): USD{imageDomains} 999 STORAGE_ALERT_VG_METADATA_CRITICALLY_FULL Error The system has reached the 80% watermark on the VG metadata area size on USD{StorageDomainName}.\nThis is due to a high number of Vdisks or large Vdisks size allocated on this specific VG. 1000 STORAGE_ALERT_SMALL_VG_METADATA Warning The allocated VG metadata area size is smaller than 50MB on USD{StorageDomainName},\nwhich might limit its capacity (the number of Vdisks and/or their size). 1001 USER_RUN_VM_FAILURE_STATELESS_SNAPSHOT_LEFT Error Failed to start VM USD{VmName}, because exist snapshot for stateless state. Snapshot will be deleted. 1002 USER_ATTACH_STORAGE_DOMAINS_TO_POOL Info Storage Domains were attached to Data Center USD{StoragePoolName} by USD{UserName} 1003 USER_ATTACH_STORAGE_DOMAINS_TO_POOL_FAILED Error Failed to attach Storage Domains to Data Center USD{StoragePoolName}. (User: USD{UserName}) 1004 STORAGE_DOMAIN_TASKS_ERROR Warning Storage Domain USD{StorageDomainName} is down while there are tasks running on it. These tasks may fail. 1005 UPDATE_OVF_FOR_STORAGE_POOL_FAILED Warning Failed to update VMs/Templates OVF data in Data Center USD{StoragePoolName}. 1006 UPGRADE_STORAGE_POOL_ENCOUNTERED_PROBLEMS Warning Data Center USD{StoragePoolName} has encountered problems during upgrade process. 1007 REFRESH_REPOSITORY_IMAGE_LIST_INCOMPLETE Warning Refresh image list probably incomplete for domain USD{imageDomain}, only USD{imageListSize} images discovered. 1008 NUMBER_OF_LVS_ON_STORAGE_DOMAIN_EXCEEDED_THRESHOLD Warning The number of LVs on the domain USD{storageDomainName} exceeded USD{maxNumOfLVs}, you are approaching the limit where performance may degrade. 1009 USER_DEACTIVATE_STORAGE_DOMAIN_OVF_UPDATE_INCOMPLETE Warning Failed to deactivate Storage Domain USD{StorageDomainName} as the engine was restarted during the operation, please retry. (Data Center USD{StoragePoolName}). 1010 RELOAD_CONFIGURATIONS_SUCCESS Info System Configurations reloaded successfully. 1011 RELOAD_CONFIGURATIONS_FAILURE Error System Configurations failed to reload. 1012 NETWORK_ACTIVATE_VM_INTERFACE_SUCCESS Info Network Interface USD{InterfaceName} (USD{InterfaceType}) was plugged to VM USD{VmName}. (User: USD{UserName}) 1013 NETWORK_ACTIVATE_VM_INTERFACE_FAILURE Error Failed to plug Network Interface USD{InterfaceName} (USD{InterfaceType}) to VM USD{VmName}. (User: USD{UserName}) 1014 NETWORK_DEACTIVATE_VM_INTERFACE_SUCCESS Info Network Interface USD{InterfaceName} (USD{InterfaceType}) was unplugged from VM USD{VmName}. (User: USD{UserName}) 1015 NETWORK_DEACTIVATE_VM_INTERFACE_FAILURE Error Failed to unplug Network Interface USD{InterfaceName} (USD{InterfaceType}) from VM USD{VmName}. (User: USD{UserName}) 1016 UPDATE_FOR_OVF_STORES_FAILED Warning Failed to update OVF disks USD{DisksIds}, OVF data isn't updated on those OVF stores (Data Center USD{DataCenterName}, Storage Domain USD{StorageDomainName}). 1017 RETRIEVE_OVF_STORE_FAILED Warning Failed to retrieve VMs and Templates from the OVF disk of Storage Domain USD{StorageDomainName}. 1018 OVF_STORE_DOES_NOT_EXISTS Warning This Data center compatibility version does not support importing a data domain with its entities (VMs and Templates). The imported domain will be imported without them. 1019 UPDATE_DESCRIPTION_FOR_DISK_FAILED Error Failed to update the meta data description of disk USD{DiskName} (Data Center USD{DataCenterName}, Storage Domain USD{StorageDomainName}). 1020 UPDATE_DESCRIPTION_FOR_DISK_SKIPPED_SINCE_STORAGE_DOMAIN_NOT_ACTIVE Warning Not updating the metadata of Disk USD{DiskName} (Data Center USD{DataCenterName}. Since the Storage Domain USD{StorageDomainName} is not in active. 1022 USER_REFRESH_LUN_STORAGE_DOMAIN Info Resize LUNs operation succeeded. 1023 USER_REFRESH_LUN_STORAGE_DOMAIN_FAILED Error Failed to resize LUNs. 1024 USER_REFRESH_LUN_STORAGE_DIFFERENT_SIZE_DOMAIN_FAILED Error Failed to resize LUNs.\n Not all the hosts are seeing the same LUN size. 1025 VM_PAUSED Info VM USD{VmName} has been paused. 1026 FAILED_TO_STORE_ENTIRE_DISK_FIELD_IN_DISK_DESCRIPTION_METADATA Warning Failed to store field USD{DiskFieldName} as a part of USD{DiskAlias}'s description metadata due to storage space limitations. The field USD{DiskFieldName} will be truncated. 1027 FAILED_TO_STORE_ENTIRE_DISK_FIELD_AND_REST_OF_FIELDS_IN_DISK_DESCRIPTION_METADATA Warning Failed to store field USD{DiskFieldName} as a part of USD{DiskAlias}'s description metadata due to storage space limitations. The value will be truncated and the following fields will not be stored at all: USD{DiskFieldsNames}. 1028 FAILED_TO_STORE_DISK_FIELDS_IN_DISK_DESCRIPTION_METADATA Warning Failed to store the following fields in the description metadata of disk USD{DiskAlias} due to storage space limitations: USD{DiskFieldsNames}. 1029 STORAGE_DOMAIN_MOVED_TO_MAINTENANCE Info Storage Domain USD{StorageDomainName} (Data Center USD{StoragePoolName}) successfully moved to Maintenance as it's no longer accessed by any Host of the Data Center. 1030 USER_DEACTIVATED_LAST_MASTER_STORAGE_DOMAIN Info Storage Domain USD{StorageDomainName} (Data Center USD{StoragePoolName}) was deactivated. 1031 TRANSFER_IMAGE_INITIATED Info Image USD{TransferType} with disk USD{DiskAlias} was initiated by USD{UserName}. 1032 TRANSFER_IMAGE_SUCCEEDED Info Image USD{TransferType} with disk USD{DiskAlias} succeeded. 1033 TRANSFER_IMAGE_CANCELLED Info Image USD{TransferType} with disk USD{DiskAlias} was cancelled. 1034 TRANSFER_IMAGE_FAILED Error Image USD{TransferType} with disk USD{DiskAlias} failed. 1035 TRANSFER_IMAGE_TEARDOWN_FAILED Info Failed to tear down image USD{DiskAlias} after image transfer session. 1036 USER_SCAN_STORAGE_DOMAIN_FOR_UNREGISTERED_DISKS Info Storage Domain USD{StorageDomainName} has finished to scan for unregistered disks by USD{UserName}. 1037 USER_SCAN_STORAGE_DOMAIN_FOR_UNREGISTERED_DISKS_FAILED Error Storage Domain USD{StorageDomainName} failed to scan for unregistered disks by USD{UserName}. 1039 LUNS_BROKE_SD_PASS_DISCARD_SUPPORT Warning Luns with IDs: [USD{LunsIds}] were updated in the DB but caused the storage domain USD{StorageDomainName} (ID USD{storageDomainId}) to stop supporting passing discard from the guest to the underlying storage. Please configure these luns' discard support in the underlying storage or disable 'Enable Discard' for vm disks on this storage domain. 1040 DISKS_WITH_ILLEGAL_PASS_DISCARD_EXIST Warning Disks with IDs: [USD{DisksIds}] have their 'Enable Discard' on even though the underlying storage does not support it. Please configure the underlying storage to support discard or disable 'Enable Discard' for these disks. 1041 USER_REMOVE_DEVICE_FROM_STORAGE_DOMAIN_FAILED Error Failed to remove USD{LunId} from Storage Domain USD{StorageDomainName}. (User: USD{UserName}) 1042 USER_REMOVE_DEVICE_FROM_STORAGE_DOMAIN Info USD{LunId} was removed from Storage Domain USD{StorageDomainName}. (User: USD{UserName}) 1043 USER_REMOVE_DEVICE_FROM_STORAGE_DOMAIN_STARTED Info Started to remove USD{LunId} from Storage Domain USD{StorageDomainName}. (User: USD{UserName}) 1044 ILLEGAL_STORAGE_DOMAIN_DISCARD_AFTER_DELETE Warning The storage domain with id USD{storageDomainId} has its 'Discard After Delete' enabled even though the underlying storage does not support discard. Therefore, disks and snapshots on this storage domain will not be discarded before they are removed. 1045 LUNS_BROKE_SD_DISCARD_AFTER_DELETE_SUPPORT Warning Luns with IDs: [USD{LunsIds}] were updated in the DB but caused the storage domain USD{StorageDomainName} (ID USD{storageDomainId}) to stop supporting discard after delete. Please configure these luns' discard support in the underlying storage or disable 'Discard After Delete' for this storage domain. 1046 STORAGE_DOMAINS_COULD_NOT_BE_SYNCED Info Storage domains with IDs [USD{StorageDomainsIds}] could not be synchronized. To synchronize them, please move them to maintenance and then activate. 1048 DIRECT_LUNS_COULD_NOT_BE_SYNCED Info Direct LUN disks with IDs [USD{DirectLunDisksIds}] could not be synchronized because there was no active host in the data center. Please synchronize them to get their latest information from the storage. 1052 OVF_STORES_UPDATE_IGNORED Normal OVFs update was ignored - nothing to update for storage domain 'USD{StorageDomainName}' 1060 UPLOAD_IMAGE_CLIENT_ERROR Error Unable to upload image to disk USD{DiskId} due to a client error. Make sure the selected file is readable. 1061 UPLOAD_IMAGE_XHR_TIMEOUT_ERROR Error Unable to upload image to disk USD{DiskId} due to a request timeout error. The upload bandwidth might be too slow. Please try to reduce the chunk size: 'engine-config -s UploadImageChunkSizeKB 1062 UPLOAD_IMAGE_NETWORK_ERROR Error Unable to upload image to disk USD{DiskId} due to a network error. Ensure that ovirt-imageio service is installed and configured and that ovirt-engine's CA certificate is registered as a trusted CA in the browser. The certificate can be fetched from USD{EngineUrl}/ovirt-engine/services/pki-resource?resource 1063 DOWNLOAD_IMAGE_NETWORK_ERROR Error Unable to download disk USD{DiskId} due to a network error. Make sure ovirt-imageio service is installed and configured, and ovirt-engine's certificate is registered as a valid CA in the browser. The certificate can be fetched from https://<engine_url>/ovirt-engine/services/pki-resource?resource 1064 TRANSFER_IMAGE_STOPPED_BY_SYSTEM_TICKET_RENEW_FAILURE Error Transfer was stopped by system. Reason: failure in transfer image ticket renewal. 1065 TRANSFER_IMAGE_STOPPED_BY_SYSTEM_MISSING_TICKET Error Transfer was stopped by system. Reason: missing transfer image ticket. 1067 TRANSFER_IMAGE_STOPPED_BY_SYSTEM_MISSING_HOST Error Transfer was stopped by system. Reason: Could not find a suitable host for image data transfer. 1068 TRANSFER_IMAGE_STOPPED_BY_SYSTEM_FAILED_TO_CREATE_TICKET Error Transfer was stopped by system. Reason: failed to create a signed image ticket. 1069 TRANSFER_IMAGE_STOPPED_BY_SYSTEM_FAILED_TO_ADD_TICKET_TO_DAEMON Error Transfer was stopped by system. Reason: failed to add image ticket to ovirt-imageio-daemon. 1070 TRANSFER_IMAGE_STOPPED_BY_SYSTEM_FAILED_TO_ADD_TICKET_TO_PROXY Error Transfer was stopped by system. Reason: failed to add image ticket to ovirt-imageio. 1071 UPLOAD_IMAGE_PAUSED_BY_SYSTEM_TIMEOUT Error Upload was paused by system. Reason: timeout due to transfer inactivity. 1072 DOWNLOAD_IMAGE_CANCELED_TIMEOUT Error Download was canceled by system. Reason: timeout due to transfer inactivity. 1073 TRANSFER_IMAGE_PAUSED_BY_USER Normal Image transfer was paused by user (USD{UserName}). 1074 TRANSFER_IMAGE_RESUMED_BY_USER Normal Image transfer was resumed by user (USD{UserName}). 1098 NETWORK_UPDATE_DISPLAY_FOR_HOST_WITH_ACTIVE_VM Warning Display Network was updated on Host USD{VdsName} with active VMs attached. The change will be applied to those VMs after their reboot. Running VMs might loose display connectivity until then. 1099 NETWORK_UPDATE_DISPLAY_FOR_CLUSTER_WITH_ACTIVE_VM Warning Display Network (USD{NetworkName}) was updated for Cluster USD{ClusterName} with active VMs attached. The change will be applied to those VMs after their reboot. 1100 NETWORK_UPDATE_DISPLAY_TO_CLUSTER Info Update Display Network (USD{NetworkName}) for Cluster USD{ClusterName}. (User: USD{UserName}) 1101 NETWORK_UPDATE_DISPLAY_TO_CLUSTER_FAILED Error Failed to update Display Network (USD{NetworkName}) for Cluster USD{ClusterName}. (User: USD{UserName}) 1102 NETWORK_UPDATE_NETWORK_TO_VDS_INTERFACE Info Update Network USD{NetworkName} in Host USD{VdsName}. (User: USD{UserName}) 1103 NETWORK_UPDATE_NETWORK_TO_VDS_INTERFACE_FAILED Error Failed to update Network USD{NetworkName} in Host USD{VdsName}. (User: USD{UserName}) 1104 NETWORK_COMMINT_NETWORK_CHANGES Info Network changes were saved on host USD{VdsName} 1105 NETWORK_COMMINT_NETWORK_CHANGES_FAILED Error Failed to commit network changes on USD{VdsName} 1106 NETWORK_HOST_USING_WRONG_CLUSER_VLAN Warning USD{VdsName} is having wrong vlan id: USD{VlanIdHost}, expected vlan id: USD{VlanIdCluster} 1107 NETWORK_HOST_MISSING_CLUSER_VLAN Warning USD{VdsName} is missing vlan id: USD{VlanIdCluster} that is expected by the cluster 1108 VDS_NETWORK_MTU_DIFFER_FROM_LOGICAL_NETWORK Info 1109 BRIDGED_NETWORK_OVER_MULTIPLE_INTERFACES Warning Bridged network USD{NetworkName} is attached to multiple interfaces: USD{Interfaces} on Host USD{VdsName}. 1110 VDS_NETWORKS_OUT_OF_SYNC Warning Host USD{VdsName}'s following network(s) are not synchronized with their Logical Network configuration: USD{Networks}. 1111 VM_MIGRATION_FAILED_DURING_MOVE_TO_MAINTENANCE_NO_DESTINATION_VDS Error Migration failedUSD{DueToMigrationError} while Source Host is in 'preparing for maintenance' state.\n Consider manual intervention\: stopping/migrating Vms as Host's state will not\n turn to maintenance while VMs are still running on it.(VM: USD{VmName}, Source: USD{VdsName}). 1112 NETWORK_UPDTAE_NETWORK_ON_CLUSTER Info Network USD{NetworkName} on Cluster USD{ClusterName} updated. 1113 NETWORK_UPDTAE_NETWORK_ON_CLUSTER_FAILED Error Failed to update Network USD{NetworkName} on Cluster USD{ClusterName}. 1114 NETWORK_UPDATE_NETWORK Info Network USD{NetworkName} was updated on Data Center: USD{StoragePoolName} 1115 NETWORK_UPDATE_NETWORK_FAILED Error Failed to update Network USD{NetworkName} on Data Center: USD{StoragePoolName} 1116 NETWORK_UPDATE_VM_INTERFACE_LINK_UP Info Link State is UP. 1117 NETWORK_UPDATE_VM_INTERFACE_LINK_DOWN Info Link State is DOWN. 1118 INVALID_BOND_INTERFACE_FOR_MANAGEMENT_NETWORK_CONFIGURATION Error Failed to configure management network on host USD{VdsName}. Host USD{VdsName} has an invalid bond interface (USD{InterfaceName} contains less than 2 active slaves) for the management network configuration. 1119 VLAN_ID_MISMATCH_FOR_MANAGEMENT_NETWORK_CONFIGURATION Error Failed to configure management network on host USD{VdsName}. Host USD{VdsName} has an interface USD{InterfaceName} for the management network configuration with VLAN-ID (USD{VlanId}), which is different from data-center definition (USD{MgmtVlanId}). 1120 SETUP_NETWORK_FAILED_FOR_MANAGEMENT_NETWORK_CONFIGURATION Error Failed to configure management network on host USD{VdsName} due to setup networks failure. 1121 PERSIST_NETWORK_FAILED_FOR_MANAGEMENT_NETWORK Warning Failed to configure management network on host USD{VdsName} due to failure in persisting the management network configuration. 1122 ADD_VNIC_PROFILE Info VM network interface profile USD{VnicProfileName} was added to network USD{NetworkName} in Data Center: USD{DataCenterName}. (User: USD{UserName}) 1123 ADD_VNIC_PROFILE_FAILED Error Failed to add VM network interface profile USD{VnicProfileName} to network USD{NetworkName} in Data Center: USD{DataCenterName} (User: USD{UserName}) 1124 UPDATE_VNIC_PROFILE Info VM network interface profile USD{VnicProfileName} was updated for network USD{NetworkName} in Data Center: USD{DataCenterName}. (User: USD{UserName}) 1125 UPDATE_VNIC_PROFILE_FAILED Error Failed to update VM network interface profile USD{VnicProfileName} for network USD{NetworkName} in Data Center: USD{DataCenterName}. (User: USD{UserName}) 1126 REMOVE_VNIC_PROFILE Info VM network interface profile USD{VnicProfileName} was removed from network USD{NetworkName} in Data Center: USD{DataCenterName}. (User: USD{UserName}) 1127 REMOVE_VNIC_PROFILE_FAILED Error Failed to remove VM network interface profile USD{VnicProfileName} from network USD{NetworkName} in Data Center: USD{DataCenterName}. (User: USD{UserName}) 1128 NETWORK_WITHOUT_INTERFACES Warning Network USD{NetworkName} is not attached to any interface on host USD{VdsName}. 1129 VNIC_PROFILE_UNSUPPORTED_FEATURES Warning VM USD{VmName} has network interface USD{NicName} which is using profile USD{VnicProfile} with unsupported feature(s) 'USD{UnsupportedFeatures}' by VM cluster USD{ClusterName} (version USD{CompatibilityVersion}). 1131 REMOVE_NETWORK_BY_LABEL_FAILED Error Network USD{Network} cannot be removed from the following hosts: USD{HostNames} in data-center USD{StoragePoolName}. 1132 LABEL_NETWORK Info Network USD{NetworkName} was labeled USD{Label} in data-center USD{StoragePoolName}. 1133 LABEL_NETWORK_FAILED Error Failed to label network USD{NetworkName} with label USD{Label} in data-center USD{StoragePoolName}. 1134 UNLABEL_NETWORK Info Network USD{NetworkName} was unlabeled in data-center USD{StoragePoolName}. 1135 UNLABEL_NETWORK_FAILED Error Failed to unlabel network USD{NetworkName} in data-center USD{StoragePoolName}. 1136 LABEL_NIC Info Network interface card USD{NicName} was labeled USD{Label} on host USD{VdsName}. 1137 LABEL_NIC_FAILED Error Failed to label network interface card USD{NicName} with label USD{Label} on host USD{VdsName}. 1138 UNLABEL_NIC Info Label USD{Label} was removed from network interface card USD{NicName} on host USD{VdsName}. 1139 UNLABEL_NIC_FAILED Error Failed to remove label USD{Label} from network interface card USD{NicName} on host USD{VdsName}. 1140 SUBNET_REMOVED Info Subnet USD{SubnetName} was removed from provider USD{ProviderName}. (User: USD{UserName}) 1141 SUBNET_REMOVAL_FAILED Error Failed to remove subnet USD{SubnetName} from provider USD{ProviderName}. (User: USD{UserName}) 1142 SUBNET_ADDED Info Subnet USD{SubnetName} was added on provider USD{ProviderName}. (User: USD{UserName}) 1143 SUBNET_ADDITION_FAILED Error Failed to add subnet USD{SubnetName} on provider USD{ProviderName}. (User: USD{UserName}) 1144 CONFIGURE_NETWORK_BY_LABELS_WHEN_CHANGING_CLUSTER_FAILED Error Failed to configure networks on host USD{VdsName} while changing its cluster. 1145 PERSIST_NETWORK_ON_HOST Info (USD{Sequence}/USD{Total}): Applying changes for network(s) USD{NetworkNames} on host USD{VdsName}. (User: USD{UserName}) 1146 PERSIST_NETWORK_ON_HOST_FINISHED Info (USD{Sequence}/USD{Total}): Successfully applied changes for network(s) USD{NetworkNames} on host USD{VdsName}. (User: USD{UserName}) 1147 PERSIST_NETWORK_ON_HOST_FAILED Error (USD{Sequence}/USD{Total}): Failed to apply changes for network(s) USD{NetworkNames} on host USD{VdsName}. (User: USD{UserName}) 1148 MULTI_UPDATE_NETWORK_NOT_POSSIBLE Warning Cannot apply network USD{NetworkName} changes to hosts on unsupported data center USD{StoragePoolName}. (User: USD{UserName}) 1149 REMOVE_PORT_FROM_EXTERNAL_PROVIDER_FAILED Warning Failed to remove vNIC USD{NicName} from external network provider USD{ProviderName}. The vNIC can be identified on the provider by device id USD{NicId}. 1150 IMPORTEXPORT_EXPORT_VM Info Vm USD{VmName} was exported successfully to USD{StorageDomainName} 1151 IMPORTEXPORT_EXPORT_VM_FAILED Error Failed to export Vm USD{VmName} to USD{StorageDomainName} 1152 IMPORTEXPORT_IMPORT_VM Info Vm USD{VmName} was imported successfully to Data Center USD{StoragePoolName}, Cluster USD{ClusterName} 1153 IMPORTEXPORT_IMPORT_VM_FAILED Error Failed to import Vm USD{VmName} to Data Center USD{StoragePoolName}, Cluster USD{ClusterName} 1154 IMPORTEXPORT_REMOVE_TEMPLATE Info Template USD{VmTemplateName} was removed from USD{StorageDomainName} 1155 IMPORTEXPORT_REMOVE_TEMPLATE_FAILED Error Failed to remove Template USD{VmTemplateName} from USD{StorageDomainName} 1156 IMPORTEXPORT_EXPORT_TEMPLATE Info Template USD{VmTemplateName} was exported successfully to USD{StorageDomainName} 1157 IMPORTEXPORT_EXPORT_TEMPLATE_FAILED Error Failed to export Template USD{VmTemplateName} to USD{StorageDomainName} 1158 IMPORTEXPORT_IMPORT_TEMPLATE Info Template USD{VmTemplateName} was imported successfully to Data Center USD{StoragePoolName}, Cluster USD{ClusterName} 1159 IMPORTEXPORT_IMPORT_TEMPLATE_FAILED Error Failed to import Template USD{VmTemplateName} to Data Center USD{StoragePoolName}, Cluster USD{ClusterName} 1160 IMPORTEXPORT_REMOVE_VM Info Vm USD{VmName} was removed from USD{StorageDomainName} 1161 IMPORTEXPORT_REMOVE_VM_FAILED Error Failed to remove Vm USD{VmName} remove from USD{StorageDomainName} 1162 IMPORTEXPORT_STARTING_EXPORT_VM Info Starting export Vm USD{VmName} to USD{StorageDomainName} 1163 IMPORTEXPORT_STARTING_IMPORT_TEMPLATE Info Starting to import Template USD{VmTemplateName} to Data Center USD{StoragePoolName}, Cluster USD{ClusterName} 1164 IMPORTEXPORT_STARTING_EXPORT_TEMPLATE Info Starting to export Template USD{VmTemplateName} to USD{StorageDomainName} 1165 IMPORTEXPORT_STARTING_IMPORT_VM Info Starting to import Vm USD{VmName} to Data Center USD{StoragePoolName}, Cluster USD{ClusterName} 1166 IMPORTEXPORT_STARTING_REMOVE_TEMPLATE Info Starting to remove Template USD{VmTemplateName} remove USD{StorageDomainName} 1167 IMPORTEXPORT_STARTING_REMOVE_VM Info Starting to remove Vm USD{VmName} remove from USD{StorageDomainName} 1168 IMPORTEXPORT_FAILED_TO_IMPORT_VM Warning Failed to read VM 'USD{ImportedVmName}' OVF, it may be corrupted. Underlying error message: USD{ErrorMessage} 1169 IMPORTEXPORT_FAILED_TO_IMPORT_TEMPLATE Warning Failed to read Template 'USD{Template}' OVF, it may be corrupted. Underlying error message: USD{ErrorMessage} 1170 IMPORTEXPORT_IMPORT_TEMPLATE_INVALID_INTERFACES Normal While importing Template USD{EntityName}, the Network/s USD{Networks} were found to be Non-VM Networks or do not exist in Cluster. Network Name was not set in the Interface/s USD{Interfaces}. 1171 USER_ACCOUNT_PASSWORD_EXPIRED Error User USD{UserName} cannot login, as the user account password has expired. Please contact the system administrator. 1172 AUTH_FAILED_INVALID_CREDENTIALS Error User USD{UserName} cannot login, please verify the username and password. 1173 AUTH_FAILED_CLOCK_SKEW_TOO_GREAT Error User USD{UserName} cannot login, the engine clock is not synchronized with directory services. Please contact the system administrator. 1174 AUTH_FAILED_NO_KDCS_FOUND Error User USD{UserName} cannot login, authentication domain cannot be found. Please contact the system administrator. 1175 AUTH_FAILED_DNS_ERROR Error User USD{UserName} cannot login, there's an error in DNS configuration. Please contact the system administrator. 1176 AUTH_FAILED_OTHER Error User USD{UserName} cannot login, unknown kerberos error. Please contact the system administrator. 1177 AUTH_FAILED_DNS_COMMUNICATION_ERROR Error User USD{UserName} cannot login, cannot lookup DNS for SRV records. Please contact the system administrator. 1178 AUTH_FAILED_CONNECTION_TIMED_OUT Error User USD{UserName} cannot login, connection to LDAP server has timed out. Please contact the system administrator. 1179 AUTH_FAILED_WRONG_REALM Error User USD{UserName} cannot login, please verify your domain name. 1180 AUTH_FAILED_CONNECTION_ERROR Error User USD{UserName} cannot login, connection refused or some configuration problems exist. Possible DNS error. Please contact the system administrator. 1181 AUTH_FAILED_CANNOT_FIND_LDAP_SERVER_FOR_DOMAIN Error User USD{UserName} cannot login, cannot find valid LDAP server for domain. Please contact the system administrator. 1182 AUTH_FAILED_NO_USER_INFORMATION_WAS_FOUND Error User USD{UserName} cannot login, no user information was found. Please contact the system administrator. 1183 AUTH_FAILED_CLIENT_NOT_FOUND_IN_KERBEROS_DATABASE Error User USD{UserName} cannot login, user was not found in domain. Please contact the system administrator. 1184 AUTH_FAILED_INTERNAL_KERBEROS_ERROR Error User USD{UserName} cannot login, an internal error has ocurred in the Kerberos implementation of the JVM. Please contact the system administrator. 1185 USER_ACCOUNT_EXPIRED Error The account for USD{UserName} got expired. Please contact the system administrator. 1186 IMPORTEXPORT_NO_PROXY_HOST_AVAILABLE_IN_DC Error No Host in Data Center 'USD{StoragePoolName}' can serve as a proxy to retrieve remote VMs information (User: USD{UserName}). 1187 IMPORTEXPORT_HOST_CANNOT_SERVE_AS_PROXY Error Host USD{VdsName} cannot be used as a proxy to retrieve remote VMs information since it is not up (User: USD{UserName}). 1188 IMPORTEXPORT_PARTIAL_VM_MISSING_ENTITIES Warning The following entities could not be verified and will not be part of the imported VM USD{VmName}: 'USD{MissingEntities}' (User: USD{UserName}). 1189 IMPORTEXPORT_IMPORT_VM_FAILED_UPDATING_OVF Error Failed to import Vm USD{VmName} to Data Center USD{StoragePoolName}, Cluster USD{ClusterName}, could not update VM data in export. 1190 USER_RESTORE_FROM_SNAPSHOT_START Info Restoring VM USD{VmName} from snapshot started by user USD{UserName}. 1191 VM_DISK_ALREADY_CHANGED Info CD USD{DiskName} is already inserted to VM USD{VmName}, disk change action was skipped. User: USD{UserName}. 1192 VM_DISK_ALREADY_EJECTED Info CD is already ejected from VM USD{VmName}, disk change action was skipped. User: USD{UserName}. 1193 IMPORTEXPORT_STARTING_CONVERT_VM Info Starting to convert Vm USD{VmName} 1194 IMPORTEXPORT_CONVERT_FAILED Info Failed to convert Vm USD{VmName} 1195 IMPORTEXPORT_CANNOT_GET_OVF Info Failed to get the configuration of converted Vm USD{VmName} 1196 IMPORTEXPORT_INVALID_OVF Info Failed to process the configuration of converted Vm USD{VmName} 1197 IMPORTEXPORT_PARTIAL_TEMPLATE_MISSING_ENTITIES Warning The following entities could not be verified and will not be part of the imported Template USD{VmTemplateName}: 'USD{MissingEntities}' (User: USD{UserName}). 1200 ENTITY_RENAMED Info USD{EntityType} USD{OldEntityName} was renamed from USD{OldEntityName} to USD{NewEntityName} by USD{UserName}. 1201 UPDATE_HOST_NIC_VFS_CONFIG Info The VFs configuration of network interface card USD{NicName} on host USD{VdsName} was updated. 1202 UPDATE_HOST_NIC_VFS_CONFIG_FAILED Error Failed to update the VFs configuration of network interface card USD{NicName} on host USD{VdsName}. 1203 ADD_VFS_CONFIG_NETWORK Info Network USD{NetworkName} was added to the VFs configuration of network interface card USD{NicName} on host USD{VdsName}. 1204 ADD_VFS_CONFIG_NETWORK_FAILED Info Failed to add USD{NetworkName} to the VFs configuration of network interface card USD{NicName} on host USD{VdsName}. 1205 REMOVE_VFS_CONFIG_NETWORK Info Network USD{NetworkName} was removed from the VFs configuration of network interface card USD{NicName} on host USD{VdsName}. 1206 REMOVE_VFS_CONFIG_NETWORK_FAILED Info Failed to remove USD{NetworkName} from the VFs configuration of network interface card USD{NicName} on host USD{VdsName}. 1207 ADD_VFS_CONFIG_LABEL Info Label USD{Label} was added to the VFs configuration of network interface card USD{NicName} on host USD{VdsName}. 1208 ADD_VFS_CONFIG_LABEL_FAILED Info Failed to add USD{Label} to the VFs configuration of network interface card USD{NicName} on host USD{VdsName}. 1209 REMOVE_VFS_CONFIG_LABEL Info Label USD{Label} was removed from the VFs configuration of network interface card USD{NicName} on host USD{VdsName}. 1210 REMOVE_VFS_CONFIG_LABEL_FAILED Info Failed to remove USD{Label} from the VFs configuration of network interface card USD{NicName} on host USD{VdsName}. 1211 USER_REDUCE_DOMAIN_DEVICES_STARTED Info Started to reduce Storage USD{StorageDomainName} devices. (User: USD{UserName}). 1212 USER_REDUCE_DOMAIN_DEVICES_FAILED_METADATA_DEVICES Error Failed to reduce Storage USD{StorageDomainName}. The following devices contains the domain metadata USD{deviceIds} and can't be reduced from the domain. (User: USD{UserName}). 1213 USER_REDUCE_DOMAIN_DEVICES_FAILED Error Failed to reduce Storage USD{StorageDomainName}. (User: USD{UserName}). 1214 USER_REDUCE_DOMAIN_DEVICES_SUCCEEDED Info Storage USD{StorageDomainName} has been reduced. (User: USD{UserName}). 1215 USER_REDUCE_DOMAIN_DEVICES_FAILED_NO_FREE_SPACE Error Can't reduce Storage USD{StorageDomainName}. There is not enough space on the destination devices of the storage domain. (User: USD{UserName}). 1216 USER_REDUCE_DOMAIN_DEVICES_FAILED_TO_GET_DOMAIN_INFO Error Can't reduce Storage USD{StorageDomainName}. Failed to get the domain info. (User: USD{UserName}). 1217 CANNOT_IMPORT_VM_WITH_LEASE_COMPAT_VERSION Warning The VM USD{VmName} has a VM lease defined yet will be imported without it as the VM compatibility version does not support VM leases. 1218 CANNOT_IMPORT_VM_WITH_LEASE_STORAGE_DOMAIN Warning The VM USD{VmName} has a VM lease defined yet will be imported without it as the Storage Domain for the lease does not exist or is not active. 1219 FAILED_DETERMINE_STORAGE_DOMAIN_METADATA_DEVICES Error Failed to determine the metadata devices of Storage Domain USD{StorageDomainName}. 1220 HOT_PLUG_LEASE_FAILED Error Failed to hot plug lease to the VM USD{VmName}. The VM is running without a VM lease. 1221 HOT_UNPLUG_LEASE_FAILED Error Failed to hot unplug lease to the VM USD{VmName}. 1222 DETACH_DOMAIN_WITH_VMS_AND_TEMPLATES_LEASES Warning The deactivated domain USD{storageDomainName} contained leases for the following VMs/Templates: USD{entitiesNames}, a part of those VMs will not run and need manual removal of the VM leases. 1223 IMPORTEXPORT_STARTING_EXPORT_VM_TO_OVA Info Starting to export Vm USD{VmName} as a Virtual Appliance 1224 IMPORTEXPORT_EXPORT_VM_TO_OVA Info Vm USD{VmName} was exported successfully as a Virtual Appliance to path USD{OvaPath} on Host USD{VdsName} 1225 IMPORTEXPORT_EXPORT_VM_TO_OVA_FAILED Error Failed to export Vm USD{VmName} as a Virtual Appliance to path USD{OvaPath} on Host USD{VdsName} 1226 IMPORTEXPORT_STARTING_EXPORT_TEMPLATE_TO_OVA Info Starting to export Template USD{VmTemplateName} as a Virtual Appliance 1227 IMPORTEXPORT_EXPORT_TEMPLATE_TO_OVA Info Template USD{VmTemplateName} was exported successfully as a Virtual Appliance to path USD{OvaPath} on Host USD{VdsName} 1228 IMPORTEXPORT_EXPORT_TEMPLATE_TO_OVA_FAILED Error Failed to export Template USD{VmTemplateName} as a Virtual Appliance to path USD{OvaPath} on Host USD{VdsName} 1300 NUMA_ADD_VM_NUMA_NODE_SUCCESS Info Add VM NUMA node successfully. 1301 NUMA_ADD_VM_NUMA_NODE_FAILED Error Add VM NUMA node failed. 1310 NUMA_UPDATE_VM_NUMA_NODE_SUCCESS Info Update VM NUMA node successfully. 1311 NUMA_UPDATE_VM_NUMA_NODE_FAILED Error Update VM NUMA node failed. 1320 NUMA_REMOVE_VM_NUMA_NODE_SUCCESS Info Remove VM NUMA node successfully. 1321 NUMA_REMOVE_VM_NUMA_NODE_FAILED Error Remove VM NUMA node failed. 1322 USER_ADD_VM_TEMPLATE_CREATE_TEMPLATE_FAILURE Error Failed to create Template USD{VmTemplateName} or its disks from VM USD{VmName}. 1323 USER_ADD_VM_TEMPLATE_ASSIGN_ILLEGAL_FAILURE Error Failed preparing Template USD{VmTemplateName} for sealing (VM: USD{VmName}). 1324 USER_ADD_VM_TEMPLATE_SEAL_FAILURE Error Failed to seal Template USD{VmTemplateName} (VM: USD{VmName}). 1325 USER_SPARSIFY_IMAGE_START Info Started to sparsify USD{DiskAlias} 1326 USER_SPARSIFY_IMAGE_FINISH_SUCCESS Info USD{DiskAlias} sparsified successfully. 1327 USER_SPARSIFY_IMAGE_FINISH_FAILURE Error Failed to sparsify USD{DiskAlias}. 1328 USER_AMEND_IMAGE_START Info Started to amend USD{DiskAlias} 1329 USER_AMEND_IMAGE_FINISH_SUCCESS Info USD{DiskAlias} has been amended successfully. 1330 USER_AMEND_IMAGE_FINISH_FAILURE Error Failed to amend USD{DiskAlias}. 1340 VM_DOES_NOT_FIT_TO_SINGLE_NUMA_NODE Warning VM USD{VmName} does not fit to a single NUMA node on host USD{HostName}. This may negatively impact its performance. Consider using vNUMA and NUMA pinning for this VM. 1400 ENTITY_RENAMED_INTERNALLY Info USD{EntityType} USD{OldEntityName} was renamed from USD{OldEntityName} to USD{NewEntityName}. 1402 USER_LOGIN_ON_BEHALF_FAILED Error Failed to execute login on behalf - USD{LoginOnBehalfLogInfo}. 1403 IRS_CONFIRMED_DISK_SPACE_LOW Warning Warning, low confirmed disk space. USD{StorageDomainName} domain has USD{DiskSpace} GB of confirmed free space. 2000 USER_HOTPLUG_DISK Info VM USD{VmName} disk USD{DiskAlias} was plugged by USD{UserName}. 2001 USER_FAILED_HOTPLUG_DISK Error Failed to plug disk USD{DiskAlias} to VM USD{VmName} (User: USD{UserName}). 2002 USER_HOTUNPLUG_DISK Info VM USD{VmName} disk USD{DiskAlias} was unplugged by USD{UserName}. 2003 USER_FAILED_HOTUNPLUG_DISK Error Failed to unplug disk USD{DiskAlias} from VM USD{VmName} (User: USD{UserName}). 2004 USER_COPIED_DISK Info User USD{UserName} is copying disk USD{DiskAlias} to domain USD{StorageDomainName}. 2005 USER_FAILED_COPY_DISK Error User USD{UserName} failed to copy disk USD{DiskAlias} to domain USD{StorageDomainName}. 2006 USER_COPIED_DISK_FINISHED_SUCCESS Info User USD{UserName} finished copying disk USD{DiskAlias} to domain USD{StorageDomainName}. 2007 USER_COPIED_DISK_FINISHED_FAILURE Error User USD{UserName} finished with error copying disk USD{DiskAlias} to domain USD{StorageDomainName}. 2008 USER_MOVED_DISK Info User USD{UserName} moving disk USD{DiskAlias} to domain USD{StorageDomainName}. 2009 USER_FAILED_MOVED_VM_DISK Error User USD{UserName} failed to move disk USD{DiskAlias} to domain USD{StorageDomainName}. 2010 USER_MOVED_DISK_FINISHED_SUCCESS Info User USD{UserName} finished moving disk USD{DiskAlias} to domain USD{StorageDomainName}. 2011 USER_MOVED_DISK_FINISHED_FAILURE Error User USD{UserName} have failed to move disk USD{DiskAlias} to domain USD{StorageDomainName}. 2012 USER_FINISHED_REMOVE_DISK_NO_DOMAIN Info Disk USD{DiskAlias} was successfully removed (User USD{UserName}). 2013 USER_FINISHED_FAILED_REMOVE_DISK_NO_DOMAIN Warning Failed to remove disk USD{DiskAlias} (User USD{UserName}). 2014 USER_FINISHED_REMOVE_DISK Info Disk USD{DiskAlias} was successfully removed from domain USD{StorageDomainName} (User USD{UserName}). 2015 USER_FINISHED_FAILED_REMOVE_DISK Warning Failed to remove disk USD{DiskAlias} from storage domain USD{StorageDomainName} (User: USD{UserName}). 2016 USER_ATTACH_DISK_TO_VM Info Disk USD{DiskAlias} was successfully attached to VM USD{VmName} by USD{UserName}. 2017 USER_FAILED_ATTACH_DISK_TO_VM Error Failed to attach Disk USD{DiskAlias} to VM USD{VmName} (User: USD{UserName}). 2018 USER_DETACH_DISK_FROM_VM Info Disk USD{DiskAlias} was successfully detached from VM USD{VmName} by USD{UserName}. 2019 USER_FAILED_DETACH_DISK_FROM_VM Error Failed to detach Disk USD{DiskAlias} from VM USD{VmName} (User: USD{UserName}). 2020 USER_ADD_DISK Info Add-Disk operation of 'USD{DiskAlias}' was initiated by USD{UserName}. 2021 USER_ADD_DISK_FINISHED_SUCCESS Info The disk 'USD{DiskAlias}' was successfully added. 2022 USER_ADD_DISK_FINISHED_FAILURE Error Add-Disk operation failed to complete. 2023 USER_FAILED_ADD_DISK Error Add-Disk operation failed (User: USD{UserName}). 2024 USER_RUN_UNLOCK_ENTITY_SCRIPT Info 2025 USER_MOVE_IMAGE_GROUP_FAILED_TO_DELETE_SRC_IMAGE Warning Possible failure while deleting USD{DiskAlias} from the source Storage Domain USD{StorageDomainName} during the move operation. The Storage Domain may be manually cleaned-up from possible leftovers (User:USD{UserName}). 2026 USER_MOVE_IMAGE_GROUP_FAILED_TO_DELETE_DST_IMAGE Warning Possible failure while clearing possible leftovers of USD{DiskAlias} from the target Storage Domain USD{StorageDomainName} after the move operation failed to copy the image to it properly. The Storage Domain may be manually cleaned-up from possible leftovers (User:USD{UserName}). 2027 USER_IMPORT_IMAGE Info User USD{UserName} importing image USD{RepoImageName} to domain USD{StorageDomainName}. 2028 USER_IMPORT_IMAGE_FINISHED_SUCCESS Info User USD{UserName} successfully imported image USD{RepoImageName} to domain USD{StorageDomainName}. 2029 USER_IMPORT_IMAGE_FINISHED_FAILURE Error User USD{UserName} failed to import image USD{RepoImageName} to domain USD{StorageDomainName}. 2030 USER_EXPORT_IMAGE Info User USD{UserName} exporting image USD{RepoImageName} to domain USD{DestinationStorageDomainName}. 2031 USER_EXPORT_IMAGE_FINISHED_SUCCESS Info User USD{UserName} successfully exported image USD{RepoImageName} to domain USD{DestinationStorageDomainName}. 2032 USER_EXPORT_IMAGE_FINISHED_FAILURE Error User USD{UserName} failed to export image USD{RepoImageName} to domain USD{DestinationStorageDomainName}. 2033 HOT_SET_NUMBER_OF_CPUS Info Hotplug CPU: changed the number of CPUs on VM USD{vmName} from USD{previousNumberOfCpus} to USD{numberOfCpus} 2034 FAILED_HOT_SET_NUMBER_OF_CPUS Error Failed to hot set number of CPUS to VM USD{vmName}. Underlying error message: USD{ErrorMessage} 2035 USER_ISCSI_BOND_HOST_RESTART_WARNING Warning The following Networks has been removed from the iSCSI bond USD{IscsiBondName}: USD{NetworkNames}. for those changes to take affect, the hosts must be moved to maintenance and activated again. 2036 ADD_DISK_INTERNAL Info Add-Disk operation of 'USD{DiskAlias}' was initiated by the system. 2037 ADD_DISK_INTERNAL_FAILURE Info Add-Disk operation of 'USD{DiskAlias}' failed to complete. 2038 USER_REMOVE_DISK_INITIATED Info Removal of Disk USD{DiskAlias} from domain USD{StorageDomainName} was initiated by USD{UserName}. 2039 HOT_SET_MEMORY Info Hotset memory: changed the amount of memory on VM USD{vmName} from USD{previousMem} to USD{newMem} 2040 FAILED_HOT_SET_MEMORY Error Failed to hot set memory to VM USD{vmName}. Underlying error message: USD{ErrorMessage} 2041 DISK_PREALLOCATION_FAILED Error 2042 USER_FINISHED_REMOVE_DISK_ATTACHED_TO_VMS Info Disk USD{DiskAlias} associated to the VMs USD{VmNames} was successfully removed from domain USD{StorageDomainName} (User USD{UserName}). 2043 USER_FINISHED_REMOVE_DISK_ATTACHED_TO_VMS_NO_DOMAIN Info Disk USD{DiskAlias} associated to the VMs USD{VmNames} was successfully removed (User USD{UserName}). 2044 USER_REMOVE_DISK_ATTACHED_TO_VMS_INITIATED Info Removal of Disk USD{DiskAlias} associated to the VMs USD{VmNames} from domain USD{StorageDomainName} was initiated by USD{UserName}. 2045 USER_COPY_IMAGE_GROUP_FAILED_TO_DELETE_DST_IMAGE Warning Possible failure while clearing possible leftovers of USD{DiskAlias} from the target Storage Domain USD{StorageDomainName} after the operation failed. The Storage Domain may be manually cleaned-up from possible leftovers (User:USD{UserName}). 2046 MEMORY_HOT_UNPLUG_SUCCESSFULLY_REQUESTED Info Hot unplug of memory device (USD{deviceId}) of size USD{memoryDeviceSizeMb}MB was successfully requested on VM 'USD{vmName}'. Physical memory guaranteed updated from USD{oldMinMemoryMb}MB to USD{newMinMemoryMb}MB}. 2047 MEMORY_HOT_UNPLUG_FAILED Error Failed to hot unplug memory device (USD{deviceId}) of size USD{memoryDeviceSizeMb}MiB out of VM 'USD{vmName}': USD{errorMessage} 2048 FAILED_HOT_SET_MEMORY_NOT_DIVIDABLE Error Failed to hot plug memory to VM USD{vmName}. Amount of added memory (USD{memoryAdded}MiB) is not dividable by USD{requiredFactor}MiB. 2049 MEMORY_HOT_UNPLUG_SUCCESSFULLY_REQUESTED_PLUS_MEMORY_INFO Info Hot unplug of memory device (USD{deviceId}) of size USD{memoryDeviceSizeMb}MiB was successfully requested on VM 'USD{vmName}'. Defined Memory updated from USD{oldMemoryMb}MiB to USD{newMemoryMb}MiB. Physical memory guaranteed updated from USD{oldMinMemoryMb}MiB to USD{newMinMemoryMb}MiB. 2050 NO_MEMORY_DEVICE_TO_HOT_UNPLUG Info Defined memory can't be decreased. There are no hot plugged memory devices on VM USD{vmName}. 2051 NO_SUITABLE_MEMORY_DEVICE_TO_HOT_UNPLUG Info There is no memory device to hot unplug to satisfy request to decrement memory from USD{oldMemoryMb}MiB to USD{newMemoryMB}MiB on VM USD{vmName}. Available memory devices (decremented memory sizes): USD{memoryHotUnplugOptions}. 3000 USER_ADD_QUOTA Info Quota USD{QuotaName} has been added by USD{UserName}. 3001 USER_FAILED_ADD_QUOTA Error Failed to add Quota USD{QuotaName}. The operation was initiated by USD{UserName}. 3002 USER_UPDATE_QUOTA Info Quota USD{QuotaName} has been updated by USD{UserName}. 3003 USER_FAILED_UPDATE_QUOTA Error Failed to update Quota USD{QuotaName}. The operation was initiated by USD{UserName}.. 3004 USER_DELETE_QUOTA Info Quota USD{QuotaName} has been deleted by USD{UserName}. 3005 USER_FAILED_DELETE_QUOTA Error Failed to delete Quota USD{QuotaName}. The operation was initiated by USD{UserName}.. 3006 USER_EXCEEDED_QUOTA_CLUSTER_GRACE_LIMIT Error Cluster-Quota USD{QuotaName} limit exceeded and operation was blocked. Utilization: USD{Utilization}, Requested: USD{Requested} - Please select a different quota or contact your administrator to extend the quota. 3007 USER_EXCEEDED_QUOTA_CLUSTER_LIMIT Warning Cluster-Quota USD{QuotaName} limit exceeded and entered the grace zone. Utilization: USD{Utilization} (It is advised to select a different quota or contact your administrator to extend the quota). 3008 USER_EXCEEDED_QUOTA_CLUSTER_THRESHOLD Warning Cluster-Quota USD{QuotaName} is about to exceed. Utilization: USD{Utilization} 3009 USER_EXCEEDED_QUOTA_STORAGE_GRACE_LIMIT Error Storage-Quota USD{QuotaName} limit exceeded and operation was blocked. Utilization(used/requested): USD{CurrentStorage}%/USD{Requested}% - Please select a different quota or contact your administrator to extend the quota. 3010 USER_EXCEEDED_QUOTA_STORAGE_LIMIT Warning Storage-Quota USD{QuotaName} limit exceeded and entered the grace zone. Utilization: USD{CurrentStorage}% (It is advised to select a different quota or contact your administrator to extend the quota). 3011 USER_EXCEEDED_QUOTA_STORAGE_THRESHOLD Warning Storage-Quota USD{QuotaName} is about to exceed. Utilization: USD{CurrentStorage}% 3012 QUOTA_STORAGE_RESIZE_LOWER_THEN_CONSUMPTION Warning Storage-Quota USD{QuotaName}: the new size set for this quota is less than current disk utilization. 3013 MISSING_QUOTA_STORAGE_PARAMETERS_PERMISSIVE_MODE Warning Missing Quota for Disk, proceeding since in Permissive (Audit) mode. 3014 MISSING_QUOTA_CLUSTER_PARAMETERS_PERMISSIVE_MODE Warning Missing Quota for VM USD{VmName}, proceeding since in Permissive (Audit) mode. 3015 USER_EXCEEDED_QUOTA_CLUSTER_GRACE_LIMIT_PERMISSIVE_MODE Warning Cluster-Quota USD{QuotaName} limit exceeded, proceeding since in Permissive (Audit) mode. Utilization: USD{Utilization}, Requested: USD{Requested} - Please select a different quota or contact your administrator to extend the quota. 3016 USER_EXCEEDED_QUOTA_STORAGE_GRACE_LIMIT_PERMISSIVE_MODE Warning Storage-Quota USD{QuotaName} limit exceeded, proceeding since in Permissive (Audit) mode. Utilization(used/requested): USD{CurrentStorage}%/USD{Requested}% - Please select a different quota or contact your administrator to extend the quota. 3017 USER_IMPORT_IMAGE_AS_TEMPLATE Info User USD{UserName} importing image USD{RepoImageName} as template USD{TemplateName} to domain USD{StorageDomainName}. 3018 USER_IMPORT_IMAGE_AS_TEMPLATE_FINISHED_SUCCESS Info User USD{UserName} successfully imported image USD{RepoImageName} as template USD{TemplateName} to domain USD{StorageDomainName}. 3019 USER_IMPORT_IMAGE_AS_TEMPLATE_FINISHED_FAILURE Error User USD{UserName} failed to import image USD{RepoImageName} as template USD{TemplateName} to domain USD{StorageDomainName}. 4000 GLUSTER_VOLUME_CREATE Info Gluster Volume USD{glusterVolumeName} created on cluster USD{clusterName}. 4001 GLUSTER_VOLUME_CREATE_FAILED Error Creation of Gluster Volume USD{glusterVolumeName} failed on cluster USD{clusterName}. 4002 GLUSTER_VOLUME_OPTION_ADDED Info Volume Option USD{Key} 4003 GLUSTER_VOLUME_OPTION_SET_FAILED Error Volume Option USD{Key} 4004 GLUSTER_VOLUME_START Info Gluster Volume USD{glusterVolumeName} of cluster USD{clusterName} started. 4005 GLUSTER_VOLUME_START_FAILED Error Could not start Gluster Volume USD{glusterVolumeName} of cluster USD{clusterName}. 4006 GLUSTER_VOLUME_STOP Info Gluster Volume USD{glusterVolumeName} stopped on cluster USD{clusterName}. 4007 GLUSTER_VOLUME_STOP_FAILED Error Could not stop Gluster Volume USD{glusterVolumeName} on cluster USD{clusterName}. 4008 GLUSTER_VOLUME_OPTIONS_RESET Info Volume Option USD{Key} 4009 GLUSTER_VOLUME_OPTIONS_RESET_FAILED Error Could not reset Gluster Volume USD{glusterVolumeName} Options on cluster USD{clusterName}. 4010 GLUSTER_VOLUME_DELETE Info Gluster Volume USD{glusterVolumeName} deleted on cluster USD{clusterName}. 4011 GLUSTER_VOLUME_DELETE_FAILED Error Could not delete Gluster Volume USD{glusterVolumeName} on cluster USD{clusterName}. 4012 GLUSTER_VOLUME_REBALANCE_START Info Gluster Volume USD{glusterVolumeName} rebalance started on cluster USD{clusterName}. 4013 GLUSTER_VOLUME_REBALANCE_START_FAILED Error Could not start Gluster Volume USD{glusterVolumeName} rebalance on cluster USD{clusterName}. 4014 GLUSTER_VOLUME_REMOVE_BRICKS Info Bricks removed from Gluster Volume USD{glusterVolumeName} of cluster USD{clusterName}. 4015 GLUSTER_VOLUME_REMOVE_BRICKS_FAILED Error Could not remove bricks from Gluster Volume USD{glusterVolumeName} of cluster USD{clusterName}. 4016 GLUSTER_VOLUME_REPLACE_BRICK_FAILED Error Replace Gluster Volume USD{glusterVolumeName} Brick failed on cluster USD{clusterName} 4017 GLUSTER_VOLUME_REPLACE_BRICK_START Info Gluster Volume USD{glusterVolumeName} Replace Brick started on cluster USD{clusterName}. 4018 GLUSTER_VOLUME_REPLACE_BRICK_START_FAILED Error Could not start Gluster Volume USD{glusterVolumeName} Replace Brick on cluster USD{clusterName}. 4019 GLUSTER_VOLUME_ADD_BRICK Info USD{NoOfBricks} brick(s) added to volume USD{glusterVolumeName} of cluster USD{clusterName}. 4020 GLUSTER_VOLUME_ADD_BRICK_FAILED Error Failed to add bricks to the Gluster Volume USD{glusterVolumeName} of cluster USD{clusterName}. 4021 GLUSTER_SERVER_REMOVE_FAILED Error Failed to remove host USD{VdsName} from Cluster USD{ClusterName}. 4022 GLUSTER_VOLUME_PROFILE_START Info Gluster Volume USD{glusterVolumeName} profiling started on cluster USD{clusterName}. 4023 GLUSTER_VOLUME_PROFILE_START_FAILED Error Could not start profiling on gluster volume USD{glusterVolumeName} of cluster USD{clusterName} 4024 GLUSTER_VOLUME_PROFILE_STOP Info Gluster Volume USD{glusterVolumeName} profiling stopped on cluster USD{clusterName}. 4025 GLUSTER_VOLUME_PROFILE_STOP_FAILED Error Could not stop Profiling on gluster volume USD{glusterVolumeName} of cluster USD{clusterName}. 4026 GLUSTER_VOLUME_CREATED_FROM_CLI Warning Detected new volume USD{glusterVolumeName} on cluster USD{ClusterName}, and added it to engine DB. 4027 GLUSTER_VOLUME_DELETED_FROM_CLI Info Detected deletion of volume USD{glusterVolumeName} on cluster USD{ClusterName}, and deleted it from engine DB. 4028 GLUSTER_VOLUME_OPTION_SET_FROM_CLI Warning Detected new option USD{key} 4029 GLUSTER_VOLUME_OPTION_RESET_FROM_CLI Warning Detected option USD{key} 4030 GLUSTER_VOLUME_PROPERTIES_CHANGED_FROM_CLI Warning Detected changes in properties of volume USD{glusterVolumeName} of cluster USD{ClusterName}, and updated the same in engine DB. 4031 GLUSTER_VOLUME_BRICK_ADDED_FROM_CLI Warning Detected new brick USD{brick} on volume USD{glusterVolumeName} of cluster USD{ClusterName}, and added it to engine DB. 4032 GLUSTER_VOLUME_BRICK_REMOVED_FROM_CLI Info Detected brick USD{brick} removed from Volume USD{glusterVolumeName} of cluster USD{ClusterName}, and removed it from engine DB. 4033 GLUSTER_SERVER_REMOVED_FROM_CLI Info Detected server USD{VdsName} removed from Cluster USD{ClusterName}, and removed it from engine DB. 4034 GLUSTER_VOLUME_INFO_FAILED Error Failed to fetch gluster volume list from server USD{VdsName}. 4035 GLUSTER_COMMAND_FAILED Error Gluster command [USD{Command}] failed on server USD{Server}. 4038 GLUSTER_SERVER_REMOVE Info Host USD{VdsName} removed from Cluster USD{ClusterName}. 4039 GLUSTER_VOLUME_STARTED_FROM_CLI Warning Detected that Volume USD{glusterVolumeName} of Cluster USD{ClusterName} was started, and updated engine DB with it's new status. 4040 GLUSTER_VOLUME_STOPPED_FROM_CLI Warning Detected that Volume USD{glusterVolumeName} of Cluster USD{ClusterName} was stopped, and updated engine DB with it's new status. 4041 GLUSTER_VOLUME_OPTION_CHANGED_FROM_CLI Info Detected change in value of option USD{key} from USD{oldValue} to USD{newValue} on volume USD{glusterVolumeName} of cluster USD{ClusterName}, and updated it to engine DB. 4042 GLUSTER_HOOK_ENABLE Info Gluster Hook USD{GlusterHookName} enabled on cluster USD{ClusterName}. 4043 GLUSTER_HOOK_ENABLE_FAILED Error Failed to enable Gluster Hook USD{GlusterHookName} on cluster USD{ClusterName}. USD{FailureMessage} 4044 GLUSTER_HOOK_ENABLE_PARTIAL Warning Gluster Hook USD{GlusterHookName} enabled on some of the servers on cluster USD{ClusterName}. USD{FailureMessage} 4045 GLUSTER_HOOK_DISABLE Info Gluster Hook USD{GlusterHookName} disabled on cluster USD{ClusterName}. 4046 GLUSTER_HOOK_DISABLE_FAILED Error Failed to disable Gluster Hook USD{GlusterHookName} on cluster USD{ClusterName}. USD{FailureMessage} 4047 GLUSTER_HOOK_DISABLE_PARTIAL Warning Gluster Hook USD{GlusterHookName} disabled on some of the servers on cluster USD{ClusterName}. USD{FailureMessage} 4048 GLUSTER_HOOK_LIST_FAILED Error Failed to retrieve hook list from USD{VdsName} of Cluster USD{ClusterName}. 4049 GLUSTER_HOOK_CONFLICT_DETECTED Warning Detected conflict in hook USD{HookName} of Cluster USD{ClusterName}. 4050 GLUSTER_HOOK_DETECTED_NEW Info Detected new hook USD{HookName} in Cluster USD{ClusterName}. 4051 GLUSTER_HOOK_DETECTED_DELETE Info Detected removal of hook USD{HookName} in Cluster USD{ClusterName}. 4052 GLUSTER_VOLUME_OPTION_MODIFIED Info Volume Option USD{Key} changed to USD{Value} from USD{oldvalue} on USD{glusterVolumeName} of cluster USD{clusterName}. 4053 GLUSTER_HOOK_GETCONTENT_FAILED Error Failed to read content of hook USD{HookName} in Cluster USD{ClusterName}. 4054 GLUSTER_SERVICES_LIST_FAILED Error Could not fetch statuses of services from server USD{VdsName}. Updating statuses of all services on this server to UNKNOWN. 4055 GLUSTER_SERVICE_TYPE_ADDED_TO_CLUSTER Info Service type USD{ServiceType} was not mapped to cluster USD{ClusterName}. Mapped it now. 4056 GLUSTER_CLUSTER_SERVICE_STATUS_CHANGED Info Status of service type USD{ServiceType} changed from USD{OldStatus} to USD{NewStatus} on cluster USD{ClusterName} 4057 GLUSTER_SERVICE_ADDED_TO_SERVER Info Service USD{ServiceName} was not mapped to server USD{VdsName}. Mapped it now. 4058 GLUSTER_SERVER_SERVICE_STATUS_CHANGED Info Status of service USD{ServiceName} on server USD{VdsName} changed from USD{OldStatus} to USD{NewStatus}. Updating in engine now. 4059 GLUSTER_HOOK_UPDATED Info Gluster Hook USD{GlusterHookName} updated on conflicting servers. 4060 GLUSTER_HOOK_UPDATE_FAILED Error Failed to update Gluster Hook USD{GlusterHookName} on conflicting servers. USD{FailureMessage} 4061 GLUSTER_HOOK_ADDED Info Gluster Hook USD{GlusterHookName} added on conflicting servers. 4062 GLUSTER_HOOK_ADD_FAILED Error Failed to add Gluster Hook USD{GlusterHookName} on conflicting servers. USD{FailureMessage} 4063 GLUSTER_HOOK_REMOVED Info Gluster Hook USD{GlusterHookName} removed from all servers in cluster USD{ClusterName}. 4064 GLUSTER_HOOK_REMOVE_FAILED Error Failed to remove Gluster Hook USD{GlusterHookName} from cluster USD{ClusterName}. USD{FailureMessage} 4065 GLUSTER_HOOK_REFRESH Info Refreshed gluster hooks in Cluster USD{ClusterName}. 4066 GLUSTER_HOOK_REFRESH_FAILED Error Failed to refresh gluster hooks in Cluster USD{ClusterName}. 4067 GLUSTER_SERVICE_STARTED Info USD{servicetype} service started on host USD{VdsName} of cluster USD{ClusterName}. 4068 GLUSTER_SERVICE_START_FAILED Error Could not start USD{servicetype} service on host USD{VdsName} of cluster USD{ClusterName}. 4069 GLUSTER_SERVICE_STOPPED Info USD{servicetype} services stopped on host USD{VdsName} of cluster USD{ClusterName}. 4070 GLUSTER_SERVICE_STOP_FAILED Error Could not stop USD{servicetype} service on host USD{VdsName} of cluster USD{ClusterName}. 4071 GLUSTER_SERVICES_LIST_NOT_FETCHED Info Could not fetch list of services from USD{ServiceGroupType} named USD{ServiceGroupName}. 4072 GLUSTER_SERVICE_RESTARTED Info USD{servicetype} service re-started on host USD{VdsName} of cluster USD{ClusterName}. 4073 GLUSTER_SERVICE_RESTART_FAILED Error Could not re-start USD{servicetype} service on host USD{VdsName} of cluster USD{ClusterName}. 4074 GLUSTER_VOLUME_OPTIONS_RESET_ALL Info All Volume Options reset on USD{glusterVolumeName} of cluster USD{clusterName}. 4075 GLUSTER_HOST_UUID_NOT_FOUND Error Could not find gluster uuid of server USD{VdsName} on Cluster USD{ClusterName}. 4076 GLUSTER_VOLUME_BRICK_ADDED Info Brick [USD{brickpath}] on host [USD{servername}] added to volume [USD{glusterVolumeName}] of cluster USD{clusterName} 4077 GLUSTER_CLUSTER_SERVICE_STATUS_ADDED Info Status of service type USD{ServiceType} set to USD{NewStatus} on cluster USD{ClusterName} 4078 GLUSTER_VOLUME_REBALANCE_STOP Info Gluster Volume USD{glusterVolumeName} rebalance stopped of cluster USD{clusterName}. 4079 GLUSTER_VOLUME_REBALANCE_STOP_FAILED Error Could not stop rebalance of gluster volume USD{glusterVolumeName} of cluster USD{clusterName}. 4080 START_REMOVING_GLUSTER_VOLUME_BRICKS Info Started removing bricks from Volume USD{glusterVolumeName} of cluster USD{clusterName} 4081 START_REMOVING_GLUSTER_VOLUME_BRICKS_FAILED Error Could not start remove bricks from Volume USD{glusterVolumeName} of cluster USD{clusterName} 4082 GLUSTER_VOLUME_REMOVE_BRICKS_STOP Info Stopped removing bricks from Volume USD{glusterVolumeName} of cluster USD{clusterName} 4083 GLUSTER_VOLUME_REMOVE_BRICKS_STOP_FAILED Error Failed to stop remove bricks from Volume USD{glusterVolumeName} of cluster USD{clusterName} 4084 GLUSTER_VOLUME_REMOVE_BRICKS_COMMIT Info Gluster volume USD{glusterVolumeName} remove bricks committed on cluster USD{clusterName}. USD{NoOfBricks} brick(s) removed from volume USD{glusterVolumeName}. 4085 GLUSTER_VOLUME_REMOVE_BRICKS_COMMIT_FAILED Error Gluster volume USD{glusterVolumeName} remove bricks could not be commited on cluster USD{clusterName} 4086 GLUSTER_BRICK_STATUS_CHANGED Warning Detected change in status of brick USD{brickpath} of volume USD{glusterVolumeName} of cluster USD{clusterName} from USD{oldValue} to USD{newValue} via USD{source}. 4087 GLUSTER_VOLUME_REBALANCE_FINISHED Info USD{action} USD{status} on volume USD{glusterVolumeName} of cluster USD{clusterName}. 4088 GLUSTER_VOLUME_MIGRATE_BRICK_DATA_FINISHED Info USD{action} USD{status} for brick(s) on volume USD{glusterVolumeName} of cluster USD{clusterName}. Please review to abort or commit. 4089 GLUSTER_VOLUME_REBALANCE_START_DETECTED_FROM_CLI Info Detected start of rebalance on volume USD{glusterVolumeName} of Cluster USD{ClusterName} from CLI. 4090 START_REMOVING_GLUSTER_VOLUME_BRICKS_DETECTED_FROM_CLI Info Detected start of brick removal for bricks USD{brick} on volume USD{glusterVolumeName} of Cluster USD{ClusterName} from CLI. 4091 GLUSTER_VOLUME_REBALANCE_NOT_FOUND_FROM_CLI Warning Could not find information for rebalance on volume USD{glusterVolumeName} of Cluster USD{ClusterName} from CLI. Marking it as unknown. 4092 REMOVE_GLUSTER_VOLUME_BRICKS_NOT_FOUND_FROM_CLI Warning Could not find information for remove brick on volume USD{glusterVolumeName} of Cluster USD{ClusterName} from CLI. Marking it as unknown. 4093 GLUSTER_VOLUME_DETAILS_REFRESH Info Refreshed details of the volume USD{glusterVolumeName} of cluster USD{clusterName}. 4094 GLUSTER_VOLUME_DETAILS_REFRESH_FAILED Error Failed to refresh the details of volume USD{glusterVolumeName} of cluster USD{clusterName}. 4095 GLUSTER_HOST_UUID_ALREADY_EXISTS Error Gluster UUID of host USD{VdsName} on Cluster USD{ClusterName} already exists. 4096 USER_FORCE_SELECTED_SPM_STOP_FAILED Error Failed to force select USD{VdsName} as the SPM due to a failure to stop the current SPM. 4097 GLUSTER_GEOREP_SESSION_DELETED_FROM_CLI Warning Detected deletion of geo-replication session USD{geoRepSessionKey} from volume USD{glusterVolumeName} of cluster USD{clusterName} 4098 GLUSTER_GEOREP_SESSION_DETECTED_FROM_CLI Warning Detected new geo-replication session USD{geoRepSessionKey} for volume USD{glusterVolumeName} of cluster USD{clusterName}. Adding it to engine. 4099 GLUSTER_GEOREP_SESSION_REFRESH Info Refreshed geo-replication sessions for volume USD{glusterVolumeName} of cluster USD{clusterName}. 4100 GLUSTER_GEOREP_SESSION_REFRESH_FAILED Error Failed to refresh geo-replication sessions for volume USD{glusterVolumeName} of cluster USD{clusterName}. 4101 GEOREP_SESSION_STOP Info Geo-replication session on volume USD{glusterVolumeName} of cluster USD{clusterName} has been stopped. 4102 GEOREP_SESSION_STOP_FAILED Error Failed to stop geo-replication session on volume USD{glusterVolumeName} of cluster USD{clusterName} 4103 GEOREP_SESSION_DELETED Info Geo-replication session deleted on volume USD{glusterVolumeName} of cluster USD{clusterName} 4104 GEOREP_SESSION_DELETE_FAILED Error Failed to delete geo-replication session on volume USD{glusterVolumeName} of cluster USD{clusterName} 4105 GLUSTER_GEOREP_CONFIG_SET Info Configuration USD{key} has been set to USD{value} on the geo-rep session USD{geoRepSessionKey}. 4106 GLUSTER_GEOREP_CONFIG_SET_FAILED Error Failed to set the configuration USD{key} to USD{value} on geo-rep session USD{geoRepSessionKey}. 4107 GLUSTER_GEOREP_CONFIG_LIST Info Refreshed configuration options for geo-replication session USD{geoRepSessionKey} 4108 GLUSTER_GEOREP_CONFIG_LIST_FAILED Error Failed to refresh configuration options for geo-replication session USD{geoRepSessionKey} 4109 GLUSTER_GEOREP_CONFIG_SET_DEFAULT Info Configuration of USD{key} of session USD{geoRepSessionKey} reset to its default value . 4110 GLUSTER_GEOREP_CONFIG_SET_DEFAULT_FAILED Error Failed to set USD{key} of session USD{geoRepSessionKey} to its default value. 4111 GLUSTER_VOLUME_SNAPSHOT_DELETED Info Gluster volume snapshot USD{snapname} deleted. 4112 GLUSTER_VOLUME_SNAPSHOT_DELETE_FAILED Error Failed to delete gluster volume snapshot USD{snapname}. 4113 GLUSTER_VOLUME_ALL_SNAPSHOTS_DELETED Info Deleted all the gluster volume snapshots for the volume USD{glusterVolumeName} of cluster USD{clusterName}. 4114 GLUSTER_VOLUME_ALL_SNAPSHOTS_DELETE_FAILED Error Failed to delete all the gluster volume snapshots for the volume USD{glusterVolumeName} of cluster USD{clusterName}. 4115 GLUSTER_VOLUME_SNAPSHOT_ACTIVATED Info Activated the gluster volume snapshot USD{snapname} on volume USD{glusterVolumeName} of cluster USD{clusterName}. 4116 GLUSTER_VOLUME_SNAPSHOT_ACTIVATE_FAILED Error Failed to activate the gluster volume snapshot USD{snapname} on volume USD{glusterVolumeName} of cluster USD{clusterName}. 4117 GLUSTER_VOLUME_SNAPSHOT_DEACTIVATED Info De-activated the gluster volume snapshot USD{snapname} on volume USD{glusterVolumeName} of cluster USD{clusterName}. 4118 GLUSTER_VOLUME_SNAPSHOT_DEACTIVATE_FAILED Error Failed to de-activate gluster volume snapshot USD{snapname} on volume USD{glusterVolumeName} of cluster USD{clusterName}. 4119 GLUSTER_VOLUME_SNAPSHOT_RESTORED Info Restored the volume USD{glusterVolumeName} of cluster USD{clusterName} to the state of gluster volume snapshot USD{snapname}. 4120 GLUSTER_VOLUME_SNAPSHOT_RESTORE_FAILED Error Failed to restore the volume USD{glusterVolumeName} of cluster USD{clusterName} to the state of gluster volume snapshot USD{snapname}. 4121 GLUSTER_VOLUME_SNAPSHOT_CONFIG_UPDATED Info Updated Gluster volume snapshot configuration(s). 4122 GLUSTER_VOLUME_SNAPSHOT_CONFIG_UPDATE_FAILED Error Failed to update gluster volume snapshot configuration(s). 4123 GLUSTER_VOLUME_SNAPSHOT_CONFIG_UPDATE_FAILED_PARTIALLY Error Failed to update gluster volume snapshot configuration(s) USD{failedSnapshotConfigs}. 4124 NEW_STORAGE_DEVICE_DETECTED Info Found new storage device USD{storageDevice} on host USD{VdsName}, and added it to engine DB." 4125 STORAGE_DEVICE_REMOVED_FROM_THE_HOST Info Detected deletion of storage device USD{storageDevice} on host USD{VdsName}, and deleting it from engine DB." 4126 SYNC_STORAGE_DEVICES_IN_HOST Info Manually synced the storage devices from host USD{VdsName} 4127 SYNC_STORAGE_DEVICES_IN_HOST_FAILED Error Failed to sync storage devices from host USD{VdsName} 4128 GEOREP_OPTION_SET_FROM_CLI Warning Detected new option USD{key} 4129 GEOREP_OPTION_CHANGED_FROM_CLI Warning Detected change in value of option USD{key} from USD{oldValue} to USD{value} for geo-replication session on volume USD{glusterVolumeName} of cluster USD{ClusterName}, and updated it to engine. 4130 GLUSTER_MASTER_VOLUME_STOP_FAILED_DURING_SNAPSHOT_RESTORE Error Could not stop master volume USD{glusterVolumeName} of cluster USD{clusterName} during snapshot restore. 4131 GLUSTER_MASTER_VOLUME_SNAPSHOT_RESTORE_FAILED Error Could not restore master volume USD{glusterVolumeName} of cluster USD{clusterName}. 4132 GLUSTER_VOLUME_SNAPSHOT_CREATED Info Snapshot USD{snapname} created for volume USD{glusterVolumeName} of cluster USD{clusterName}. 4133 GLUSTER_VOLUME_SNAPSHOT_CREATE_FAILED Error Could not create snapshot for volume USD{glusterVolumeName} of cluster USD{clusterName}. 4134 GLUSTER_VOLUME_SNAPSHOT_SCHEDULED Info Snapshots scheduled on volume USD{glusterVolumeName} of cluster USD{clusterName}. 4135 GLUSTER_VOLUME_SNAPSHOT_SCHEDULE_FAILED Error Failed to schedule snapshots on the volume USD{glusterVolumeName} of cluster USD{clusterName}. 4136 GLUSTER_VOLUME_SNAPSHOT_RESCHEDULED Info Rescheduled snapshots on volume USD{glusterVolumeName} of cluster USD{clusterName}. 4137 GLUSTER_VOLUME_SNAPSHOT_RESCHEDULE_FAILED Error Failed to reschedule snapshots on volume USD{glusterVolumeName} of cluster USD{clusterName}. 4138 CREATE_GLUSTER_BRICK Info Brick USD{brickName} created successfully on host USD{vdsName} of cluster USD{clusterName}. 4139 CREATE_GLUSTER_BRICK_FAILED Error Failed to create brick USD{brickName} on host USD{vdsName} of cluster USD{clusterName}. 4140 GLUSTER_GEO_REP_PUB_KEY_FETCH_FAILED Error Failed to fetch public keys. 4141 GLUSTER_GET_PUB_KEY Info Public key fetched. 4142 GLUSTER_GEOREP_PUBLIC_KEY_WRITE_FAILED Error Failed to write public keys to USD{VdsName} 4143 GLUSTER_WRITE_PUB_KEYS Info Public keys written to USD{VdsName} 4144 GLUSTER_GEOREP_SETUP_MOUNT_BROKER_FAILED Error Failed to setup geo-replication mount broker for user USD{geoRepUserName} on the slave volume USD{geoRepSlaveVolumeName}. 4145 GLUSTER_SETUP_GEOREP_MOUNT_BROKER Info Geo-replication mount broker has been setup for user USD{geoRepUserName} on the slave volume USD{geoRepSlaveVolumeName}. 4146 GLUSTER_GEOREP_SESSION_CREATE_FAILED Error Failed to create geo-replication session between master volume : USD{glusterVolumeName} of cluster USD{clusterName} and slave volume : USD{geoRepSlaveVolumeName} for the user USD{geoRepUserName}. 4147 CREATE_GLUSTER_VOLUME_GEOREP_SESSION Info Created geo-replication session between master volume : USD{glusterVolumeName} of cluster USD{clusterName} and slave volume : USD{geoRepSlaveVolumeName} for the user USD{geoRepUserName}. 4148 GLUSTER_VOLUME_SNAPSHOT_SOFT_LIMIT_REACHED Info Gluster Volume Snapshot soft limit reached for the volume USD{glusterVolumeName} on cluster USD{clusterName}. 4149 HOST_FEATURES_INCOMPATIBILE_WITH_CLUSTER Error Host USD{VdsName} does not comply with the list of features supported by cluster USD{ClusterName}. USD{UnSupportedFeature} is not supported by the Host 4150 GLUSTER_VOLUME_SNAPSHOT_SCHEDULE_DELETED Info Snapshot schedule deleted for volume USD{glusterVolumeName} of USD{clusterName}. 4151 GLUSTER_BRICK_STATUS_DOWN Info Status of brick USD{brickpath} of volume USD{glusterVolumeName} on cluster USD{ClusterName} is down. 4152 GLUSTER_VOLUME_SNAPSHOT_DETECTED_NEW Info Found new gluster volume snapshot USD{snapname} for volume USD{glusterVolumeName} on cluster USD{ClusterName}, and added it to engine DB." 4153 GLUSTER_VOLUME_SNAPSHOT_DELETED_FROM_CLI Info Detected deletion of gluster volume snapshot USD{snapname} for volume USD{glusterVolumeName} on cluster USD{ClusterName}, and deleting it from engine DB." 4154 GLUSTER_VOLUME_SNAPSHOT_CLUSTER_CONFIG_DETECTED_NEW Info Found new gluster volume snapshot configuration USD{snapConfigName} with value USD{snapConfigValue} on cluster USD{ClusterName}, and added it to engine DB." 4155 GLUSTER_VOLUME_SNAPSHOT_VOLUME_CONFIG_DETECTED_NEW Info Found new gluster volume snapshot configuration USD{snapConfigName} with value USD{snapConfigValue} for volume USD{glusterVolumeName} on cluster USD{ClusterName}, and added it to engine DB." 4156 GLUSTER_VOLUME_SNAPSHOT_HARD_LIMIT_REACHED Info Gluster Volume Snapshot hard limit reached for the volume USD{glusterVolumeName} on cluster USD{clusterName}. 4157 GLUSTER_CLI_SNAPSHOT_SCHEDULE_DISABLE_FAILED Error Failed to disable gluster CLI based snapshot schedule on cluster USD{clusterName}. 4158 GLUSTER_CLI_SNAPSHOT_SCHEDULE_DISABLED Info Disabled gluster CLI based scheduling successfully on cluster USD{clusterName}. 4159 SET_UP_PASSWORDLESS_SSH Info Password-less SSH has been setup for user USD{geoRepUserName} on the nodes of remote volume USD{geoRepSlaveVolumeName} from the nodes of the volume USD{glusterVolumeName}. 4160 SET_UP_PASSWORDLESS_SSH_FAILED Error Failed to setup Passwordless ssh for user USD{geoRepUserName} on the nodes of remote volume USD{geoRepSlaveVolumeName} from the nodes of the volume USD{glusterVolumeName}. 4161 GLUSTER_VOLUME_TYPE_UNSUPPORTED Warning Detected a volume USD{glusterVolumeName} with type USD{glusterVolumeType} on cluster USD{Cluster} and it is not fully supported by engine. 4162 GLUSTER_VOLUME_BRICK_REPLACED Info Replaced brick 'USD{brick}' with new brick 'USD{newBrick}' of Gluster Volume USD{glusterVolumeName} on cluster USD{clusterName} 4163 GLUSTER_SERVER_STATUS_DISCONNECTED Info Gluster server USD{vdsName} set to DISCONNECTED on cluster USD{clusterName}. 4164 GLUSTER_STORAGE_DOMAIN_SYNC_FAILED Info Failed to synchronize data from storage domain USD{storageDomainName} to remote location. 4165 GLUSTER_STORAGE_DOMAIN_SYNCED Info Successfully synchronized data from storage domain USD{storageDomainName} to remote location. 4166 GLUSTER_STORAGE_DOMAIN_SYNC_STARTED Info Successfully started data synchronization data from storage domain USD{storageDomainName} to remote location. 4167 STORAGE_DOMAIN_DR_DELETED Error Deleted the data synchronization schedule for storage domain USD{storageDomainName} as the underlying geo-replication session USD{geoRepSessionKey} has been deleted. 4168 GLUSTER_WEBHOOK_ADDED Info Added webhook on USD{clusterName} 4169 GLUSTER_WEBHOOK_ADD_FAILED Error Failed to add webhook on USD{clusterName} 4170 GLUSTER_VOLUME_RESET_BRICK_FAILED Error 4171 GLUSTER_VOLUME_BRICK_RESETED Info 4172 GLUSTER_VOLUME_CONFIRMED_SPACE_LOW Warning Warning! Low confirmed free space on gluster volume USD{glusterVolumeName} 4436 GLUSTER_SERVER_ADD_FAILED Error Failed to add host USD{VdsName} into Cluster USD{ClusterName}. USD{ErrorMessage} 4437 GLUSTER_SERVERS_LIST_FAILED Error Failed to fetch gluster peer list from server USD{VdsName} on Cluster USD{ClusterName}. USD{ErrorMessage} 4595 GLUSTER_VOLUME_GEO_REP_START_FAILED_EXCEPTION Error Failed to start geo-replication session on volume USD{glusterVolumeName} of cluster USD{clusterName} 4596 GLUSTER_VOLUME_GEO_REP_START Info Geo-replication session on volume USD{glusterVolumeName} of cluster USD{clusterName} has been started. 4597 GLUSTER_VOLUME_GEO_REP_PAUSE_FAILED Error Failed to pause geo-replication session on volume USD{glusterVolumeName} of cluster USD{clusterName} 4598 GLUSTER_VOLUME_GEO_REP_RESUME_FAILED Error Failed to resume geo-replication session on volume USD{glusterVolumeName} of cluster USD{clusterName} 4599 GLUSTER_VOLUME_GEO_REP_RESUME Info Geo-replication session on volume USD{glusterVolumeName} of cluster USD{clusterName} has been resumed. 4600 GLUSTER_VOLUME_GEO_REP_PAUSE Info Geo-replication session on volume USD{glusterVolumeName} of cluster USD{clusterName} has been paused. 9000 VDS_ALERT_FENCE_IS_NOT_CONFIGURED Info Failed to verify Power Management configuration for Host USD{VdsName}. 9001 VDS_ALERT_FENCE_TEST_FAILED Info Power Management test failed for Host USD{VdsName}.USD{Reason} 9002 VDS_ALERT_FENCE_OPERATION_FAILED Info Failed to power fence host USD{VdsName}. Please check the host status and it's power management settings, and then manually reboot it and click "Confirm Host Has Been Rebooted" 9003 VDS_ALERT_FENCE_OPERATION_SKIPPED Info Host USD{VdsName} became non responsive. Fence operation skipped as the system is still initializing and this is not a host where hosted engine was running on previously. 9004 VDS_ALERT_FENCE_NO_PROXY_HOST Info There is no other host in the data center that can be used to test the power management settings. 9005 VDS_ALERT_FENCE_STATUS_VERIFICATION_FAILED Info Failed to verify Host USD{Host} USD{Status} status, Please USD{Status} Host USD{Host} manually. 9006 CANNOT_HIBERNATE_RUNNING_VMS_AFTER_CLUSTER_CPU_UPGRADE Warning Hibernation of VMs after CPU upgrade of Cluster USD{Cluster} is not supported. Please stop and restart those VMs in case you wish to hibernate them 9007 VDS_ALERT_SECONDARY_AGENT_USED_FOR_FENCE_OPERATION Info Secondary fence agent was used to USD{Operation} Host USD{VdsName} 9008 VDS_HOST_NOT_RESPONDING_CONNECTING Warning Host USD{VdsName} is not responding. It will stay in Connecting state for a grace period of USD{Seconds} seconds and after that an attempt to fence the host will be issued. 9009 VDS_ALERT_PM_HEALTH_CHECK_FENCE_AGENT_NON_RESPONSIVE Info Health check on Host USD{VdsName} indicates that Fence-Agent USD{AgentId} is non-responsive. 9010 VDS_ALERT_PM_HEALTH_CHECK_START_MIGHT_FAIL Info Health check on Host USD{VdsName} indicates that future attempts to Start this host using Power-Management are expected to fail. 9011 VDS_ALERT_PM_HEALTH_CHECK_STOP_MIGHT_FAIL Info Health check on Host USD{VdsName} indicates that future attempts to Stop this host using Power-Management are expected to fail. 9012 VDS_ALERT_PM_HEALTH_CHECK_RESTART_MIGHT_FAIL Info Health check on Host USD{VdsName} indicates that future attempts to Restart this host using Power-Management are expected to fail. 9013 VDS_ALERT_FENCE_OPERATION_SKIPPED_BROKEN_CONNECTIVITY Info Host USD{VdsName} became non responsive and was not restarted due to Fencing Policy: USD{Percents} percents of the Hosts in the Cluster have connectivity issues. 9014 VDS_ALERT_NOT_RESTARTED_DUE_TO_POLICY Info Host USD{VdsName} became non responsive and was not restarted due to the Cluster Fencing Policy. 9015 VDS_ALERT_FENCE_DISABLED_BY_CLUSTER_POLICY Info Host USD{VdsName} became Non Responsive and was not restarted due to disabled fencing in the Cluster Fencing Policy. 9016 FENCE_DISABLED_IN_CLUSTER_POLICY Info Fencing is disabled in Fencing Policy of the Cluster USD{ClusterName}, so HA VMs running on a non-responsive host will not be restarted elsewhere. 9017 FENCE_OPERATION_STARTED Info Power management USD{Action} of Host USD{VdsName} initiated. 9018 FENCE_OPERATION_SUCCEEDED Info Power management USD{Action} of Host USD{VdsName} succeeded. 9019 FENCE_OPERATION_FAILED Error Power management USD{Action} of Host USD{VdsName} failed. 9020 FENCE_OPERATION_USING_AGENT_AND_PROXY_STARTED Info Executing power management USD{Action} on Host USD{Host} using Proxy Host USD{ProxyHost} and Fence Agent USD{AgentType}:USD{AgentIp}. 9021 FENCE_OPERATION_USING_AGENT_AND_PROXY_FAILED Warning Execution of power management USD{Action} on Host USD{Host} using Proxy Host USD{ProxyHost} and Fence Agent USD{AgentType}:USD{AgentIp} failed. 9022 ENGINE_NO_FULL_BACKUP Info There is no full backup available, please run engine-backup to prevent data loss in case of corruption. 9023 ENGINE_NO_WARM_BACKUP Info Full backup was created on USD{Date} and it's too old. Please run engine-backup to prevent data loss in case of corruption. 9024 ENGINE_BACKUP_STARTED Normal Engine backup started. 9025 ENGINE_BACKUP_COMPLETED Normal Engine backup completed successfully. 9026 ENGINE_BACKUP_FAILED Error Engine backup failed. 9028 VDS_ALERT_NO_PM_CONFIG_FENCE_OPERATION_SKIPPED Info Host USD{VdsName} became non responsive. It has no power management configured. Please check the host status, manually reboot it, and click "Confirm Host Has Been Rebooted" 9500 TASK_STOPPING_ASYNC_TASK Info Stopping async task USD{CommandName} that started at USD{Date} 9501 TASK_CLEARING_ASYNC_TASK Info Clearing asynchronous task USD{CommandName} that started at USD{Date} 9506 USER_ACTIVATE_STORAGE_DOMAIN_FAILED_ASYNC Warning Failed to autorecover Storage Domain USD{StorageDomainName} (Data Center USD{StoragePoolName}). 9600 IMPORTEXPORT_IMPORT_VM_INVALID_INTERFACES Warning While importing VM USD{EntityName}, the Network/s USD{Networks} were found to be Non-VM Networks or do not exist in Cluster or are missing a suitable VM network interface profile. Network Name was not set in the Interface/s USD{Interfaces}. 9601 VDS_SET_NON_OPERATIONAL_VM_NETWORK_IS_BRIDGELESS Warning Host USD{VdsName} does not comply with the cluster USD{ClusterName} networks, the following VM networks are non-VM networks: 'USD{Networks}'. The host will become NonOperational. 9602 HA_VM_FAILED Error Highly Available VM USD{VmName} failed. It will be restarted automatically. 9603 HA_VM_RESTART_FAILED Error Restart of the Highly Available VM USD{VmName} failed. 9604 EMULATED_MACHINES_INCOMPATIBLE_WITH_CLUSTER Warning Host USD{VdsName} does not comply with the cluster USD{ClusterName} emulated machine. The cluster emulated machine is USD{clusterEmulatedMachines} and the host emulated machines are USD{hostSupportedEmulatedMachines}. 9605 EXCEEDED_MAXIMUM_NUM_OF_RESTART_HA_VM_ATTEMPTS Error Highly Available VM USD{VmName} could not be restarted automatically, exceeded the maximum number of attempts. 9606 IMPORTEXPORT_SNAPSHOT_VM_INVALID_INTERFACES Warning While previewing a snapshot of VM USD{EntityName}, the Network/s USD{Networks} were found to be Non-VM Networks or do not exist in Cluster. Network Name was not set in the Interface/s USD{Interfaces}. 9607 ADD_VM_FROM_SNAPSHOT_INVALID_INTERFACES Warning While adding vm USD{EntityName} from snapshot, the Network/s USD{Networks} were found to be Non-VM Networks or do not exist in Cluster. Network Name was not set in the Interface/s USD{Interfaces}. 9608 RNG_SOURCES_INCOMPATIBLE_WITH_CLUSTER Warning Host USD{VdsName} does not comply with the cluster USD{ClusterName} Random Number Generator sources. The Hosts supported sources are: USD{hostSupportedRngSources}; and the cluster requirements are: USD{clusterRequiredRngSources}. 9609 EMULATED_MACHINES_INCOMPATIBLE_WITH_CLUSTER_LEVEL Warning Host USD{VdsName} does not comply with the cluster USD{ClusterName} emulated machines. The current cluster compatibility level supports USD{clusterEmulatedMachines} and the host emulated machines are USD{hostSupportedEmulatedMachines}. 9610 MIXING_RHEL_VERSIONS_IN_CLUSTER Warning Not possible to mix RHEL 6.x and 7.x hosts in one cluster. Tried adding USD{addingRhel} host to a cluster with USD{previousRhel} hosts. 9611 COLD_REBOOT_VM_DOWN Info VM USD{VmName} is down as a part of cold reboot process 9612 COLD_REBOOT_FAILED Error Cold reboot of VM USD{VmName} failed 9613 EXCEEDED_MAXIMUM_NUM_OF_COLD_REBOOT_VM_ATTEMPTS Error VM USD{VmName} could not be rebooted, exceeded the maximum number of attempts. 9700 DWH_STARTED Info ETL Service started. 9701 DWH_STOPPED Info ETL Service stopped. 9704 DWH_ERROR Error Error in ETL Service. 9801 EXTERNAL_EVENT_NORMAL Info An external event with NORMAL severity has been added. 9802 EXTERNAL_EVENT_WARNING Warning An external event with WARNING severity has been added. 9803 EXTERNAL_EVENT_ERROR Error An external event with ERROR severity has been added. 9804 EXTERNAL_ALERT Info An external event with ALERT severity has been added. 9901 WATCHDOG_EVENT Warning Watchdog event (USD{wdaction}) triggered on USD{VmName} at USD{wdevent} (host time). 9910 USER_ADD_CLUSTER_POLICY Info Scheduling Policy USD{ClusterPolicy} was added. (User: USD{UserName}) 9911 USER_FAILED_TO_ADD_CLUSTER_POLICY Error Failed to add Scheduling Policy: USD{ClusterPolicy}. (User: USD{UserName}) 9912 USER_UPDATE_CLUSTER_POLICY Info Scheduling Policy USD{ClusterPolicy} was updated. (User: USD{UserName}) 9913 USER_FAILED_TO_UPDATE_CLUSTER_POLICY Error Failed to update Scheduling Policy: USD{ClusterPolicy}. (User: USD{UserName}) 9914 USER_REMOVE_CLUSTER_POLICY Info Scheduling Policy USD{ClusterPolicy} was removed. (User: USD{UserName}) 9915 USER_FAILED_TO_REMOVE_CLUSTER_POLICY Error Failed to remove Scheduling Policy: USD{ClusterPolicy}. (User: USD{UserName}) 9920 FAILED_TO_CONNECT_TO_SCHEDULER_PROXY Error Failed to connect to external scheduler proxy. External filters, scoring functions and load balancing will not be performed. 10000 VDS_UNTRUSTED Error Host USD{VdsName} was set to non-operational. Host is not trusted by the attestation service. 10001 USER_UPDATE_VM_FROM_TRUSTED_TO_UNTRUSTED Warning The VM USD{VmName} was updated from trusted cluster to non-trusted cluster. 10002 USER_UPDATE_VM_FROM_UNTRUSTED_TO_TRUSTED Warning The VM USD{VmName} was updated from non-trusted cluster to trusted cluster. 10003 IMPORTEXPORT_IMPORT_VM_FROM_TRUSTED_TO_UNTRUSTED Warning The VM USD{VmName} was created in trusted cluster and imported into a non-trusted cluster 10004 IMPORTEXPORT_IMPORT_VM_FROM_UNTRUSTED_TO_TRUSTED Warning The VM USD{VmName} was created in non-trusted cluster and imported into a trusted cluster 10005 USER_ADD_VM_FROM_TRUSTED_TO_UNTRUSTED Warning The VM USD{VmName} was created in an untrusted cluster. It was originated from the Template USD{VmTemplateName} which was created in a trusted cluster. 10006 USER_ADD_VM_FROM_UNTRUSTED_TO_TRUSTED Warning The VM USD{VmName} was created in a trusted cluster. It was originated from the Template USD{VmTemplateName} which was created in an untrusted cluster. 10007 IMPORTEXPORT_IMPORT_TEMPLATE_FROM_TRUSTED_TO_UNTRUSTED Warning The Template USD{VmTemplateName} was created in trusted cluster and imported into a non-trusted cluster 10008 IMPORTEXPORT_IMPORT_TEMPLATE_FROM_UNTRUSTED_TO_TRUSTED Warning The Template USD{VmTemplateName} was created in non-trusted cluster and imported into a trusted cluster 10009 USER_ADD_VM_TEMPLATE_FROM_TRUSTED_TO_UNTRUSTED Warning The non-trusted Template USD{VmTemplateName} was created from trusted Vm USD{VmName}. 10010 USER_ADD_VM_TEMPLATE_FROM_UNTRUSTED_TO_TRUSTED Warning The trusted template USD{VmTemplateName} was created from non-trusted Vm USD{VmName}. 10011 USER_UPDATE_VM_TEMPLATE_FROM_TRUSTED_TO_UNTRUSTED Warning The Template USD{VmTemplateName} was updated from trusted cluster to non-trusted cluster. 10012 USER_UPDATE_VM_TEMPLATE_FROM_UNTRUSTED_TO_TRUSTED Warning The Template USD{VmTemplateName} was updated from non-trusted cluster to trusted cluster. 10013 IMPORTEXPORT_GET_EXTERNAL_VMS_NOT_IN_DOWN_STATUS Warning The following VMs retrieved from external server USD{URL} are not in down status: USD{Vms}. 10100 USER_ADDED_NETWORK_QOS Info Network QoS USD{QosName} was added. (User: USD{UserName}) 10101 USER_FAILED_TO_ADD_NETWORK_QOS Error Failed to add Network QoS USD{QosName}. (User: USD{UserName}) 10102 USER_REMOVED_NETWORK_QOS Info Network QoS USD{QosName} was removed. (User: USD{UserName}) 10103 USER_FAILED_TO_REMOVE_NETWORK_QOS Error Failed to remove Network QoS USD{QosName}. (User: USD{UserName}) 10104 USER_UPDATED_NETWORK_QOS Info Network QoS USD{QosName} was updated. (User: USD{UserName}) 10105 USER_FAILED_TO_UPDATE_NETWORK_QOS Error Failed to update Network QoS USD{QosName}. (User: USD{UserName}) 10110 USER_ADDED_QOS Info QoS USD{QoSName} was added. (User: USD{UserName}) 10111 USER_FAILED_TO_ADD_QOS Error Failed to add QoS USD{QoSName}. (User: USD{UserName}) 10112 USER_REMOVED_QOS Info QoS USD{QoSName} was removed. (User: USD{UserName}) 10113 USER_FAILED_TO_REMOVE_QOS Error Failed to remove QoS USD{QoSName}. (User: USD{UserName}) 10114 USER_UPDATED_QOS Info QoS USD{QoSName} was updated. (User: USD{UserName}) 10115 USER_FAILED_TO_UPDATE_QOS Error Failed to update QoS USD{QoSName}. (User: USD{UserName}) 10120 USER_ADDED_DISK_PROFILE Info Disk Profile USD{ProfileName} was successfully added (User: USD{UserName}). 10121 USER_FAILED_TO_ADD_DISK_PROFILE Error Failed to add Disk Profile (User: USD{UserName}). 10122 USER_REMOVED_DISK_PROFILE Info Disk Profile USD{ProfileName} was successfully removed (User: USD{UserName}). 10123 USER_FAILED_TO_REMOVE_DISK_PROFILE Error Failed to remove Disk Profile USD{ProfileName} (User: USD{UserName}). 10124 USER_UPDATED_DISK_PROFILE Info Disk Profile USD{ProfileName} was successfully updated (User: USD{UserName}). 10125 USER_FAILED_TO_UPDATE_DISK_PROFILE Error Failed to update Disk Profile USD{ProfileName} (User: USD{UserName}). 10130 USER_ADDED_CPU_PROFILE Info CPU Profile USD{ProfileName} was successfully added (User: USD{UserName}). 10131 USER_FAILED_TO_ADD_CPU_PROFILE Error Failed to add CPU Profile (User: USD{UserName}). 10132 USER_REMOVED_CPU_PROFILE Info CPU Profile USD{ProfileName} was successfully removed (User: USD{UserName}). 10133 USER_FAILED_TO_REMOVE_CPU_PROFILE Error Failed to remove CPU Profile USD{ProfileName} (User: USD{UserName}). 10134 USER_UPDATED_CPU_PROFILE Info CPU Profile USD{ProfileName} was successfully updated (User: USD{UserName}). 10135 USER_FAILED_TO_UPDATE_CPU_PROFILE Error Failed to update CPU Profile USD{ProfileName} (User: USD{UserName}). 10200 USER_UPDATED_MOM_POLICIES Info Mom policy was updated on host USD{VdsName}. 10201 USER_FAILED_TO_UPDATE_MOM_POLICIES Warning Mom policy could not be updated on host USD{VdsName}. 10250 PM_POLICY_UP_TO_MAINTENANCE Info Host USD{Host} is not currently needed, activating maintenance mode in preparation for shutdown. 10251 PM_POLICY_MAINTENANCE_TO_DOWN Info Host USD{Host} is not currently needed, shutting down. 10252 PM_POLICY_TO_UP Info Reactivating host USD{Host} according to the current power management policy. 10300 CLUSTER_ALERT_HA_RESERVATION Info Cluster USD{ClusterName} failed the HA Reservation check, HA VMs on host(s): USD{Hosts} will fail to migrate in case of a failover, consider adding resources or shutting down unused VMs. 10301 CLUSTER_ALERT_HA_RESERVATION_DOWN Info Cluster USD{ClusterName} passed the HA Reservation check. 10350 USER_ADDED_AFFINITY_GROUP Info Affinity Group USD{affinityGroupName} was added. (User: USD{UserName}) 10351 USER_FAILED_TO_ADD_AFFINITY_GROUP Error Failed to add Affinity Group USD{affinityGroupName}. (User: USD{UserName}) 10352 USER_UPDATED_AFFINITY_GROUP Info Affinity Group USD{affinityGroupName} was updated. (User: USD{UserName}) 10353 USER_FAILED_TO_UPDATE_AFFINITY_GROUP Error Failed to update Affinity Group USD{affinityGroupName}. (User: USD{UserName}) 10354 USER_REMOVED_AFFINITY_GROUP Info Affinity Group USD{affinityGroupName} was removed. (User: USD{UserName}) 10355 USER_FAILED_TO_REMOVE_AFFINITY_GROUP Error Failed to remove Affinity Group USD{affinityGroupName}. (User: USD{UserName}) 10356 VM_TO_HOST_CONFLICT_IN_ENFORCING_POSITIVE_AND_NEGATIVE_AFFINITY Error The affinity groups: USD{AffinityGroups}, with hosts :USD{Hosts} and VMs : USD{Vms}, have VM to host conflicts between positive and negative enforcing affinity groups. 10357 VM_TO_HOST_CONFLICT_IN_POSITIVE_AND_NEGATIVE_AFFINITY Warning The affinity groups: USD{AffinityGroups}, with hosts: USD{Hosts} and VMs: USD{Vms}, have VM to host conflicts between positive and negative affinity groups. 10358 VM_TO_HOST_CONFLICTS_POSITIVE_VM_TO_VM_AFFINITY Warning The affinity groups: USD{AffinityGroups}, with hosts : USD{Hosts} and VMs: USD{Vms}, have conflicts between VM to host affinity and VM to VM positive affinity. 10359 VM_TO_HOST_CONFLICTS_NEGATIVE_VM_TO_VM_AFFINITY Warning The affinity groups: USD{AffinityGroups}, with hosts : USD{Hosts} and VMs: USD{Vms}, have conflicts between VM to host affinity and VM to VM negative affinity. 10360 NON_INTERSECTING_POSITIVE_HOSTS_AFFINITY_CONFLICTS Warning The affinity groups: USD{AffinityGroups}, with hosts : USD{Hosts} and VMs : USD{Vms} , have non intersecting positive hosts conflicts. 10361 VM_TO_VM_AFFINITY_CONFLICTS Error 10380 USER_ADDED_AFFINITY_LABEL Info Affinity Label USD{labelName} was added. (User: USD{UserName}) 10381 USER_FAILED_TO_ADD_AFFINITY_LABEL Error Failed to add Affinity Label USD{labelName}. (User: USD{UserName}) 10382 USER_UPDATED_AFFINITY_LABEL Info Affinity Label USD{labelName} was updated. (User: USD{UserName}) 10383 USER_FAILED_TO_UPDATE_AFFINITY_LABEL Error Failed to update Affinity Label USD{labelName}. (User: USD{UserName}) 10384 USER_REMOVED_AFFINITY_LABEL Info Affinity Label USD{labelName} was removed. (User: USD{UserName}) 10385 USER_FAILED_TO_REMOVE_AFFINITY_LABEL Error Failed to remove Affinity Label USD{labelName}. (User: USD{UserName}) 10400 ISCSI_BOND_ADD_SUCCESS Info iSCSI bond 'USD{IscsiBondName}' was successfully created in Data Center 'USD{StoragePoolName}'. 10401 ISCSI_BOND_ADD_FAILED Error Failed to create iSCSI bond 'USD{IscsiBondName}' in Data Center 'USD{StoragePoolName}'. 10402 ISCSI_BOND_EDIT_SUCCESS Info iSCSI bond 'USD{IscsiBondName}' was successfully updated. 10403 ISCSI_BOND_EDIT_FAILED Error Failed to update iSCSI bond 'USD{IscsiBondName}'. 10404 ISCSI_BOND_REMOVE_SUCCESS Info iSCSI bond 'USD{IscsiBondName}' was removed from Data Center 'USD{StoragePoolName}' 10405 ISCSI_BOND_REMOVE_FAILED Error Failed to remove iSCSI bond 'USD{IscsiBondName}' from Data Center 'USD{StoragePoolName}' 10406 ISCSI_BOND_EDIT_SUCCESS_WITH_WARNING Warning iSCSI bond 'USD{IscsiBondName}' was successfully updated but some of the hosts encountered connection issues. 10407 ISCSI_BOND_ADD_SUCCESS_WITH_WARNING Warning iSCSI bond 'USD{IscsiBondName}' was successfully created in Data Center 'USD{StoragePoolName}' but some of the hosts encountered connection issues. 10450 USER_SET_HOSTED_ENGINE_MAINTENANCE Info Hosted Engine HA maintenance mode was updated on host USD{VdsName}. 10451 USER_FAILED_TO_SET_HOSTED_ENGINE_MAINTENANCE Error Hosted Engine HA maintenance mode could not be updated on host USD{VdsName}. 10452 VDS_MAINTENANCE_MANUAL_HA Warning Host USD{VdsName} was switched to Maintenance mode, but Hosted Engine HA maintenance could not be enabled. Please enable it manually. 10453 USER_VDS_MAINTENANCE_MANUAL_HA Warning Host USD{VdsName} was switched to Maintenance mode by USD{UserName}, but Hosted Engine HA maintenance could not be enabled. Please enable it manually. 10454 VDS_ACTIVATE_MANUAL_HA Warning Host USD{VdsName} was activated by USD{UserName}, but the Hosted Engine HA service may still be in maintenance mode. If necessary, please correct this manually. 10455 VDS_ACTIVATE_MANUAL_HA_ASYNC Warning Host USD{VdsName} was autorecovered, but the Hosted Engine HA service may still be in maintenance mode. If necessary, please correct this manually. 10456 HOSTED_ENGINE_VM_IMPORT_SUCCEEDED Normal Hosted Engine VM was imported successfully 10460 HOSTED_ENGINE_DOMAIN_IMPORT_SUCCEEDED Normal Hosted Engine Storage Domain imported successfully 10461 HOSTED_ENGINE_DOMAIN_IMPORT_FAILED Error Failed to import the Hosted Engine Storage Domain 10500 EXTERNAL_SCHEDULER_PLUGIN_ERROR Error Running the external scheduler plugin 'USD{PluginName}' failed: 'USD{ErrorMessage}' 10501 EXTERNAL_SCHEDULER_ERROR Error Running the external scheduler failed: 'USD{ErrorMessage}' 10550 VM_SLA_POLICY_CPU Info VM USD{VmName} SLA Policy was set. CPU limit is set to USD{cpuLimit} 10551 VM_SLA_POLICY_STORAGE Info VM USD{VmName} SLA Policy was set. Storage policy changed for disks: [USD{diskList}] 10552 VM_SLA_POLICY_CPU_STORAGE Info VM USD{VmName} SLA Policy was set. CPU limit is set to USD{cpuLimit}. Storage policy changed for disks: [USD{diskList}] 10553 FAILED_VM_SLA_POLICY Error Failed to set SLA Policy to VM USD{VmName}. Underlying error message: USD{ErrorMessage} 10600 USER_REMOVE_AUDIT_LOG Info Event list message USD{AuditLogId} was removed by User USD{UserName}. 10601 USER_REMOVE_AUDIT_LOG_FAILED Error User USD{UserName} failed to remove event list message USD{AuditLogId}. 10602 USER_CLEAR_ALL_AUDIT_LOG_EVENTS Info All events were removed. (User: USD{UserName}) 10603 USER_CLEAR_ALL_AUDIT_LOG_EVENTS_FAILED Error Failed to remove all events. (User: USD{UserName}) 10604 USER_DISPLAY_ALL_AUDIT_LOG Info All events were displayed. (User: USD{UserName}) 10605 USER_DISPLAY_ALL_AUDIT_LOG_FAILED Error Failed to display all events. (User: USD{UserName}) 10606 USER_CLEAR_ALL_AUDIT_LOG_ALERTS Info All alerts were removed. (User: USD{UserName}) 10607 USER_CLEAR_ALL_AUDIT_LOG_ALERTS_FAILED Error Failed to remove all alerts. (User: USD{UserName}) 10700 MAC_POOL_ADD_SUCCESS Info MAC Pool 'USD{MacPoolName}' (id 10701 MAC_POOL_ADD_FAILED Error Failed to create MAC Pool 'USD{MacPoolName}'. (User: USD{UserName}) 10702 MAC_POOL_EDIT_SUCCESS Info MAC Pool 'USD{MacPoolName}' (id 10703 MAC_POOL_EDIT_FAILED Error Failed to update MAC Pool 'USD{MacPoolName}' (id 10704 MAC_POOL_REMOVE_SUCCESS Info MAC Pool 'USD{MacPoolName}' (id 10705 MAC_POOL_REMOVE_FAILED Error Failed to remove MAC Pool 'USD{MacPoolName}' (id 10750 CINDER_PROVIDER_ERROR Error An error occurred on Cinder provider: 'USD{CinderException}' 10751 CINDER_DISK_CONNECTION_FAILURE Error Failed to retrieve connection information for Cinder Disk 'USD{DiskAlias}'. 10752 CINDER_DISK_CONNECTION_VOLUME_DRIVER_UNSUPPORTED Error Unsupported volume driver for Cinder Disk 'USD{DiskAlias}'. 10753 USER_FINISHED_FAILED_REMOVE_CINDER_DISK Error Failed to remove disk USD{DiskAlias} from storage domain USD{StorageDomainName}. The following entity id could not be deleted from the Cinder provider 'USD{imageId}'. (User: USD{UserName}). 10754 USER_ADDED_LIBVIRT_SECRET Info Authentication Key USD{LibvirtSecretUUID} was added. (User: USD{UserName}). 10755 USER_FAILED_TO_ADD_LIBVIRT_SECRET Error Failed to add Authentication Key USD{LibvirtSecretUUID}. (User: USD{UserName}). 10756 USER_UPDATE_LIBVIRT_SECRET Info Authentication Key USD{LibvirtSecretUUID} was updated. (User: USD{UserName}). 10757 USER_FAILED_TO_UPDATE_LIBVIRT_SECRET Error Failed to update Authentication Key USD{LibvirtSecretUUID}. (User: USD{UserName}). 10758 USER_REMOVED_LIBVIRT_SECRET Info Authentication Key USD{LibvirtSecretUUID} was removed. (User: USD{UserName}). 10759 USER_FAILED_TO_REMOVE_LIBVIRT_SECRET Error Failed to remove Authentication Key USD{LibvirtSecretUUID}. (User: USD{UserName}). 10760 FAILED_TO_REGISTER_LIBVIRT_SECRET Error Failed to register Authentication Keys for storage domain USD{StorageDomainName} on host USD{VdsName}. 10761 FAILED_TO_UNREGISTER_LIBVIRT_SECRET Error Failed to unregister Authentication Keys for storage domain USD{StorageDomainName} on host USD{VdsName}. 10762 FAILED_TO_REGISTER_LIBVIRT_SECRET_ON_VDS Error Failed to register Authentication Keys on host USD{VdsName}. 10763 NO_LIBRBD_PACKAGE_AVAILABLE_ON_VDS Error Librbd1 package is not available on host USD{VdsName}, which is mandatory for using Cinder storage domains. 10764 FAILED_TO_FREEZE_VM Warning Failed to freeze guest filesystems on VM USD{VmName}. Note that using the created snapshot might cause data inconsistency. 10765 FAILED_TO_THAW_VM Warning Failed to thaw guest filesystems on VM USD{VmName}. The filesystems might be unresponsive until the VM is restarted. 10766 FREEZE_VM_INITIATED Normal Freeze of guest filesystems on VM USD{VmName} was initiated. 10767 FREEZE_VM_SUCCESS Normal Guest filesystems on VM USD{VmName} have been frozen successfully. 10768 THAW_VM_SUCCESS Normal Guest filesystems on VM USD{VmName} have been thawed successfully. 10769 USER_FAILED_TO_FREEZE_VM Warning Failed to freeze guest filesystems on USD{VmName} (Host: USD{VdsName}, User: USD{UserName}). 10770 USER_FAILED_TO_THAW_VM Warning Failed to thaw guest filesystems on USD{VmName} (Host: USD{VdsName}, User: USD{UserName}). 10771 VDS_CANNOT_CONNECT_TO_GLUSTERFS Error Host USD{VdsName} cannot connect to Glusterfs. Verify that glusterfs-cli package is installed on the host. 10780 AFFINITY_RULES_ENFORCEMENT_MANAGER_START Normal Affinity Rules Enforcement Manager started. 10781 AFFINITY_RULES_ENFORCEMENT_MANAGER_INTERVAL_REACHED Normal 10800 VM_ADD_HOST_DEVICES Info Host devices USD{NamesAdded} were attached to Vm USD{VmName} by User USD{UserName}. 10801 VM_REMOVE_HOST_DEVICES Info Host devices USD{NamesRemoved} were detached from Vm USD{VmName} by User USD{UserName}. 10802 VDS_BROKER_COMMAND_FAILURE Error VDSM USD{VdsName} command USD{CommandName} failed: USD{message} 10803 IRS_BROKER_COMMAND_FAILURE Error VDSM command USD{CommandName} failed: USD{message} 10804 VDS_UNKNOWN_HOST Error The address of host USD{VdsName} could not be determined 10810 SYSTEM_CHANGE_STORAGE_POOL_STATUS_UP_REPORTING_HOSTS Normal Data Center USD{StoragePoolName} status was changed to UP as some of its hosts are in status UP. 10811 SYSTEM_CHANGE_STORAGE_POOL_STATUS_NON_RESPONSIVE_NO_REPORTING_HOSTS Info Data Center USD{StoragePoolName} status was changed to Non Responsive as none of its hosts are in status UP. 10812 STORAGE_POOL_LOWER_THAN_ENGINE_HIGHEST_CLUSTER_LEVEL Info Data Center USD{StoragePoolName} compatibility version is USD{dcVersion}, which is lower than latest engine version USD{engineVersion}. Please upgrade your Data Center to latest version to successfully finish upgrade of your setup. 10900 HOST_SYNC_ALL_NETWORKS_FAILED Error Failed to sync all host USD{VdsName} networks 10901 HOST_SYNC_ALL_NETWORKS_FINISHED Info Managed to sync all host USD{VdsName} networks. 10902 PERSIST_HOST_SETUP_NETWORK_ON_HOST Info (USD{Sequence}/USD{Total}): Applying network's changes on host USD{VdsName}. (User: USD{UserName}) 10903 PERSIST_SETUP_NETWORK_ON_HOST_FINISHED Info (USD{Sequence}/USD{Total}): Successfully applied changes on host USD{VdsName}. (User: USD{UserName}) 10904 PERSIST_SETUP_NETWORK_ON_HOST_FAILED Error (USD{Sequence}/USD{Total}): Failed to apply changes on host USD{VdsName}. (User: USD{UserName}) 10905 CLUSTER_SYNC_ALL_NETWORKS_FAILED Error Failed to sync all cluster USD{ClusterName} networks 10906 CLUSTER_SYNC_ALL_NETWORKS_STARTED Info Started sync of all cluster USD{ClusterName} networks. 10910 NETWORK_REMOVE_NIC_FILTER_PARAMETER Info Network interface filter parameter (id USD{VmNicFilterParameterId}) was successfully removed by USD{UserName}. 10911 NETWORK_REMOVE_NIC_FILTER_PARAMETER_FAILED Error Failed to remove network interface filter parameter ((id USD{VmNicFilterParameterId}) by USD{UserName}. 10912 NETWORK_ADD_NIC_FILTER_PARAMETER Info Network interface filter parameter USD{VmNicFilterParameterName} (id USD{VmNicFilterParameterId}) was successfully added to Interface with id USD{VmInterfaceId} on VM USD{VmName} by USD{UserName}. 10913 NETWORK_ADD_NIC_FILTER_PARAMETER_FAILED Error Failed to add network interface filter parameter USD{VmNicFilterParameterName} (id USD{VmNicFilterParameterId}) to Interface with id USD{VmInterfaceId} on VM USD{VmName} by USD{UserName} by USD{UserName}. 10914 NETWORK_UPDATE_NIC_FILTER_PARAMETER Info Network interface filter parameter USD{VmNicFilterParameterName} (id USD{VmNicFilterParameterId}) on Interface with id USD{VmInterfaceId} on VM USD{VmName} was successfully updated by USD{UserName}. 10915 NETWORK_UPDATE_NIC_FILTER_PARAMETER_FAILED Error Failed to update network interface filter parameter USD{VmNicFilterParameterName} (id USD{VmNicFilterParameterId}) on Interface with id USD{VmInterfaceId} on VM USD{VmName} by USD{UserName}. 10916 MAC_ADDRESS_HAD_TO_BE_REALLOCATED Warning Some MAC addresses had to be reallocated because they are duplicate. 10917 MAC_ADDRESS_VIOLATES_NO_DUPLICATES_SETTING Error Duplicate MAC addresses had to be introduced into mac pool violating no duplicates setting. 10918 MAC_ADDRESS_COULDNT_BE_REALLOCATED Error Some MAC addresses had to be reallocated, but operation failed because of insufficient amount of free MACs. 10920 NETWORK_IMPORT_EXTERNAL_NETWORK Info Successfully initiated import of external network USD{NetworkName} from provider USD{ProviderName}. 10921 NETWORK_IMPORT_EXTERNAL_NETWORK_FAILED Error Failed to initiate external network USD{NetworkName} from provider USD{ProviderName}. 10922 NETWORK_IMPORT_EXTERNAL_NETWORK_INTERNAL Info 10923 NETWORK_IMPORT_EXTERNAL_NETWORK_INTERNAL_FAILED Error 10924 NETWORK_AUTO_DEFINE_NO_DEFAULT_EXTERNAL_PROVIDER Warning Cannot create auto-defined network connected to USD{NetworkName}. Cluster USD{ClusterName} does not have default external network provider. 11000 USER_ADD_EXTERNAL_JOB Info New external Job USD{description} was added by user USD{UserName} 11001 USER_ADD_EXTERNAL_JOB_FAILED Error Failed to add new external Job USD{description} 11500 FAULTY_MULTIPATHS_ON_HOST Warning Faulty multipath paths on host USD{VdsName} on devices: [USD{MpathGuids}] 11501 NO_FAULTY_MULTIPATHS_ON_HOST Normal No faulty multipath paths on host USD{VdsName} 11502 MULTIPATH_DEVICES_WITHOUT_VALID_PATHS_ON_HOST Warning Multipath devices without valid paths on host USD{VdsName} : [USD{MpathGuids}] 12000 MIGRATION_REASON_AFFINITY_ENFORCEMENT Info Affinity rules enforcement 12001 MIGRATION_REASON_LOAD_BALANCING Info Load balancing 12002 MIGRATION_REASON_HOST_IN_MAINTENANCE Info Host preparing for maintenance 12003 VM_MIGRATION_NOT_ALL_VM_NICS_WERE_PLUGGED_BACK Error After migration of USD{VmName}, following vm nics failed to be plugged back: USD{NamesOfNotRepluggedNics}. 12004 VM_MIGRATION_PLUGGING_VM_NICS_FAILED Error After migration of USD{VmName} vm nics failed to be plugged back. 12005 CLUSTER_CANNOT_UPDATE_VM_COMPATIBILITY_VERSION Error Cannot update compatibility version of Vm/Template: [USD{VmName}], Message: USD{Message} 13000 DEPRECATED_API Warning Client from address "USD{ClientAddress}" is using version USD{ApiVersion} of the API, which has been \ 13001 DEPRECATED_IPTABLES_FIREWALL Warning Cluster USD{ClusterName} uses IPTables firewall, which has been deprecated in \	null	https://docs.redhat.com/en/documentation/red_hat_virtualization/4.4/html/technical_reference/appe-event_codes
Compatibility Guide	Compatibility Guide Red Hat Ceph Storage 5 Red Hat Ceph Storage and Its Compatibility With Other Products Red Hat Ceph Storage Documentation Team	null	https://docs.redhat.com/en/documentation/red_hat_ceph_storage/5/html/compatibility_guide/index
30.8. Statistics Files in /sys	30.8. Statistics Files in /sys Statistics for a running VDO volume may be read from files in the /sys/kvdo/ volume_name /statistics directory, where volume_name is the name of thhe VDO volume. This provides an alternate interface to the data produced by the vdostats utility suitable for access by shell scripts and management software. There are files in the statistics directory in addition to the ones listed in the table below. These additional statistics files are not guaranteed to be supported in future releases. Table 30.10. Statistics files File Description dataBlocksUsed The number of physical blocks currently in use by a VDO volume to store data. logicalBlocksUsed The number of logical blocks currently mapped. physicalBlocks The total number of physical blocks allocated for a VDO volume. logicalBlocks The maximum number of logical blocks that can be mapped by a VDO volume. mode Indicates whether a VDO volume is operating normally, is in recovery mode, or is in read-only mode.	null	https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/storage_administration_guide/vdo-ig-integrating-sysfs-entries
Chapter 9. File Systems	Chapter 9. File Systems The CephFS kernel client is fully supported with Red Hat Ceph Storage 3 The Ceph File System (CephFS) kernel module enables Red Hat Enterprise Linux nodes to mount Ceph File Systems from Red Hat Ceph Storage clusters. The kernel client in Red Hat Enterprise Linux is a more efficient alternative to the Filesystem in Userspace (FUSE) client included with Red Hat Ceph Storage. Note that the kernel client currently lacks support for CephFS quotas. The CephFS kernel client was introduced in Red Hat Enterprise Linux 7.3 as a Technology Preview, and since the release of Red Hat Ceph Storage 3, CephFS is fully supported. For more information, see the Ceph File System Guide for Red Hat Ceph Storage 3: https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/3/html/ceph_file_system_guide/ . (BZ#1205497) XFS now supports modifying labels on mounted file systems You can now modify the label attribute of mounted XFS file systems using the xfs_io utility: Previously, it was only possible to modify labels on unmounted file systems using the xfs_admin utility, which is still supported. (BZ# 1322930 ) pNFS SCSI layout is now fully supported for client and server Client and server support for parallel NFS (pNFS) SCSI layouts is now fully supported. It was first introduced in Red Hat Enterprise Linux 7.3 as a Technology Preview. Building on the work of block layouts, the pNFS layout is defined across SCSI devices and contains sequential series of fixed-size blocks as logical units that must be capable of supporting SCSI persistent reservations. The Logical Unit (LU) devices are identified by their SCSI device identification, and fencing is handled through the assignment of reservations. (BZ#1305092) ima-evm-utils is now fully supported on AMD64 and Intel 64 The ima-evm-utils package is now fully supported when used on the AMD64 and Intel 64 architecture. Note that on other architectures, ima-evm-utils remains in Technology Preview. The ima-evm-utils package provides utilities to label the file system and verify the integrity of your system at run time using the Integrity Measurement Architecture (IMA) and Extended Verification Module (EVM) features. These utilities enable you to monitor if files have been accidentally or maliciously altered. (BZ#1627278)	[ "xfs_io -c \"label -s new-label\" /mount-point" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/7.6_release_notes/new_features_file_systems
Installing Red Hat Virtualization as a standalone Manager with local databases	Installing Red Hat Virtualization as a standalone Manager with local databases Red Hat Virtualization 4.4 Installing the Red Hat Virtualization Manager and its databases on the same server Red Hat Virtualization Documentation Team Red Hat Customer Content Services [email protected] Abstract This document describes how to install a standalone Manager environment - where the Red Hat Virtualization Manager is installed on either a physical server or a virtual machine hosted in another environment - with the Manager database and the Data Warehouse service and database installed on the same machine as the Manager. If this is not the configuration you want to use, see the other Installation Options in the Product Guide .	null	https://docs.redhat.com/en/documentation/red_hat_virtualization/4.4/html/installing_red_hat_virtualization_as_a_standalone_manager_with_local_databases/index
Making open source more inclusive	Making open source more inclusive Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright's message .	null	https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.13/html/managing_and_allocating_storage_resources/making-open-source-more-inclusive
Chapter 2. ConsoleCLIDownload [console.openshift.io/v1]	Chapter 2. ConsoleCLIDownload [console.openshift.io/v1] Description ConsoleCLIDownload is an extension for configuring openshift web console command line interface (CLI) downloads. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer). 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's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata spec object ConsoleCLIDownloadSpec is the desired cli download configuration. 2.1.1. .spec Description ConsoleCLIDownloadSpec is the desired cli download configuration. Type object Required description displayName links Property Type Description description string description is the description of the CLI download (can include markdown). displayName string displayName is the display name of the CLI download. links array links is a list of objects that provide CLI download link details. links[] object 2.1.2. .spec.links Description links is a list of objects that provide CLI download link details. Type array 2.1.3. .spec.links[] Description Type object Required href Property Type Description href string href is the absolute secure URL for the link (must use https) text string text is the display text for the link 2.2. API endpoints The following API endpoints are available: /apis/console.openshift.io/v1/consoleclidownloads DELETE : delete collection of ConsoleCLIDownload GET : list objects of kind ConsoleCLIDownload POST : create a ConsoleCLIDownload /apis/console.openshift.io/v1/consoleclidownloads/{name} DELETE : delete a ConsoleCLIDownload GET : read the specified ConsoleCLIDownload PATCH : partially update the specified ConsoleCLIDownload PUT : replace the specified ConsoleCLIDownload /apis/console.openshift.io/v1/consoleclidownloads/{name}/status GET : read status of the specified ConsoleCLIDownload PATCH : partially update status of the specified ConsoleCLIDownload PUT : replace status of the specified ConsoleCLIDownload 2.2.1. /apis/console.openshift.io/v1/consoleclidownloads HTTP method DELETE Description delete collection of ConsoleCLIDownload Table 2.1. HTTP responses HTTP code Reponse body 200 - OK Status schema 401 - Unauthorized Empty HTTP method GET Description list objects of kind ConsoleCLIDownload Table 2.2. HTTP responses HTTP code Reponse body 200 - OK ConsoleCLIDownloadList schema 401 - Unauthorized Empty HTTP method POST Description create a ConsoleCLIDownload Table 2.3. 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.4. Body parameters Parameter Type Description body ConsoleCLIDownload schema Table 2.5. HTTP responses HTTP code Reponse body 200 - OK ConsoleCLIDownload schema 201 - Created ConsoleCLIDownload schema 202 - Accepted ConsoleCLIDownload schema 401 - Unauthorized Empty 2.2.2. /apis/console.openshift.io/v1/consoleclidownloads/{name} Table 2.6. Global path parameters Parameter Type Description name string name of the ConsoleCLIDownload HTTP method DELETE Description delete a ConsoleCLIDownload Table 2.7. 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.8. HTTP responses HTTP code Reponse body 200 - OK Status schema 202 - Accepted Status schema 401 - Unauthorized Empty HTTP method GET Description read the specified ConsoleCLIDownload Table 2.9. HTTP responses HTTP code Reponse body 200 - OK ConsoleCLIDownload schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified ConsoleCLIDownload Table 2.10. 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.11. HTTP responses HTTP code Reponse body 200 - OK ConsoleCLIDownload schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified ConsoleCLIDownload 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. Body parameters Parameter Type Description body ConsoleCLIDownload schema Table 2.14. HTTP responses HTTP code Reponse body 200 - OK ConsoleCLIDownload schema 201 - Created ConsoleCLIDownload schema 401 - Unauthorized Empty 2.2.3. /apis/console.openshift.io/v1/consoleclidownloads/{name}/status Table 2.15. Global path parameters Parameter Type Description name string name of the ConsoleCLIDownload HTTP method GET Description read status of the specified ConsoleCLIDownload Table 2.16. HTTP responses HTTP code Reponse body 200 - OK ConsoleCLIDownload schema 401 - Unauthorized Empty HTTP method PATCH Description partially update status of the specified ConsoleCLIDownload Table 2.17. 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.18. HTTP responses HTTP code Reponse body 200 - OK ConsoleCLIDownload schema 401 - Unauthorized Empty HTTP method PUT Description replace status of the specified ConsoleCLIDownload Table 2.19. 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.20. Body parameters Parameter Type Description body ConsoleCLIDownload schema Table 2.21. HTTP responses HTTP code Reponse body 200 - OK ConsoleCLIDownload schema 201 - Created ConsoleCLIDownload schema 401 - Unauthorized Empty	null	https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/console_apis/consoleclidownload-console-openshift-io-v1
Chapter 2. Differences from upstream OpenJDK 11	Chapter 2. Differences from upstream OpenJDK 11 Red Hat build of OpenJDK in Red Hat Enterprise Linux (RHEL) contains a number of structural changes from the upstream distribution of OpenJDK. The Microsoft Windows version of Red Hat build of OpenJDK attempts to follow RHEL updates as closely as possible. The following list details the most notable Red Hat build of OpenJDK 11 changes: FIPS support. Red Hat build of OpenJDK 11 automatically detects whether RHEL is in FIPS mode and automatically configures Red Hat build of OpenJDK 11 to operate in that mode. This change does not apply to Red Hat build of OpenJDK builds for Microsoft Windows. Cryptographic policy support. Red Hat build of OpenJDK 11 obtains the list of enabled cryptographic algorithms and key size constraints from RHEL. These configuration components are used by the Transport Layer Security (TLS) encryption protocol, the certificate path validation, and any signed JARs. You can set different security profiles to balance safety and compatibility. This change does not apply to Red Hat build of OpenJDK builds for Microsoft Windows. Red Hat build of OpenJDK on RHEL dynamically links against native libraries such as zlib for archive format support and libjpeg-turbo , libpng , and giflib for image support. RHEL also dynamically links against Harfbuzz and Freetype for font rendering and management. The src.zip file includes the source for all the JAR libraries shipped with Red Hat build of OpenJDK. Red Hat build of OpenJDK on RHEL uses system-wide timezone data files as a source for timezone information. Red Hat build of OpenJDK on RHEL uses system-wide CA certificates. Red Hat build of OpenJDK on Microsoft Windows includes the latest available timezone data from RHEL. Red Hat build of OpenJDK on Microsoft Windows uses the latest available CA certificate from RHEL. Additional resources For more information about detecting if a system is in FIPS mode, see the Improve system FIPS detection example on the Red Hat RHEL Planning Jira. For more information about cryptographic policies, see Using system-wide cryptographic policies .	null	https://docs.redhat.com/en/documentation/red_hat_build_of_openjdk/11/html/release_notes_for_red_hat_build_of_openjdk_11.0.17/rn-openjdk-diff-from-upstream
Chapter 34. Elasticsearch	Chapter 34. Elasticsearch Since Camel 3.18.3 Only producer is supported The ElasticSearch component allows you to interface with an ElasticSearch 8.x API using the Java API Client library. 34.1. Dependencies When using elasticsearch with Red Hat build of Camel Spring Boot make sure to use the following Maven dependency to have support for auto configuration: <dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-elasticsearch-starter</artifactId> </dependency> 34.2. URI format 34.3. Configuring Options Camel components are configured on two separate levels: component level endpoint level 34.3.1. Configuring Component Options At the component level, you set general and shared configurations that are, then, inherited by the endpoints. It is the highest configuration level. For example, a component may have security settings, credentials for authentication, urls for network connection and so forth. Some components only have a few options, and others may have many. Because components typically have pre-configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all. You can configure components using: the Component DSL . in a configuration file (application.properties, *.yaml files, etc). directly in the Java code. 34.3.2. Configuring Endpoint Options You usually spend more time setting up endpoints because they have many options. These options help you customize what you want the endpoint to do. The options are also categorized into whether the endpoint is used as a consumer (from), as a producer (to), or both. Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java. A good practice when configuring options is to use Property Placeholders . Property placeholders provide a few benefits: They help prevent using hardcoded urls, port numbers, sensitive information, and other settings. They allow externalizing the configuration from the code. They help the code to become more flexible and reusable. The following two sections list all the options, firstly for the component followed by the endpoint. 34.4. Component Options The Elasticsearch component supports 14 options, which are listed below. Name Description Default Type connectionTimeout (producer) The time in ms to wait before connection will timeout. 30000 int hostAddresses (producer) Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for hostAddresses to be considered instead. String lazyStartProducer (producer) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false boolean maxRetryTimeout (producer) The time in ms before retry. 30000 int socketTimeout (producer) The timeout in ms to wait before the socket will timeout. 30000 int autowiredEnabled (advanced) Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. true boolean client (advanced) Autowired To use an existing configured Elasticsearch client, instead of creating a client per endpoint. This allow to customize the client with specific settings. RestClient enableSniffer (advanced) Enable automatically discover nodes from a running Elasticsearch cluster. If this option is used in conjunction with Spring Boot then it's managed by the Spring Boot configuration (see: Disable Sniffer in Spring Boot). false boolean sniffAfterFailureDelay (advanced) The delay of a sniff execution scheduled after a failure (in milliseconds). 60000 int snifferInterval (advanced) The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions. 300000 int certificatePath (security) The path of the self-signed certificate to use to access to Elasticsearch. String enableSSL (security) Enable SSL. false boolean password (security) Password for authenticate. String user (security) Basic authenticate user. String 34.5. Endpoint Options The Elasticsearch endpoint is configured using URI syntax: with the following path and query parameters: 34.5.1. Path Parameters (1 parameters) Name Description Default Type clusterName (producer) Required Name of the cluster. String 34.5.2. Query Parameters (19 parameters) Name Description Default Type connectionTimeout (producer) The time in ms to wait before connection will timeout. 30000 int disconnect (producer) Disconnect after it finish calling the producer. false boolean from (producer) Starting index of the response. Integer hostAddresses (producer) Comma separated list with ip:port formatted remote transport addresses to use. String indexName (producer) The name of the index to act against. String maxRetryTimeout (producer) The time in ms before retry. 30000 int operation (producer) What operation to perform. Enum values: Index Update Bulk GetById MultiGet MultiSearch Delete DeleteIndex Search Exists Ping ElasticsearchOperation scrollKeepAliveMs (producer) Time in ms during which elasticsearch will keep search context alive. 60000 int size (producer) Size of the response. Integer socketTimeout (producer) The timeout in ms to wait before the socket will timeout. 30000 int useScroll (producer) Enable scroll usage. false boolean waitForActiveShards (producer) Index creation waits for the write consistency number of shards to be available. 1 int lazyStartProducer (producer (advanced)) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false boolean documentClass (advanced) The class to use when deserializing the documents. ObjectNode Class enableSniffer (advanced) Enable automatically discover nodes from a running Elasticsearch cluster. If this option is used in conjunction with Spring Boot then it's managed by the Spring Boot configuration (see: Disable Sniffer in Spring Boot). false boolean sniffAfterFailureDelay (advanced) The delay of a sniff execution scheduled after a failure (in milliseconds). 60000 int snifferInterval (advanced) The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions. 300000 int certificatePath (security) The path of the self-signed certificate to use to access to Elasticsearch. String enableSSL (security) Enable SSL. false boolean 34.6. Message Headers The Elasticsearch component supports 9 message header(s), which is/are listed below: Name Description Default Type operation (producer) Constant: PARAM_OPERATION The operation to perform. Enum values: Index Update Bulk GetById MultiGet MultiSearch Delete DeleteIndex Search Exists Ping ElasticsearchOperation indexId (producer) Constant: PARAM_INDEX_ID The id of the indexed document. String indexName (producer) Constant: PARAM_INDEX_NAME The name of the index to act against. String documentClass (producer) Constant: PARAM_DOCUMENT_CLASS The full qualified name of the class of the document to unmarshall. ObjectNode Class waitForActiveShards (producer) Constant: PARAM_WAIT_FOR_ACTIVE_SHARDS The index creation waits for the write consistency number of shards to be available. Integer scrollKeepAliveMs (producer) Constant: PARAM_SCROLL_KEEP_ALIVE_MS The starting index of the response. Integer useScroll (producer) Constant: PARAM_SCROLL Set to true to enable scroll usage. Boolean size (producer) Constant: PARAM_SIZE The size of the response. Integer from (producer) Constant: PARAM_FROM The starting index of the response. Integer 34.7. Message Operations The following ElasticSearch operations are currently supported. Simply set an endpoint URI option or exchange header with a key of "operation" and a value set to one of the following. Some operations also require other parameters or the message body to be set. operation message body description Index Map , String , byte[] , Reader , InputStream or IndexRequest.Builder content to index Adds content to an index and returns the content's indexId in the body. You can set the name of the target index by setting the message header with the key "indexName". You can set the indexId by setting the message header with the key "indexId". GetById String or GetRequest.Builder index id of content to retrieve Retrieves the document corresponding to the given index id and returns a GetResponse object in the body. You can set the name of the target index by setting the message header with the key "indexName". You can set the type of document by setting the message header with the key "documentClass". Delete String or DeleteRequest.Builder index id of content to delete Deletes the specified indexName and returns a Result object in the body. You can set the name of the target index by setting the message header with the key "indexName". DeleteIndex String or DeleteIndexRequest.Builder index name of the index to delete Deletes the specified indexName and returns a status code in the body. You can set the name of the target index by setting the message header with the key "indexName". Bulk Iterable or BulkRequest.Builder of any type that is already accepted (DeleteOperation.Builder for delete operation, UpdateOperation.Builder for update operation, CreateOperation.Builder for create operation, byte[], InputStream, String, Reader, Map or any document type for index operation) Adds/Updates/Deletes content from/to an index and returns a List<BulkResponseItem> object in the body You can set the name of the target index by setting the message header with the key "indexName". Search Map , String or SearchRequest.Builder Search the content with the map of query string. You can set the name of the target index by setting the message header with the key "indexName". You can set the number of hits to return by setting the message header with the key "size". You can set the starting document offset by setting the message header with the key "from". MultiSearch MsearchRequest.Builder Multiple search in one MultiGet Iterable<String> or MgetRequest.Builder the id of the document to retrieve Multiple get in one You can set the name of the target index by setting the message header with the key "indexName". Exists None Checks whether the index exists or not and returns a Boolean flag in the body. You must set the name of the target index by setting the message header with the key "indexName". Update byte[] , InputStream , String , Reader , Map or any document type content to update Updates content to an index and returns the content's indexId in the body. You can set the name of the target index by setting the message header with the key "indexName". You can set the indexId by setting the message header with the key "indexId". Ping None Pings the Elasticsearch cluster and returns true if the ping succeeded, false otherwise 34.8. Configure the component and enable basic authentication To use the Elasticsearch component it has to be configured with a minimum configuration. ElasticsearchComponent elasticsearchComponent = new ElasticsearchComponent(); elasticsearchComponent.setHostAddresses("myelkhost:9200"); camelContext.addComponent("elasticsearch", elasticsearchComponent); For basic authentication with elasticsearch or using reverse http proxy in front of the elasticsearch cluster, simply setup basic authentication and SSL on the component like the example below ElasticsearchComponent elasticsearchComponent = new ElasticsearchComponent(); elasticsearchComponent.setHostAddresses("myelkhost:9200"); elasticsearchComponent.setUser("elkuser"); elasticsearchComponent.setPassword("secure!!"); elasticsearchComponent.setEnableSSL(true); elasticsearchComponent.setCertificatePath(certPath); camelContext.addComponent("elasticsearch", elasticsearchComponent); 34.9. Index Example Below is a simple INDEX example from("direct:index") .to("elasticsearch://elasticsearch?operation=Index&indexName=twitter"); <route> <from uri="direct:index"/> <to uri="elasticsearch://elasticsearch?operation=Index&indexName=twitter"/> </route> For this operation you need to specify a indexId header. A client would simply need to pass a body message containing a Map to the route. The result body contains the indexId created. Map<String, String> map = new HashMap<String, String>(); map.put("content", "test"); String indexId = template.requestBody("direct:index", map, String.class); 34.10. Search Example Searching on specific field(s) and value use the Operation \u0301Search \u0301. Pass in the query JSON String or the Map from("direct:search") .to("elasticsearch://elasticsearch?operation=Search&indexName=twitter"); <route> <from uri="direct:search"/> <to uri="elasticsearch://elasticsearch?operation=Search&indexName=twitter"/> </route> String query = "{\"query\":{\"match\":{\"doc.content\":\"new release of ApacheCamel\"}}}"; HitsMetadata<?> response = template.requestBody("direct:search", query, HitsMetadata.class); Search on specific field(s) using Map. Map<String, Object> actualQuery = new HashMap<>(); actualQuery.put("doc.content", "new release of ApacheCamel"); Map<String, Object> match = new HashMap<>(); match.put("match", actualQuery); Map<String, Object> query = new HashMap<>(); query.put("query", match); HitsMetadata<?> response = template.requestBody("direct:search", query, HitsMetadata.class); Search using Elasticsearch scroll api in order to fetch all results. from("direct:search") .to("elasticsearch://elasticsearch?operation=Search&indexName=twitter&useScroll=true&scrollKeepAliveMs=30000"); <route> <from uri="direct:search"/> <to uri="elasticsearch://elasticsearch?operation=Search&indexName=twitter&useScroll=true&scrollKeepAliveMs=30000"/> </route> String query = "{\"query\":{\"match\":{\"doc.content\":\"new release of ApacheCamel\"}}}"; try (ElasticsearchScrollRequestIterator response = template.requestBody("direct:search", query, ElasticsearchScrollRequestIterator.class)) { // do something smart with results } can also be used. from("direct:search") .to("elasticsearch://elasticsearch?operation=Search&indexName=twitter&useScroll=true&scrollKeepAliveMs=30000") .split() .body() .streaming() .to("mock:output") .end(); 34.11. MultiSearch Example MultiSearching on specific field(s) and value use the Operation \u0301MultiSearch \u0301. Pass in the MultiSearchRequest instance from("direct:multiSearch") .to("elasticsearch://elasticsearch?operation=MultiSearch"); <route> <from uri="direct:multiSearch"/> <to uri="elasticsearch://elasticsearch?operation=MultiSearch"/> </route> MultiSearch on specific field(s) MsearchRequest.Builder builder = new MsearchRequest.Builder().index("twitter").searches( new RequestItem.Builder().header(new MultisearchHeader.Builder().build()) .body(new MultisearchBody.Builder().query(b -> b.matchAll(x -> x)).build()).build(), new RequestItem.Builder().header(new MultisearchHeader.Builder().build()) .body(new MultisearchBody.Builder().query(b -> b.matchAll(x -> x)).build()).build()); List<MultiSearchResponseItem<?>> response = template.requestBody("direct:multiSearch", builder, List.class); 34.12. Document type For all the search operations, it is possible to indicate the type of document to retrieve in order to get the result already unmarshalled with the expected type. The document type can be set using the header "documentClass" or via the uri parameter of the same name. 34.13. Using Camel Elasticsearch with Spring Boot When you use camel-elasticsearch-starter with Spring Boot v2, then you must declare the following dependency in your own pom.xml . <dependency> <groupId>jakarta.json</groupId> <artifactId>jakarta.json-api</artifactId> <version>2.0.2</version> </dependency> This is needed because Spring Boot v2 provides jakarta.json-api:1.1.6, and Elasticsearch requires to use json-api v2. 34.13.1. Use RestClient provided by Spring Boot By default Spring Boot will auto configure an Elasticsearch RestClient that will be used by camel, it is possible to customize the client with the following basic properties: spring.elasticsearch.uris=myelkhost:9200 spring.elasticsearch.username=elkuser spring.elasticsearch.password=secure!! More information can be found in application-properties.data.spring.elasticsearch.connection-timeout . 34.13.2. Disable Sniffer when using Spring Boot When Spring Boot is on the classpath the Sniffer client for Elasticsearch is enabled by default. This option can be disabled in the Spring Boot Configuration: spring: autoconfigure: exclude: org.springframework.boot.autoconfigure.elasticsearch.ElasticsearchRestClientAutoConfiguration 34.14. Spring Boot Auto-Configuration The component supports 15 options, which are listed below. Name Description Default Type camel.component.elasticsearch.autowired-enabled Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. true Boolean camel.component.elasticsearch.certificate-path The path of the self-signed certificate to use to access to Elasticsearch. String camel.component.elasticsearch.client To use an existing configured Elasticsearch client, instead of creating a client per endpoint. This allow to customize the client with specific settings. The option is a org.elasticsearch.client.RestClient type. RestClient camel.component.elasticsearch.connection-timeout The time in ms to wait before connection will timeout. 30000 Integer camel.component.elasticsearch.enable-s-s-l Enable SSL. false Boolean camel.component.elasticsearch.enable-sniffer Enable automatically discover nodes from a running Elasticsearch cluster. If this option is used in conjunction with Spring Boot then it's managed by the Spring Boot configuration (see: Disable Sniffer in Spring Boot). false Boolean camel.component.elasticsearch.enabled Whether to enable auto configuration of the elasticsearch component. This is enabled by default. Boolean camel.component.elasticsearch.host-addresses Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for hostAddresses to be considered instead. String camel.component.elasticsearch.lazy-start-producer Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false Boolean camel.component.elasticsearch.max-retry-timeout The time in ms before retry. 30000 Integer camel.component.elasticsearch.password Password for authenticate. String camel.component.elasticsearch.sniff-after-failure-delay The delay of a sniff execution scheduled after a failure (in milliseconds). 60000 Integer camel.component.elasticsearch.sniffer-interval The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions. 300000 Integer camel.component.elasticsearch.socket-timeout The timeout in ms to wait before the socket will timeout. 30000 Integer camel.component.elasticsearch.user Basic authenticate user. String	[ "<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-elasticsearch-starter</artifactId> </dependency>", "elasticsearch://clusterName[?options]", "elasticsearch:clusterName", "ElasticsearchComponent elasticsearchComponent = new ElasticsearchComponent(); elasticsearchComponent.setHostAddresses(\"myelkhost:9200\"); camelContext.addComponent(\"elasticsearch\", elasticsearchComponent);", "ElasticsearchComponent elasticsearchComponent = new ElasticsearchComponent(); elasticsearchComponent.setHostAddresses(\"myelkhost:9200\"); elasticsearchComponent.setUser(\"elkuser\"); elasticsearchComponent.setPassword(\"secure!!\"); elasticsearchComponent.setEnableSSL(true); elasticsearchComponent.setCertificatePath(certPath); camelContext.addComponent(\"elasticsearch\", elasticsearchComponent);", "from(\"direct:index\") .to(\"elasticsearch://elasticsearch?operation=Index&indexName=twitter\");", "<route> <from uri=\"direct:index\"/> <to uri=\"elasticsearch://elasticsearch?operation=Index&indexName=twitter\"/> </route>", "Map<String, String> map = new HashMap<String, String>(); map.put(\"content\", \"test\"); String indexId = template.requestBody(\"direct:index\", map, String.class);", "from(\"direct:search\") .to(\"elasticsearch://elasticsearch?operation=Search&indexName=twitter\");", "<route> <from uri=\"direct:search\"/> <to uri=\"elasticsearch://elasticsearch?operation=Search&indexName=twitter\"/> </route>", "String query = \"{\\\"query\\\":{\\\"match\\\":{\\\"doc.content\\\":\\\"new release of ApacheCamel\\\"}}}\"; HitsMetadata<?> response = template.requestBody(\"direct:search\", query, HitsMetadata.class);", "Map<String, Object> actualQuery = new HashMap<>(); actualQuery.put(\"doc.content\", \"new release of ApacheCamel\"); Map<String, Object> match = new HashMap<>(); match.put(\"match\", actualQuery); Map<String, Object> query = new HashMap<>(); query.put(\"query\", match); HitsMetadata<?> response = template.requestBody(\"direct:search\", query, HitsMetadata.class);", "from(\"direct:search\") .to(\"elasticsearch://elasticsearch?operation=Search&indexName=twitter&useScroll=true&scrollKeepAliveMs=30000\");", "<route> <from uri=\"direct:search\"/> <to uri=\"elasticsearch://elasticsearch?operation=Search&indexName=twitter&useScroll=true&scrollKeepAliveMs=30000\"/> </route>", "String query = \"{\\\"query\\\":{\\\"match\\\":{\\\"doc.content\\\":\\\"new release of ApacheCamel\\\"}}}\"; try (ElasticsearchScrollRequestIterator response = template.requestBody(\"direct:search\", query, ElasticsearchScrollRequestIterator.class)) { // do something smart with results }", "from(\"direct:search\") .to(\"elasticsearch://elasticsearch?operation=Search&indexName=twitter&useScroll=true&scrollKeepAliveMs=30000\") .split() .body() .streaming() .to(\"mock:output\") .end();", "from(\"direct:multiSearch\") .to(\"elasticsearch://elasticsearch?operation=MultiSearch\");", "<route> <from uri=\"direct:multiSearch\"/> <to uri=\"elasticsearch://elasticsearch?operation=MultiSearch\"/> </route>", "MsearchRequest.Builder builder = new MsearchRequest.Builder().index(\"twitter\").searches( new RequestItem.Builder().header(new MultisearchHeader.Builder().build()) .body(new MultisearchBody.Builder().query(b -> b.matchAll(x -> x)).build()).build(), new RequestItem.Builder().header(new MultisearchHeader.Builder().build()) .body(new MultisearchBody.Builder().query(b -> b.matchAll(x -> x)).build()).build()); List<MultiSearchResponseItem<?>> response = template.requestBody(\"direct:multiSearch\", builder, List.class);", "<dependency> <groupId>jakarta.json</groupId> <artifactId>jakarta.json-api</artifactId> <version>2.0.2</version> </dependency>", "spring.elasticsearch.uris=myelkhost:9200 spring.elasticsearch.username=elkuser spring.elasticsearch.password=secure!!", "spring: autoconfigure: exclude: org.springframework.boot.autoconfigure.elasticsearch.ElasticsearchRestClientAutoConfiguration" ]	https://docs.redhat.com/en/documentation/red_hat_build_of_apache_camel/4.8/html/red_hat_build_of_apache_camel_for_spring_boot_reference/csb-camel-elasticsearch-component-starter
Chapter 211. Language Component	Chapter 211. Language Component Available as of Camel version 2.5 The language component allows you to send Exchange to an endpoint which executes a script by any of the supported Languages in Camel. By having a component to execute language scripts, it allows more dynamic routing capabilities. For example by using the Routing Slip or Dynamic Router EIPs you can send messages to language endpoints where the script is dynamic defined as well. This component is provided out of the box in camel-core and hence no additional JARs is needed. You only have to include additional Camel components if the language of choice mandates it, such as using Groovy or JavaScript languages. 211.1. URI format And from Camel 2.11 onwards you can refer to an external resource for the script using same notation as supported by the other Language s in Camel 211.2. URI Options The Language component has no options. The Language endpoint is configured using URI syntax: with the following path and query parameters: 211.2.1. Path Parameters (2 parameters): Name Description Default Type languageName Required Sets the name of the language to use String resourceUri Path to the resource, or a reference to lookup a bean in the Registry to use as the resource String 211.2.2. Query Parameters (6 parameters): Name Description Default Type binary (producer) Whether the script is binary content or text content. By default the script is read as text content (eg java.lang.String) false boolean cacheScript (producer) Whether to cache the compiled script and reuse Notice reusing the script can cause side effects from processing one Camel org.apache.camel.Exchange to the org.apache.camel.Exchange. false boolean contentCache (producer) Sets whether to use resource content cache or not. false boolean script (producer) Sets the script to execute String transform (producer) Whether or not the result of the script should be used as message body. This options is default true. true boolean synchronous (advanced) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). false boolean 211.3. Message Headers The following message headers can be used to affect the behavior of the component Header Description CamelLanguageScript The script to execute provided in the header. Takes precedence over script configured on the endpoint. 211.4. Examples For example you can use the Simple language to Message Translator a message: In case you want to convert the message body type you can do this as well: You can also use the Groovy language, such as this example where the input message will by multiplied with 2: You can also provide the script as a header as shown below. Here we use XPath language to extract the text from the <foo> tag. Object out = producer.requestBodyAndHeader("language:xpath", "<foo>Hello World</foo>", Exchange.LANGUAGE_SCRIPT, "/foo/text()"); assertEquals("Hello World", out); 211.5. Loading scripts from resources Available as of Camel 2.9 You can specify a resource uri for a script to load in either the endpoint uri, or in the Exchange.LANGUAGE_SCRIPT header. The uri must start with one of the following schemes: file:, classpath:, or http: For example to load a script from the classpath: By default the script is loaded once and cached. However you can disable the contentCache option and have the script loaded on each evaluation. For example if the file myscript.txt is changed on disk, then the updated script is used: From Camel 2.11 onwards you can refer to the resource similar to the other Language s in Camel by prefixing with "resource:" as shown below:	[ "language://languageName[:script][?options]", "language://languageName:resource:scheme:location][?options]", "language:languageName:resourceUri", "Object out = producer.requestBodyAndHeader(\"language:xpath\", \"<foo>Hello World</foo>\", Exchange.LANGUAGE_SCRIPT, \"/foo/text()\"); assertEquals(\"Hello World\", out);" ]	https://docs.redhat.com/en/documentation/red_hat_fuse/7.13/html/apache_camel_component_reference/language-component