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
Chapter 7. Config [imageregistry.operator.openshift.io/v1]	Chapter 7. Config [imageregistry.operator.openshift.io/v1] Description Config is the configuration object for a registry instance managed by the registry operator Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). Type object Required metadata spec 7.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 ImageRegistrySpec defines the specs for the running registry. status object ImageRegistryStatus reports image registry operational status. 7.1.1. .spec Description ImageRegistrySpec defines the specs for the running registry. Type object Required replicas Property Type Description affinity object affinity is a group of node affinity scheduling rules for the image registry pod(s). defaultRoute boolean defaultRoute indicates whether an external facing route for the registry should be created using the default generated hostname. disableRedirect boolean disableRedirect controls whether to route all data through the Registry, rather than redirecting to the backend. httpSecret string httpSecret is the value needed by the registry to secure uploads, generated by default. 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". logging integer logging is deprecated, use logLevel instead. managementState string managementState indicates whether and how the operator should manage the component nodeSelector object (string) nodeSelector defines the node selection constraints for the registry pod. 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". proxy object proxy defines the proxy to be used when calling master api, upstream registries, etc. readOnly boolean readOnly indicates whether the registry instance should reject attempts to push new images or delete existing ones. replicas integer replicas determines the number of registry instances to run. requests object requests controls how many parallel requests a given registry instance will handle before queuing additional requests. resources object resources defines the resource requests+limits for the registry pod. rolloutStrategy string rolloutStrategy defines rollout strategy for the image registry deployment. routes array routes defines additional external facing routes which should be created for the registry. routes[] object ImageRegistryConfigRoute holds information on external route access to image registry. storage object storage details for configuring registry storage, e.g. S3 bucket coordinates. tolerations array tolerations defines the tolerations for the registry pod. tolerations[] object The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>. topologySpreadConstraints array topologySpreadConstraints specify how to spread matching pods among the given topology. topologySpreadConstraints[] object TopologySpreadConstraint specifies how to spread matching pods among the given topology. 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. 7.1.2. .spec.affinity Description affinity is a group of node affinity scheduling rules for the image registry pod(s). 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)). 7.1.3. .spec.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. 7.1.4. .spec.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 7.1.5. .spec.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. 7.1.6. .spec.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. 7.1.7. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions Description A list of node selector requirements by node's labels. Type array 7.1.8. .spec.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. 7.1.9. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields Description A list of node selector requirements by node's fields. Type array 7.1.10. .spec.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. 7.1.11. .spec.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. 7.1.12. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms Description Required. A list of node selector terms. The terms are ORed. Type array 7.1.13. .spec.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. 7.1.14. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions Description A list of node selector requirements by node's labels. Type array 7.1.15. .spec.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. 7.1.16. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields Description A list of node selector requirements by node's fields. Type array 7.1.17. .spec.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. 7.1.18. .spec.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 7.1.19. .spec.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 7.1.20. .spec.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. 7.1.21. .spec.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. 7.1.22. .spec.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. 7.1.23. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 7.1.24. .spec.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. 7.1.25. .spec.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. 7.1.26. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 7.1.27. .spec.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. 7.1.28. .spec.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 7.1.29. .spec.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. 7.1.30. .spec.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. 7.1.31. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 7.1.32. .spec.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. 7.1.33. .spec.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. 7.1.34. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 7.1.35. .spec.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. 7.1.36. .spec.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 7.1.37. .spec.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 7.1.38. .spec.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. 7.1.39. .spec.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. 7.1.40. .spec.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. 7.1.41. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 7.1.42. .spec.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. 7.1.43. .spec.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. 7.1.44. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 7.1.45. .spec.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. 7.1.46. .spec.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 7.1.47. .spec.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. 7.1.48. .spec.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. 7.1.49. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 7.1.50. .spec.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. 7.1.51. .spec.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. 7.1.52. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 7.1.53. .spec.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. 7.1.54. .spec.proxy Description proxy defines the proxy to be used when calling master api, upstream registries, etc. Type object Property Type Description http string http defines the proxy to be used by the image registry when accessing HTTP endpoints. https string https defines the proxy to be used by the image registry when accessing HTTPS endpoints. noProxy string noProxy defines a comma-separated list of host names that shouldn't go through any proxy. 7.1.55. .spec.requests Description requests controls how many parallel requests a given registry instance will handle before queuing additional requests. Type object Property Type Description read object read defines limits for image registry's reads. write object write defines limits for image registry's writes. 7.1.56. .spec.requests.read Description read defines limits for image registry's reads. Type object Property Type Description maxInQueue integer maxInQueue sets the maximum queued api requests to the registry. maxRunning integer maxRunning sets the maximum in flight api requests to the registry. maxWaitInQueue string maxWaitInQueue sets the maximum time a request can wait in the queue before being rejected. 7.1.57. .spec.requests.write Description write defines limits for image registry's writes. Type object Property Type Description maxInQueue integer maxInQueue sets the maximum queued api requests to the registry. maxRunning integer maxRunning sets the maximum in flight api requests to the registry. maxWaitInQueue string maxWaitInQueue sets the maximum time a request can wait in the queue before being rejected. 7.1.58. .spec.resources Description resources defines the resource requests+limits for the registry pod. 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/ 7.1.59. .spec.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 7.1.60. .spec.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. 7.1.61. .spec.routes Description routes defines additional external facing routes which should be created for the registry. Type array 7.1.62. .spec.routes[] Description ImageRegistryConfigRoute holds information on external route access to image registry. Type object Required name Property Type Description hostname string hostname for the route. name string name of the route to be created. secretName string secretName points to secret containing the certificates to be used by the route. 7.1.63. .spec.storage Description storage details for configuring registry storage, e.g. S3 bucket coordinates. Type object Property Type Description azure object azure represents configuration that uses Azure Blob Storage. emptyDir object emptyDir represents ephemeral storage on the pod's host node. WARNING: this storage cannot be used with more than 1 replica and is not suitable for production use. When the pod is removed from a node for any reason, the data in the emptyDir is deleted forever. gcs object gcs represents configuration that uses Google Cloud Storage. ibmcos object ibmcos represents configuration that uses IBM Cloud Object Storage. managementState string managementState indicates if the operator manages the underlying storage unit. If Managed the operator will remove the storage when this operator gets Removed. oss object Oss represents configuration that uses Alibaba Cloud Object Storage Service. pvc object pvc represents configuration that uses a PersistentVolumeClaim. s3 object s3 represents configuration that uses Amazon Simple Storage Service. swift object swift represents configuration that uses OpenStack Object Storage. 7.1.64. .spec.storage.azure Description azure represents configuration that uses Azure Blob Storage. Type object Property Type Description accountName string accountName defines the account to be used by the registry. cloudName string cloudName is the name of the Azure cloud environment to be used by the registry. If empty, the operator will set it based on the infrastructure object. container string container defines Azure's container to be used by registry. networkAccess object networkAccess defines the network access properties for the storage account. Defaults to type: External. 7.1.65. .spec.storage.azure.networkAccess Description networkAccess defines the network access properties for the storage account. Defaults to type: External. Type object Property Type Description internal object internal defines the vnet and subnet names to configure a private endpoint and connect it to the storage account in order to make it private. when type: Internal and internal is unset, the image registry operator will discover vnet and subnet names, and generate a private endpoint name. type string type is the network access level to be used for the storage account. type: Internal means the storage account will be private, type: External means the storage account will be publicly accessible. Internal storage accounts are only exposed within the cluster's vnet. External storage accounts are publicly exposed on the internet. When type: Internal is used, a vnetName, subNetName and privateEndpointName may optionally be specified. If unspecificed, the image registry operator will discover vnet and subnet names, and generate a privateEndpointName. Defaults to "External". 7.1.66. .spec.storage.azure.networkAccess.internal Description internal defines the vnet and subnet names to configure a private endpoint and connect it to the storage account in order to make it private. when type: Internal and internal is unset, the image registry operator will discover vnet and subnet names, and generate a private endpoint name. Type object Property Type Description networkResourceGroupName string networkResourceGroupName is the resource group name where the cluster's vnet and subnet are. When omitted, the registry operator will use the cluster resource group (from in the infrastructure status). If you set a networkResourceGroupName on your install-config.yaml, that value will be used automatically (for clusters configured with publish:Internal). Note that both vnet and subnet must be in the same resource group. It must be between 1 and 90 characters in length and must consist only of alphanumeric characters, hyphens (-), periods (.) and underscores (_), and not end with a period. privateEndpointName string privateEndpointName is the name of the private endpoint for the registry. When provided, the registry will use it as the name of the private endpoint it will create for the storage account. When omitted, the registry will generate one. It must be between 2 and 64 characters in length and must consist only of alphanumeric characters, hyphens (-), periods (.) and underscores (_). It must start with an alphanumeric character and end with an alphanumeric character or an underscore. subnetName string subnetName is the name of the subnet the registry operates in. When omitted, the registry operator will discover and set this by using the kubernetes.io_cluster.<cluster-id> tag in the vnet resource, then using one of listed subnets. Advanced cluster network configurations that use network security groups to protect subnets should ensure the provided subnetName has access to Azure Storage service. It must be between 1 and 80 characters in length and must consist only of alphanumeric characters, hyphens (-), periods (.) and underscores (_). vnetName string vnetName is the name of the vnet the registry operates in. When omitted, the registry operator will discover and set this by using the kubernetes.io_cluster.<cluster-id> tag in the vnet resource. This tag is set automatically by the installer. Commonly, this will be the same vnet as the cluster. Advanced cluster network configurations should ensure the provided vnetName is the vnet of the nodes where the image registry pods are running from. It must be between 2 and 64 characters in length and must consist only of alphanumeric characters, hyphens (-), periods (.) and underscores (_). It must start with an alphanumeric character and end with an alphanumeric character or an underscore. 7.1.67. .spec.storage.emptyDir Description emptyDir represents ephemeral storage on the pod's host node. WARNING: this storage cannot be used with more than 1 replica and is not suitable for production use. When the pod is removed from a node for any reason, the data in the emptyDir is deleted forever. Type object 7.1.68. .spec.storage.gcs Description gcs represents configuration that uses Google Cloud Storage. Type object Property Type Description bucket string bucket is the bucket name in which you want to store the registry's data. Optional, will be generated if not provided. keyID string keyID is the KMS key ID to use for encryption. Optional, buckets are encrypted by default on GCP. This allows for the use of a custom encryption key. projectID string projectID is the Project ID of the GCP project that this bucket should be associated with. region string region is the GCS location in which your bucket exists. Optional, will be set based on the installed GCS Region. 7.1.69. .spec.storage.ibmcos Description ibmcos represents configuration that uses IBM Cloud Object Storage. Type object Property Type Description bucket string bucket is the bucket name in which you want to store the registry's data. Optional, will be generated if not provided. location string location is the IBM Cloud location in which your bucket exists. Optional, will be set based on the installed IBM Cloud location. resourceGroupName string resourceGroupName is the name of the IBM Cloud resource group that this bucket and its service instance is associated with. Optional, will be set based on the installed IBM Cloud resource group. resourceKeyCRN string resourceKeyCRN is the CRN of the IBM Cloud resource key that is created for the service instance. Commonly referred as a service credential and must contain HMAC type credentials. Optional, will be computed if not provided. serviceInstanceCRN string serviceInstanceCRN is the CRN of the IBM Cloud Object Storage service instance that this bucket is associated with. Optional, will be computed if not provided. 7.1.70. .spec.storage.oss Description Oss represents configuration that uses Alibaba Cloud Object Storage Service. Type object Property Type Description bucket string Bucket is the bucket name in which you want to store the registry's data. About Bucket naming, more details you can look at the [official documentation]( https://www.alibabacloud.com/help/doc-detail/257087.htm ) Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be autogenerated in the form of <clusterid>-image-registry-<region>-<random string 27 chars> encryption object Encryption specifies whether you would like your data encrypted on the server side. More details, you can look cat the [official documentation]( https://www.alibabacloud.com/help/doc-detail/117914.htm ) endpointAccessibility string EndpointAccessibility specifies whether the registry use the OSS VPC internal endpoint Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is Internal . region string Region is the Alibaba Cloud Region in which your bucket exists. For a list of regions, you can look at the [official documentation]( https://www.alibabacloud.com/help/doc-detail/31837.html ). Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be based on the installed Alibaba Cloud Region. 7.1.71. .spec.storage.oss.encryption Description Encryption specifies whether you would like your data encrypted on the server side. More details, you can look cat the [official documentation]( https://www.alibabacloud.com/help/doc-detail/117914.htm ) Type object Property Type Description kms object KMS (key management service) is an encryption type that holds the struct for KMS KeyID method string Method defines the different encrytion modes available Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is AES256 . 7.1.72. .spec.storage.oss.encryption.kms Description KMS (key management service) is an encryption type that holds the struct for KMS KeyID Type object Required keyID Property Type Description keyID string KeyID holds the KMS encryption key ID 7.1.73. .spec.storage.pvc Description pvc represents configuration that uses a PersistentVolumeClaim. Type object Property Type Description claim string claim defines the Persisent Volume Claim's name to be used. 7.1.74. .spec.storage.s3 Description s3 represents configuration that uses Amazon Simple Storage Service. Type object Property Type Description bucket string bucket is the bucket name in which you want to store the registry's data. Optional, will be generated if not provided. chunkSizeMiB integer chunkSizeMiB defines the size of the multipart upload chunks of the S3 API. The S3 API requires multipart upload chunks to be at least 5MiB. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default value is 10 MiB. The value is an integer number of MiB. The minimum value is 5 and the maximum value is 5120 (5 GiB). cloudFront object cloudFront configures Amazon Cloudfront as the storage middleware in a registry. encrypt boolean encrypt specifies whether the registry stores the image in encrypted format or not. Optional, defaults to false. keyID string keyID is the KMS key ID to use for encryption. Optional, Encrypt must be true, or this parameter is ignored. region string region is the AWS region in which your bucket exists. Optional, will be set based on the installed AWS Region. regionEndpoint string regionEndpoint is the endpoint for S3 compatible storage services. It should be a valid URL with scheme, e.g. https://s3.example.com . Optional, defaults based on the Region that is provided. trustedCA object trustedCA is a reference to a config map containing a CA bundle. The image registry and its operator use certificates from this bundle to verify S3 server certificates. The namespace for the config map referenced by trustedCA is "openshift-config". The key for the bundle in the config map is "ca-bundle.crt". virtualHostedStyle boolean virtualHostedStyle enables using S3 virtual hosted style bucket paths with a custom RegionEndpoint Optional, defaults to false. 7.1.75. .spec.storage.s3.cloudFront Description cloudFront configures Amazon Cloudfront as the storage middleware in a registry. Type object Required baseURL keypairID privateKey Property Type Description baseURL string baseURL contains the SCHEME://HOST[/PATH] at which Cloudfront is served. duration string duration is the duration of the Cloudfront session. keypairID string keypairID is key pair ID provided by AWS. privateKey object privateKey points to secret containing the private key, provided by AWS. 7.1.76. .spec.storage.s3.cloudFront.privateKey Description privateKey points to secret containing the private key, provided by AWS. 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. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896 . optional boolean Specify whether the Secret or its key must be defined 7.1.77. .spec.storage.s3.trustedCA Description trustedCA is a reference to a config map containing a CA bundle. The image registry and its operator use certificates from this bundle to verify S3 server certificates. The namespace for the config map referenced by trustedCA is "openshift-config". The key for the bundle in the config map is "ca-bundle.crt". Type object Property Type Description name string name is the metadata.name of the referenced config map. This field must adhere to standard config map naming restrictions. The name must consist solely of alphanumeric characters, hyphens (-) and periods (.). It has a maximum length of 253 characters. If this field is not specified or is empty string, the default trust bundle will be used. 7.1.78. .spec.storage.swift Description swift represents configuration that uses OpenStack Object Storage. Type object Property Type Description authURL string authURL defines the URL for obtaining an authentication token. authVersion string authVersion specifies the OpenStack Auth's version. container string container defines the name of Swift container where to store the registry's data. domain string domain specifies Openstack's domain name for Identity v3 API. domainID string domainID specifies Openstack's domain id for Identity v3 API. regionName string regionName defines Openstack's region in which container exists. tenant string tenant defines Openstack tenant name to be used by registry. tenantID string tenant defines Openstack tenant id to be used by registry. 7.1.79. .spec.tolerations Description tolerations defines the tolerations for the registry pod. Type array 7.1.80. .spec.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. 7.1.81. .spec.topologySpreadConstraints Description topologySpreadConstraints specify how to spread matching pods among the given topology. Type array 7.1.82. .spec.topologySpreadConstraints[] Description TopologySpreadConstraint specifies how to spread matching pods among the given topology. Type object Required maxSkew topologyKey whenUnsatisfiable Property Type Description labelSelector object LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. matchLabelKeys array (string) MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default). maxSkew integer MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule , it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. \| zone1 \| zone2 \| zone3 \| \| P P \| P P \| P \| - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway , it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. minDomains integer MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: \| zone1 \| zone2 \| zone3 \| \| P P \| P P \| P P \| The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. nodeAffinityPolicy string NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. If this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. nodeTaintsPolicy string NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. If this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. topologyKey string TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field. whenUnsatisfiable string WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: \| zone1 \| zone2 \| zone3 \| \| P P P \| P \| P \| If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field. 7.1.83. .spec.topologySpreadConstraints[].labelSelector Description LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. 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. 7.1.84. .spec.topologySpreadConstraints[].labelSelector.matchExpressions Description matchExpressions is a list of label selector requirements. The requirements are ANDed. Type array 7.1.85. .spec.topologySpreadConstraints[].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. 7.1.86. .status Description ImageRegistryStatus reports image registry operational status. Type object Required storage storageManaged 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. 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 storage object storage indicates the current applied storage configuration of the registry. storageManaged boolean storageManaged is deprecated, please refer to Storage.managementState version string version is the level this availability applies to 7.1.87. .status.conditions Description conditions is a list of conditions and their status Type array 7.1.88. .status.conditions[] Description OperatorCondition is just the standard condition fields. Type object Required type Property Type Description lastTransitionTime string message string reason string status string type string 7.1.89. .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 7.1.90. .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 7.1.91. .status.storage Description storage indicates the current applied storage configuration of the registry. Type object Property Type Description azure object azure represents configuration that uses Azure Blob Storage. emptyDir object emptyDir represents ephemeral storage on the pod's host node. WARNING: this storage cannot be used with more than 1 replica and is not suitable for production use. When the pod is removed from a node for any reason, the data in the emptyDir is deleted forever. gcs object gcs represents configuration that uses Google Cloud Storage. ibmcos object ibmcos represents configuration that uses IBM Cloud Object Storage. managementState string managementState indicates if the operator manages the underlying storage unit. If Managed the operator will remove the storage when this operator gets Removed. oss object Oss represents configuration that uses Alibaba Cloud Object Storage Service. pvc object pvc represents configuration that uses a PersistentVolumeClaim. s3 object s3 represents configuration that uses Amazon Simple Storage Service. swift object swift represents configuration that uses OpenStack Object Storage. 7.1.92. .status.storage.azure Description azure represents configuration that uses Azure Blob Storage. Type object Property Type Description accountName string accountName defines the account to be used by the registry. cloudName string cloudName is the name of the Azure cloud environment to be used by the registry. If empty, the operator will set it based on the infrastructure object. container string container defines Azure's container to be used by registry. networkAccess object networkAccess defines the network access properties for the storage account. Defaults to type: External. 7.1.93. .status.storage.azure.networkAccess Description networkAccess defines the network access properties for the storage account. Defaults to type: External. Type object Property Type Description internal object internal defines the vnet and subnet names to configure a private endpoint and connect it to the storage account in order to make it private. when type: Internal and internal is unset, the image registry operator will discover vnet and subnet names, and generate a private endpoint name. type string type is the network access level to be used for the storage account. type: Internal means the storage account will be private, type: External means the storage account will be publicly accessible. Internal storage accounts are only exposed within the cluster's vnet. External storage accounts are publicly exposed on the internet. When type: Internal is used, a vnetName, subNetName and privateEndpointName may optionally be specified. If unspecificed, the image registry operator will discover vnet and subnet names, and generate a privateEndpointName. Defaults to "External". 7.1.94. .status.storage.azure.networkAccess.internal Description internal defines the vnet and subnet names to configure a private endpoint and connect it to the storage account in order to make it private. when type: Internal and internal is unset, the image registry operator will discover vnet and subnet names, and generate a private endpoint name. Type object Property Type Description networkResourceGroupName string networkResourceGroupName is the resource group name where the cluster's vnet and subnet are. When omitted, the registry operator will use the cluster resource group (from in the infrastructure status). If you set a networkResourceGroupName on your install-config.yaml, that value will be used automatically (for clusters configured with publish:Internal). Note that both vnet and subnet must be in the same resource group. It must be between 1 and 90 characters in length and must consist only of alphanumeric characters, hyphens (-), periods (.) and underscores (_), and not end with a period. privateEndpointName string privateEndpointName is the name of the private endpoint for the registry. When provided, the registry will use it as the name of the private endpoint it will create for the storage account. When omitted, the registry will generate one. It must be between 2 and 64 characters in length and must consist only of alphanumeric characters, hyphens (-), periods (.) and underscores (_). It must start with an alphanumeric character and end with an alphanumeric character or an underscore. subnetName string subnetName is the name of the subnet the registry operates in. When omitted, the registry operator will discover and set this by using the kubernetes.io_cluster.<cluster-id> tag in the vnet resource, then using one of listed subnets. Advanced cluster network configurations that use network security groups to protect subnets should ensure the provided subnetName has access to Azure Storage service. It must be between 1 and 80 characters in length and must consist only of alphanumeric characters, hyphens (-), periods (.) and underscores (_). vnetName string vnetName is the name of the vnet the registry operates in. When omitted, the registry operator will discover and set this by using the kubernetes.io_cluster.<cluster-id> tag in the vnet resource. This tag is set automatically by the installer. Commonly, this will be the same vnet as the cluster. Advanced cluster network configurations should ensure the provided vnetName is the vnet of the nodes where the image registry pods are running from. It must be between 2 and 64 characters in length and must consist only of alphanumeric characters, hyphens (-), periods (.) and underscores (_). It must start with an alphanumeric character and end with an alphanumeric character or an underscore. 7.1.95. .status.storage.emptyDir Description emptyDir represents ephemeral storage on the pod's host node. WARNING: this storage cannot be used with more than 1 replica and is not suitable for production use. When the pod is removed from a node for any reason, the data in the emptyDir is deleted forever. Type object 7.1.96. .status.storage.gcs Description gcs represents configuration that uses Google Cloud Storage. Type object Property Type Description bucket string bucket is the bucket name in which you want to store the registry's data. Optional, will be generated if not provided. keyID string keyID is the KMS key ID to use for encryption. Optional, buckets are encrypted by default on GCP. This allows for the use of a custom encryption key. projectID string projectID is the Project ID of the GCP project that this bucket should be associated with. region string region is the GCS location in which your bucket exists. Optional, will be set based on the installed GCS Region. 7.1.97. .status.storage.ibmcos Description ibmcos represents configuration that uses IBM Cloud Object Storage. Type object Property Type Description bucket string bucket is the bucket name in which you want to store the registry's data. Optional, will be generated if not provided. location string location is the IBM Cloud location in which your bucket exists. Optional, will be set based on the installed IBM Cloud location. resourceGroupName string resourceGroupName is the name of the IBM Cloud resource group that this bucket and its service instance is associated with. Optional, will be set based on the installed IBM Cloud resource group. resourceKeyCRN string resourceKeyCRN is the CRN of the IBM Cloud resource key that is created for the service instance. Commonly referred as a service credential and must contain HMAC type credentials. Optional, will be computed if not provided. serviceInstanceCRN string serviceInstanceCRN is the CRN of the IBM Cloud Object Storage service instance that this bucket is associated with. Optional, will be computed if not provided. 7.1.98. .status.storage.oss Description Oss represents configuration that uses Alibaba Cloud Object Storage Service. Type object Property Type Description bucket string Bucket is the bucket name in which you want to store the registry's data. About Bucket naming, more details you can look at the [official documentation]( https://www.alibabacloud.com/help/doc-detail/257087.htm ) Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be autogenerated in the form of <clusterid>-image-registry-<region>-<random string 27 chars> encryption object Encryption specifies whether you would like your data encrypted on the server side. More details, you can look cat the [official documentation]( https://www.alibabacloud.com/help/doc-detail/117914.htm ) endpointAccessibility string EndpointAccessibility specifies whether the registry use the OSS VPC internal endpoint Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is Internal . region string Region is the Alibaba Cloud Region in which your bucket exists. For a list of regions, you can look at the [official documentation]( https://www.alibabacloud.com/help/doc-detail/31837.html ). Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default will be based on the installed Alibaba Cloud Region. 7.1.99. .status.storage.oss.encryption Description Encryption specifies whether you would like your data encrypted on the server side. More details, you can look cat the [official documentation]( https://www.alibabacloud.com/help/doc-detail/117914.htm ) Type object Property Type Description kms object KMS (key management service) is an encryption type that holds the struct for KMS KeyID method string Method defines the different encrytion modes available Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is AES256 . 7.1.100. .status.storage.oss.encryption.kms Description KMS (key management service) is an encryption type that holds the struct for KMS KeyID Type object Required keyID Property Type Description keyID string KeyID holds the KMS encryption key ID 7.1.101. .status.storage.pvc Description pvc represents configuration that uses a PersistentVolumeClaim. Type object Property Type Description claim string claim defines the Persisent Volume Claim's name to be used. 7.1.102. .status.storage.s3 Description s3 represents configuration that uses Amazon Simple Storage Service. Type object Property Type Description bucket string bucket is the bucket name in which you want to store the registry's data. Optional, will be generated if not provided. chunkSizeMiB integer chunkSizeMiB defines the size of the multipart upload chunks of the S3 API. The S3 API requires multipart upload chunks to be at least 5MiB. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default value is 10 MiB. The value is an integer number of MiB. The minimum value is 5 and the maximum value is 5120 (5 GiB). cloudFront object cloudFront configures Amazon Cloudfront as the storage middleware in a registry. encrypt boolean encrypt specifies whether the registry stores the image in encrypted format or not. Optional, defaults to false. keyID string keyID is the KMS key ID to use for encryption. Optional, Encrypt must be true, or this parameter is ignored. region string region is the AWS region in which your bucket exists. Optional, will be set based on the installed AWS Region. regionEndpoint string regionEndpoint is the endpoint for S3 compatible storage services. It should be a valid URL with scheme, e.g. https://s3.example.com . Optional, defaults based on the Region that is provided. trustedCA object trustedCA is a reference to a config map containing a CA bundle. The image registry and its operator use certificates from this bundle to verify S3 server certificates. The namespace for the config map referenced by trustedCA is "openshift-config". The key for the bundle in the config map is "ca-bundle.crt". virtualHostedStyle boolean virtualHostedStyle enables using S3 virtual hosted style bucket paths with a custom RegionEndpoint Optional, defaults to false. 7.1.103. .status.storage.s3.cloudFront Description cloudFront configures Amazon Cloudfront as the storage middleware in a registry. Type object Required baseURL keypairID privateKey Property Type Description baseURL string baseURL contains the SCHEME://HOST[/PATH] at which Cloudfront is served. duration string duration is the duration of the Cloudfront session. keypairID string keypairID is key pair ID provided by AWS. privateKey object privateKey points to secret containing the private key, provided by AWS. 7.1.104. .status.storage.s3.cloudFront.privateKey Description privateKey points to secret containing the private key, provided by AWS. 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. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896 . optional boolean Specify whether the Secret or its key must be defined 7.1.105. .status.storage.s3.trustedCA Description trustedCA is a reference to a config map containing a CA bundle. The image registry and its operator use certificates from this bundle to verify S3 server certificates. The namespace for the config map referenced by trustedCA is "openshift-config". The key for the bundle in the config map is "ca-bundle.crt". Type object Property Type Description name string name is the metadata.name of the referenced config map. This field must adhere to standard config map naming restrictions. The name must consist solely of alphanumeric characters, hyphens (-) and periods (.). It has a maximum length of 253 characters. If this field is not specified or is empty string, the default trust bundle will be used. 7.1.106. .status.storage.swift Description swift represents configuration that uses OpenStack Object Storage. Type object Property Type Description authURL string authURL defines the URL for obtaining an authentication token. authVersion string authVersion specifies the OpenStack Auth's version. container string container defines the name of Swift container where to store the registry's data. domain string domain specifies Openstack's domain name for Identity v3 API. domainID string domainID specifies Openstack's domain id for Identity v3 API. regionName string regionName defines Openstack's region in which container exists. tenant string tenant defines Openstack tenant name to be used by registry. tenantID string tenant defines Openstack tenant id to be used by registry. 7.2. API endpoints The following API endpoints are available: /apis/imageregistry.operator.openshift.io/v1/configs DELETE : delete collection of Config GET : list objects of kind Config POST : create a Config /apis/imageregistry.operator.openshift.io/v1/configs/{name} DELETE : delete a Config GET : read the specified Config PATCH : partially update the specified Config PUT : replace the specified Config /apis/imageregistry.operator.openshift.io/v1/configs/{name}/status GET : read status of the specified Config PATCH : partially update status of the specified Config PUT : replace status of the specified Config 7.2.1. /apis/imageregistry.operator.openshift.io/v1/configs HTTP method DELETE Description delete collection of Config Table 7.1. HTTP responses HTTP code Reponse body 200 - OK Status schema 401 - Unauthorized Empty HTTP method GET Description list objects of kind Config Table 7.2. HTTP responses HTTP code Reponse body 200 - OK ConfigList schema 401 - Unauthorized Empty HTTP method POST Description create a Config Table 7.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 7.4. Body parameters Parameter Type Description body Config schema Table 7.5. HTTP responses HTTP code Reponse body 200 - OK Config schema 201 - Created Config schema 202 - Accepted Config schema 401 - Unauthorized Empty 7.2.2. /apis/imageregistry.operator.openshift.io/v1/configs/{name} Table 7.6. Global path parameters Parameter Type Description name string name of the Config HTTP method DELETE Description delete a Config Table 7.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 7.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 Config Table 7.9. HTTP responses HTTP code Reponse body 200 - OK Config schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified Config Table 7.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 7.11. HTTP responses HTTP code Reponse body 200 - OK Config schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified Config Table 7.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 7.13. Body parameters Parameter Type Description body Config schema Table 7.14. HTTP responses HTTP code Reponse body 200 - OK Config schema 201 - Created Config schema 401 - Unauthorized Empty 7.2.3. /apis/imageregistry.operator.openshift.io/v1/configs/{name}/status Table 7.15. Global path parameters Parameter Type Description name string name of the Config HTTP method GET Description read status of the specified Config Table 7.16. HTTP responses HTTP code Reponse body 200 - OK Config schema 401 - Unauthorized Empty HTTP method PATCH Description partially update status of the specified Config Table 7.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 7.18. HTTP responses HTTP code Reponse body 200 - OK Config schema 401 - Unauthorized Empty HTTP method PUT Description replace status of the specified Config Table 7.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 7.20. Body parameters Parameter Type Description body Config schema Table 7.21. HTTP responses HTTP code Reponse body 200 - OK Config schema 201 - Created Config schema 401 - Unauthorized Empty	null	https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/operator_apis/config-imageregistry-operator-openshift-io-v1
16.3. Configuring a DHCPv4 Client	16.3. Configuring a DHCPv4 Client To configure a DHCP client manually, modify the /etc/sysconfig/network file to enable networking and the configuration file for each network device in the /etc/sysconfig/network-scripts directory. In this directory, each device should have a configuration file named ifcfg-eth0 , where eth0 is the network device name. Make sure that the /etc/sysconfig/network-scripts/ifcfg-eth0 file contains the following lines: To use DHCP, set a configuration file for each device. Other options for the network script include: DHCP_HOSTNAME - Only use this option if the DHCP server requires the client to specify a host name before receiving an IP address. PEERDNS= <answer> , where <answer> is one of the following: yes - Modify /etc/resolv.conf with information from the server. This is the default. no - Do not modify /etc/resolv.conf . If you prefer using a graphical interface, see Chapter 10, NetworkManager for instructions on using NetworkManager to configure a network interface to use DHCP. Note For advanced configurations of client DHCP options such as protocol timing, lease requirements and requests, dynamic DNS support, aliases, as well as a wide variety of values to override, prepend, or append to client-side configurations, see the dhclient and dhclient.conf man pages.	[ "DEVICE=eth0 BOOTPROTO=dhcp ONBOOT=yes" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/deployment_guide/s1-dhcp-configuring-client
Understanding OpenShift GitOps	Understanding OpenShift GitOps Red Hat OpenShift GitOps 1.12 Introduction to OpenShift GitOps Red Hat OpenShift Documentation Team	null	https://docs.redhat.com/en/documentation/red_hat_openshift_gitops/1.12/html/understanding_openshift_gitops/index
Chapter 19. OAuth [config.openshift.io/v1]	Chapter 19. OAuth [config.openshift.io/v1] Description OAuth holds cluster-wide information about OAuth. The canonical name is cluster . It is used to configure the integrated OAuth server. This configuration is only honored when the top level Authentication config has type set to IntegratedOAuth. 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 19.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 holds user settable values for configuration status object status holds observed values from the cluster. They may not be overridden. 19.1.1. .spec Description spec holds user settable values for configuration Type object Property Type Description identityProviders array identityProviders is an ordered list of ways for a user to identify themselves. When this list is empty, no identities are provisioned for users. identityProviders[] object IdentityProvider provides identities for users authenticating using credentials templates object templates allow you to customize pages like the login page. tokenConfig object tokenConfig contains options for authorization and access tokens 19.1.2. .spec.identityProviders Description identityProviders is an ordered list of ways for a user to identify themselves. When this list is empty, no identities are provisioned for users. Type array 19.1.3. .spec.identityProviders[] Description IdentityProvider provides identities for users authenticating using credentials Type object Property Type Description basicAuth object basicAuth contains configuration options for the BasicAuth IdP github object github enables user authentication using GitHub credentials gitlab object gitlab enables user authentication using GitLab credentials google object google enables user authentication using Google credentials htpasswd object htpasswd enables user authentication using an HTPasswd file to validate credentials keystone object keystone enables user authentication using keystone password credentials ldap object ldap enables user authentication using LDAP credentials mappingMethod string mappingMethod determines how identities from this provider are mapped to users Defaults to "claim" name string name is used to qualify the identities returned by this provider. - It MUST be unique and not shared by any other identity provider used - It MUST be a valid path segment: name cannot equal "." or ".." or contain "/" or "%" or ":" Ref: https://godoc.org/github.com/openshift/origin/pkg/user/apis/user/validation#ValidateIdentityProviderName openID object openID enables user authentication using OpenID credentials requestHeader object requestHeader enables user authentication using request header credentials type string type identifies the identity provider type for this entry. 19.1.4. .spec.identityProviders[].basicAuth Description basicAuth contains configuration options for the BasicAuth IdP Type object Property Type Description ca object ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config. tlsClientCert object tlsClientCert is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate to present when connecting to the server. The key "tls.crt" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. tlsClientKey object tlsClientKey is an optional reference to a secret by name that contains the PEM-encoded TLS private key for the client certificate referenced in tlsClientCert. The key "tls.key" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. url string url is the remote URL to connect to 19.1.5. .spec.identityProviders[].basicAuth.ca Description ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced config map 19.1.6. .spec.identityProviders[].basicAuth.tlsClientCert Description tlsClientCert is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate to present when connecting to the server. The key "tls.crt" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced secret 19.1.7. .spec.identityProviders[].basicAuth.tlsClientKey Description tlsClientKey is an optional reference to a secret by name that contains the PEM-encoded TLS private key for the client certificate referenced in tlsClientCert. The key "tls.key" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced secret 19.1.8. .spec.identityProviders[].github Description github enables user authentication using GitHub credentials Type object Property Type Description ca object ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. This can only be configured when hostname is set to a non-empty value. The namespace for this config map is openshift-config. clientID string clientID is the oauth client ID clientSecret object clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config. hostname string hostname is the optional domain (e.g. "mycompany.com") for use with a hosted instance of GitHub Enterprise. It must match the GitHub Enterprise settings value configured at /setup/settings#hostname. organizations array (string) organizations optionally restricts which organizations are allowed to log in teams array (string) teams optionally restricts which teams are allowed to log in. Format is <org>/<team>. 19.1.9. .spec.identityProviders[].github.ca Description ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. This can only be configured when hostname is set to a non-empty value. The namespace for this config map is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced config map 19.1.10. .spec.identityProviders[].github.clientSecret Description clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced secret 19.1.11. .spec.identityProviders[].gitlab Description gitlab enables user authentication using GitLab credentials Type object Property Type Description ca object ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config. clientID string clientID is the oauth client ID clientSecret object clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config. url string url is the oauth server base URL 19.1.12. .spec.identityProviders[].gitlab.ca Description ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced config map 19.1.13. .spec.identityProviders[].gitlab.clientSecret Description clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced secret 19.1.14. .spec.identityProviders[].google Description google enables user authentication using Google credentials Type object Property Type Description clientID string clientID is the oauth client ID clientSecret object clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config. hostedDomain string hostedDomain is the optional Google App domain (e.g. "mycompany.com") to restrict logins to 19.1.15. .spec.identityProviders[].google.clientSecret Description clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced secret 19.1.16. .spec.identityProviders[].htpasswd Description htpasswd enables user authentication using an HTPasswd file to validate credentials Type object Property Type Description fileData object fileData is a required reference to a secret by name containing the data to use as the htpasswd file. The key "htpasswd" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. If the specified htpasswd data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. 19.1.17. .spec.identityProviders[].htpasswd.fileData Description fileData is a required reference to a secret by name containing the data to use as the htpasswd file. The key "htpasswd" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. If the specified htpasswd data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced secret 19.1.18. .spec.identityProviders[].keystone Description keystone enables user authentication using keystone password credentials Type object Property Type Description ca object ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config. domainName string domainName is required for keystone v3 tlsClientCert object tlsClientCert is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate to present when connecting to the server. The key "tls.crt" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. tlsClientKey object tlsClientKey is an optional reference to a secret by name that contains the PEM-encoded TLS private key for the client certificate referenced in tlsClientCert. The key "tls.key" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. url string url is the remote URL to connect to 19.1.19. .spec.identityProviders[].keystone.ca Description ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced config map 19.1.20. .spec.identityProviders[].keystone.tlsClientCert Description tlsClientCert is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate to present when connecting to the server. The key "tls.crt" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced secret 19.1.21. .spec.identityProviders[].keystone.tlsClientKey Description tlsClientKey is an optional reference to a secret by name that contains the PEM-encoded TLS private key for the client certificate referenced in tlsClientCert. The key "tls.key" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced secret 19.1.22. .spec.identityProviders[].ldap Description ldap enables user authentication using LDAP credentials Type object Property Type Description attributes object attributes maps LDAP attributes to identities bindDN string bindDN is an optional DN to bind with during the search phase. bindPassword object bindPassword is an optional reference to a secret by name containing a password to bind with during the search phase. The key "bindPassword" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config. ca object ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config. insecure boolean insecure, if true, indicates the connection should not use TLS WARNING: Should not be set to true with the URL scheme "ldaps://" as "ldaps://" URLs always attempt to connect using TLS, even when insecure is set to true When true , "ldap://" URLS connect insecurely. When false , "ldap://" URLs are upgraded to a TLS connection using StartTLS as specified in https://tools.ietf.org/html/rfc2830 . url string url is an RFC 2255 URL which specifies the LDAP search parameters to use. The syntax of the URL is: ldap://host:port/basedn?attribute?scope?filter 19.1.23. .spec.identityProviders[].ldap.attributes Description attributes maps LDAP attributes to identities Type object Property Type Description email array (string) email is the list of attributes whose values should be used as the email address. Optional. If unspecified, no email is set for the identity id array (string) id is the list of attributes whose values should be used as the user ID. Required. First non-empty attribute is used. At least one attribute is required. If none of the listed attribute have a value, authentication fails. LDAP standard identity attribute is "dn" name array (string) name is the list of attributes whose values should be used as the display name. Optional. If unspecified, no display name is set for the identity LDAP standard display name attribute is "cn" preferredUsername array (string) preferredUsername is the list of attributes whose values should be used as the preferred username. LDAP standard login attribute is "uid" 19.1.24. .spec.identityProviders[].ldap.bindPassword Description bindPassword is an optional reference to a secret by name containing a password to bind with during the search phase. The key "bindPassword" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced secret 19.1.25. .spec.identityProviders[].ldap.ca Description ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced config map 19.1.26. .spec.identityProviders[].openID Description openID enables user authentication using OpenID credentials Type object Property Type Description ca object ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config. claims object claims mappings clientID string clientID is the oauth client ID clientSecret object clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config. extraAuthorizeParameters object (string) extraAuthorizeParameters are any custom parameters to add to the authorize request. extraScopes array (string) extraScopes are any scopes to request in addition to the standard "openid" scope. issuer string issuer is the URL that the OpenID Provider asserts as its Issuer Identifier. It must use the https scheme with no query or fragment component. 19.1.27. .spec.identityProviders[].openID.ca Description ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced config map 19.1.28. .spec.identityProviders[].openID.claims Description claims mappings Type object Property Type Description email array (string) email is the list of claims whose values should be used as the email address. Optional. If unspecified, no email is set for the identity groups array (string) groups is the list of claims value of which should be used to synchronize groups from the OIDC provider to OpenShift for the user. If multiple claims are specified, the first one with a non-empty value is used. name array (string) name is the list of claims whose values should be used as the display name. Optional. If unspecified, no display name is set for the identity preferredUsername array (string) preferredUsername is the list of claims whose values should be used as the preferred username. If unspecified, the preferred username is determined from the value of the sub claim 19.1.29. .spec.identityProviders[].openID.clientSecret Description clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced secret 19.1.30. .spec.identityProviders[].requestHeader Description requestHeader enables user authentication using request header credentials Type object Property Type Description ca object ca is a required reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. Specifically, it allows verification of incoming requests to prevent header spoofing. The key "ca.crt" is used to locate the data. If the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. The namespace for this config map is openshift-config. challengeURL string challengeURL is a URL to redirect unauthenticated /authorize requests to Unauthenticated requests from OAuth clients which expect WWW-Authenticate challenges will be redirected here. USD{url} is replaced with the current URL, escaped to be safe in a query parameter https://www.example.com/sso-login?then=USD{url} USD{query} is replaced with the current query string https://www.example.com/auth-proxy/oauth/authorize?USD{query} Required when challenge is set to true. clientCommonNames array (string) clientCommonNames is an optional list of common names to require a match from. If empty, any client certificate validated against the clientCA bundle is considered authoritative. emailHeaders array (string) emailHeaders is the set of headers to check for the email address headers array (string) headers is the set of headers to check for identity information loginURL string loginURL is a URL to redirect unauthenticated /authorize requests to Unauthenticated requests from OAuth clients which expect interactive logins will be redirected here USD{url} is replaced with the current URL, escaped to be safe in a query parameter https://www.example.com/sso-login?then=USD{url} USD{query} is replaced with the current query string https://www.example.com/auth-proxy/oauth/authorize?USD{query} Required when login is set to true. nameHeaders array (string) nameHeaders is the set of headers to check for the display name preferredUsernameHeaders array (string) preferredUsernameHeaders is the set of headers to check for the preferred username 19.1.31. .spec.identityProviders[].requestHeader.ca Description ca is a required reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. Specifically, it allows verification of incoming requests to prevent header spoofing. The key "ca.crt" is used to locate the data. If the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. The namespace for this config map is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced config map 19.1.32. .spec.templates Description templates allow you to customize pages like the login page. Type object Property Type Description error object error is the name of a secret that specifies a go template to use to render error pages during the authentication or grant flow. The key "errors.html" is used to locate the template data. If specified and the secret or expected key is not found, the default error page is used. If the specified template is not valid, the default error page is used. If unspecified, the default error page is used. The namespace for this secret is openshift-config. login object login is the name of a secret that specifies a go template to use to render the login page. The key "login.html" is used to locate the template data. If specified and the secret or expected key is not found, the default login page is used. If the specified template is not valid, the default login page is used. If unspecified, the default login page is used. The namespace for this secret is openshift-config. providerSelection object providerSelection is the name of a secret that specifies a go template to use to render the provider selection page. The key "providers.html" is used to locate the template data. If specified and the secret or expected key is not found, the default provider selection page is used. If the specified template is not valid, the default provider selection page is used. If unspecified, the default provider selection page is used. The namespace for this secret is openshift-config. 19.1.33. .spec.templates.error Description error is the name of a secret that specifies a go template to use to render error pages during the authentication or grant flow. The key "errors.html" is used to locate the template data. If specified and the secret or expected key is not found, the default error page is used. If the specified template is not valid, the default error page is used. If unspecified, the default error page is used. The namespace for this secret is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced secret 19.1.34. .spec.templates.login Description login is the name of a secret that specifies a go template to use to render the login page. The key "login.html" is used to locate the template data. If specified and the secret or expected key is not found, the default login page is used. If the specified template is not valid, the default login page is used. If unspecified, the default login page is used. The namespace for this secret is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced secret 19.1.35. .spec.templates.providerSelection Description providerSelection is the name of a secret that specifies a go template to use to render the provider selection page. The key "providers.html" is used to locate the template data. If specified and the secret or expected key is not found, the default provider selection page is used. If the specified template is not valid, the default provider selection page is used. If unspecified, the default provider selection page is used. The namespace for this secret is openshift-config. Type object Required name Property Type Description name string name is the metadata.name of the referenced secret 19.1.36. .spec.tokenConfig Description tokenConfig contains options for authorization and access tokens Type object Property Type Description accessTokenInactivityTimeout string accessTokenInactivityTimeout defines the token inactivity timeout for tokens granted by any client. The value represents the maximum amount of time that can occur between consecutive uses of the token. Tokens become invalid if they are not used within this temporal window. The user will need to acquire a new token to regain access once a token times out. Takes valid time duration string such as "5m", "1.5h" or "2h45m". The minimum allowed value for duration is 300s (5 minutes). If the timeout is configured per client, then that value takes precedence. If the timeout value is not specified and the client does not override the value, then tokens are valid until their lifetime. WARNING: existing tokens' timeout will not be affected (lowered) by changing this value accessTokenInactivityTimeoutSeconds integer accessTokenInactivityTimeoutSeconds - DEPRECATED: setting this field has no effect. accessTokenMaxAgeSeconds integer accessTokenMaxAgeSeconds defines the maximum age of access tokens 19.1.37. .status Description status holds observed values from the cluster. They may not be overridden. Type object 19.2. API endpoints The following API endpoints are available: /apis/config.openshift.io/v1/oauths DELETE : delete collection of OAuth GET : list objects of kind OAuth POST : create an OAuth /apis/config.openshift.io/v1/oauths/{name} DELETE : delete an OAuth GET : read the specified OAuth PATCH : partially update the specified OAuth PUT : replace the specified OAuth /apis/config.openshift.io/v1/oauths/{name}/status GET : read status of the specified OAuth PATCH : partially update status of the specified OAuth PUT : replace status of the specified OAuth 19.2.1. /apis/config.openshift.io/v1/oauths HTTP method DELETE Description delete collection of OAuth Table 19.1. HTTP responses HTTP code Reponse body 200 - OK Status schema 401 - Unauthorized Empty HTTP method GET Description list objects of kind OAuth Table 19.2. HTTP responses HTTP code Reponse body 200 - OK OAuthList schema 401 - Unauthorized Empty HTTP method POST Description create an OAuth Table 19.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 19.4. Body parameters Parameter Type Description body OAuth schema Table 19.5. HTTP responses HTTP code Reponse body 200 - OK OAuth schema 201 - Created OAuth schema 202 - Accepted OAuth schema 401 - Unauthorized Empty 19.2.2. /apis/config.openshift.io/v1/oauths/{name} Table 19.6. Global path parameters Parameter Type Description name string name of the OAuth HTTP method DELETE Description delete an OAuth Table 19.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 19.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 OAuth Table 19.9. HTTP responses HTTP code Reponse body 200 - OK OAuth schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified OAuth Table 19.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 19.11. HTTP responses HTTP code Reponse body 200 - OK OAuth schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified OAuth Table 19.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 19.13. Body parameters Parameter Type Description body OAuth schema Table 19.14. HTTP responses HTTP code Reponse body 200 - OK OAuth schema 201 - Created OAuth schema 401 - Unauthorized Empty 19.2.3. /apis/config.openshift.io/v1/oauths/{name}/status Table 19.15. Global path parameters Parameter Type Description name string name of the OAuth HTTP method GET Description read status of the specified OAuth Table 19.16. HTTP responses HTTP code Reponse body 200 - OK OAuth schema 401 - Unauthorized Empty HTTP method PATCH Description partially update status of the specified OAuth Table 19.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 19.18. HTTP responses HTTP code Reponse body 200 - OK OAuth schema 401 - Unauthorized Empty HTTP method PUT Description replace status of the specified OAuth Table 19.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 19.20. Body parameters Parameter Type Description body OAuth schema Table 19.21. HTTP responses HTTP code Reponse body 200 - OK OAuth schema 201 - Created OAuth schema 401 - Unauthorized Empty	null	https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/config_apis/oauth-config-openshift-io-v1
15.5. Configuring Bootstrap Credentials	15.5. Configuring Bootstrap Credentials When you use bind distinguished name (DN) groups in a replication agreement, there can be situations where the group is not present or outdated: During online initialization where you must authenticate to the replica before the database is initialized When you use GSSAPI as authentication method and the Kerberos credentials are changed If you configured bootstrap credentials in a replication agreement, Directory Server uses these credentials in case that the connection failed because one of the following errors: LDAP_INVALID_CREDENTIALS (err=49) LDAP_INAPPROPRIATE_AUTH (err=48) LDAP_NO_SUCH_OBJECT (err=32) If the bind succeeds with the bootstrap credentials, the server establishes the replication connection and a new replication session begins. This allows any updates to the bind DN group members to be updated. By default on the replication session, Directory Server uses the default credentials in the agreement, that now succeeds. The bootstrap credentials also fail, Directory Server stops trying to connect. Procedure To set the bootstrap credentials when you create a replication agreement: To set the bootstrap credentials in an existing replication agreement:	[ "dsconf -D \"cn=Directory Manager\" ldap://supplier.example.com repl-agmt create ... --bootstrap-bind-dn \" bind_DN \" --bootstrap-bind-passwd \" password \" --bootstrap-bind-method bind_method --bootstrap-conn-protocol connection protocol", "dsconf -D \"cn=Directory Manager\" ldap://supplier.example.com repl-agmt set --suffix=\" suffix \" --bootstrap-bind-dn \" bind_DN \" --bootstrap-bind-passwd \" password \" --bootstrap-bind-method bind_method --bootstrap-conn-protocol connection protocol agreement_name" ]	https://docs.redhat.com/en/documentation/red_hat_directory_server/11/html/administration_guide/configuring-bootstrap-credentials
Managing security compliance	Managing security compliance Red Hat Satellite 6.16 Plan and configure SCAP compliance policies, deploy the policies to hosts, and monitor compliance of your hosts Red Hat Satellite Documentation Team [email protected]	[ "hammer scap-content list --location \" My_Location \" --organization \" My_Organization \"", "hammer scap-content bulk-upload --type default", "rpm2cpio scap-security-guide-0.1.69-3.el8_6.noarch.rpm \| cpio -iv --to-stdout ./usr/share/xml/scap/ssg/content/ssg-rhel8-ds.xml > ssg-rhel-8.6-ds.xml", "hammer scap-content bulk-upload --type directory --directory /usr/share/xml/scap/my_content/ --location \" My_Location \" --organization \" My_Organization \"", "oscap info /usr/share/xml/scap/ssg/content/ssg-rhel8-ds.xml \| grep \"WARNING\" WARNING: Datastream component 'scap_org.open-scap_cref_security-data-oval-com.redhat.rhsa-RHEL8.xml.bz2' points out to the remote 'https://access.redhat.com/security/data/oval/com.redhat.rhsa-RHEL8.xml.bz2'. Use '--fetch-remote-resources' option to download it. WARNING: Skipping 'https://access.redhat.com/security/data/oval/com.redhat.rhsa-RHEL8.xml.bz2' file which is referenced from datastream", "oscap info /usr/share/xml/scap/ssg/content/ssg-rhel8-ds.xml \| grep \"WARNING\" WARNING: Datastream component 'scap_org.open-scap_cref_security-data-oval-com.redhat.rhsa-RHEL8.xml.bz2' points out to the remote 'https://access.redhat.com/security/data/oval/com.redhat.rhsa-RHEL8.xml.bz2'. Use '--fetch-remote-resources' option to download it. WARNING: Skipping 'https://access.redhat.com/security/data/oval/com.redhat.rhsa-RHEL8.xml.bz2' file which is referenced from datastream", "oscap info /usr/share/xml/scap/ssg/content/ssg-rhel8-ds.xml Referenced check files: ssg-rhel8-oval.xml system: http://oval.mitre.org/XMLSchema/oval-definitions-5 ssg-rhel8-ocil.xml system: http://scap.nist.gov/schema/ocil/2 security-data-oval-com.redhat.rhsa-RHEL8.xml.bz2 system: http://oval.mitre.org/XMLSchema/oval-definitions-5", "curl -o security-data-oval-com.redhat.rhsa-RHEL8.xml.bz2 https://www.redhat.com/security/data/oval/com.redhat.rhsa-RHEL8.xml.bz2", "curl -o /root/ security-data-oval-com.redhat.rhsa-RHEL8.xml.bz2 http:// satellite.example.com /pulp/content/ My_Organization_Label /Library/custom/ My_Product_Label / My_Repo_Label / security-data-oval-com.redhat.rhsa-RHEL8.xml.bz2", "failed > 5", "host ~ prod- AND date > \"Jan 1, 2023\"", "\"1 hour ago\" AND compliance_policy = date = \"1 hour ago\" AND compliance_policy = rhel7_audit", "xccdf_rule_passed = xccdf_org.ssgproject.content_rule_firefox_preferences-auto-download_actions", "xccdf_rule_failed = xccdf_org.ssgproject.content_rule_firefox_preferences-auto-download_actions", "xccdf_rule_othered = xccdf_org.ssgproject.content_rule_firefox_preferences-auto-download_actions" ]	https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html-single/managing_security_compliance/index
23.3. Authenticating to an Identity Management Client with a Smart Card	23.3. Authenticating to an Identity Management Client with a Smart Card As an Identity Management user with multiple role accounts in the Identity Management server, you can authenticate with your smart card to a desktop client system joined to the Identity Management domain. This enables you to use the client system as the selected role. For a basic overview of the supported options, see: Section 23.3.1, "Smart Card-based Authentication Options Supported on Identity Management Clients" For information on configuring the environment to enable the authentication, see: Section 23.3.2, "Preparing the Identity Management Client for Smart-card Authentication" For information on how to authenticate, see: Section 23.3.3, "Authenticating on an Identity Management Client with a Smart Card Using the Console Login" 23.3.1. Smart Card-based Authentication Options Supported on Identity Management Clients Users in Identity Management can use the following options when authenticating using a smart card on Identity Management clients. Local authentication Local authentication includes authentication using: the text console the graphical console, such as the Gnome Display Manager (GDM) local authentication services, such as su or sudo Remote authentication with ssh Certificates on a smart card are stored together with the PIN-protected SSH private key. Smart card-based authentication using other services, such as FTP, is not supported. 23.3.2. Preparing the Identity Management Client for Smart-card Authentication As the Identity Management administrator, perform these steps: On the server, create a shell script to configure the client. Use the ipa-advise config-client-for-smart-card-auth command, and save its output to a file: Open the script file, and review its contents. Add execute permissions to the file using the chmod utility: Copy the script to the client, and run it. Add the path to the PEM file with the certificate authority (CA) that signed the smart card certificate: Additionally, if an external certificate authority (CA) signed the certificate on the smart card, add the smart card CA as a trusted CA: On the Identity Management server, install the CA certificate: Repeat ipa-certupdate also on all replicas and clients. Restart the HTTP server: Repeat systemctl restart httpd also on all replicas. Note SSSD enables administrators to tune the certificate verification process with the certificate_verification parameter, for example if the Online Certificate Status Protocol (OCSP) servers defined in the certificate are not reachable from the client. For more information, see the sssd.conf (5) man page. 23.3.3. Authenticating on an Identity Management Client with a Smart Card Using the Console Login To authenticate as an Identity Management user, enter the user name and PIN. When logging in from the command line: When logging in using the Gnome Desktop Manager (GDM), GDM prompts you for the smart card PIN after you select the required user: Figure 23.13. Entering the smart card PIN in the Gnome Desktop Manager To authenticate as an Active Directory user, enter the user name in a format that uses the NetBIOS domain name: AD.EXAMPLE.COM\ad_user or [email protected] . If the authentication fails, see Section A.4, "Investigating Smart Card Authentication Failures" . 23.3.4. Authenticating to the Remote System from the Local System On the local system, perform these steps: Insert the smart card. Launch ssh , and specify the PKCS#11 library with the -I option: As an Identity Management user: As an Active Directory user: Optional. Use the id utility to check that you are logged in as the intended user. As an Identity Management user: As an Active Directory user: If the authentication fails, see Section A.4, "Investigating Smart Card Authentication Failures" . 23.3.5. Additional Resources Authentication using ssh with a smart card does not obtain a ticket-granting ticket (TGT) on the remote system. To obtain a TGT on the remote system, the administrator must configure Kerberos on the local system and enable Kerberos delegation. For an example of the required configuration, see this Kerberos knowledge base entry . For details on smart-card authentication with OpenSSH, see Using Smart Cards to Supply Credentials to OpenSSH in the Security Guide .	[ "ipa-advise config-client-for-smart-card-auth > client_smart_card_script.sh", "chmod +x client_smart_card_script.sh", "./client_smart_card_script.sh CA_cert.pem", "ipa-cacert-manage -n \"SmartCard CA\" -t CT,C,C install ca.pem ipa-certupdate", "systemctl restart httpd", "client login: idm_user PIN for PIV Card Holder pin (PIV_II) for user [email protected]:", "ssh -I /usr/lib64/opensc-pkcs11.so -l idm_user server.idm.example.com Enter PIN for 'PIV_II (PIV Card Holder pin)': Last login: Thu Apr 6 12:49:32 2017 from 10.36.116.42", "ssh -I /usr/lib64/opensc-pkcs11.so -l [email protected] server.idm.example.com Enter PIN for 'PIV_II (PIV Card Holder pin)': Last login: Thu Apr 6 12:49:32 2017 from 10.36.116.42", "id uid=1928200001(idm_user) gid=1928200001(idm_user) groups=1928200001(idm_user) context=unconfined_u:unconfined_r:unconfined_t:s0-s0:c0.c1023", "id uid=1171201116([email protected]) gid=1171201116([email protected]) groups=1171201116([email protected]),1171200513(domain [email protected]) context=unconfined_u:unconfined_r:unconfined_t:s0-s0:c0.c1023" ]	https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/linux_domain_identity_authentication_and_policy_guide/auth-idm-client-sc
31.7. Persistent Module Loading	31.7. Persistent Module Loading As shown in Example 31.1, "Listing information about a kernel module with lsmod" , many kernel modules are loaded automatically at boot time. You can specify additional modules to be loaded by creating a new <file_name> .modules file in the /etc/sysconfig/modules/ directory, where <file_name> is any descriptive name of your choice. Your <file_name> .modules files are treated by the system startup scripts as shell scripts, and as such should begin with an interpreter directive (also called a " bang line " ) as their first line: Example 31.6. First line of a file_name .modules file Additionally, the <file_name> .modules file should be executable. You can make it executable by running: For example, the following bluez-uinput.modules script loads the uinput module: Example 31.7. /etc/sysconfig/modules/bluez-uinput.modules #!/bin/sh if [ ! -c /dev/input/uinput ] ; then exec /sbin/modprobe uinput >/dev/null 2>&1 fi The if -conditional statement on the third line ensures that the /dev/input/uinput file does not already exist (the ! symbol negates the condition), and, if that is the case, loads the uinput module by calling exec /sbin/modprobe uinput . Note that the uinput module creates the /dev/input/uinput file, so testing to see if that file exists serves as verification of whether the uinput module is loaded into the kernel. The following >/dev/null 2>&1 clause at the end of that line redirects any output to /dev/null so that the modprobe command remains quiet.	[ "#!/bin/sh", "modules]# chmod +x <file_name> .modules", "#!/bin/sh if [ ! -c /dev/input/uinput ] ; then exec /sbin/modprobe uinput >/dev/null 2>&1 fi" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/deployment_guide/sec-Persistent_Module_Loading
Chapter 18. Setting the disk scheduler	Chapter 18. Setting the disk scheduler The disk scheduler is responsible for ordering the I/O requests submitted to a storage device. You can configure the scheduler in several different ways: Set the scheduler using TuneD , as described in Setting the disk scheduler using TuneD Set the scheduler using udev , as described in Setting the disk scheduler using udev rules Temporarily change the scheduler on a running system, as described in Temporarily setting a scheduler for a specific disk Note In Red Hat Enterprise Linux 8, block devices support only multi-queue scheduling. This enables the block layer performance to scale well with fast solid-state drives (SSDs) and multi-core systems. The traditional, single-queue schedulers, which were available in Red Hat Enterprise Linux 7 and earlier versions, have been removed. 18.1. Available disk schedulers The following multi-queue disk schedulers are supported in Red Hat Enterprise Linux 8: none Implements a first-in first-out (FIFO) scheduling algorithm. It merges requests at the generic block layer through a simple last-hit cache. mq-deadline Attempts to provide a guaranteed latency for requests from the point at which requests reach the scheduler. The mq-deadline scheduler sorts queued I/O requests into a read or write batch and then schedules them for execution in increasing logical block addressing (LBA) order. By default, read batches take precedence over write batches, because applications are more likely to block on read I/O operations. After mq-deadline processes a batch, it checks how long write operations have been starved of processor time and schedules the read or write batch as appropriate. This scheduler is suitable for most use cases, but particularly those in which the write operations are mostly asynchronous. bfq Targets desktop systems and interactive tasks. The bfq scheduler ensures that a single application is never using all of the bandwidth. In effect, the storage device is always as responsive as if it was idle. In its default configuration, bfq focuses on delivering the lowest latency rather than achieving the maximum throughput. bfq is based on cfq code. It does not grant the disk to each process for a fixed time slice but assigns a budget measured in the number of sectors to the process. This scheduler is suitable while copying large files and the system does not become unresponsive in this case. kyber The scheduler tunes itself to achieve a latency goal by calculating the latencies of every I/O request submitted to the block I/O layer. You can configure the target latencies for read, in the case of cache-misses, and synchronous write requests. This scheduler is suitable for fast devices, for example NVMe, SSD, or other low latency devices. 18.2. Different disk schedulers for different use cases Depending on the task that your system performs, the following disk schedulers are recommended as a baseline prior to any analysis and tuning tasks: Table 18.1. Disk schedulers for different use cases Use case Disk scheduler Traditional HDD with a SCSI interface Use mq-deadline or bfq . High-performance SSD or a CPU-bound system with fast storage Use none , especially when running enterprise applications. Alternatively, use kyber . Desktop or interactive tasks Use bfq . Virtual guest Use mq-deadline . With a host bus adapter (HBA) driver that is multi-queue capable, use none . 18.3. The default disk scheduler Block devices use the default disk scheduler unless you specify another scheduler. Note For non-volatile Memory Express (NVMe) block devices specifically, the default scheduler is none and Red Hat recommends not changing this. The kernel selects a default disk scheduler based on the type of device. The automatically selected scheduler is typically the optimal setting. If you require a different scheduler, Red Hat recommends to use udev rules or the TuneD application to configure it. Match the selected devices and switch the scheduler only for those devices. 18.4. Determining the active disk scheduler This procedure determines which disk scheduler is currently active on a given block device. Procedure Read the content of the /sys/block/ device /queue/scheduler file: In the file name, replace device with the block device name, for example sdc . The active scheduler is listed in square brackets ( [ ] ). 18.5. Setting the disk scheduler using TuneD This procedure creates and enables a TuneD profile that sets a given disk scheduler for selected block devices. The setting persists across system reboots. In the following commands and configuration, replace: device with the name of the block device, for example sdf selected-scheduler with the disk scheduler that you want to set for the device, for example bfq Prerequisites The TuneD service is installed and enabled. For details, see Installing and enabling TuneD . Procedure Optional: Select an existing TuneD profile on which your profile will be based. For a list of available profiles, see TuneD profiles distributed with RHEL . To see which profile is currently active, use: Create a new directory to hold your TuneD profile: Find the system unique identifier of the selected block device: Note The command in the this example will return all values identified as a World Wide Name (WWN) or serial number associated with the specified block device. Although it is preferred to use a WWN, the WWN is not always available for a given device and any values returned by the example command are acceptable to use as the device system unique ID . Create the /etc/tuned/ my-profile /tuned.conf configuration file. In the file, set the following options: Optional: Include an existing profile: Set the selected disk scheduler for the device that matches the WWN identifier: Here: Replace IDNAME with the name of the identifier being used (for example, ID_WWN ). Replace device system unique id with the value of the chosen identifier (for example, 0x5002538d00000000 ). To match multiple devices in the devices_udev_regex option, enclose the identifiers in parentheses and separate them with vertical bars: Enable your profile: Verification Verify that the TuneD profile is active and applied: Read the contents of the /sys/block/ device /queue/scheduler file: In the file name, replace device with the block device name, for example sdc . The active scheduler is listed in square brackets ( [] ). Additional resources Customizing TuneD profiles . 18.6. Setting the disk scheduler using udev rules This procedure sets a given disk scheduler for specific block devices using udev rules. The setting persists across system reboots. In the following commands and configuration, replace: device with the name of the block device, for example sdf selected-scheduler with the disk scheduler that you want to set for the device, for example bfq Procedure Find the system unique identifier of the block device: Note The command in the this example will return all values identified as a World Wide Name (WWN) or serial number associated with the specified block device. Although it is preferred to use a WWN, the WWN is not always available for a given device and any values returned by the example command are acceptable to use as the device system unique ID . Configure the udev rule. Create the /etc/udev/rules.d/99-scheduler.rules file with the following content: Here: Replace IDNAME with the name of the identifier being used (for example, ID_WWN ). Replace device system unique id with the value of the chosen identifier (for example, 0x5002538d00000000 ). Reload udev rules: Apply the scheduler configuration: Verification Verify the active scheduler: 18.7. Temporarily setting a scheduler for a specific disk This procedure sets a given disk scheduler for specific block devices. The setting does not persist across system reboots. Procedure Write the name of the selected scheduler to the /sys/block/ device /queue/scheduler file: In the file name, replace device with the block device name, for example sdc . Verification Verify that the scheduler is active on the device:	[ "cat /sys/block/ device /queue/scheduler [mq-deadline] kyber bfq none", "tuned-adm active", "mkdir /etc/tuned/ my-profile", "udevadm info --query=property --name=/dev/ device \| grep -E '(WWN\|SERIAL)' ID_WWN= 0x5002538d00000000_ ID_SERIAL= Generic-_SD_MMC_20120501030900000-0:0 ID_SERIAL_SHORT= 20120501030900000", "[main] include= existing-profile", "[disk] devices_udev_regex= IDNAME = device system unique id elevator= selected-scheduler", "devices_udev_regex=(ID_WWN= 0x5002538d00000000 )\|(ID_WWN= 0x1234567800000000 )", "tuned-adm profile my-profile", "tuned-adm active Current active profile: my-profile", "tuned-adm verify Verification succeeded, current system settings match the preset profile. See TuneD log file ('/var/log/tuned/tuned.log') for details.", "cat /sys/block/ device /queue/scheduler [mq-deadline] kyber bfq none", "udevadm info --name=/dev/ device \| grep -E '(WWN\|SERIAL)' E: ID_WWN= 0x5002538d00000000 E: ID_SERIAL= Generic-_SD_MMC_20120501030900000-0:0 E: ID_SERIAL_SHORT= 20120501030900000", "ACTION==\"add\|change\", SUBSYSTEM==\"block\", ENV{ IDNAME }==\" device system unique id \", ATTR{queue/scheduler}=\" selected-scheduler \"", "udevadm control --reload-rules", "udevadm trigger --type=devices --action=change", "cat /sys/block/ device /queue/scheduler", "echo selected-scheduler > /sys/block/ device /queue/scheduler", "cat /sys/block/ device /queue/scheduler" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/8/html/managing_storage_devices/setting-the-disk-scheduler_managing-storage-devices
Chapter 2. Performance Monitoring Tools	Chapter 2. Performance Monitoring Tools This chapter describes tools used to monitor guest virtual machine environments. 2.1. perf kvm You can use the perf command with the kvm option to collect and analyze guest operating system statistics from the host. The perf package provides the perf command. It is installed by running the following command: In order to use perf kvm in the host, you must have access to the /proc/modules and /proc/kallsyms files from the guest. See Procedure 2.1, "Copying /proc files from guest to host" to transfer the files into the host and run reports on the files. Procedure 2.1. Copying /proc files from guest to host Important If you directly copy the required files (for instance, using scp ) you will only copy files of zero length. This procedure describes how to first save the files in the guest to a temporary location (with the cat command), and then copy them to the host for use by perf kvm . Log in to the guest and save files Log in to the guest and save /proc/modules and /proc/kallsyms to a temporary location, /tmp : Copy the temporary files to the host Once you have logged off from the guest, run the following example scp commands to copy the saved files to the host. You should substitute your host name and TCP port if they are different: You now have two files from the guest ( guest-kallsyms and guest-modules ) on the host, ready for use by perf kvm . Recording and reporting events with perf kvm Using the files obtained in the steps, recording and reporting of events in the guest, the host, or both is now possible. Run the following example command: Note If both --host and --guest are used in the command, output will be stored in perf.data.kvm . If only --host is used, the file will be named perf.data.host . Similarly, if only --guest is used, the file will be named perf.data.guest . Pressing Ctrl-C stops recording. Reporting events The following example command uses the file obtained by the recording process, and redirects the output into a new file, analyze . View the contents of the analyze file to examine the recorded events: # cat analyze # Events: 7K cycles # # Overhead Command Shared Object Symbol # ........ ............ ................. ......................... # 95.06% vi vi [.] 0x48287 0.61% init [kernel.kallsyms] [k] intel_idle 0.36% vi libc-2.12.so [.] _wordcopy_fwd_aligned 0.32% vi libc-2.12.so [.] __strlen_sse42 0.14% swapper [kernel.kallsyms] [k] intel_idle 0.13% init [kernel.kallsyms] [k] uhci_irq 0.11% perf [kernel.kallsyms] [k] generic_exec_single 0.11% init [kernel.kallsyms] [k] tg_shares_up 0.10% qemu-kvm [kernel.kallsyms] [k] tg_shares_up [output truncated...]	[ "yum install perf", "cat /proc/modules > /tmp/modules cat /proc/kallsyms > /tmp/kallsyms", "scp root@GuestMachine:/tmp/kallsyms guest-kallsyms scp root@GuestMachine:/tmp/modules guest-modules", "perf kvm --host --guest --guestkallsyms=guest-kallsyms --guestmodules=guest-modules record -a -o perf.data", "perf kvm --host --guest --guestmodules=guest-modules report -i perf.data.kvm --force > analyze", "cat analyze Events: 7K cycles # Overhead Command Shared Object Symbol ........ ............ ................. ...................... # 95.06% vi vi [.] 0x48287 0.61% init [kernel.kallsyms] [k] intel_idle 0.36% vi libc-2.12.so [.] _wordcopy_fwd_aligned 0.32% vi libc-2.12.so [.] __strlen_sse42 0.14% swapper [kernel.kallsyms] [k] intel_idle 0.13% init [kernel.kallsyms] [k] uhci_irq 0.11% perf [kernel.kallsyms] [k] generic_exec_single 0.11% init [kernel.kallsyms] [k] tg_shares_up 0.10% qemu-kvm [kernel.kallsyms] [k] tg_shares_up [output truncated...]" ]	https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/virtualization_tuning_and_optimization_guide/chap-virtualization_tuning_optimization_guide-monitoring_tools
Chapter 9. Revision History	Chapter 9. Revision History 0.1-8 Tue Sep 29 2020, Jaroslav Klech ( [email protected] ) Document version for 7.9 GA publication. 0.1-7 Tue Mar 31 2020, Jaroslav Klech ( [email protected] ) Document version for 7.8 GA publication. 0.1-6 Tue Aug 6 2019, Jaroslav Klech ( [email protected] ) Document version for 7.7 GA publication. 0.1-5 Fri Oct 19 2018, Jaroslav Klech ( [email protected] ) Document version for 7.6 GA publication. 0.1-4 Mon Mar 26 2018, Marie Dolezelova ( [email protected] ) Document version for 7.5 GA publication. 0.1-3 Mon Jan 5 2018, Mark Flitter ( [email protected] ) Document version for 7.5 Beta publication. 0.1-2 Mon Jul 31 2017, Mark Flitter ( [email protected] ) Document version for 7.4 GA publication. 0.1-0 Thu Apr 20 2017, Mark Flitter ( [email protected] ) Initial build for review	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/kernel_administration_guide/revision_history
Chapter 14. Using bound service account tokens	Chapter 14. Using bound service account tokens You can use bound service account tokens, which improves the ability to integrate with cloud provider identity access management (IAM) services, such as AWS IAM. 14.1. About bound service account tokens You can use bound service account tokens to limit the scope of permissions for a given service account token. These tokens are audience and time-bound. This facilitates the authentication of a service account to an IAM role and the generation of temporary credentials mounted to a pod. You can request bound service account tokens by using volume projection and the TokenRequest API. 14.2. Configuring bound service account tokens using volume projection You can configure pods to request bound service account tokens by using volume projection. Prerequisites You have access to the cluster as a user with the cluster-admin role. You have created a service account. This procedure assumes that the service account is named build-robot . Procedure Optional: Set the service account issuer. This step is typically not required if the bound tokens are used only within the cluster. Important If you change the service account issuer to a custom one, the service account issuer is still trusted for the 24 hours. You can force all holders to request a new bound token either by manually restarting all pods in the cluster or by performing a rolling node restart. Before performing either action, wait for a new revision of the Kubernetes API server pods to roll out with your service account issuer changes. Edit the cluster Authentication object: USD oc edit authentications cluster Set the spec.serviceAccountIssuer field to the desired service account issuer value: spec: serviceAccountIssuer: https://test.default.svc 1 1 This value should be a URL from which the recipient of a bound token can source the public keys necessary to verify the signature of the token. The default is https://kubernetes.default.svc . Save the file to apply the changes. Wait for a new revision of the Kubernetes API server pods to roll out. It can take several minutes for all nodes to update to the new revision. Run the following command: USD oc get kubeapiserver -o=jsonpath='{range .items[0].status.conditions[?(@.type=="NodeInstallerProgressing")]}{.reason}{"\n"}{.message}{"\n"}' Review the NodeInstallerProgressing status condition for the Kubernetes API server to verify that all nodes are at the latest revision. The output shows AllNodesAtLatestRevision upon successful update: AllNodesAtLatestRevision 3 nodes are at revision 12 1 1 In this example, the latest revision number is 12 . If the output shows a message similar to one of the following messages, the update is still in progress. Wait a few minutes and try again. 3 nodes are at revision 11; 0 nodes have achieved new revision 12 2 nodes are at revision 11; 1 nodes are at revision 12 Optional: Force the holder to request a new bound token either by performing a rolling node restart or by manually restarting all pods in the cluster. Perform a rolling node restart: Warning It is not recommended to perform a rolling node restart if you have custom workloads running on your cluster, because it can cause a service interruption. Instead, manually restart all pods in the cluster. Restart nodes sequentially. Wait for the node to become fully available before restarting the node. See Rebooting a node gracefully for instructions on how to drain, restart, and mark a node as schedulable again. Manually restart all pods in the cluster: Warning Be aware that running this command causes a service interruption, because it deletes every running pod in every namespace. These pods will automatically restart after they are deleted. Run the following command: USD for I in USD(oc get ns -o jsonpath='{range .items[*]} {.metadata.name}{"\n"} {end}'); \ do oc delete pods --all -n USDI; \ sleep 1; \ done Configure a pod to use a bound service account token by using volume projection. Create a file called pod-projected-svc-token.yaml with the following contents: apiVersion: v1 kind: Pod metadata: name: nginx spec: containers: - image: nginx name: nginx volumeMounts: - mountPath: /var/run/secrets/tokens name: vault-token serviceAccountName: build-robot 1 volumes: - name: vault-token projected: sources: - serviceAccountToken: path: vault-token 2 expirationSeconds: 7200 3 audience: vault 4 1 A reference to an existing service account. 2 The path relative to the mount point of the file to project the token into. 3 Optionally set the expiration of the service account token, in seconds. The default is 3600 seconds (1 hour) and must be at least 600 seconds (10 minutes). 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. 4 Optionally set the intended audience of the token. The recipient of a token should verify that the recipient identity matches the audience claim of the token, and should otherwise reject the token. The audience defaults to the identifier of the API server. Create the pod: USD oc create -f pod-projected-svc-token.yaml The kubelet requests and stores the token on behalf of the pod, makes the token available to the pod at a configurable file path, and refreshes the token as it approaches expiration. The application that uses the bound token must handle reloading the token when it rotates. The kubelet rotates the token if it is older than 80 percent of its time to live, or if the token is older than 24 hours. Additional resources Rebooting a node gracefully	[ "oc edit authentications cluster", "spec: serviceAccountIssuer: https://test.default.svc 1", "oc get kubeapiserver -o=jsonpath='{range .items[0].status.conditions[?(@.type==\"NodeInstallerProgressing\")]}{.reason}{\"\\n\"}{.message}{\"\\n\"}'", "AllNodesAtLatestRevision 3 nodes are at revision 12 1", "for I in USD(oc get ns -o jsonpath='{range .items[*]} {.metadata.name}{\"\\n\"} {end}'); do oc delete pods --all -n USDI; sleep 1; done", "apiVersion: v1 kind: Pod metadata: name: nginx spec: containers: - image: nginx name: nginx volumeMounts: - mountPath: /var/run/secrets/tokens name: vault-token serviceAccountName: build-robot 1 volumes: - name: vault-token projected: sources: - serviceAccountToken: path: vault-token 2 expirationSeconds: 7200 3 audience: vault 4", "oc create -f pod-projected-svc-token.yaml" ]	https://docs.redhat.com/en/documentation/openshift_container_platform/4.10/html/authentication_and_authorization/bound-service-account-tokens
Providing feedback on Red Hat documentation	Providing feedback on Red Hat documentation We appreciate your input on our documentation. Tell us how we can make it better. Providing documentation feedback in Jira Use the Create Issue form to provide feedback on the documentation for Red Hat OpenStack Services on OpenShift (RHOSO) or earlier releases of Red Hat OpenStack Platform (RHOSP). When you create an issue for RHOSO or RHOSP documents, the issue is recorded in the RHOSO Jira project, where you can track the progress of your feedback. To complete the Create Issue form, ensure that you are logged in to Jira. If you do not have a Red Hat Jira account, you can create an account at https://issues.redhat.com . Click the following link to open a Create Issue page: Create Issue Complete the Summary and Description fields. In the Description field, include the documentation URL, chapter or section number, and a detailed description of the issue. Do not modify any other fields in the form. Click Create .	null	https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html/deploying_red_hat_openstack_services_on_openshift/proc_providing-feedback-on-red-hat-documentation
Chapter 5. Using Firewalls	Chapter 5. Using Firewalls 5.1. Getting Started with firewalld A firewall is a way to protect machines from any unwanted traffic from outside. It enables users to control incoming network traffic on host machines by defining a set of firewall rules . These rules are used to sort the incoming traffic and either block it or allow through. firewalld is a firewall service daemon that provides a dynamic customizable host-based firewall with a D-Bus interface. Being dynamic, it enables creating, changing, and deleting the rules without the necessity to restart the firewall daemon each time the rules are changed. firewalld uses the concepts of zones and services , that simplify the traffic management. Zones are predefined sets of rules. Network interfaces and sources can be assigned to a zone. The traffic allowed depends on the network your computer is connected to and the security level this network is assigned. Firewall services are predefined rules that cover all necessary settings to allow incoming traffic for a specific service and they apply within a zone. Services use one or more ports or addresses for network communication. Firewalls filter communication based on ports. To allow network traffic for a service, its ports must be open . firewalld blocks all traffic on ports that are not explicitly set as open. Some zones, such as trusted , allow all traffic by default. Figure 5.1. The Firewall Stack 5.1.1. Zones firewalld can be used to separate networks into different zones according to the level of trust that the user has decided to place on the interfaces and traffic within that network. A connection can only be part of one zone, but a zone can be used for many network connections. NetworkManager notifies firewalld of the zone of an interface. You can assign zones to interfaces with NetworkManager , with the firewall-config tool, or the firewall-cmd command-line tool. The latter two only edit the appropriate NetworkManager configuration files. If you change the zone of the interface using firewall-cmd or firewall-config , the request is forwarded to NetworkManager and is not handled by firewalld . The predefined zones are stored in the /usr/lib/firewalld/zones/ directory and can be instantly applied to any available network interface. These files are copied to the /etc/firewalld/zones/ directory only after they are modified. The following table describes the default settings of the predefined zones: block Any incoming network connections are rejected with an icmp-host-prohibited message for IPv4 and icmp6-adm-prohibited for IPv6 . Only network connections initiated from within the system are possible. dmz For computers in your demilitarized zone that are publicly-accessible with limited access to your internal network. Only selected incoming connections are accepted. drop Any incoming network packets are dropped without any notification. Only outgoing network connections are possible. external For use on external networks with masquerading enabled, especially for routers. You do not trust the other computers on the network to not harm your computer. Only selected incoming connections are accepted. home For use at home when you mostly trust the other computers on the network. Only selected incoming connections are accepted. internal For use on internal networks when you mostly trust the other computers on the network. Only selected incoming connections are accepted. public For use in public areas where you do not trust other computers on the network. Only selected incoming connections are accepted. trusted All network connections are accepted. work For use at work where you mostly trust the other computers on the network. Only selected incoming connections are accepted. One of these zones is set as the default zone. When interface connections are added to NetworkManager , they are assigned to the default zone. On installation, the default zone in firewalld is set to be the public zone. The default zone can be changed. Note The network zone names have been chosen to be self-explanatory and to allow users to quickly make a reasonable decision. To avoid any security problems, review the default zone configuration and disable any unnecessary services according to your needs and risk assessments. 5.1.2. Predefined Services A service can be a list of local ports, protocols, source ports, and destinations, as well as a list of firewall helper modules automatically loaded if a service is enabled. Using services saves users time because they can achieve several tasks, such as opening ports, defining protocols, enabling packet forwarding and more, in a single step, rather than setting up everything one after another. Service configuration options and generic file information are described in the firewalld.service(5) man page. The services are specified by means of individual XML configuration files, which are named in the following format: service-name .xml . Protocol names are preferred over service or application names in firewalld . 5.1.3. Runtime and Permanent Settings Any changes committed in runtime mode only apply while firewalld is running. When firewalld is restarted, the settings revert to their permanent values. To make the changes persistent across reboots, apply them again using the --permanent option. Alternatively, to make changes persistent while firewalld is running, use the --runtime-to-permanent firewall-cmd option. If you set the rules while firewalld is running using only the --permanent option, they do not become effective before firewalld is restarted. However, restarting firewalld closes all open ports and stops the networking traffic. 5.1.4. Modifying Settings in Runtime and Permanent Configuration using CLI Using the CLI, you do not modify the firewall settings in both modes at the same time. You only modify either runtime or permanent mode. To modify the firewall settings in the permanent mode, use the --permanent option with the firewall-cmd command. Without this option, the command modifies runtime mode. To change settings in both modes, you can use two methods: Change runtime settings and then make them permanent as follows: Set permanent settings and reload the settings into runtime mode: The first method allows you to test the settings before you apply them to the permanent mode. Note It is possible, especially on remote systems, that an incorrect setting results in a user locking themselves out of a machine. To prevent such situations, use the --timeout option. After a specified amount of time, any change reverts to its state. Using this options excludes the --permanent option. For example, to add the SSH service for 15 minutes:	[ "~]# firewall-cmd --permanent <other options>", "~]# firewall-cmd <other options> ~]# firewall-cmd --runtime-to-permanent", "~]# firewall-cmd --permanent <other options> ~]# firewall-cmd --reload", "~]# firewall-cmd --add-service=ssh --timeout 15m" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/security_guide/sec-Using_Firewalls
Architecture	Architecture OpenShift Dedicated 4 Architecture overview. Red Hat OpenShift Documentation Team	[ "apiVersion: admissionregistration.k8s.io/v1beta1 kind: MutatingWebhookConfiguration 1 metadata: name: <webhook_name> 2 webhooks: - name: <webhook_name> 3 clientConfig: 4 service: namespace: default 5 name: kubernetes 6 path: <webhook_url> 7 caBundle: <ca_signing_certificate> 8 rules: 9 - operations: 10 - <operation> apiGroups: - \"\" apiVersions: - \"\" resources: - <resource> failurePolicy: <policy> 11 sideEffects: None", "apiVersion: admissionregistration.k8s.io/v1beta1 kind: ValidatingWebhookConfiguration 1 metadata: name: <webhook_name> 2 webhooks: - name: <webhook_name> 3 clientConfig: 4 service: namespace: default 5 name: kubernetes 6 path: <webhook_url> 7 caBundle: <ca_signing_certificate> 8 rules: 9 - operations: 10 - <operation> apiGroups: - \"\" apiVersions: - \"\" resources: - <resource> failurePolicy: <policy> 11 sideEffects: Unknown" ]	https://docs.redhat.com/en/documentation/openshift_dedicated/4/html-single/architecture/index
Chapter 4. Additional information	Chapter 4. Additional information Depending on your environment (cloud providers, third party user tools, and agents), you should change SELinux labels on additional mount points ( /opt , /sapmnt , and /trans ).	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux_for_sap_solutions/9/html/using_selinux_for_sap_hana/ref_add_info_using-selinux
Chapter 3. Backup and recovery	Chapter 3. Backup and recovery For information about performing a backup and recovery of Ansible Automation Platform, see Backup and restore in the Automation Controller Administration Guide. For information about troubleshooting backup and recovery for installations of Ansible Automation Platform Operator on OpenShift Container Platform, see the Troubleshooting section in Red Hat Ansible Automation Platform operator backup and recovery guide .	null	https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/troubleshooting_ansible_automation_platform/troubleshoot-backup-recovery
Chapter 4. Downloading Red Hat build of OptaPlanner examples	Chapter 4. Downloading Red Hat build of OptaPlanner examples You can download the Red Hat build of OptaPlanner examples as a part of the {PRODUCTPAM} add-ons package available on the Red Hat Customer Portal. Procedure Navigate to the Software Downloads page in the Red Hat Customer Portal (login required), and select the product and version from the drop-down options: Product: Process Automation Manager Version: 7.13.5 Download Red Hat Process Automation Manager 7.13 Add Ons . Extract the rhpam-7.13.5-add-ons.zip file. The extracted add-ons folder contains the rhpam-7.13.5-planner-engine.zip file. Extract the rhpam-7.13.5-planner-engine.zip file. Result The extracted rhpam-7.13.5-planner-engine directory contains example source code under the following subdirectories: examples/sources/src/main/java/org/optaplanner/examples examples/sources/src/main/resources/org/optaplanner/examples 4.1. Running OptaPlanner examples Red Hat build of OptaPlanner includes several examples that demonstrate a variety of planning use cases. Download and use the examples to explore different types of planning solutions. Prerequisites You have downloaded and extracted the examples as described in Chapter 4, Downloading Red Hat build of OptaPlanner examples . Procedure To run the examples, in the rhpam-7.13.5-planner-engine/examples directory enter one of the following commands: Linux or Mac: Windows: The OptaPlanner Examples window opens. Select an example to run that example. Note Red Hat build of OptaPlanner has no GUI dependencies. It runs just as well on a server or a mobile JVM as it does on the desktop. 4.2. Running the Red Hat build of OptaPlanner examples in an IDE (IntelliJ, Eclipse, or Netbeans) If you use an integrated development environment (IDE), such as IntelliJ, Eclipse, or Netbeans, you can run your downloaded OptaPlanner examples within your development environment. Prerequisites You have downloaded and extracted the OptaPlanner examples as described in Chapter 4, Downloading Red Hat build of OptaPlanner examples . Procedure Open the OptaPlanner examples as a new project: For IntelliJ or Netbeans, open examples/sources/pom.xml as the new project. The Maven integration guides you through the rest of the installation. Skip the rest of the steps in this procedure. For Eclipse, open a new project for the /examples/binaries directory, located under the rhpam-7.13.5-planner-engine directory. Add all the JAR files that are in the binaries directory to the classpath, except for the examples/binaries/optaplanner-examples-7.67.0.Final-redhat-00024.jar file. Add the Java source directory src/main/java and the Java resources directory src/main/resources , located under the rhpam-7.13.5-planner-engine/examples/sources/ directory. Create a run configuration: Main class: org.optaplanner.examples.app.OptaPlannerExamplesApp VM parameters (optional): -Xmx512M -server -Dorg.optaplanner.examples.dataDir=examples/sources/data Working directory: examples/sources Run the run configuration.	[ "./runExamples.sh", "runExamples.bat" ]	https://docs.redhat.com/en/documentation/red_hat_decision_manager/7.13/html/developing_solvers_with_red_hat_build_of_optaplanner_in_red_hat_decision_manager/examples-download-proc
Chapter 15. Package Management with RPM	Chapter 15. Package Management with RPM The RPM Package Manager (RPM) is an open packaging system, available for anyone to use, which runs on Red Hat Enterprise Linux as well as other Linux and UNIX systems. Red Hat, Inc encourages other vendors to use RPM for their own products. RPM is distributable under the terms of the GPL. For the end user, RPM makes system updates easy. Installing, uninstalling, and upgrading RPM packages can be accomplished with short commands. RPM maintains a database of installed packages and their files, so you can invoke powerful queries and verifications on your system. If you prefer a graphical interface, you can use the Package Management Tool to perform many RPM commands. During upgrades, RPM handles configuration files carefully, so that you never lose your customizations - something that you cannot accomplish with regular .tar.gz files. For the developer, RPM allows you to take software source code and package it into source and binary packages for end users. This process is quite simple and is driven from a single file and optional patches that you create. This clear delineation between pristine sources and your patches along with build instructions eases the maintenance of the package as new versions of the software are released. Note Because RPM makes changes to your system, you must be root to install, remove, or upgrade an RPM package. 15.1. RPM Design Goals To understand how to use RPM, it can be helpful to understand RPM's design goals: Upgradability Using RPM, you can upgrade individual components of your system without completely reinstalling. When you get a new release of an operating system based on RPM (such as Red Hat Enterprise Linux), you do not need to reinstall on your machine (as you do with operating systems based on other packaging systems). RPM allows intelligent, fully-automated, in-place upgrades of your system. Configuration files in packages are preserved across upgrades, so you do not lose your customizations. There are no special upgrade files needed to upgrade a package because the same RPM file is used to install and upgrade the package on your system. Powerful Querying RPM is designed to provide powerful querying options. You can do searches through your entire database for packages or just for certain files. You can also easily find out what package a file belongs to and from where the package came. The files an RPM package contains are in a compressed archive, with a custom binary header containing useful information about the package and its contents, allowing you to query individual packages quickly and easily. System Verification Another powerful feature is the ability to verify packages. If you are worried that you deleted an important file for some package, verify the package. You are notified of any anomalies. At that point, you can reinstall the package if necessary. Any configuration files that you modified are preserved during reinstallation. Pristine Sources A crucial design goal was to allow the use of "pristine" software sources, as distributed by the original authors of the software. With RPM, you have the pristine sources along with any patches that were used, plus complete build instructions. This is an important advantage for several reasons. For instance, if a new version of a program comes out, you do not necessarily have to start from scratch to get it to compile. You can look at the patch to see what you might need to do. All the compiled-in defaults, and all of the changes that were made to get the software to build properly, are easily visible using this technique. The goal of keeping sources pristine may only seem important for developers, but it results in higher quality software for end users, too.	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/4/html/system_administration_guide/Package_Management_with_RPM
Chapter 52. JSON Jackson	Chapter 52. JSON Jackson Jackson is a Data Format which uses the Jackson Library from("activemq:My.Queue"). marshal().json(JsonLibrary.Jackson). to("mqseries:Another.Queue"); 52.1. Dependencies When using json-jackson 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-jackson-starter</artifactId> </dependency> 52.2. Jackson Options The JSON Jackson dataformat supports 20 options, which are listed below. Name Default Java Type Description objectMapper String Lookup and use the existing ObjectMapper with the given id when using Jackson. useDefaultObjectMapper Boolean Whether to lookup and use default Jackson ObjectMapper from the registry. prettyPrint Boolean To enable pretty printing output nicely formatted. Is by default false. unmarshalType String Class name of the java type to use when unmarshalling. jsonView String When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations. include String If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL. allowJmsType Boolean Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to. collectionType String Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default. useList Boolean To unmarshal to a List of Map or a List of Pojo. moduleClassNames String To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma. moduleRefs String To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma. enableFeatures String Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma. disableFeatures String Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma. allowUnmarshallType Boolean If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used. timezone String If set then Jackson will use the Timezone when marshalling/unmarshalling. This option will have no effect on the others Json DataFormat, like gson, fastjson and xstream. autoDiscoverObjectMapper Boolean If set to true then Jackson will lookup for an objectMapper into the registry. contentTypeHeader Boolean Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON. schemaResolver String Optional schema resolver used to lookup schemas for the data in transit. autoDiscoverSchemaResolver Boolean When not disabled, the SchemaResolver will be looked up into the registry. namingStrategy String If set then Jackson will use the the defined Property Naming Strategy.Possible values are: LOWER_CAMEL_CASE, LOWER_DOT_CASE, LOWER_CASE, KEBAB_CASE, SNAKE_CASE and UPPER_CAMEL_CASE. 52.3. Using custom ObjectMapper You can configure JacksonDataFormat to use a custom ObjectMapper in case you need more control of the mapping configuration. If you setup a single ObjectMapper in the registry, then Camel will automatic lookup and use this ObjectMapper . For example if you use Spring Boot, then Spring Boot can provide a default ObjectMapper for you if you have Spring MVC enabled. And this would allow Camel to detect that there is one bean of ObjectMapper class type in the Spring Boot bean registry and then use it. When this happens you should set a INFO logging from Camel. 52.4. Using Jackson for automatic type conversion The camel-jackson module allows integrating Jackson as a Type Converter . This works in a similar way to JAXB that integrates with Camel's type converter. To use this camel-jackson must be enabled, which is done by setting the following options on the CamelContext global options, as shown: @Bean CamelContextConfiguration contextConfiguration() { return new CamelContextConfiguration() { @Override public void beforeApplicationStart(CamelContext context) { // Enable Jackson JSON type converter. context.getGlobalOptions().put(JacksonConstants.ENABLE_TYPE_CONVERTER, "true"); // Allow Jackson JSON to convert to pojo types also // (by default Jackson only converts to String and other simple types) getContext().getGlobalOptions().put(JacksonConstants.TYPE_CONVERTER_TO_POJO, "true"); } @Override public void afterApplicationStart(CamelContext camelContext) { } }; } The camel-jackson type converter integrates with JAXB which means you can annotate POJO class with JAXB annotations that Jackson can use. You can also use Jackson's own annotations on your POJO classes. 52.5. Spring Boot Auto-Configuration The component supports 21 options, which are listed below. Name Description Default Type camel.dataformat.json-jackson.allow-jms-type Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to. false Boolean camel.dataformat.json-jackson.allow-unmarshall-type If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used. false Boolean camel.dataformat.json-jackson.auto-discover-object-mapper If set to true then Jackson will lookup for an objectMapper into the registry. false Boolean camel.dataformat.json-jackson.auto-discover-schema-resolver When not disabled, the SchemaResolver will be looked up into the registry. true Boolean camel.dataformat.json-jackson.collection-type Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default. String camel.dataformat.json-jackson.content-type-header Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON. true Boolean camel.dataformat.json-jackson.disable-features Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma. String camel.dataformat.json-jackson.enable-features Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma. String camel.dataformat.json-jackson.enabled Whether to enable auto configuration of the json-jackson data format. This is enabled by default. Boolean camel.dataformat.json-jackson.include If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL. String camel.dataformat.json-jackson.json-view When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations. String camel.dataformat.json-jackson.module-class-names To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma. String camel.dataformat.json-jackson.module-refs To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma. String camel.dataformat.json-jackson.naming-strategy If set then Jackson will use the the defined Property Naming Strategy.Possible values are: LOWER_CAMEL_CASE, LOWER_DOT_CASE, LOWER_CASE, KEBAB_CASE, SNAKE_CASE and UPPER_CAMEL_CASE. String camel.dataformat.json-jackson.object-mapper Lookup and use the existing ObjectMapper with the given id when using Jackson. String camel.dataformat.json-jackson.pretty-print To enable pretty printing output nicely formatted. Is by default false. false Boolean camel.dataformat.json-jackson.schema-resolver Optional schema resolver used to lookup schemas for the data in transit. String camel.dataformat.json-jackson.timezone If set then Jackson will use the Timezone when marshalling/unmarshalling. This option will have no effect on the others Json DataFormat, like gson, fastjson and xstream. String camel.dataformat.json-jackson.unmarshal-type Class name of the java type to use when unmarshalling. String camel.dataformat.json-jackson.use-default-object-mapper Whether to lookup and use default Jackson ObjectMapper from the registry. true Boolean camel.dataformat.json-jackson.use-list To unmarshal to a List of Map or a List of Pojo. false Boolean	[ "from(\"activemq:My.Queue\"). marshal().json(JsonLibrary.Jackson). to(\"mqseries:Another.Queue\");", "<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-jackson-starter</artifactId> </dependency>", "@Bean CamelContextConfiguration contextConfiguration() { return new CamelContextConfiguration() { @Override public void beforeApplicationStart(CamelContext context) { // Enable Jackson JSON type converter. context.getGlobalOptions().put(JacksonConstants.ENABLE_TYPE_CONVERTER, \"true\"); // Allow Jackson JSON to convert to pojo types also // (by default Jackson only converts to String and other simple types) getContext().getGlobalOptions().put(JacksonConstants.TYPE_CONVERTER_TO_POJO, \"true\"); } @Override public void afterApplicationStart(CamelContext camelContext) { } }; }" ]	https://docs.redhat.com/en/documentation/red_hat_build_of_apache_camel/4.0/html/red_hat_build_of_apache_camel_for_spring_boot_reference/csb-camel-json-jackson-dataformat-starter
Chapter 1. About OpenShift Virtualization	Chapter 1. About OpenShift Virtualization Learn about OpenShift Virtualization's capabilities and support scope. 1.1. What you can do with OpenShift Virtualization OpenShift Virtualization is an add-on to OpenShift Container Platform that allows you to run and manage virtual machine workloads alongside container workloads. OpenShift Virtualization adds new objects into your OpenShift Container Platform cluster via Kubernetes custom resources to enable virtualization tasks. These tasks include: Creating and managing Linux and Windows virtual machines Connecting to virtual machines through a variety of consoles and CLI tools Importing and cloning existing virtual machines Managing network interface controllers and storage disks attached to virtual machines Live migrating virtual machines between nodes An enhanced web console provides a graphical portal to manage these virtualized resources alongside the OpenShift Container Platform cluster containers and infrastructure. OpenShift Virtualization is tested with OpenShift Container Storage (OCS) and designed to use with OCS features for the best experience. You can use OpenShift Virtualization with the OVN-Kubernetes , OpenShift SDN , or one of the other certified default Container Network Interface (CNI) network providers listed in Certified OpenShift CNI Plugins . 1.1.1. OpenShift Virtualization supported cluster version OpenShift Virtualization 4.9 is supported for use on OpenShift Container Platform 4.9 clusters. To use the latest z-stream release of OpenShift Virtualization, you must first upgrade to the latest version of OpenShift Container Platform.	null	https://docs.redhat.com/en/documentation/openshift_container_platform/4.9/html/virtualization/about-virt
Chapter 7. Management of Alerts on the Ceph dashboard	Chapter 7. Management of Alerts on the Ceph dashboard As a storage administrator, you can see the details of alerts and create silences for them on the Red Hat Ceph Storage dashboard. This includes the following pre-defined alerts: CephadmDaemonFailed CephadmPaused CephadmUpgradeFailed CephDaemonCrash CephDeviceFailurePredicted CephDeviceFailurePredictionTooHigh CephDeviceFailureRelocationIncomplete CephFilesystemDamaged CephFilesystemDegraded CephFilesystemFailureNoStandby CephFilesystemInsufficientStandby CephFilesystemMDSRanksLow CephFilesystemOffline CephFilesystemReadOnly CephHealthError CephHealthWarning CephMgrModuleCrash CephMgrPrometheusModuleInactive CephMonClockSkew CephMonDiskspaceCritical CephMonDiskspaceLow CephMonDown CephMonDownQuorumAtRisk CephNodeDiskspaceWarning CephNodeInconsistentMTU CephNodeNetworkPacketDrops CephNodeNetworkPacketErrors CephNodeRootFilesystemFull CephObjectMissing CephOSDBackfillFull CephOSDDown CephOSDDownHigh CephOSDFlapping CephOSDFull CephOSDHostDown CephOSDInternalDiskSizeMismatch CephOSDNearFull CephOSDReadErrors CephOSDTimeoutsClusterNetwork CephOSDTimeoutsPublicNetwork CephOSDTooManyRepairs CephPGBackfillAtRisk CephPGImbalance CephPGNotDeepScrubbed CephPGNotScrubbed CephPGRecoveryAtRisk CephPGsDamaged CephPGsHighPerOSD CephPGsInactive CephPGsUnclean CephPGUnavilableBlockingIO CephPoolBackfillFull CephPoolFull CephPoolGrowthWarning CephPoolNearFull CephSlowOps PrometheusJobMissing Figure 7.1. Pre-defined alerts You can also monitor alerts using simple network management protocol (SNMP) traps. See the Configuration of SNMP traps chapter in the Red Hat Ceph Storage Operations Guide . 7.1. Enabling monitoring stack You can manually enable the monitoring stack of the Red Hat Ceph Storage cluster, such as Prometheus, Alertmanager, and Grafana, using the command-line interface. You can use the Prometheus and Alertmanager API to manage alerts and silences. Prerequisite A running Red Hat Ceph Storage cluster. root-level access to all the hosts. Procedure Log into the cephadm shell: Example Set the APIs for the monitoring stack: Specify the host and port of the Alertmanager server: Syntax Example To see the configured alerts, configure the URL to the Prometheus API. Using this API, the Ceph Dashboard UI verifies that a new silence matches a corresponding alert. Syntax Example After setting up the hosts, refresh your browser's dashboard window. Specify the host and port of the Grafana server: Syntax Example Get the Prometheus, Alertmanager, and Grafana API host details: Example Optional: If you are using a self-signed certificate in your Prometheus, Alertmanager, or Grafana setup, disable the certificate verification in the dashboard This avoids refused connections caused by certificates signed by an unknown Certificate Authority (CA) or that do not match the hostname. For Prometheus: Example For Alertmanager: Example For Grafana: Example Get the details of the self-signed certificate verification setting for Prometheus, Alertmanager, and Grafana: Example Optional: If the dashboard does not reflect the changes, you have to disable and then enable the dashboard: Example Additional Resources See the Bootstrap command options section in the Red Hat Ceph Storage Installation Guide . See the Red Hat Ceph Storage installation chapter in the Red Hat Ceph Storage Installation Guide . See the Deploying the monitoring stack using the Ceph Orchestrator section in the Red Hat Ceph Storage Operations Guide . 7.2. Configuring Grafana certificate The cephadm deploys Grafana using the certificate defined in the ceph key/value store. If a certificate is not specified, cephadm generates a self-signed certificate during the deployment of the Grafana service. You can configure a custom certificate with the ceph config-key set command. Prerequisite A running Red Hat Ceph Storage cluster. Procedure Log into the cephadm shell: Example Configure the custom certificate for Grafana: Example If Grafana is already deployed, then run reconfig to update the configuration: Example Every time a new certificate is added, follow the below steps: Make a new directory Example Generate the key: Example View the key: Example Make a request: Example Review the request prior to sending it for signature: Example As the CA sign: Example Check the signed certificate: Example Additional Resources See the Using shared system certificates for more details. 7.3. Adding Alertmanager webhooks You can add new webhooks to an existing Alertmanager configuration to receive real-time alerts about the health of the storage cluster. You have to enable incoming webhooks to allow asynchronous messages into third-party applications. For example, if an OSD is down in a Red Hat Ceph Storage cluster, you can configure the Alertmanager to send notification on Google chat. Prerequisite A running Red Hat Ceph Storage cluster with monitoring stack components enabled. Incoming webhooks configured on the receiving third-party application. Procedure Log into the cephadm shell: Example Configure the Alertmanager to use the webhook for notification: Syntax The default_webhook_urls is a list of additional URLs that are added to the default receivers' webhook_configs configuration. Example Update Alertmanager configuration: Example Verification An example notification from Alertmanager to Gchat: Example 7.4. Viewing alerts on the Ceph dashboard After an alert has fired, you can view it on the Red Hat Ceph Storage Dashboard. You can edit the Manager module settings to trigger a mail when an alert is fired. Note SSL is not supported in Red Hat Ceph Storage 5 cluster. Prerequisite A running Red Hat Ceph Storage cluster. Dashboard is installed. A running simple mail transfer protocol (SMTP) configured. An alert fired. Procedure Log in to the Dashboard. Customize the alerts module on the dashboard to get an email alert for the storage cluster: On the navigation menu, click Cluster . Select Manager modules . Select alerts module. In the Edit drop-down menu, select Edit . In the Edit Manager module window, update the required parameters and click Update . Figure 7.2. Edit Manager module for alerts On the navigation menu, click Cluster . Select Monitoring from the drop-down menu. To view details of the alert, click the Expand/Collapse icon on it's row. Figure 7.3. Viewing alerts To view the source of an alert, click on its row, and then click Source . Additional resources See the Management of Alerts on the Ceph dashboard for more details to configure SMTP. 7.5. Creating a silence on the Ceph dashboard You can create a silence for an alert for a specified amount of time on the Red Hat Ceph Storage Dashboard. Prerequisite A running Red Hat Ceph Storage cluster. Dashboard is installed. An alert fired. Procedure Log in to the Dashboard. On the navigation menu, click Cluster . Select Monitoring from the drop-down menu. To create silence for an alert, select it's row. Click +Create Silence . In the Create Silence window, Add the details for the Duration and click Create Silence . Figure 7.4. Create Silence You get a notification that the silence was created successfully. 7.6. Re-creating a silence on the Ceph dashboard You can re-create a silence from an expired silence on the Red Hat Ceph Storage Dashboard. Prerequisite A running Red Hat Ceph Storage cluster. Dashboard is installed. An alert fired. A silence created for the alert. Procedure Log in to the Dashboard. On the navigation menu, click Cluster . Select Monitoring from the drop-down menu. Click the Silences tab. To recreate an expired silence, click it's row. Click the Recreate button. In the Recreate Silence window, add the details and click Recreate Silence . Figure 7.5. Recreate silence You get a notification that the silence was recreated successfully. 7.7. Editing a silence on the Ceph dashboard You can edit an active silence, for example, to extend the time it is active on the Red Hat Ceph Storage Dashboard. If the silence has expired, you can either recreate a silence or create a new silence for the alert. Prerequisite A running Red Hat Ceph Storage cluster. Dashboard is installed. An alert fired. A silence created for the alert. Procedure Log in to the Dashboard. On the navigation menu, click Cluster . Select Monitoring from the drop-down menu. Click the Silences tab. To edit the silence, click it's row. In the Edit drop-down menu, select Edit . In the Edit Silence window, update the details and click Edit Silence . Figure 7.6. Edit silence You get a notification that the silence was updated successfully. 7.8. Expiring a silence on the Ceph dashboard You can expire a silence so any matched alerts will not be suppressed on the Red Hat Ceph Storage Dashboard. Prerequisite A running Red Hat Ceph Storage cluster. Dashboard is installed. An alert fired. A silence created for the alert. Procedure Log in to the Dashboard. On the navigation menu, click Cluster . Select Monitoring from the drop-down menu. Click the Silences tab. To expire a silence, click it's row. In the Edit drop-down menu, select Expire . In the Expire Silence dialog box, select Yes, I am sure , and then click Expire Silence . Figure 7.7. Expire Silence You get a notification that the silence was expired successfully. 7.9. Additional Resources For more information, see the Red Hat Ceph StorageTroubleshooting Guide .	[ "cephadm shell", "ceph dashboard set-alertmanager-api-host ' ALERTMANAGER_API_HOST : PORT '", "ceph dashboard set-alertmanager-api-host 'http://10.0.0.101:9093' Option ALERTMANAGER_API_HOST updated", "ceph dashboard set-prometheus-api-host ' PROMETHEUS_API_HOST : PORT '", "ceph dashboard set-prometheus-api-host 'http://10.0.0.101:9095' Option PROMETHEUS_API_HOST updated", "ceph dashboard set-grafana-api-url ' GRAFANA_API_URL : PORT '", "ceph dashboard set-grafana-api-url 'http://10.0.0.101:3000' Option GRAFANA_API_URL updated", "ceph dashboard get-alertmanager-api-host http://10.0.0.101:9093 ceph dashboard get-prometheus-api-host http://10.0.0.101:9095 ceph dashboard get-grafana-api-url http://10.0.0.101:3000", "ceph dashboard set-prometheus-api-ssl-verify False", "ceph dashboard set-alertmanager-api-ssl-verify False", "ceph dashboard set-grafana-api-ssl-verify False", "ceph dashboard get-prometheus-api-ssl-verify ceph dashboard get-alertmanager-api-ssl-verify ceph dashboard get-grafana-api-ssl-verify", "ceph mgr module disable dashboard ceph mgr module enable dashboard", "cephadm shell", "ceph config-key set mgr/cephadm/grafana_key -i USDPWD/key.pem ceph config-key set mgr/cephadm/grafana_crt -i USDPWD/certificate.pem", "ceph orch reconfig grafana", "mkdir /root/internalca cd /root/internalca", "openssl ecparam -genkey -name secp384r1 -out USD(date +%F).key", "openssl ec -text -in USD(date +%F).key \| less", "umask 077; openssl req -config openssl-san.cnf -new -sha256 -key USD(date +%F).key -out USD(date +%F).csr", "openssl req -text -in USD(date +%F).csr \| less", "openssl ca -extensions v3_req -in USD(date +%F).csr -out USD(date +%F).crt -extfile openssl-san.cnf", "openssl x509 -text -in USD(date +%F).crt -noout \| less", "cephadm shell", "service_type: alertmanager spec: user_data: default_webhook_urls: - \"_URLS_\"", "service_type: alertmanager spec: user_data: webhook_configs: - url: 'http:127.0.0.10:8080'", "ceph orch reconfig alertmanager", "using: https://chat.googleapis.com/v1/spaces/(xx- space identifyer -xx)/messages posting: {'status': 'resolved', 'labels': {'alertname': 'PrometheusTargetMissing', 'instance': 'postgres-exporter.host03.chest response: 200 response: { \"name\": \"spaces/(xx- space identifyer -xx)/messages/3PYDBOsIofE.3PYDBOsIofE\", \"sender\": { \"name\": \"users/114022495153014004089\", \"displayName\": \"monitoring\", \"avatarUrl\": \"\", \"email\": \"\", \"domainId\": \"\", \"type\": \"BOT\", \"isAnonymous\": false, \"caaEnabled\": false }, \"text\": \"Prometheus target missing (instance postgres-exporter.cluster.local:9187)\\n\\nA Prometheus target has disappeared. An e \"cards\": [], \"annotations\": [], \"thread\": { \"name\": \"spaces/(xx- space identifyer -xx)/threads/3PYDBOsIofE\" }, \"space\": { \"name\": \"spaces/(xx- space identifyer -xx)\", \"type\": \"ROOM\", \"singleUserBotDm\": false, \"threaded\": false, \"displayName\": \"_privmon\", \"legacyGroupChat\": false }, \"fallbackText\": \"\", \"argumentText\": \"Prometheus target missing (instance postgres-exporter.cluster.local:9187)\\n\\nA Prometheus target has disappea \"attachment\": [], \"createTime\": \"2022-06-06T06:17:33.805375Z\", \"lastUpdateTime\": \"2022-06-06T06:17:33.805375Z\"" ]	https://docs.redhat.com/en/documentation/red_hat_ceph_storage/5/html/dashboard_guide/management-of-alerts-on-the-ceph-dashboard
12.6. Setting ethers Information for a Host	12.6. Setting ethers Information for a Host NIS can host an ethers table which can be used to manage DHCP configuration files for systems based on their platform, operating system, DNS domain, and MAC address - all information stored in host entries in IdM. In Identity Management, each system is created with a corresponding ethers entry in the directory, in the ou=ethers subtree. This entry is used to create a NIS map for the ethers service which can be managed by the NIS compatibility plug-in in IdM. To configure NIS maps for ethers entries: Add the MAC address attribute to a host entry. For example: Open the nsswitch.conf file. Add a line for the ethers service, and set it to use LDAP for its lookup. Check that the ethers information is available for the client.	[ "cn=server,ou=ethers,dc=example,dc=com", "[jsmith@server ~]USD kinit admin [jsmith@server ~]USD ipa host-mod --macaddress=12:34:56:78:9A:BC server.example.com", "ethers: ldap", "getent ethers server.example.com" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/linux_domain_identity_authentication_and_policy_guide/host-ethers
Chapter 9. Logging	Chapter 9. Logging 9.1. Configuring logging The client uses the SLF4J API, enabling users to select a particular logging implementation based on their needs. For example, users can provide the slf4j-log4j binding to select the Log4J implementation. More details on SLF4J are available from its website . The client uses Logger names residing within the org.apache.qpid.jms hierarchy, which you can use to configure a logging implementation based on your needs. 9.2. Enabling protocol logging When debugging, it is sometimes useful to enable additional protocol trace logging from the Qpid Proton AMQP 1.0 library. There are two ways to achieve this. Set the environment variable (not the Java system property) PN_TRACE_FRM to 1 . When the variable is set to 1 , Proton emits frame logging to the console. Add the option amqp.traceFrames=true to your connection URI and configure the org.apache.qpid.jms.provider.amqp.FRAMES logger to log level TRACE . This adds a protocol tracer to Proton and includes the output in your logs. You can also configure the client to emit low-level tracing of input and output bytes. To enable this, add the option transport.traceBytes=true to your connection URI and configure the org.apache.qpid.jms.transports.netty.NettyTcpTransport logger to log level DEBUG .	null	https://docs.redhat.com/en/documentation/red_hat_build_of_apache_qpid_jms/2.4/html/using_qpid_jms/logging
Chapter 1. Creating a deployment with separate heat stacks	Chapter 1. Creating a deployment with separate heat stacks When you use separate heat stacks in your Red Hat OpenStack Platform environment, you can isolate the management operations that director performs. For example, you can scale Compute nodes without updating the Controller nodes that the control plane stack manages. You can also use this technique to deploy multiple Red Hat Ceph Storage clusters. 1.1. Using separate heat stacks In a typical Red Hat OpenStack Platform deployment, a single heat stack manages all nodes, including the control plane (Controllers). You can now use separate heat stacks to address architectural constraints. Use separate heat stacks for different node types. For example, the control plane, Compute nodes, and HCI nodes can each be managed by their own stack. This allows you to change or scale the compute stack without affecting the control plane. You can use separate heat stacks at the same site to deploy multiple Ceph clusters. You can use separate heat stacks for disparate availability zones (AZs) within the same data center. Separate heat stacks are required for deploying Red Hat OpenStack Platform using a distributed compute node (DCN) architecture. This reduces network and management dependencies on the central data center. Each edge site in this architecture must also have its own AZ from both Compute and Storage nodes. This feature is available in this release as a Technology Preview , and therefore is not fully supported by Red Hat. It should only be used for testing, and should not be deployed in a production environment. For more information about Technology Preview features, see Scope of Coverage Details . 1.2. Prerequisites for using separate heat stacks Your environment must meet the following prerequisites before you create a deployment using separate heat stacks: A working Red Hat OpenStack Platform 16 undercloud. For Ceph Storage users: access to Red Hat Ceph Storage 4. For the central location: three nodes that are capable of serving as central Controller nodes. All three Controller nodes must be in the same heat stack. You cannot split Controller nodes, or any of the control plane services, across separate heat stacks. For the distributed compute node (DCN) site: three nodes that are capable of serving as hyper-converged infrastructure (HCI) Compute nodes or standard compute nodes. For each additional DCN site: three HCI compute or Ceph nodes. All nodes must be pre-provisioned or able to PXE boot from the central deployment network. You can use a DHCP relay to enable this connectivity for DCNs. All nodes have been introspected by ironic. 1.3. Limitations of the example separate heat stacks deployment This document provides an example deployment that uses separate heat stacks on Red Hat OpenStack Platform. This example environment has the following limitations: Image service (glance) multi store is not currently available, but it is expected to be available in a future release. In the example in this guide, Block Storage (cinder) is the only service that uses Ceph Storage. Spine/Leaf networking - The example in this guide does not demonstrate any routing requirements. Routing requirements are found in most distributed compute node (DCN) deployments. Ironic DHCP Relay - This guide does not include how to configure ironic with a DHCP relay. Block Storage (cinder) active/active without Pacemaker is available as technical preview only. DCN HCI nodes are available as technical preview only.	null	https://docs.redhat.com/en/documentation/red_hat_openstack_platform/16.0/html/deploying_distributed_compute_nodes_with_separate_heat_stacks/assembly_creating-a-deployment-with-separate-heat-stacks
25.2. Prerequisites for Using Vaults	25.2. Prerequisites for Using Vaults To enable vaults, install the Key Recovery Authority (KRA) Certificate System component on one or more of the servers in your IdM domain: Note To make the Vault service highly available, install the KRA on two IdM servers or more.	[ "ipa-kra-install" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/linux_domain_identity_authentication_and_policy_guide/vault-prereqs
3.3. Confined and Unconfined Users	3.3. Confined and Unconfined Users Each Linux user is mapped to an SELinux user using SELinux policy. This allows Linux users to inherit the restrictions on SELinux users. This Linux user mapping is seen by running the semanage login -l command as root: In Red Hat Enterprise Linux, Linux users are mapped to the SELinux __default__ login by default, which is mapped to the SELinux unconfined_u user. The following line defines the default mapping: The following procedure demonstrates how to add a new Linux user to the system and how to map that user to the SELinux unconfined_u user. It assumes that the root user is running unconfined, as it does by default in Red Hat Enterprise Linux: Procedure 3.4. Mapping a New Linux User to the SELinux unconfined_u User As root, enter the following command to create a new Linux user named newuser : To assign a password to the Linux newuser user. Enter the following command as root: Log out of your current session, and log in as the Linux newuser user. When you log in, the pam_selinux PAM module automatically maps the Linux user to an SELinux user (in this case, unconfined_u ), and sets up the resulting SELinux context. The Linux user's shell is then launched with this context. Enter the following command to view the context of a Linux user: Note If you no longer need the newuser user on your system, log out of the Linux newuser 's session, log in with your account, and run the userdel -r newuser command as root. It will remove newuser along with their home directory. Confined and unconfined Linux users are subject to executable and writable memory checks, and are also restricted by MCS or MLS. To list the available SELinux users, enter the following command: Note that the seinfo command is provided by the setools-console package, which is not installed by default. If an unconfined Linux user executes an application that SELinux policy defines as one that can transition from the unconfined_t domain to its own confined domain, the unconfined Linux user is still subject to the restrictions of that confined domain. The security benefit of this is that, even though a Linux user is running unconfined, the application remains confined. Therefore, the exploitation of a flaw in the application can be limited by the policy. Similarly, we can apply these checks to confined users. Each confined Linux user is restricted by a confined user domain. The SELinux policy can also define a transition from a confined user domain to its own target confined domain. In such a case, confined Linux users are subject to the restrictions of that target confined domain. The main point is that special privileges are associated with the confined users according to their role. In the table below, you can see examples of basic confined domains for Linux users in Red Hat Enterprise Linux: Table 3.1. SELinux User Capabilities User Role Domain X Window System su or sudo Execute in home directory and /tmp (default) Networking sysadm_u sysadm_r sysadm_t yes su and sudo yes yes staff_u staff_r staff_t yes only sudo yes yes user_u user_r user_t yes no yes yes guest_u guest_r guest_t no no yes no xguest_u xguest_r xguest_t yes no yes Firefox only Linux users in the user_t , guest_t , and xguest_t domains can only run set user ID (setuid) applications if SELinux policy permits it (for example, passwd ). These users cannot run the su and sudo setuid applications, and therefore cannot use these applications to become root. Linux users in the sysadm_t , staff_t , user_t , and xguest_t domains can log in using the X Window System and a terminal. By default, Linux users in the staff_t , user_t , guest_t , and xguest_t domains can execute applications in their home directories and /tmp . To prevent them from executing applications, which inherit users' permissions, in directories they have write access to, set the guest_exec_content and xguest_exec_content booleans to off . This helps prevent flawed or malicious applications from modifying users' files. See Section 6.6, "Booleans for Users Executing Applications" for information about allowing and preventing users from executing applications in their home directories and /tmp . The only network access Linux users in the xguest_t domain have is Firefox connecting to web pages. Note that system_u is a special user identity for system processes and objects. It must never be associated to a Linux user. Also, unconfined_u and root are unconfined users. For these reasons, they are not included in the aforementioned table of SELinux user capabilities. Alongside with the already mentioned SELinux users, there are special roles, that can be mapped to those users. These roles determine what SELinux allows the user to do: webadm_r can only administrate SELinux types related to the Apache HTTP Server. See Section 13.2, "Types" for further information. dbadm_r can only administrate SELinux types related to the MariaDB database and the PostgreSQL database management system. See Section 20.2, "Types" and Section 21.2, "Types" for further information. logadm_r can only administrate SELinux types related to the syslog and auditlog processes. secadm_r can only administrate SELinux. auditadm_r can only administrate processes related to the audit subsystem. To list all available roles, enter the following command: As mentioned before, the seinfo command is provided by the setools-console package, which is not installed by default. 3.3.1. The sudo Transition and SELinux Roles In certain cases, confined users need to perform an administrative task that require root privileges. To do so, such a confined user has to gain a confined administrator SELinux role using the sudo command. The sudo command is used to give trusted users administrative access. When users precede an administrative command with sudo , they are prompted for their own password. Then, when they have been authenticated and assuming that the command is permitted, the administrative command is executed as if they were the root user. As shown in Table 3.1, "SELinux User Capabilities" , only the staff_u and sysadm_u SELinux confined users are permitted to use sudo by default. When such users execute a command with sudo , their role can be changed based on the rules specified in the /etc/sudoers configuration file or in a respective file in the /etc/sudoers.d/ directory if such a file exists. For more information about sudo , see the Gaining Privileges section in the Red Hat Enterprise Linux 7 System Administrator's Guide . Procedure 3.5. Configuring the sudo Transition This procedure shows how to set up sudo to transition a newly-created SELinux_user_u confined user from a default_role_r to an administrator_r administrator role. Note To configure a confined administrator role for an already existing SELinux user, skip the first two steps. Create a new SELinux user and specify the default SELinux role and a supplementary confined administrator role for this user: Set up the default SElinux policy context file. For example, to have the same SELinux rules as the staff_u SELinux user, copy the staff_u context file: Map the newly-created SELinux user to an existing Linux user: Create a new configuration file with the same name as your Linux user in the /etc/sudoers.d/ directory and add the following string to it: Use the restorecon utility to relabel the linux_user home directory: Log in to the system as the newly-created Linux user and check that the user is labeled with the default SELinux role: Run sudo to change the user's SELinux context to the supplementary SELinux role as specified in /etc/sudoers.d/ linux_user . The -i option used with sudo causes that an interactive shell is executed: To better understand the placeholders, such as default_role_r or administrator_r , see the following example. Example 3.1. Configuring the sudo Transition This example creates a new SELinux user confined_u with default assigned role staff_r and with sudo configured to change the role of confined_u from staff_r to webadm_r . Enter all the following commands as the root user in the sysadm_r or unconfined_r role. Log in to the system as the newly-created Linux user and check that the user is labeled with the default SELinux role:	[ "~]# semanage login -l Login Name SELinux User MLS/MCS Range Service __default__ unconfined_u s0-s0:c0.c1023 * root unconfined_u s0-s0:c0.c1023 * system_u system_u s0-s0:c0.c1023 *", "__default__ unconfined_u s0-s0:c0.c1023", "~]# useradd newuser", "~]# passwd newuser Changing password for user newuser. New UNIX password: Enter a password Retype new UNIX password: Enter the same password again passwd: all authentication tokens updated successfully.", "[newuser@localhost ~]USD id -Z unconfined_u:unconfined_r:unconfined_t:s0-s0:c0.c1023", "~]USD seinfo -u Users: 8 sysadm_u system_u xguest_u root guest_u staff_u user_u unconfined_u", "~]USD seinfo -r", "~]# semanage user -a -r s0-s0:c0.c1023 -R \" default_role_r administrator_r \" SELinux_user_u", "~]# cp /etc/selinux/targeted/contexts/users/staff_u /etc/selinux/targeted/contexts/users/ SELinux_user_u", "semanage login -a -s SELinux_user_u -rs0:c0.c1023 linux_user", "~]# echo \" linux_user ALL=(ALL) TYPE= administrator_t ROLE= administrator_r /bin/bash \" > /etc/sudoers.d/ linux_user", "~]# restorecon -FR -v /home/ linux_user", "~]USD id -Z SELinux_user_u : default_role_r : SELinux_user_t :s0:c0.c1023", "~]USD sudo -i ~]# id -Z SELinux_user_u : administrator_r : administrator_t :s0:c0.c1023", "~]# semanage user -a -r s0-s0:c0.c1023 -R \"staff_r webadm_r\" confined_u ~]# cp /etc/selinux/targeted/contexts/users/staff_u /etc/selinux/targeted/contexts/users/confined_u ~]# semanage login -a -s confined_u -rs0:c0.c1023 linux_user ~]# restorecon -FR -v /home/linux_user ~]# echo \" linux_user ALL=(ALL) ROLE=webadm_r TYPE=webadm_t /bin/bash \" > /etc/sudoers.d/linux_user", "~]USD id -Z confined_u:staff_r:staff_t:s0:c0.c1023 ~]USD sudo -i ~]# id -Z confined_u:webadm_r:webadm_t:s0:c0.c1023" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/selinux_users_and_administrators_guide/sect-Security-Enhanced_Linux-Targeted_Policy-Confined_and_Unconfined_Users
Chapter 7. Requesting persistent storage for workspaces	Chapter 7. Requesting persistent storage for workspaces OpenShift Dev Spaces workspaces and workspace data are ephemeral and are lost when the workspace stops. To preserve the workspace state in persistent storage while the workspace is stopped, request a Kubernetes PersistentVolume (PV) for the Dev Workspace containers in the OpenShift cluster of your organization's OpenShift Dev Spaces instance. You can request a PV by using the devfile or a Kubernetes PersistentVolumeClaim (PVC). An example of a PV is the /projects/ directory of a workspace, which is mounted by default for non-ephemeral workspaces. Persistent Volumes come at a cost: attaching a persistent volume slows workspace startup. Warning Starting another, concurrently running workspace with a ReadWriteOnce PV might fail. Additional resources Red Hat OpenShift Documentation: Understanding persistent storage Kubernetes Documentation: Persistent Volumes 7.1. Requesting persistent storage in a devfile When a workspace requires its own persistent storage, request a PersistentVolume (PV) in the devfile, and OpenShift Dev Spaces will automatically manage the necessary PersistentVolumeClaims. Prerequisites You have not started the workspace. Procedure Add a volume component in the devfile: ... components: ... - name: <chosen_volume_name> volume: size: <requested_volume_size> G ... Add a volumeMount for the relevant container in the devfile: ... components: - name: ... container: ... volumeMounts: - name: <chosen_volume_name_from_previous_step> path: <path_where_to_mount_the_PV> ... Example 7.1. A devfile that provisions a PV for a workspace to a container When a workspace is started with the following devfile, the cache PV is provisioned to the golang container in the ./cache container path: schemaVersion: 2.1.0 metadata: name: mydevfile components: - name: golang container: image: golang memoryLimit: 512Mi mountSources: true command: ['sleep', 'infinity'] volumeMounts: - name: cache path: /.cache - name: cache volume: size: 2Gi 7.2. Requesting persistent storage in a PVC You can opt to apply a PersistentVolumeClaim (PVC) to request a PersistentVolume (PV) for your workspaces in the following cases: Not all developers of the project need the PV. The PV lifecycle goes beyond the lifecycle of a single workspace. The data included in the PV are shared across workspaces. Tip You can apply a PVC to the Dev Workspace containers even if the workspace is ephemeral and its devfile contains the controller.devfile.io/storage-type: ephemeral attribute. Prerequisites You have not started the workspace. An active oc session with administrative permissions to the destination OpenShift cluster. See Getting started with the CLI . A PVC is created in your user project to mount to all Dev Workspace containers. Procedure Add the controller.devfile.io/mount-to-devworkspace: true label to the PVC. Optional: Use the annotations to configure how the PVC is mounted: Table 7.1. Optional annotations Annotation Description controller.devfile.io/mount-path: The mount path for the PVC. Defaults to /tmp/ <PVC_name> . controller.devfile.io/read-only: Set to 'true' or 'false' to specify whether the PVC is to be mounted as read-only. Defaults to 'false' , resulting in the PVC mounted as read/write. Example 7.2. Mounting a read-only PVC apiVersion: v1 kind: PersistentVolumeClaim metadata: name: <pvc_name> labels: controller.devfile.io/mount-to-devworkspace: 'true' annotations: controller.devfile.io/mount-path: </example/directory> 1 controller.devfile.io/read-only: 'true' spec: accessModes: - ReadWriteOnce resources: requests: storage: 3Gi 2 storageClassName: <storage_class_name> 3 volumeMode: Filesystem 1 The mounted PV is available at </example/directory> in the workspace. 2 Example size value of the requested storage. 3 The name of the StorageClass required by the claim. Remove this line if you want to use a default StorageClass.	[ "components: - name: <chosen_volume_name> volume: size: <requested_volume_size> G", "components: - name: container: volumeMounts: - name: <chosen_volume_name_from_previous_step> path: <path_where_to_mount_the_PV>", "schemaVersion: 2.1.0 metadata: name: mydevfile components: - name: golang container: image: golang memoryLimit: 512Mi mountSources: true command: ['sleep', 'infinity'] volumeMounts: - name: cache path: /.cache - name: cache volume: size: 2Gi", "oc label persistentvolumeclaim <PVC_name> \\ controller.devfile.io/mount-to-devworkspace=true", "apiVersion: v1 kind: PersistentVolumeClaim metadata: name: <pvc_name> labels: controller.devfile.io/mount-to-devworkspace: 'true' annotations: controller.devfile.io/mount-path: </example/directory> 1 controller.devfile.io/read-only: 'true' spec: accessModes: - ReadWriteOnce resources: requests: storage: 3Gi 2 storageClassName: <storage_class_name> 3 volumeMode: Filesystem" ]	https://docs.redhat.com/en/documentation/red_hat_openshift_dev_spaces/3.19/html/user_guide/requesting-persistent-storage-for-workspaces
12.2.3. Using the chkconfig Utility	12.2.3. Using the chkconfig Utility The chkconfig utility is a command-line tool that allows you to specify in which runlevel to start a selected service, as well as to list all available services along with their current setting. Note that with the exception of listing, you must have superuser privileges to use this command. 12.2.3.1. Listing the Services To display a list of system services (services from the /etc/rc.d/init.d/ directory, as well as the services controlled by xinetd ), either type chkconfig --list , or use chkconfig with no additional arguments. You will be presented with an output similar to the following: Each line consists of the name of the service followed by its status ( on or off ) for each of the seven numbered runlevels. For example, in the listing above, NetworkManager is enabled in runlevel 2, 3, 4, and 5, while abrtd runs in runlevel 3 and 5. The xinetd based services are listed at the end, being either on , or off . To display the current settings for a selected service only, use chkconfig --list followed by the name of the service: chkconfig --list service_name For example, to display the current settings for the sshd service, type: You can also use this command to display the status of a service that is managed by xinetd . In that case, the output will only contain the information whether the service is enabled or disabled: 12.2.3.2. Enabling a Service To enable a service in runlevels 2, 3, 4, and 5, type the following at a shell prompt as root : chkconfig service_name on For example, to enable the httpd service in these four runlevels, type: To enable a service in certain runlevels only, add the --level option followed by numbers from 0 to 6 representing each runlevel in which you want the service to run: chkconfig service_name on --level runlevels For instance, to enable the abrtd service in runlevels 3 and 5, type: The service will be started the time you enter one of these runlevels. If you need to start the service immediately, use the service command as described in Section 12.3.2, "Starting a Service" . Do not use the --level option when working with a service that is managed by xinetd , as it is not supported. For example, to enable the rsync service, type: If the xinetd daemon is running, the service is immediately enabled without having to manually restart the daemon. 12.2.3.3. Disabling a Service To disable a service in runlevels 2, 3, 4, and 5, type the following at a shell prompt as root : chkconfig service_name off For instance, to disable the httpd service in these four runlevels, type: To disable a service in certain runlevels only, add the --level option followed by numbers from 0 to 6 representing each runlevel in which you do not want the service to run: chkconfig service_name off --level runlevels For instance, to disable the abrtd in runlevels 2 and 4, type: The service will be stopped the time you enter one of these runlevels. If you need to stop the service immediately, use the service command as described in Section 12.3.3, "Stopping a Service" . Do not use the --level option when working with a service that is managed by xinetd , as it is not supported. For example, to disable the rsync service, type: If the xinetd daemon is running, the service is immediately disabled without having to manually restart the daemon.	[ "~]# chkconfig --list NetworkManager 0:off 1:off 2:on 3:on 4:on 5:on 6:off abrtd 0:off 1:off 2:off 3:on 4:off 5:on 6:off acpid 0:off 1:off 2:on 3:on 4:on 5:on 6:off anamon 0:off 1:off 2:off 3:off 4:off 5:off 6:off atd 0:off 1:off 2:off 3:on 4:on 5:on 6:off auditd 0:off 1:off 2:on 3:on 4:on 5:on 6:off avahi-daemon 0:off 1:off 2:off 3:on 4:on 5:on 6:off ... several lines omitted wpa_supplicant 0:off 1:off 2:off 3:off 4:off 5:off 6:off xinetd based services: chargen-dgram: off chargen-stream: off cvs: off daytime-dgram: off daytime-stream: off discard-dgram: off ... several lines omitted time-stream: off", "~]# chkconfig --list sshd sshd 0:off 1:off 2:on 3:on 4:on 5:on 6:off", "~]# chkconfig --list rsync rsync off", "~]# chkconfig httpd on", "~]# chkconfig abrtd on --level 35", "~]# chkconfig rsync on", "~]# chkconfig httpd off", "~]# chkconfig abrtd off --level 24", "~]# chkconfig rsync off" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/deployment_guide/s2-services-chkconfig
3.5 Release Notes	3.5 Release Notes Red Hat Gluster Storage 3.5 Release Notes for Red Hat Gluster Storage 3.5 Edition 1 Gluster Storage Documentation Team Red Hat Customer Content Services [email protected]	null	https://docs.redhat.com/en/documentation/red_hat_gluster_storage/3.5/html/3.5_release_notes/index
5.4.16.4. Converting a Mirrored LVM Device to a RAID1 Device	5.4.16.4. Converting a Mirrored LVM Device to a RAID1 Device You can convert an existing mirrored LVM device to a RAID1 LVM device with the lvconvert command by specifying the --type raid1 argument. This renames the mirror subvolumes ( _mimage_ ) to RAID subvolumes ( _rimage_ ). In addition, the mirror log is removed and metadata subvolumes ( _rmeta_ ) are created for the data subvolumes on the same physical volumes as the corresponding data subvolumes. The following example shows the layout of a mirrored logical volume my_vg/my_lv . The following command converts the mirrored logical volume my_vg/my_lv to a RAID1 logical volume.	[ "lvs -a -o name,copy_percent,devices my_vg LV Copy% Devices my_lv 15.20 my_lv_mimage_0(0),my_lv_mimage_1(0) [my_lv_mimage_0] /dev/sde1(0) [my_lv_mimage_1] /dev/sdf1(0) [my_lv_mlog] /dev/sdd1(0)", "lvconvert --type raid1 my_vg/my_lv lvs -a -o name,copy_percent,devices my_vg LV Copy% Devices my_lv 100.00 my_lv_rimage_0(0),my_lv_rimage_1(0) [my_lv_rimage_0] /dev/sde1(0) [my_lv_rimage_1] /dev/sdf1(0) [my_lv_rmeta_0] /dev/sde1(125) [my_lv_rmeta_1] /dev/sdf1(125)" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/logical_volume_manager_administration/convert-mirror-to-RAID1
Chapter 16. Installing a three-node cluster on AWS	Chapter 16. Installing a three-node cluster on AWS In OpenShift Container Platform version 4.14, you can install a three-node cluster on Amazon Web Services (AWS). A three-node cluster consists of three control plane machines, which also act as compute machines. This type of cluster provides a smaller, more resource efficient cluster, for cluster administrators and developers to use for testing, development, and production. You can install a three-node cluster using either installer-provisioned or user-provisioned infrastructure. Note Deploying a three-node cluster using an AWS Marketplace image is not supported. 16.1. Configuring a three-node cluster You configure a three-node cluster by setting the number of worker nodes to 0 in the install-config.yaml file before deploying the cluster. Setting the number of worker nodes to 0 ensures that the control plane machines are schedulable. This allows application workloads to be scheduled to run from the control plane nodes. Note Because application workloads run from control plane nodes, additional subscriptions are required, as the control plane nodes are considered to be compute nodes. Prerequisites You have an existing install-config.yaml file. Procedure Set the number of compute replicas to 0 in your install-config.yaml file, as shown in the following compute stanza: Example install-config.yaml file for a three-node cluster apiVersion: v1 baseDomain: example.com compute: - name: worker platform: {} replicas: 0 # ... If you are deploying a cluster with user-provisioned infrastructure: After you create the Kubernetes manifest files, make sure that the spec.mastersSchedulable parameter is set to true in cluster-scheduler-02-config.yml file. You can locate this file in <installation_directory>/manifests . For more information, see "Creating the Kubernetes manifest and Ignition config files" in "Installing a cluster on user-provisioned infrastructure in AWS by using CloudFormation templates". Do not create additional worker nodes. Example cluster-scheduler-02-config.yml file for a three-node cluster apiVersion: config.openshift.io/v1 kind: Scheduler metadata: creationTimestamp: null name: cluster spec: mastersSchedulable: true policy: name: "" status: {} 16.2. steps Installing a cluster on AWS with customizations Installing a cluster on user-provisioned infrastructure in AWS by using CloudFormation templates	[ "apiVersion: v1 baseDomain: example.com compute: - name: worker platform: {} replicas: 0", "apiVersion: config.openshift.io/v1 kind: Scheduler metadata: creationTimestamp: null name: cluster spec: mastersSchedulable: true policy: name: \"\" status: {}" ]	https://docs.redhat.com/en/documentation/openshift_container_platform_installation/4.14/html/installing_on_aws/installing-aws-three-node
8.187. rubygems	8.187. rubygems 8.187.1. RHBA-2013:1694 - rubygems bug fix and enhancement update Updated rubygems packages that fix one bug and add one enhancement are now available for Red Hat Enterprise Linux 6. RubyGems is the Ruby standard for publishing and managing third-party libraries. Bug Fix BZ# 559707 Previously, the specification file listed an incorrect license. The specification file has been updated to fix the license, which is MIT now. Enhancement BZ# 788001 New release of rubygems package introduces rubygems-devel subpackage with RPM macros for easier packaging and better compatibility with Fedora. Users of rubygems are advised to upgrade to these updated packages, which fix this bug and add this enhancement.	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/6.5_technical_notes/rubygems
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_fuse/7.13/html/managing_fuse_on_jboss_eap_standalone/making-open-source-more-inclusive
Chapter 4. Searching Identity Management entries from the command line	Chapter 4. Searching Identity Management entries from the command line The following sections describe how to use IPA commands, which helps you to find or show objects. 4.1. Overview of listing IdM entries You can use the ipa -find commands to help you to search for particular types of IdM entries. To list all the find commands, use the following ipa help command: You may need to check if a particular user is included in the IdM database. You can then list all users with the following command: To list user groups whose specified attributes contain a keyword: For example the ipa group-find admin command lists all groups whose names or descriptions include string admin : When searching user groups, you can also limit the search results to groups that contain a particular user: To search for groups that do not contain a particular user: 4.2. Showing details for a particular entry Use the ipa -show command to display details about a particular IdM entry. Procedure To display details about a host named server.example.com : 4.3. Adjusting the search size and time limit Some queries, such as requesting a list of IdM users, can return a very large number of entries. By tuning these search operations, you can improve the overall server performance when running the ipa *-find commands, such as ipa user-find , and when displaying corresponding lists in the Web UI. Search size limit Defines the maximum number of entries returned for a request sent to the server from a client's CLI or from a browser accessing the IdM Web UI. Default: 100 entries. Search time limit Defines the maximum time (in seconds) that the server waits for searches to run. Once the search reaches this limit, the server stops the search and returns the entries discovered in that time. Default: 2 seconds. If you set the values to -1 , IdM will not apply any limits when searching. Important Setting search size or time limits too high can negatively affect server performance. 4.3.1. Adjusting the search size and time limit in the command line The following procedure describes adjusting search size and time limits in the command line: Globally For a specific entry Procedure To display current search time and size limits in CLI, use the ipa config-show command: To adjust the limits globally for all queries, use the ipa config-mod command and add the --searchrecordslimit and --searchtimelimit options. For example: To temporarily adjust the limits only for a specific query, add the --sizelimit or --timelimit options to the command. For example: 4.3.2. Adjusting the search size and time limit in the Web UI The following procedure describes adjusting global search size and time limits in the IdM Web UI. Procedure Log in to the IdM Web UI. Click IPA Server . On the IPA Server tab, click Configuration . Set the required values in the Search Options area. Default values are: Search size limit: 100 entries Search time limit: 2 seconds Click Save at the top of the page.	[ "ipa help commands \| grep find", "ipa user-find", "ipa group-find keyword", "---------------- 3 groups matched ---------------- Group name: admins Description: Account administrators group GID: 427200002 Group name: editors Description: Limited admins who can edit other users GID: 427200002 Group name: trust admins Description: Trusts administrators group", "ipa group-find --user= user_name", "ipa group-find --no-user= user_name", "ipa host-show server.example.com Host name: server.example.com Principal name: host/[email protected]", "ipa config-show Search time limit: 2 Search size limit: 100", "ipa config-mod --searchrecordslimit=500 --searchtimelimit=5", "ipa user-find --sizelimit=200 --timelimit=120" ]	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/8/html/accessing_identity_management_services/searching-ipa-entries_accessing-idm-services
Chapter 4. Defining REST Services	Chapter 4. Defining REST Services Abstract Apache Camel supports multiple approaches to defining REST services. In particular, Apache Camel provides the REST DSL (Domain Specific Language), which is a simple but powerful fluent API that can be layered over any REST component and provides integration with OpenAPI . 4.1. Overview of REST in Camel Overview Apache Camel provides many different approaches and components for defining REST services in your Camel applications. This section provides a quick overview of these different approaches and components, so that you can decide which implementation and API best suits your requirements. What is REST? Representational State Transfer (REST) is an architecture for distributed applications that centers around the transmission of data over HTTP, using only the four basic HTTP verbs: GET , POST , PUT , and DELETE . In contrast to a protocol such as SOAP, which treats HTTP as a mere transport protocol for SOAP messages, the REST architecture exploits HTTP directly. The key insight is that the HTTP protocol itself , augmented by a few simple conventions, is eminently suitable to serve as the framework for distributed applications. A sample REST invocation Because the REST architecture is built around the standard HTTP verbs, in many cases you can use a regular browser as a REST client. For example, to invoke a simple Hello World REST service running on the host and port, localhost:9091 , you could navigate to a URL like the following in your browser: The Hello World REST service might then return a response string, such as: Which gets displayed in your browser window. The ease with which you can invoke REST services, using nothing more than a standard browser (or the curl command-line utility), is one of the many reasons why the REST protocol has rapidly gained popularity. REST wrapper layers The following REST wrapper layers offer a simplified syntax for defining REST services and can be layered on top of different REST implementations: REST DSL The REST DSL (in camel-core ) is a facade or wrapper layer that provides a simplified builder API for defining REST services. The REST DSL does not itself provide a REST implementation: it must be combined with an underlying REST implementation. For example, the following Java code shows how to define a simple Hello World service using the REST DSL: For more details, see Section 4.2, "Defining Services with REST DSL" . Rest component The Rest component (in camel-core ) is a wrapper layer that enables you to define REST services using a URI syntax. Like the REST DSL, the Rest component does not itself provide a REST implementation. It must be combined with an underlying REST implementation. If you do not explicitly configure an HTTP transport component then the REST DSL automatically discovers which HTTP component to use by checking for available components on the classpath. The REST DSL looks for the default names of any HTTP components and uses the first one it finds. If there are no HTTP components on the classpath and you did not explicitly configure an HTTP transport then the default HTTP component is camel-http . Note The ability to automatically discover which HTTP component to use is new in Camel 2.18. It is not available in Camel 2.17. The following Java code shows how to define a simple Hello World service using the camel-rest component: REST implementations Apache Camel provides several different REST implementations, through the following components: Spark-Rest component The Spark-Rest component (in camel-spark-rest ) is a REST implementation that enables you to define REST services using a URI syntax. The Spark framework itself is a Java API, which is loosely based on the Sinatra framework (a Python API). For example, the following Java code shows how to define a simple Hello World service using the Spark-Rest component: Notice that, in contrast to the Rest component, the syntax for a variable in the URI is :name instead of {name} . Note The Spark-Rest component requires Java 8. Restlet component The Restlet component (in camel-restlet ) is a REST implementation that can, in principle, be layered above different transport protocols (although this component is only tested against the HTTP protocol). This component also provides an integration with the Restlet Framework , which is a commercial framework for developing REST services in Java. For example, the following Java code shows how to define a simple Hello World service using the Restlet component: For more details, see Restlet in the Apache Camel Component Reference Guide . Servlet component The Servlet component (in camel-servlet ) is a component that binds a Java servlet to a Camel route. In other words, the Servlet component enables you to package and deploy a Camel route as if it was a standard Java servlet. The Servlet component is therefore particularly useful, if you need to deploy a Camel route inside a servlet container (for example, into an Apache Tomcat HTTP server or into a JBoss Enterprise Application Platform container). The Servlet component on its own, however, does not provide any convenient REST API for defining REST services. The easiest way to use the Servlet component, therefore, is to combine it with the REST DSL, so that you can define REST services with a user-friendly API. For more details, see Servlet in the Apache Camel Component Reference Guide . JAX-RS REST implementation JAX-RS (Java API for RESTful Web Services) is a framework for binding REST requests to Java objects, where the Java classes must be decorated with JAX-RS annotations in order to define the binding. The JAX-RS framework is relatively mature and provides a sophisticated framework for developing REST services, but it is also somewhat complex to program. The JAX-RS integration with Apache Camel is implemented by the CXFRS component, which is layered over Apache CXF. In outline, JAX-RS binds a REST request to a Java class using the following annotations (where this is only an incomplete sample of the many available annotations): @Path Annotation that can map a context path to a Java class or map a sub-path to a particular Java method. @GET, @POST, @PUT, @DELETE Annotations that map a HTTP method to a Java method. @PathParam Annotation that either maps a URI parameter to a Java method argument, or injects a URI parameter into a field. @QueryParam Annotation that either maps a query parameter to a Java method argument, or injects a query parameter into a field. The body of a REST request or REST response is normally expected to be in JAXB (XML) data format. But Apache CXF also supports conversion of JSON format to JAXB format, so that JSON messages can also be parsed. For more details, see CXFRS in the Apache Camel Component Reference Guide and Apache CXF Development Guide . Note The CXFRS component is not integrated with the REST DSL. 4.2. Defining Services with REST DSL REST DSL is a facade The REST DSL is effectively a facade that provides a simplified syntax for defining REST services in a Java DSL or an XML DSL (Domain Specific Language). REST DSL does not actually provide the REST implementation, it is just a wrapper around an existing REST implementation (of which there are several in Apache Camel). Advantages of the REST DSL The REST DSL wrapper layer offers the following advantages: A modern easy-to-use syntax for defining REST services. Compatible with multiple different Apache Camel components. OpenAPI integration (through the camel-openapi-java component). Components that integrate with REST DSL Because the REST DSL is not an actual REST implementation, one of the first things you need to do is to choose a Camel component to provide the underlying implementation. The following Camel components are currently integrated with the REST DSL: Servlet component ( camel-servlet ). Spark REST component ( camel-spark-rest ). Netty4 HTTP component ( camel-netty4-http ). Jetty component ( camel-jetty ). Restlet component ( camel-restlet ). Undertow component ( camel-undertow ). Note The Rest component (part of camel-core ) is not a REST implementation. Like the REST DSL, the Rest component is a facade, providing a simplified syntax to define REST services using a URI syntax. The Rest component also requires an underlying REST implementation. Configuring REST DSL to use a REST implementation To specify the REST implementation, you use either the restConfiguration() builder (in Java DSL) or the restConfiguration element (in XML DSL). For example, to configure REST DSL to use the Spark-Rest component, you would use a builder expression like the following in the Java DSL: And you would use an element like the following (as a child of camelContext ) in the XML DSL: Syntax The Java DSL syntax for defining a REST service is as follows: Where CamelRoute is an optional embedded Camel route (defined using the standard Java DSL syntax for routes). The REST service definition starts with the rest() keyword, followed by one or more verb clauses that handle specific URL path segments. The HTTP verb can be one of get() , head() , put() , post() , delete() , patch() or verb() . Each verb clause can use either of the following syntaxes: Verb clause ending in to() keyword. For example: Verb clause ending in route() keyword (for embedding a Camel route). For example: REST DSL with Java In Java, to define a service with the REST DSL, put the REST definition into the body of a RouteBuilder.configure() method, just like you do for regular Apache Camel routes. For example, to define a simple Hello World service using the REST DSL with the Spark-Rest component, define the following Java code: The preceding example features three different kinds of builder: restConfiguration() Configures the REST DSL to use a specific REST implementation (Spark-Rest). rest() Defines a service using the REST DSL. Each of the verb clauses are terminated by a to() keyword, which forwards the incoming message to a direct endpoint (the direct component splices routes together within the same application). from() Defines a regular Camel route. REST DSL with XML In XML, to define a service with the XML DSL, define a rest element as a child of the camelContext element. For example, to define a simple Hello World service using the REST DSL with the Spark-Rest component, define the following XML code (in Blueprint): Specifying a base path The rest() keyword (Java DSL) or the path attribute of the rest element (XML DSL) allows you to define a base path, which is then prefixed to the paths in all of the verb clauses. For example, given the following snippet of Java DSL: Or given the following snippet of XML DSL: The REST DSL builder gives you the following URL mappings: The base path is optional. If you prefer, you could (less elegantly) specify the full path in each of the verb clauses: Using Dynamic To The REST DSL supports the toD dynamic to parameter. Use this parameter to specify URIs. For example, in JMS a dynamic endpoint URI could be defined in the following way: In XML DSL, the same details would look like this: For more information about the toD dynamic to parameter, see the section called "Dynamic To" . URI templates In a verb argument, you can specify a URI template, which enables you to capture specific path segments in named properties (which are then mapped to Camel message headers). For example, if you would like to personalize the Hello World application so that it greets the caller by name, you could define a REST service like the following: The URI template captures the text of the {name} path segment and copies this captured text into the name message header. If you invoke the service by sending a GET HTTP Request with the URL ending in /say/hello/Joe , the HTTP Response is Hello Joe . Embedded route syntax Instead of terminating a verb clause with the to() keyword (Java DSL) or the to element (XML DSL), you have the option of embedding an Apache Camel route directly into the REST DSL, using the route() keyword (Java DSL) or the route element (XML DSL). The route() keyword enables you to embed a route into a verb clause, with the following syntax: Where the endRest() keyword (Java DSL only) is a necessary punctuation mark that enables you to separate the verb clauses (when there is more than one verb clause in the rest() builder). For example, you could refactor the Hello World example to use embedded Camel routes, as follows in Java DSL: And as follows in XML DSL: Note If you define any exception clauses (using onException() ) or interceptors (using intercept() ) in the current CamelContext , these exception clauses and interceptors are also active in the embedded routes. REST DSL and HTTP transport component If you do not explicitly configure an HTTP transport component then the REST DSL automatically discovers which HTTP component to use by checking for available components on the classpath. The REST DSL looks for the default names of any HTTP components and uses the first one it finds. If there are no HTTP components on the classpath and you did not explicitly configure an HTTP transport then the default HTTP component is camel-http . Specifying the content type of requests and responses You can filter the content type of HTTP requests and responses using the consumes() and produces() options in Java, or the consumes and produces attributes in XML. For example, some common content types (officially known as Internet media types ) are the following: text/plain text/html text/xml application/json application/xml The content type is specified as an option on a verb clause in the REST DSL. For example, to restrict a verb clause to accept only text/plain HTTP requests, and to send only text/html HTTP responses, you would use Java code like the following: And in XML, you can set the consumes and produces attributes, as follows: You can also specify the argument to consumes() or produces() as a comma-separated list. For example, consumes("text/plain, application/json") . Additional HTTP methods Some HTTP server implementations support additional HTTP methods, which are not provided by the standard set of verbs in the REST DSL, get() , head() , put() , post() , delete() , patch() . To access additional HTTP methods, you can use the generic keyword, verb() , in Java DSL and the generic element, verb , in XML DSL. For example, to implement the TRACE HTTP method in Java: Where transform() copies the body of the IN message to the body of the OUT message, thus echoing the HTTP request. To implement the TRACE HTTP method in XML: Defining custom HTTP error messages If your REST service needs to send an error message as its response, you can define a custom HTTP error message as follows: Specify the HTTP error code by setting the Exchange.HTTP_RESPONSE_CODE header key to the error code value (for example, 400 , 404 , and so on). This setting indicates to the REST DSL that you want to send an error message reply, instead of a regular response. Populate the message body with your custom error message. Set the Content-Type header, if required. If your REST service is configured to marshal to and from Java objects (that is, bindingMode is enabled), you should ensure that the skipBindingOnErrorCode option is enabled (which it is, by default). This is to ensure that the REST DSL does not attempt to unmarshal the message body when sending the response. For more details about object binding, see Section 4.3, "Marshalling to and from Java Objects" . The following Java example shows how to define a custom error message: In this example, if the input ID is a number less than 100, we return a custom error message, using the UserErrorService bean, which is implemented as follows: In the UserErrorService bean we define the custom error message and set the HTTP error code to 400 . Parameter Default Values Default values can be specified for the headers of an incoming Camel message. You can specify a default value by using a key word such as verbose on the query parameter. For example, in the code below, the default value is false . This means that if no other value is provided for a header with the verbose key, false will be inserted as a default. Wrapping a JsonParserException in a custom HTTP error message A common case where you might want to return a custom error message is in order to wrap a JsonParserException exception. For example, you can conveniently exploit the Camel exception handling mechanism to create a custom HTTP error message, with HTTP error code 400, as follows: REST DSL options In general, REST DSL options can be applied either directly to the base part of the service definition (that is, immediately following rest() ), as follows: In which case the specified options apply to all of the subordinate verb clauses. Or the options can be applied to each individual verb clause, as follows: In which case the specified options apply only to the relevant verb clause, overriding any settings from the base part. Table 4.1, "REST DSL Options" summarizes the options supported by the REST DSL. Table 4.1. REST DSL Options Java DSL XML DSL Description bindingMode() @bindingMode Specifies the binding mode, which can be used to marshal incoming messages to Java objects (and, optionally, unmarshal Java objects to outgoing messages). Can have the following values: off (default), auto , json , xml , json_xml . consumes() @consumes Restricts the verb clause to accept only the specified Internet media type (MIME type) in a HTTP Request. Typical values are: text/plain , text/http , text/xml , application/json , application/xml . customId() @customId Defines a custom ID for JMX management. description() description Document the REST service or verb clause. Useful for JMX management and tooling. enableCORS() @enableCORS If true , enables CORS (cross-origin resource sharing) headers in the HTTP response. Default is false . id() @id Defines a unique ID for the REST service, which is useful to define for JMX management and other tooling. method() @method Specifies the HTTP method processed by this verb clause. Usually used in conjunction with the generic verb() keyword. outType() @outType When object binding is enabled (that is, when bindingMode option is enabled), this option specifies the Java type that represents a HTTP Response message. produces() produces Restricts the verb clause to produce only the specified Internet media type (MIME type) in a HTTP Response. Typical values are: text/plain , text/http , text/xml , application/json , application/xml . type() @type When object binding is enabled (that is, when bindingMode option is enabled), this option specifies the Java type that represents a HTTP Request message. VerbURIArgument @uri Specifies a path segment or URI template as an argument to a verb. For example, get( VerbURIArgument ) . BasePathArgument @path Specifies the base path in the rest() keyword (Java DSL) or in the rest element (XML DSL). 4.3. Marshalling to and from Java Objects Marshalling Java objects for transmission over HTTP One of the most common ways to use the REST protocol is to transmit the contents of a Java bean in the message body. In order for this to work, you need to have a mechanism for marshalling the Java object to and from a suitable data format. The following data formats, which are suitable for encoding Java objects, are supported by the REST DSL: JSON JSON (JavaScript object notation) is a lightweight data format that can easily be mapped to and from Java objects. The JSON syntax is compact, lightly typed, and easy for humans to read and write. For all of these reasons, JSON has become popular as a message format for REST services. For example, the following JSON code could represent a User bean with two property fields, id and name : JAXB JAXB (Java Architecture for XML Binding) is an XML-based data format that can easily be mapped to and from Java objects. In order to marshal the XML to a Java object, you must also annotate the Java class that you want to use. For example, the following JAXB code could represent a User bean with two property fields, id and name : Note From Camel 2.17.0, JAXB data format and type converter supports the conversion from XML to POJO for classes, that use ObjectFactory instead of XmlRootElement . Also, the camel context should include the CamelJaxbObjectFactory property with value true. However, due to optimization the default value is false. Integration of JSON and JAXB with the REST DSL You could, of course, write the required code to convert the message body to and from a Java object yourself. But the REST DSL offers the convenience of performing this conversion automatically. In particular, the integration of JSON and JAXB with the REST DSL offers the following advantages: Marshalling to and from Java objects is performed automatically (given the appropriate configuration). The REST DSL can automatically detect the data format (either JSON or JAXB) and perform the appropriate conversion. The REST DSL provides an abstraction layer , so that the code you write is not specific to a particular JSON or JAXB implementation. So you can switch the implementation later on, with minimum impact to your application code. Supported data format components Apache Camel provides a number of different implementations of the JSON and JAXB data formats. The following data formats are currently supported by the REST DSL: JSON Jackson data format ( camel-jackson ) (default) GSon data format ( camel-gson ) XStream data format ( camel-xstream ) JAXB JAXB data format ( camel-jaxb ) How to enable object marshalling To enable object marshalling in the REST DSL, observe the following points: Enable binding mode, by setting the bindingMode option (there are several levels at which you can set the binding mode - for details, see the section called "Configuring the binding mode" ). Specify the Java type to convert to (or from), on the incoming message with the type option (required), and on the outgoing message with the outType option (optional). If you want to convert your Java object to and from the JAXB data format, you must remember to annotate the Java class with the appropriate JAXB annotations. Specify the underlying data format implementation (or implementations), using the jsonDataFormat option and/or the xmlDataFormat option (which can be specified on the restConfiguration builder). If your route provides a return value in JAXB format, you are normally expected to set the Out message of the exchange body to be an instance of a class with JAXB annotations (a JAXB element). If you prefer to provide the JAXB return value directly in XML format, however, set the dataFormatProperty with the key, xml.out.mustBeJAXBElement , to false (which can be specified on the restConfiguration builder). For example, in the XML DSL syntax: Add the required dependencies to your project build file. For example, if you are using the Maven build system and you are using the Jackson data format, you would add the following dependency to your Maven POM file: When deploying your application to the OSGi container, remember to install the requisite feature for your chosen data format. For example, if you are using the Jackson data format (the default), you would install the camel-jackson feature, by entering the following Karaf console command: Alternatively, if you are deploying into a Fabric environment, you would add the feature to a Fabric profile. For example, if you are using the profile, MyRestProfile , you could add the feature by entering the following console command: Configuring the binding mode The bindingMode option is off by default, so you must configure it explicitly, in order to enable marshalling of Java objects. TABLE shows the list of supported binding modes. Note From Camel 2.16.3 onwards the binding from POJO to JSon/JAXB will only happen if the content-type header includes json or xml . This allows you to specify a custom content-type if the message body should not attempt to be marshalled using the binding. This is useful if, for example, the message body is a custom binary payload. Table 4.2. REST DSL BInding Modes Binding Mode Description off Binding is turned off (default) . auto Binding is enabled for JSON and/or XML. In this mode, Camel auto-selects either JSON or XML (JAXB), based on the format of the incoming message. You are not required to enable both kinds of data format, however: either a JSON implementation, an XML implementation, or both can be provided on the classpath. json Binding is enabled for JSON only. A JSON implementation must be provided on the classpath (by default, Camel tries to enable the camel-jackson implementation). xml Binding is enabled for XML only. An XML implementation must be provided on the classpath (by default, Camel tries to enable the camel-jaxb implementation). json_xml Binding is enabled for both JSON and XML. In this mode, Camel auto-selects either JSON or XML (JAXB), based on the format of the incoming message. You are required to provide both kinds of data format on the classpath. In Java, these binding mode values are represented as instances of the following enum type: There are several different levels at which you can set the bindingMode , as follows: REST DSL configuration You can set the bindingMode option from the restConfiguration builder, as follows: Service definition base part You can set the bindingMode option immediately following the rest() keyword (before the verb clauses), as follows: Verb clause You can set the bindingMode option in a verb clause, as follows: Example For a complete code example, showing how to use the REST DSL, using the Servlet component as the REST implementation, take a look at the Apache Camel camel-example-servlet-rest-blueprint example. You can find this example by installing the standalone Apache Camel distribution, apache-camel-2.23.2.fuse-7_13_0-00013-redhat-00001.zip , which is provided in the extras/ subdirectory of your Fuse installation. After installing the standalone Apache Camel distribution, you can find the example code under the following directory: Configure the Servlet component as the REST implementation In the camel-example-servlet-rest-blueprint example, the underlying implementation of the REST DSL is provided by the Servlet component. The Servlet component is configured in the Blueprint XML file, as shown in Example 4.1, "Configure Servlet Component for REST DSL" . Example 4.1. Configure Servlet Component for REST DSL To configure the Servlet component with REST DSL, you need to configure a stack consisting of the following three layers: REST DSL layer The REST DSL layer is configured by the restConfiguration element, which integrates with the Servlet component by setting the component attribute to the value, servlet . Servlet component layer The Servlet component layer is implemented as an instance of the class, CamelHttpTransportServlet , where the example instance has the bean ID, camelServlet . HTTP container layer The Servlet component must be deployed into a HTTP container. The Karaf container is normally configured with a default HTTP container (a Jetty HTTP container), which listens for HTTP requests on the port, 8181. To deploy the Servlet component to the default Jetty container, you need to do the following: Get an OSGi reference to the org.osgi.service.http.HttpService OSGi service, where this service is a standardised OSGi interface that provides access to the default HTTP server in OSGi. Create an instance of the utility class, OsgiServletRegisterer , to register the Servlet component in the HTTP container. The OsgiServletRegisterer class is a utility that simplifies managing the lifecycle of the Servlet component. When an instance of this class is created, it automatically calls the registerServlet method on the HttpService OSGi service; and when the instance is destroyed, it automatically calls the unregister method. Required dependencies This example has two dependencies which are of key importance to the REST DSL, as follows: Servlet component Provides the underlying implementation of the REST DSL. This is specified in the Maven POM file, as follows: And before you deploy the application bundle to the OSGi container, you must install the Servlet component feature, as follows: Jackson data format Provides the JSON data format implementation. This is specified in the Maven POM file, as follows: And before you deploy the application bundle to the OSGi container, you must install the Jackson data format feature, as follows: Java type for responses The example application passes User type objects back and forth in HTTP Request and Response messages. The User Java class is defined as shown in Example 4.2, "User Class for JSON Response" . Example 4.2. User Class for JSON Response The User class has a relatively simple representation in the JSON data format. For example, a typical instance of this class expressed in JSON format is: Sample REST DSL route with JSON binding The REST DSL configuration and the REST service definition for this example are shown in Example 4.3, "REST DSL Route with JSON Binding" . Example 4.3. REST DSL Route with JSON Binding REST operations The REST service from Example 4.3, "REST DSL Route with JSON Binding" defines the following REST operations: GET /camel-example-servlet-rest-blueprint/rest/user/{id} Get the details for the user identified by {id} , where the HTTP response is returned in JSON format. PUT /camel-example-servlet-rest-blueprint/rest/user Create a new user, where the user details are contained in the body of the PUT message, encoded in JSON format (to match the User object type). GET /camel-example-servlet-rest-blueprint/rest/user/findAll Get the details for all users, where the HTTP response is returned as an array of users, in JSON format. URLs to invoke the REST service By inspecting the REST DSL definitions from Example 4.3, "REST DSL Route with JSON Binding" , you can piece together the URLs required to invoke each of the REST operations. For example, to invoke the first REST operation, which returns details of a user with a given ID, the URL is built up as follows: http://localhost:8181 In restConfiguration , the protocol defaults to http and the port is set explicitly to 8181 . /camel-example-servlet-rest-blueprint/rest Specified by the contextPath attribute of the restConfiguration element. /user Specified by the path attribute of the rest element. /{id} Specified by the uri attribute of the get verb element. Hence, it is possible to invoke this REST operation with the curl utility, by entering the following command at the command line: Similarly, the remaining REST operations could be invoked with curl , by entering the following sample commands: 4.4. Configuring the REST DSL Configuring with Java In Java, you can configure the REST DSL using the restConfiguration() builder API. For example, to configure the REST DSL to use the Servlet component as the underlying implementation: Configuring with XML In XML, you can configure the REST DSL using the restConfiguration element. For example, to configure the REST DSL to use the Servlet component as the underlying implementation: Configuration options Table 4.3, "Options for Configuring REST DSL" shows options for configuring the REST DSL using the restConfiguration() builder (Java DSL) or the restConfiguration element (XML DSL). Table 4.3. Options for Configuring REST DSL Java DSL XML DSL Description component() @component Specifies the Camel component to use as the REST transport (for example, servlet , restlet , spark-rest , and so on). The value can either be the standard component name or the bean ID of a custom instance. If this option is not specified, Camel looks for an instance of RestConsumerFactory on the classpath or in the bean registry. scheme() @scheme The protocol to use for exposing the REST service. Depends on the underlying REST implementation, but http and https are usually supported. Default is http . host() @host The hostname to use for exposing the REST service. port() @port The port number to use for exposing the REST service. Note: This setting is ignored by the Servlet component, which uses the container's standard HTTP port instead. In the case of the Apache Karaf OSGi container, the standard HTTP port is normally 8181. It is good practice to set the port value nonetheless, for the sake of JMX and tooling. contextPath() @contextPath Sets a leading context path for the REST services. This can be used with components such as Servlet, where the deployed Web application is deployed using a context-path setting. hostNameResolver() @hostNameResolver If a hostname is not set explicitly, this resolver determines the host for the REST service. Possible values are RestHostNameResolver.localHostName (Java DSL) or localHostName (XML DSL), which resolves to the host name format; and RestHostNameResolver.localIp (Java DSL) or localIp (XML DSL), which resolves to the dotted decimal IP address format. From Camel 2.17 RestHostNameResolver.allLocalIp can be used to resolve to all local IP addresses. The default is localHostName up to Camel 2.16. From Camel 2.17 the default is allLocalIp . bindingMode() @bindingMode Enables binding mode for JSON or XML format messages. Possible values are: off , auto , json , xml , or json_xml . Default is off . skipBindingOnErrorCode() @skipBindingOnErrorCode Specifies whether to skip binding on output, if there is a custom HTTP error code header. This allows you to build custom error messages that do not bind to JSON or XML, as successful messages would otherwise do. Default is true . enableCORS() @enableCORS If true , enables CORS (cross-origin resource sharing) headers in the HTTP response. Default is false . jsonDataFormat() @jsonDataFormat Specifies the component that Camel uses to implement the JSON data format. Possible values are: json-jackson , json-gson , json-xstream . Default is json-jackson . xmlDataFormat() @xmlDataFormat Specifies the component that Camel uses to implement the XML data format. Possible value is: jaxb . Default is jaxb . componentProperty() componentProperty Enables you to set arbitrary component level properties on the underlying REST implementation. endpointProperty() endpointProperty Enables you to set arbitrary endpoint level properties on the underlying REST implementation. consumerProperty() consumerProperty Enables you to set arbitrary consumer endpoint properties on the underlying REST implementation. dataFormatProperty() dataFormatProperty Enables you to set arbitrary properties on the underlying data format component (for example, Jackson or JAXB). From Camel 2.14.1 onwards, you can attach the following prefixes to the property keys: json.in json.out xml.in xml.out To restrict the property setting to a specific format type (JSON or XML) and a particular message direction ( IN or OUT ). corsHeaderProperty() corsHeaders Enables you to specify custom CORS headers, as key/value pairs. Default CORS headers If CORS (cross-origin resource sharing) is enabled, the following headers are set by default. You can optionally override the default settings, by invoking the corsHeaderProperty DSL command. Table 4.4. Default CORS Headers Header Key Header Value Access-Control-Allow-Origin \* Access-Control-Allow-Methods GET , HEAD , POST , PUT , DELETE , TRACE , OPTIONS , CONNECT , PATCH Access-Control-Allow-Headers Origin , Accept , X-Requested-With , Content-Type , Access-Control-Request-Method , Access-Control-Request-Headers Access-Control-Max-Age 3600 Enabling or disabling Jackson JSON features You can enable or disable specific Jackson JSON features by configuring the following keys in the dataFormatProperty option: json.in.disableFeatures json.in.enableFeatures For example, to disable Jackson's FAIL_ON_UNKNOWN_PROPERTIES feature (which causes Jackson to fail if a JSON input has a property that cannot be mapped to a Java object): You can disable multiple features by specifying a comma-separated list. For example: Here is an example that shows how to disable and enable Jackson JSON features in the Java DSL: Here is an example that shows how to disable and enable Jackson JSON features in the XML DSL: The Jackson features that can be disabled or enabled correspond to the enum IDs from the following Jackson classes com.fasterxml.jackson.databind.SerializationFeature com.fasterxml.jackson.databind.DeserializationFeature com.fasterxml.jackson.databind.MapperFeature 4.5. OpenAPI Integration Overview You can use a OpenAPI service to create API documentation for any REST-defined routes and endpoints in a CamelContext file. To do this, use the Camel REST DSL with the camel-openapi-java module, which is purely Java-based. The camel-openapi-java module creates a servlet that is integrated with the CamelContext and that pulls the information from each REST endpoint to generate the API documentation in JSON or YAML format. If you use Maven then edit your pom.xml file to add a dependency on the camel-openapi-java component: Configuring a CamelContext to enable OpenAPI To enable the use of the OpenAPI in the Camel REST DSL, invoke apiContextPath() to set the context path for the OpenAPI-generated API documentation. For example: OpenAPI module configuration options The options described in the table below let you configure the OpenAPI module. Set an option as follows: If you are using the camel-openapi-java module as a servlet, set an option by updating the web.xml file and specifying an init-param element for each configuration option you want to set. If you are using the camel-openapi-java module from Camel REST components, set an option by invoking the appropriate RestConfigurationDefinition method, such as enableCORS() , host() , or contextPath() . Set the api.xxx options with the RestConfigurationDefinition.apiProperty() method. Option Type Description api.contact.email String Email address to be used for API-related correspondence. api.contact.name String Name of person or organization to contact. api.contact.url String URL to a website for more contact information. apiContextIdListing Boolean If your application uses more than one CamelContext object, the default behavior is to list the REST endpoints in only the current CamelContext . If you want a list of the REST endpoints in each CamelContext that is running in the JVM that is running the REST service then set this option to true. When apiContextIdListing is true then OpenAPI outputs the CamelContext IDs in the root path, for example, /api-docs , as a list of names in JSON format. To access the OpenAPI-generated documentation, append the REST context path to the CamelContext ID, for example, api-docs/myCamel . You can use the apiContextIdPattern option to filter the names in this output list. apiContextIdPattern String Pattern that filters which CamelContext IDs appear in the context listing. You can specify regular expressions and use * as a wildcard. This is the same pattern matching facility as used by the Camel Intercept feature. api.license.name String License name used for the API. api.license.url String URL to the license used for the API. api.path String Sets the path where the REST API to generate documentation for is available, for example, /api-docs . Specify a relative path. Do not specify, for example, http or https . The camel-openapi-java module calculates the absolute path at runtime in this format: protocol://host:port/context-path/api-path . api.termsOfService String URL to the terms of service of the API. api.title String Title of the application. api.version String Version of the API. The default is 0.0.0. base.path String Required. Sets the path where the REST services are available. Specify a relative path. That is, do not specify, for example, http or https . The camel-openapi-java modul calculates the absolute path at runtime in this format: protocol://host:port/context-path/base.path . cors Boolean Whether to enable HTTP Access Control (CORS). This enable CORS only for viewing the REST API documentation, and not for access to the REST service. The default is false. The recommendation is to use the CorsFilter option instead, as described after this table. host String Set the name of the host that the OpenAPI service is running on. The default is to calculate the host name based on localhost . schemes String Protocol schemes to use. Separate multiple values with a comma, for example, "http,https". The default is http . opeapi.version String OpenAPI specification version. The default is 3.0. Obtaining JSON or YAML output Starting with Camel 3.1, the camel-openapi-java module supports both JSON and YAML formatted output. To specify the output you want, add /openapi.json or /openapi.yaml to the request URL. If a request URL does not specify a format then the camel-openapi-java module inspects the HTTP Accept header to detect whether JSON or YAML can be accepted. If both are accepted or if none was set as accepted then JSON is the default return format. Examples In the Apache Camel 3.x distribution, camel-example-openapi-cdi and camel-example-openapi-java demonstrate the use of the camel-openapi-java module. In the Apache Camel 2.x distribution, camel-example-swagger-cdi and camel-example-swagger-java demonstrate the use of the camel-swagger-java module. Enhancing documentation generated by OpenAPI Starting with Camel 3.1, you can enhance the documentation generated by OpenAPI by defining parameter details such as name, description, data type, parameter type and so on. If you are using XML, specify the param element to add this information. The following example shows how to provide information about the ID path parameter: Following is the same example in Java DSL: If you define a parameter whose name is body then you must also specify body as the type of that parameter. For example: Following is the same example in Java DSL: See also: examples/camel-example-servlet-rest-tomcat in the Apache Camel distribution.	[ "http://localhost:9091/say/hello/Garp", "Hello Garp", "rest(\"/say\") .get(\"/hello/{name}\").route().transform().simple(\"Hello USD{header.name}\");", "from(\"rest:get:say:/hello/{name}\").transform().simple(\"Hello USD{header.name}\");", "from(\"spark-rest:get:/say/hello/:name\").transform().simple(\"Hello USD{header.name}\");", "from(\"restlet:http://0.0.0.0:9091/say/hello/{name}?restletMethod=get\") .transform().simple(\"Hello USD{header.name}\");", "restConfiguration().component(\"spark-rest\").port(9091);", "<restConfiguration component=\"spark-rest\" port=\"9091\"/>", "rest(\" BasePath \"). Option (). . Verb (\" Path \"). Option ().[to() \| route(). CamelRoute .endRest()] . Verb (\" Path \"). Option ().[to() \| route(). CamelRoute .endRest()] . Verb (\" Path \"). Option ().[to() \| route(). CamelRoute ];", "get(\"...\"). Option ()+.to(\"...\")", "get(\"...\"). Option ()+.route(\"...\"). CamelRoute .endRest()", "restConfiguration().component(\"spark-rest\").port(9091); rest(\"/say\") .get(\"/hello\").to(\"direct:hello\") .get(\"/bye\").to(\"direct:bye\"); from(\"direct:hello\") .transform().constant(\"Hello World\"); from(\"direct:bye\") .transform().constant(\"Bye World\");", "<camelContext xmlns=\"http://camel.apache.org/schema/blueprint\"> <restConfiguration component=\"spark-rest\" port=\"9091\"/> <rest path=\"/say\"> <get uri=\"/hello\"> <to uri=\"direct:hello\"/> </get> <get uri=\"/bye\"> <to uri=\"direct:bye\"/> </get> </rest> <route> <from uri=\"direct:hello\"/> <transform> <constant>Hello World</constant> </transform> </route> <route> <from uri=\"direct:bye\"/> <transform> <constant>Bye World</constant> </transform> </route> </camelContext>", "rest(\" /say \") .get(\"/hello\").to(\"direct:hello\") .get(\"/bye\").to(\"direct:bye\");", "<rest path=\" /say \"> <get uri=\"/hello\"> <to uri=\"direct:hello\"/> </get> <get uri=\"/bye\" consumes=\"application/json\"> <to uri=\"direct:bye\"/> </get> </rest>", "/say/hello /say/bye", "rest() .get(\" /say/hello \").to(\"direct:hello\") .get(\" /say/bye \").to(\"direct:bye\");", "public void configure() throws Exception { rest(\"/say\") .get(\"/hello/{language}\").toD(\"jms:queue:hello-USD{header.language}\"); }", "<rest uri=\"/say\"> <get uri=\"/hello//{language}\"> <toD uri=\"jms:queue:hello-USD{header.language}\"/> </get> <rest>", "rest(\"/say\") .get(\"/hello/{name}\").to(\"direct:hello\") .get(\"/bye/{name}\").to(\"direct:bye\"); from(\"direct:hello\") .transform().simple(\"Hello USD{header.name}\"); from(\"direct:bye\") .transform().simple(\"Bye USD{header.name}\");", "RESTVerbClause .route(\"...\"). CamelRoute .endRest()", "rest(\"/say\") .get(\"/hello\").route().transform().constant(\"Hello World\").endRest() .get(\"/bye\").route().transform().constant(\"Bye World\");", "<camelContext xmlns=\"http://camel.apache.org/schema/blueprint\"> <rest path=\"/say\"> <get uri=\"/hello\"> <route> <transform> <constant>Hello World</constant> </transform> </route> </get> <get uri=\"/bye\"> <route> <transform> <constant>Bye World</constant> </transform> </route> </get> </rest> </camelContext>", "rest(\"/email\") .post(\"/to/{recipient}\").consumes(\"text/plain\").produces(\"text/html\").to(\"direct:foo\");", "<camelContext xmlns=\"http://camel.apache.org/schema/blueprint\"> <rest path=\"/email\"> <post uri=\"/to/{recipient}\" consumes=\"text/plain\" produces=\"text/html\"> <to \"direct:foo\"/> </get> </rest> </camelContext>", "rest(\"/say\") .verb(\"TRACE\", \"/hello\").route().transform();", "<camelContext xmlns=\"http://camel.apache.org/schema/blueprint\"> <rest path=\"/say\"> <verb uri=\"/hello\" method=\"TRACE\"> <route> <transform/> </route> </get> </camelContext>", "// Java // Configure the REST DSL, with JSON binding mode restConfiguration().component(\"restlet\").host(\"localhost\").port(portNum).bindingMode(RestBindingMode.json); // Define the service with REST DSL rest(\"/users/\") .post(\"lives\").type(UserPojo.class).outType(CountryPojo.class) .route() .choice() .when().simple(\"USD{body.id} < 100\") .bean(new UserErrorService(), \"idTooLowError\") .otherwise() .bean(new UserService(), \"livesWhere\");", "// Java public class UserErrorService { public void idTooLowError(Exchange exchange) { exchange.getIn().setBody(\"id value is too low\"); exchange.getIn().setHeader(Exchange.CONTENT_TYPE, \"text/plain\"); exchange.getIn().setHeader(Exchange.HTTP_RESPONSE_CODE, 400); } }", "rest(\"/customers/\") .get(\"/{id}\").to(\"direct:customerDetail\") .get(\"/{id}/orders\") .param() .name(\"verbose\") .type(RestParamType.query) .defaultValue(\"false\") .description(\"Verbose order details\") .endParam() .to(\"direct:customerOrders\") .post(\"/neworder\").to(\"direct:customerNewOrder\");", "// Java onException(JsonParseException.class) .handled(true) .setHeader(Exchange.HTTP_RESPONSE_CODE, constant(400)) .setHeader(Exchange.CONTENT_TYPE, constant(\"text/plain\")) .setBody().constant(\"Invalid json data\");", "rest(\"/email\"). consumes(\"text/plain\").produces(\"text/html\") .post(\"/to/{recipient}\").to(\"direct:foo\") .get(\"/for/{username}\").to(\"direct:bar\");", "rest(\"/email\") .post(\"/to/{recipient}\"). consumes(\"text/plain\").produces(\"text/html\") .to(\"direct:foo\") .get(\"/for/{username}\"). consumes(\"text/plain\").produces(\"text/html\") .to(\"direct:bar\");", "{ \"id\" : 1234, \"name\" : \"Jane Doe\" }", "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?> <User> <Id>1234</Id> <Name>Jane Doe</Name> </User>", "<restConfiguration ...> <dataFormatProperty key=\"xml.out.mustBeJAXBElement\" value=\"false\"/> </restConfiguration>", "<?xml version=\"1.0\" encoding=\"UTF-8\"?> <project ...> <dependencies> <!-- use for json binding --> <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-jackson</artifactId> </dependency> </dependencies> </project>", "JBossFuse:karaf@root> features:install camel-jackson", "JBossFuse:karaf@root> fabric:profile-edit --features camel-jackson MyRestProfile", "org.apache.camel.model.rest.RestBindingMode", "restConfiguration().component(\"servlet\").port(8181). bindingMode(RestBindingMode.json) ;", "rest(\"/user\"). bindingMode(RestBindingMode.json) .get(\"/{id}\"). VerbClause", "rest(\"/user\") .get(\"/{id}\"). bindingMode(RestBindingMode.json) .to(\"...\");", "ApacheCamelInstallDir /examples/camel-example-servlet-rest-blueprint", "<?xml version=\"1.0\" encoding=\"UTF-8\"?> <blueprint ...> <!-- to setup camel servlet with OSGi HttpService --> <reference id=\"httpService\" interface=\"org.osgi.service.http.HttpService\"/> <bean class=\"org.apache.camel.component.servlet.osgi.OsgiServletRegisterer\" init-method=\"register\" destroy-method=\"unregister\"> <property name=\"alias\" value=\"/camel-example-servlet-rest-blueprint/rest\"/> <property name=\"httpService\" ref=\"httpService\"/> <property name=\"servlet\" ref=\"camelServlet\"/> </bean> <bean id=\"camelServlet\" class=\"org.apache.camel.component.servlet.CamelHttpTransportServlet\"/> <camelContext xmlns=\"http://camel.apache.org/schema/blueprint\"> <restConfiguration component=\"servlet\" bindingMode=\"json\" contextPath=\"/camel-example-servlet-rest-blueprint/rest\" port=\"8181\"> <dataFormatProperty key=\"prettyPrint\" value=\"true\"/> </restConfiguration> </camelContext> </blueprint>", "<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-servlet</artifactId> <version>USD{camel-version}</version> </dependency>", "JBossFuse:karaf@root> features:install camel-servlet", "<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-jackson</artifactId> <version>USD{camel-version}</version> </dependency>", "JBossFuse:karaf@root> features:install camel-jackson", "// Java package org.apache.camel.example.rest; public class User { private int id; private String name; public User() { } public User(int id, String name) { this.id = id; this.name = name; } public int getId() { return id; } public void setId(int id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } }", "{ \"id\" : 1234, \"name\" : \"Jane Doe\" }", "<?xml version=\"1.0\" encoding=\"UTF-8\"?> <blueprint xmlns=\"http://www.osgi.org/xmlns/blueprint/v1.0.0\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" ...> <!-- a bean for user services --> <bean id=\"userService\" class=\"org.apache.camel.example.rest.UserService\"/> <camelContext xmlns=\"http://camel.apache.org/schema/blueprint\"> <restConfiguration component=\"servlet\" bindingMode=\"json\" contextPath=\"/camel-example-servlet-rest-blueprint/rest\" port=\"8181\"> <dataFormatProperty key=\"prettyPrint\" value=\"true\"/> </restConfiguration> <!-- defines the REST services using the base path, /user --> <rest path=\"/user\" consumes=\"application/json\" produces=\"application/json\"> <description>User rest service</description> <!-- this is a rest GET to view a user with the given id --> <get uri=\"/{id}\" outType=\"org.apache.camel.example.rest.User\"> <description>Find user by id</description> <to uri=\"bean:userService?method=getUser(USD{header.id})\"/> </get> <!-- this is a rest PUT to create/update a user --> <put type=\"org.apache.camel.example.rest.User\"> <description>Updates or create a user</description> <to uri=\"bean:userService?method=updateUser\"/> </put> <!-- this is a rest GET to find all users --> <get uri=\"/findAll\" outType=\"org.apache.camel.example.rest.User[]\"> <description>Find all users</description> <to uri=\"bean:userService?method=listUsers\"/> </get> </rest> </camelContext> </blueprint>", "curl -X GET -H \"Accept: application/json\" http://localhost:8181/camel-example-servlet-rest-blueprint/rest/user/123", "curl -X GET -H \"Accept: application/json\" http://localhost:8181/camel-example-servlet-rest-blueprint/rest/user/findAll curl -X PUT -d \"{ \\\"id\\\": 666, \\\"name\\\": \\\"The devil\\\"}\" -H \"Accept: application/json\" http://localhost:8181/camel-example-servlet-rest-blueprint/rest/user", "restConfiguration().component(\"servlet\").bindingMode(\"json\").port(\"8181\") .contextPath(\"/camel-example-servlet-rest-blueprint/rest\");", "<?xml version=\"1.0\" encoding=\"UTF-8\"?> <blueprint ...> <camelContext xmlns=\"http://camel.apache.org/schema/blueprint\"> <restConfiguration component=\"servlet\" bindingMode=\"json\" contextPath=\"/camel-example-servlet-rest-blueprint/rest\" port=\"8181\"> <dataFormatProperty key=\"prettyPrint\" value=\"true\"/> </restConfiguration> </camelContext> </blueprint>", "restConfiguration().component(\"jetty\") .host(\"localhost\").port(getPort()) .bindingMode(RestBindingMode.json) .dataFormatProperty(\"json.in.disableFeatures\", \"FAIL_ON_UNKNOWN_PROPERTIES\");", ".dataFormatProperty(\"json.in.disableFeatures\", \"FAIL_ON_UNKNOWN_PROPERTIES,ADJUST_DATES_TO_CONTEXT_TIME_ZONE\");", "restConfiguration().component(\"jetty\") .host(\"localhost\").port(getPort()) .bindingMode(RestBindingMode.json) .dataFormatProperty(\"json.in.disableFeatures\", \"FAIL_ON_UNKNOWN_PROPERTIES,ADJUST_DATES_TO_CONTEXT_TIME_ZONE\") .dataFormatProperty(\"json.in.enableFeatures\", \"FAIL_ON_NUMBERS_FOR_ENUMS,USE_BIG_DECIMAL_FOR_FLOATS\");", "<restConfiguration component=\"jetty\" host=\"localhost\" port=\"9090\" bindingMode=\"json\"> <dataFormatProperty key=\"json.in.disableFeatures\" value=\"FAIL_ON_UNKNOWN_PROPERTIES,ADJUST_DATES_TO_CONTEXT_TIME_ZONE\"/> <dataFormatProperty key=\"json.in.enableFeatures\" value=\"FAIL_ON_NUMBERS_FOR_ENUMS,USE_BIG_DECIMAL_FOR_FLOATS\"/> </restConfiguration>", "<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-openapi-java</artifactId> <version>x.x.x</version> <!-- Specify the version of your camel-core module. --> </dependency>", "public class UserRouteBuilder extends RouteBuilder { @Override public void configure() throws Exception { // Configure the Camel REST DSL to use the netty4-http component: restConfiguration().component(\"netty4-http\").bindingMode(RestBindingMode.json) // Generate pretty print output: .dataFormatProperty(\"prettyPrint\", \"true\") // Set the context path and port number that netty will use: .contextPath(\"/\").port(8080) // Add the context path for the OpenAPI-generated API documentation: .apiContextPath(\"/api-doc\") .apiProperty(\"api.title\", \"User API\").apiProperty(\"api.version\", \"1.2.3\") // Enable CORS: .apiProperty(\"cors\", \"true\"); // This user REST service handles only JSON files: rest(\"/user\").description(\"User rest service\") .consumes(\"application/json\").produces(\"application/json\") .get(\"/{id}\").description(\"Find user by id\").outType(User.class) .param().name(\"id\").type(path).description(\"The id of the user to get\").dataType(\"int\").endParam() .to(\"bean:userService?method=getUser(USD{header.id})\") .put().description(\"Updates or create a user\").type(User.class) .param().name(\"body\").type(body).description(\"The user to update or create\").endParam() .to(\"bean:userService?method=updateUser\") .get(\"/findAll\").description(\"Find all users\").outTypeList(User.class) .to(\"bean:userService?method=listUsers\"); } }", "<!-- This is a REST GET request to view information for the user with the given ID: --> <get uri=\"/{id}\" outType=\"org.apache.camel.example.rest.User\"> <description>Find user by ID.</description> <param name=\"id\" type=\"path\" description=\"The ID of the user to get information about.\" dataType=\"int\"/> <to uri=\"bean:userService?method=getUser(USD{header.id})\"/> </get>", ".get(\"/{id}\").description(\"Find user by ID.\").outType(User.class) .param().name(\"id\").type(path).description(\"The ID of the user to get information about.\").dataType(\"int\").endParam() .to(\"bean:userService?method=getUser(USD{header.id})\")", "<!-- This is a REST PUT request to create/update information about a user. --> <put type=\"org.apache.camel.example.rest.User\"> <description>Updates or creates a user.</description> <param name=\"body\" type=\"body\" description=\"The user to update or create.\"/> <to uri=\"bean:userService?method=updateUser\"/> </put>", ".put().description(\"Updates or create a user\").type(User.class) .param().name(\"body\").type(body).description(\"The user to update or create.\").endParam() .to(\"bean:userService?method=updateUser\")" ]	https://docs.redhat.com/en/documentation/red_hat_fuse/7.13/html/apache_camel_development_guide/restservices
Chapter 51. New Drivers	Chapter 51. New Drivers Storage Drivers USB Type-C Connector Class (typec.ko.xz): USB Type-C Connector System Software Interface driver (typec_ucsi.ko.xz): TCM QLA2XXX series NPIV enabled fabric driver (tcm_qla2xxx.ko.xz): Chelsio FCoE driver (csiostor.ko.xz): 1.0.0-ko Network Drivers Software simulator of 802.11 radio(s) for mac80211 (mac80211_hwsim.ko.xz): Vsock monitoring device. Based on nlmon device. (vsockmon.ko.xz): Cavium LiquidIO Intelligent Server Adapter Virtual Function Driver (liquidio_vf.ko.xz): 1.6.1 Cavium LiquidIO Intelligent Server Adapter Driver (liquidio.ko.xz): 1.6.1 Mellanox firmware flash lib (mlxfw.ko.xz): Intel OPA Virtual Network driver (opa_vnic.ko.xz): Broadcom NetXtreme-C/E RoCE Driver Driver (bnxt_re.ko.xz): VMware Paravirtual RDMA driver (vmw_pvrdma.ko.xz): Graphics Drivers and Miscellaneous Drivers MC Driver for Intel SoC using Pondicherry memory controller (pnd2_edac.ko.xz): ALPS HID driver (hid-alps.ko.xz): Intel Corporation DAX device (device_dax.ko.xz): Synopsys DesignWare DMA Controller platform driver (dw_dmac.ko.xz): Synopsys DesignWare DMA Controller core driver (dw_dmac_core.ko.xz); Intel Sunrisepoint PCH pinctrl/GPIO driver (pinctrl-sunrisepoint.ko.xz): Intel Lewisburg pinctrl/GPIO driver (pinctrl-lewisburg.ko.xz): Intel Cannon Lake PCH pinctrl/GPIO driver (pinctrl-cannonlake.ko.xz): Intel Denverton SoC pinctrl/GPIO driver (pinctrl-denverton.ko.xz): Intel Gemini Lake SoC pinctrl/GPIO driver (pinctrl-geminilake.ko.xz): Intel pinctrl/GPIO core driver (pinctrl-intel.ko.xz):	null	https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/7.5_release_notes/new_drivers
3.5. Storage	3.5. Storage Storage for virtual machines is abstracted from the physical storage allocated to the virtual machine. It is attached to the virtual machine using the paravirtualized or emulated block device drivers. 3.5.1. Storage Pools A storage pool is a file, directory, or storage device managed by libvirt for the purpose of providing storage to virtual machines. Storage pools are divided into storage volumes that store virtual machine images or are attached to virtual machines as additional storage. Multiple guests can share the same storage pool, allowing for better allocation of storage resources. For more information, see the Red Hat Enterprise Linux 7 Virtualization Deployment and Administration Guide . Local storage pools Local storage pools are attached directly to the host server. They include local directories, directly attached disks, physical partitions, and Logical Volume Management (LVM) volume groups on local devices. Local storage pools are useful for development, testing and small deployments that do not require migration or large numbers of virtual machines. Local storage pools may not be suitable for many production environment, because they do not support live migration. Networked (shared) storage pools Networked storage pools include storage devices shared over a network using standard protocols. Networked storage is required when migrating virtual machines between hosts with virt-manager , but is optional when migrating with virsh . Networked storage pools are managed by libvirt . 3.5.2. Storage Volumes Storage pools are divided into storage volumes . Storage volumes are an abstraction of physical partitions, LVM logical volumes, file-based disk images and other storage types handled by libvirt . Storage volumes are presented to virtual machines as local storage devices regardless of the underlying hardware. 3.5.3. Emulated Storage Devices Virtual machines can be presented with a range of storage devices that are emulated by the host. Each type of storage device is appropriate for specific use cases, allowing for maximum flexibility and compatibility with guest operating systems. virtio-scsi virtio-scsi is the recommended paravirtualized device for guests using large numbers of disks or advanced storage features such as TRIM. Guest driver installation may be necessary on guests using operating systems other than Red Hat Enterprise Linux 7. virtio-blk virtio-blk is a paravirtualized storage device suitable for exposing image files to guests. virtio-blk can provide the best disk I/O performance for virtual machines, but has fewer features than virtio-scsi. IDE IDE is recommended for legacy guests that do not support virtio drivers. IDE performance is lower than virtio-scsi or virtio-blk, but it is widely compatible with different systems. CD-ROM ATAPI CD-ROMs and virtio-scsi CD-ROMs are available and make it possible for guests to use ISO files or the host's CD-ROM drive. virtio-scsi CD-ROMs can be used with guests that have the virtio-scsi driver installed. ATAPI CD-ROMs offer wider compatibility but lower performance. USB mass storage devices and floppy disks Emulated USB mass storage devices and floppy disks are available when removable media are required. USB mass storage devices are preferable to floppy disks due to their larger capacity. 3.5.4. Host Storage Disk images can be stored on a range of local and remote storage technologies connected to the host. Image files Image files can only be stored on a host file system. The image files can be stored on a local file system, such as ext4 or xfs, or a network file system, such as NFS. Tools such as libguestfs can manage, back up, and monitor files. Disk image formats on KVM include: raw Raw image files contain the contents of the disk with no additional metadata. Raw files can either be pre-allocated or sparse, if the host file system allows it. Sparse files allocate host disk space on demand, and are therefore a form of thin provisioning. Pre-allocated files are fully provisioned but have higher performance than sparse files. Raw files are desirable when disk I/O performance is critical and transferring the image file over a network is rarely necessary. qcow2 qcow2 image files offer a number of advanced disk image features, including backing files, snapshots, compression, and encryption. They can be used to instantiate virtual machines from template images. qcow2 files are typically more efficient to transfer over a network, because only sectors written by the virtual machine are allocated in the image. Red Hat Enterprise Linux 7 supports the qcow2 version 3 image file format. LVM volumes Logical volumes (LVs) can be used for disk images and managed using the system's LVM tools. LVM offers higher performance than file systems because of its simpler block storage model. LVM thin provisioning offers snapshots and efficient space usage for LVM volumes, and can be used as an alternative to migrating to qcow2. Host devices Host devices such as physical CD-ROMs, raw disks, and logical unit numbers (LUNs) can be presented to the guest. This enables SAN or iSCSI LUNs as well as local CD-ROM media to be used by the guest with good performance. Host devices can be used when storage management is done on a SAN instead of on hosts. Distributed storage systems Gluster volumes can be used as disk images. This enables high-performance clustered storage over the network. Red Hat Enterprise Linux 7 includes native support for disk images on GlusterFS. This enables a KVM host to boot virtual machine images from GlusterFS volumes, and to use images from a GlusterFS volume as data disks for virtual machines. When compared to GlusterFS FUSE, the native support in KVM delivers higher performance. For more information on storage and virtualization, see the Managing Storage for Virtual Machines .	null	https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/virtualization_getting_started_guide/sec-Virtualization_Getting_Started-Products-Storage
Chapter 14. Understanding the node_replace_inventory.yml file	Chapter 14. Understanding the node_replace_inventory.yml file The node_replace_inventory.yml file is an example Ansible inventory file that you can use to prepare a replacement host for your Red Hat Hyperconverged Infrastructure for Virtualization cluster. You can find this file at /etc/ansible/roles/gluster.ansible/playbooks/hc-ansible-deployment/node_replace_inventory.yml on any hyperconverged host. 14.1. Configuration parameters for node replacement hosts (required) Defines one active host in the cluster using the back-end FQDN. gluster_maintenance_old_node (required) Defines the backend FQDN of the node being replaced. gluster_maintenance_new_node (required) Defines the backend FQDN of the replacement node. gluster_maintenance_cluster_node (required) An active node in the cluster. Cannot be the same as gluster_maintenance_cluster_node_2 . gluster_maintenance_cluster_node_2 (required) An active node in the cluster. Cannot be the same as gluster_maintenance_cluster_node . 14.2. Example node_replace_inventory.yml	[ "cluster_nodes: hosts: host2-backend-fqdn.example.com : vars: [common host configuration]", "cluster_nodes: hosts: host2-backend-fqdn.example.com : vars: gluster_maintenance_old_node: host1-backend-fqdn.example.com", "cluster_nodes: hosts: host2-backend-fqdn.example.com : vars: gluster_maintenance_new_node: new-host-backend-fqdn.example.com", "cluster_nodes: hosts: host2-backend-fqdn.example.com : vars: gluster_maintenance_cluster_node: host2-backend-fqdn.example.com", "cluster_nodes: hosts: host2-backend-fqdn.example.com : vars: gluster_maintenance_cluster_node_2: host3-backend-fqdn.example.com", "cluster_node: hosts: host2-backend-fqdn.example.com : vars: gluster_maintenance_old_node: host1-backend-fqdn.example.com gluster_maintenance_new_node: new-host-backend-fqdn.example.com gluster_maintenance_cluster_node: host2-backend-fqdn.example.com gluster_maintenance_cluster_node_2: host3-backend-fqdn.example.com" ]	https://docs.redhat.com/en/documentation/red_hat_hyperconverged_infrastructure_for_virtualization/1.8/html/maintaining_red_hat_hyperconverged_infrastructure_for_virtualization/understanding-the-node_replace_inventory-yml-file
Chapter 6. Enabling monitoring for user-defined projects	Chapter 6. Enabling monitoring for user-defined projects In OpenShift Container Platform, you can enable monitoring for user-defined projects in addition to the default platform monitoring. You can monitor your own projects in OpenShift Container Platform without the need for an additional monitoring solution. Using this feature centralizes monitoring for core platform components and user-defined projects. Note Versions of Prometheus Operator installed using Operator Lifecycle Manager (OLM) are not compatible with user-defined monitoring. Therefore, custom Prometheus instances installed as a Prometheus custom resource (CR) managed by the OLM Prometheus Operator are not supported in OpenShift Container Platform. 6.1. Enabling monitoring for user-defined projects Cluster administrators can enable monitoring for user-defined projects by setting the enableUserWorkload: true field in the cluster monitoring ConfigMap object. Important You must remove any custom Prometheus instances before enabling monitoring for user-defined projects. Note You must have access to the cluster as a user with the cluster-admin cluster role to enable monitoring for user-defined projects in OpenShift Container Platform. Cluster administrators can then optionally grant users permission to configure the components that are responsible for monitoring user-defined projects. Prerequisites You have access to the cluster as a user with the cluster-admin cluster role. You have installed the OpenShift CLI ( oc ). You have created the cluster-monitoring-config ConfigMap object. You have optionally created and configured the user-workload-monitoring-config ConfigMap object in the openshift-user-workload-monitoring project. You can add configuration options to this ConfigMap object for the components that monitor user-defined projects. Note Every time you save configuration changes to the user-workload-monitoring-config ConfigMap object, the pods in the openshift-user-workload-monitoring project are redeployed. It might sometimes take a while for these components to redeploy. Procedure Edit the cluster-monitoring-config ConfigMap object: USD oc -n openshift-monitoring edit configmap cluster-monitoring-config Add enableUserWorkload: true under data/config.yaml : apiVersion: v1 kind: ConfigMap metadata: name: cluster-monitoring-config namespace: openshift-monitoring data: config.yaml: \| enableUserWorkload: true 1 1 When set to true , the enableUserWorkload parameter enables monitoring for user-defined projects in a cluster. Save the file to apply the changes. Monitoring for user-defined projects is then enabled automatically. Note If you enable monitoring for user-defined projects, the user-workload-monitoring-config ConfigMap object is created by default. Verify that the prometheus-operator , prometheus-user-workload , and thanos-ruler-user-workload pods are running in the openshift-user-workload-monitoring project. It might take a short while for the pods to start: USD oc -n openshift-user-workload-monitoring get pod Example output NAME READY STATUS RESTARTS AGE prometheus-operator-6f7b748d5b-t7nbg 2/2 Running 0 3h prometheus-user-workload-0 4/4 Running 1 3h prometheus-user-workload-1 4/4 Running 1 3h thanos-ruler-user-workload-0 3/3 Running 0 3h thanos-ruler-user-workload-1 3/3 Running 0 3h Additional resources Creating a user-defined workload monitoring config map Configuring the monitoring stack Granting users permission to configure monitoring for user-defined projects 6.2. Granting users permission to monitor user-defined projects As a cluster administrator, you can monitor all core OpenShift Container Platform and user-defined projects. You can also grant developers and other users different permissions: Monitoring user-defined projects Configuring the components that monitor user-defined projects Configuring alert routing for user-defined projects Managing alerts and silences for user-defined projects You can grant the permissions by assigning one of the following monitoring roles or cluster roles: Table 6.1. Monitoring roles Role name Description Project user-workload-monitoring-config-edit Users with this role can edit the user-workload-monitoring-config ConfigMap object to configure Prometheus, Prometheus Operator, Alertmanager, and Thanos Ruler for user-defined workload monitoring. openshift-user-workload-monitoring monitoring-alertmanager-api-reader Users with this role have read access to the user-defined Alertmanager API for all projects, if the user-defined Alertmanager is enabled. openshift-user-workload-monitoring monitoring-alertmanager-api-writer Users with this role have read and write access to the user-defined Alertmanager API for all projects, if the user-defined Alertmanager is enabled. openshift-user-workload-monitoring Table 6.2. Monitoring cluster roles Cluster role name Description Project monitoring-rules-view Users with this cluster role have read access to PrometheusRule custom resources (CRs) for user-defined projects. They can also view the alerts and silences in the Developer perspective of the OpenShift Container Platform web console. Can be bound with RoleBinding to any user project. monitoring-rules-edit Users with this cluster role can create, modify, and delete PrometheusRule CRs for user-defined projects. They can also manage alerts and silences in the Developer perspective of the OpenShift Container Platform web console. Can be bound with RoleBinding to any user project. monitoring-edit Users with this cluster role have the same privileges as users with the monitoring-rules-edit cluster role. Additionally, users can create, read, modify, and delete ServiceMonitor and PodMonitor resources to scrape metrics from services and pods. Can be bound with RoleBinding to any user project. alert-routing-edit Users with this cluster role can create, update, and delete AlertmanagerConfig CRs for user-defined projects. Can be bound with RoleBinding to any user project. 6.2.1. Granting user permissions by using the web console You can grant users permissions for the openshift-monitoring project or their own projects, by using the OpenShift Container Platform web console. Prerequisites You have access to the cluster as a user with the cluster-admin cluster role. The user account that you are assigning the role to already exists. Procedure In the Administrator perspective of the OpenShift Container Platform web console, go to User Management RoleBindings Create binding . In the Binding Type section, select the Namespace Role Binding type. In the Name field, enter a name for the role binding. In the Namespace field, select the project where you want to grant the access. Important The monitoring role or cluster role permissions that you grant to a user by using this procedure apply only to the project that you select in the Namespace field. Select a monitoring role or cluster role from the Role Name list. In the Subject section, select User . In the Subject Name field, enter the name of the user. Select Create to apply the role binding. 6.2.2. Granting user permissions by using the CLI You can grant users permissions for the openshift-monitoring project or their own projects, by using the OpenShift CLI ( oc ). Important Whichever role or cluster role you choose, you must bind it against a specific project as a cluster administrator. Prerequisites You have access to the cluster as a user with the cluster-admin cluster role. The user account that you are assigning the role to already exists. You have installed the OpenShift CLI ( oc ). Procedure To assign a monitoring role to a user for a project, enter the following command: USD oc adm policy add-role-to-user <role> <user> -n <namespace> --role-namespace <namespace> 1 1 Substitute <role> with the wanted monitoring role, <user> with the user to whom you want to assign the role, and <namespace> with the project where you want to grant the access. To assign a monitoring cluster role to a user for a project, enter the following command: USD oc adm policy add-cluster-role-to-user <cluster-role> <user> -n <namespace> 1 1 Substitute <cluster-role> with the wanted monitoring cluster role, <user> with the user to whom you want to assign the cluster role, and <namespace> with the project where you want to grant the access. 6.3. Granting users permission to configure monitoring for user-defined projects As a cluster administrator, you can assign the user-workload-monitoring-config-edit role to a user. This grants permission to configure and manage monitoring for user-defined projects without giving them permission to configure and manage core OpenShift Container Platform monitoring components. Prerequisites You have access to the cluster as a user with the cluster-admin cluster role. The user account that you are assigning the role to already exists. You have installed the OpenShift CLI ( oc ). Procedure Assign the user-workload-monitoring-config-edit role to a user in the openshift-user-workload-monitoring project: USD oc -n openshift-user-workload-monitoring adm policy add-role-to-user \ user-workload-monitoring-config-edit <user> \ --role-namespace openshift-user-workload-monitoring Verify that the user is correctly assigned to the user-workload-monitoring-config-edit role by displaying the related role binding: USD oc describe rolebinding <role_binding_name> -n openshift-user-workload-monitoring Example command USD oc describe rolebinding user-workload-monitoring-config-edit -n openshift-user-workload-monitoring Example output Name: user-workload-monitoring-config-edit Labels: <none> Annotations: <none> Role: Kind: Role Name: user-workload-monitoring-config-edit Subjects: Kind Name Namespace ---- ---- --------- User user1 1 1 In this example, user1 is assigned to the user-workload-monitoring-config-edit role. 6.4. Accessing metrics from outside the cluster for custom applications You can query Prometheus metrics from outside the cluster when monitoring your own services with user-defined projects. Access this data from outside the cluster by using the thanos-querier route. This access only supports using a bearer token for authentication. Prerequisites You have deployed your own service, following the "Enabling monitoring for user-defined projects" procedure. You are logged in to an account with the cluster-monitoring-view cluster role, which provides permission to access the Thanos Querier API. You are logged in to an account that has permission to get the Thanos Querier API route. Note If your account does not have permission to get the Thanos Querier API route, a cluster administrator can provide the URL for the route. Procedure Extract an authentication token to connect to Prometheus by running the following command: USD TOKEN=USD(oc whoami -t) Extract the thanos-querier API route URL by running the following command: USD HOST=USD(oc -n openshift-monitoring get route thanos-querier -ojsonpath='{.status.ingress[].host}') Set the namespace to the namespace in which your service is running by using the following command: USD NAMESPACE=ns1 Query the metrics of your own services in the command line by running the following command: USD curl -H "Authorization: Bearer USDTOKEN" -k "https://USDHOST/api/v1/query?" --data-urlencode "query=up{namespace='USDNAMESPACE'}" The output shows the status for each application pod that Prometheus is scraping: The formatted example output { "status": "success", "data": { "resultType": "vector", "result": [ { "metric": { "__name__": "up", "endpoint": "web", "instance": "10.129.0.46:8080", "job": "prometheus-example-app", "namespace": "ns1", "pod": "prometheus-example-app-68d47c4fb6-jztp2", "service": "prometheus-example-app" }, "value": [ 1591881154.748, "1" ] } ], } } Note The formatted example output uses a filtering tool, such as jq , to provide the formatted indented JSON. See the jq Manual (jq documentation) for more information about using jq . The command requests an instant query endpoint of the Thanos Querier service, which evaluates selectors at one point in time. Additional resources Enabling monitoring for user-defined projects 6.5. Excluding a user-defined project from monitoring Individual user-defined projects can be excluded from user workload monitoring. To do so, add the openshift.io/user-monitoring label to the project's namespace with a value of false . Procedure Add the label to the project namespace: USD oc label namespace my-project 'openshift.io/user-monitoring=false' To re-enable monitoring, remove the label from the namespace: USD oc label namespace my-project 'openshift.io/user-monitoring-' Note If there were any active monitoring targets for the project, it may take a few minutes for Prometheus to stop scraping them after adding the label. 6.6. Disabling monitoring for user-defined projects After enabling monitoring for user-defined projects, you can disable it again by setting enableUserWorkload: false in the cluster monitoring ConfigMap object. Note Alternatively, you can remove enableUserWorkload: true to disable monitoring for user-defined projects. Procedure Edit the cluster-monitoring-config ConfigMap object: USD oc -n openshift-monitoring edit configmap cluster-monitoring-config Set enableUserWorkload: to false under data/config.yaml : apiVersion: v1 kind: ConfigMap metadata: name: cluster-monitoring-config namespace: openshift-monitoring data: config.yaml: \| enableUserWorkload: false Save the file to apply the changes. Monitoring for user-defined projects is then disabled automatically. Check that the prometheus-operator , prometheus-user-workload and thanos-ruler-user-workload pods are terminated in the openshift-user-workload-monitoring project. This might take a short while: USD oc -n openshift-user-workload-monitoring get pod Example output No resources found in openshift-user-workload-monitoring project. Note The user-workload-monitoring-config ConfigMap object in the openshift-user-workload-monitoring project is not automatically deleted when monitoring for user-defined projects is disabled. This is to preserve any custom configurations that you may have created in the ConfigMap object.	[ "oc -n openshift-monitoring edit configmap cluster-monitoring-config", "apiVersion: v1 kind: ConfigMap metadata: name: cluster-monitoring-config namespace: openshift-monitoring data: config.yaml: \| enableUserWorkload: true 1", "oc -n openshift-user-workload-monitoring get pod", "NAME READY STATUS RESTARTS AGE prometheus-operator-6f7b748d5b-t7nbg 2/2 Running 0 3h prometheus-user-workload-0 4/4 Running 1 3h prometheus-user-workload-1 4/4 Running 1 3h thanos-ruler-user-workload-0 3/3 Running 0 3h thanos-ruler-user-workload-1 3/3 Running 0 3h", "oc adm policy add-role-to-user <role> <user> -n <namespace> --role-namespace <namespace> 1", "oc adm policy add-cluster-role-to-user <cluster-role> <user> -n <namespace> 1", "oc -n openshift-user-workload-monitoring adm policy add-role-to-user user-workload-monitoring-config-edit <user> --role-namespace openshift-user-workload-monitoring", "oc describe rolebinding <role_binding_name> -n openshift-user-workload-monitoring", "oc describe rolebinding user-workload-monitoring-config-edit -n openshift-user-workload-monitoring", "Name: user-workload-monitoring-config-edit Labels: <none> Annotations: <none> Role: Kind: Role Name: user-workload-monitoring-config-edit Subjects: Kind Name Namespace ---- ---- --------- User user1 1", "TOKEN=USD(oc whoami -t)", "HOST=USD(oc -n openshift-monitoring get route thanos-querier -ojsonpath='{.status.ingress[].host}')", "NAMESPACE=ns1", "curl -H \"Authorization: Bearer USDTOKEN\" -k \"https://USDHOST/api/v1/query?\" --data-urlencode \"query=up{namespace='USDNAMESPACE'}\"", "{ \"status\": \"success\", \"data\": { \"resultType\": \"vector\", \"result\": [ { \"metric\": { \"__name__\": \"up\", \"endpoint\": \"web\", \"instance\": \"10.129.0.46:8080\", \"job\": \"prometheus-example-app\", \"namespace\": \"ns1\", \"pod\": \"prometheus-example-app-68d47c4fb6-jztp2\", \"service\": \"prometheus-example-app\" }, \"value\": [ 1591881154.748, \"1\" ] } ], } }", "oc label namespace my-project 'openshift.io/user-monitoring=false'", "oc label namespace my-project 'openshift.io/user-monitoring-'", "oc -n openshift-monitoring edit configmap cluster-monitoring-config", "apiVersion: v1 kind: ConfigMap metadata: name: cluster-monitoring-config namespace: openshift-monitoring data: config.yaml: \| enableUserWorkload: false", "oc -n openshift-user-workload-monitoring get pod", "No resources found in openshift-user-workload-monitoring project." ]	https://docs.redhat.com/en/documentation/openshift_container_platform/4.13/html/monitoring/enabling-monitoring-for-user-defined-projects