Packages:
Resource Types:
PubSub+ Event Broker
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | pubsubplus.solace.com/v1beta1 | true |
kind | string | PubSubPlusEventBroker | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object |
EventBrokerSpec defines the desired state of PubSubPlusEventBroker |
false |
status | object |
EventBrokerStatus defines the observed state of the PubSubPlusEventBroker |
false |
EventBrokerSpec defines the desired state of PubSubPlusEventBroker
Name | Type | Description | Required |
---|---|---|---|
adminCredentialsSecret | string |
Defines the password for PubSubPlusEventBroker if provided. Random one will be generated if not provided.
When provided, ensure the secret key name is `username_admin_password`. For valid values refer to the Solace documentation https://docs.solace.com/Admin/Configuring-Internal-CLI-User-Accounts.htm. |
false |
brokerContainerSecurity | object |
ContainerSecurityContext defines the container security context for the PubSubPlusEventBroker. |
false |
developer | boolean |
Developer true specifies a minimum footprint scaled-down deployment, not for production use.
If set to true it overrides SystemScaling parameters. Default: false |
false |
enableServiceLinks | boolean |
EnableServiceLinks indicates whether information about services should be injected into pod's environment
variables, matching the syntax of Docker links. Optional: Defaults to false. Default: false |
false |
extraEnvVars | []object |
List of extra environment variables to be added to the PubSubPlusEventBroker container. Note: Do not configure Timezone or SystemScaling parameters here as it could cause unintended consequences.
A primary use case is to specify configuration keys, although the variables defined here will not override the ones defined in ConfigMap |
false |
extraEnvVarsCM | string |
List of extra environment variables to be added to the PubSubPlusEventBroker container from an existing ConfigMap. Note: Do not configure Timezone or SystemScaling parameters here as it could cause unintended consequences. |
false |
extraEnvVarsSecret | string |
List of extra environment variables to be added to the PubSubPlusEventBroker container from an existing Secret |
false |
image | object |
Image defines container image parameters for the event broker. |
false |
monitoring | object |
Monitoring specifies a Prometheus monitoring endpoint for the event broker |
false |
monitoringCredentialsSecret | string |
Defines the password for PubSubPlusEventBroker to be used by the Exporter for monitoring.
When provided, ensure the secret key name is `username_monitor_password`. For valid values refer to the Solace documentation https://docs.solace.com/Admin/Configuring-Internal-CLI-User-Accounts.htm. |
false |
nodeAssignment | []object |
NodeAssignment defines labels to constrain PubSubPlusEventBroker nodes to run on particular node(s), or to prefer to run on particular nodes. |
false |
podAnnotations | map[string]string |
PodAnnotations allows adding provider-specific pod annotations to PubSubPlusEventBroker pods Default: map[] |
false |
podDisruptionBudgetForHA | boolean |
PodDisruptionBudgetForHA enables setting up PodDisruptionBudget for the broker pods in HA deployment.
This parameter is ignored for non-HA deployments (if redundancy is false). Default: false |
false |
podLabels | map[string]string |
PodLabels allows adding provider-specific pod labels to PubSubPlusEventBroker pods Default: map[] |
false |
preSharedAuthKeySecret | string |
PreSharedAuthKeySecret defines the PreSharedAuthKey Secret for PubSubPlusEventBroker. Random one will be generated if not provided.
When provided, ensure the secret key name is `preshared_auth_key`. For valid values refer to the Solace documentation https://docs.solace.com/Features/HA-Redundancy/Pre-Shared-Keys-SMB.htm?Highlight=pre%20shared. |
false |
redundancy | boolean |
Redundancy true specifies HA deployment, false specifies Non-HA. Default: false |
false |
securityContext | object |
SecurityContext defines the pod security context for the event broker. |
false |
service | object |
Service defines broker service details. |
false |
serviceAccount | object |
ServiceAccount defines a ServiceAccount dedicated to the PubSubPlusEventBroker |
false |
storage | object |
Storage defines storage details for the broker. |
false |
systemScaling | object |
SystemScaling provides exact fine-grained specification of the event broker scaling parameters
and the assigned CPU / memory resources to the Pod. |
false |
timezone | string |
Defines the timezone for the event broker container, if undefined default is UTC. Valid values are tz database time zone names. Default: UTC |
false |
tls | object |
TLS provides TLS configuration for the event broker. |
false |
updateStrategy | enum |
UpdateStrategy specifies how to update an existing deployment. manualPodRestart waits for user intervention. Enum: automatedRolling, manualPodRestart Default: automatedRolling |
false |
ContainerSecurityContext defines the container security context for the PubSubPlusEventBroker.
Name | Type | Description | Required |
---|---|---|---|
runAsGroup | number |
Specifies runAsGroup in container security context. 0 or unset defaults either to 1000002, or if OpenShift detected to unspecified (see documentation) Format: int64 |
false |
runAsUser | number |
Specifies runAsUser in container security context. 0 or unset defaults either to 1000001, or if OpenShift detected to unspecified (see documentation) Format: int64 |
false |
ExtraEnvVar defines environment variables to be added to the PubSubPlusEventBroker container
Name | Type | Description | Required |
---|---|---|---|
name | string |
Specifies the Name of an environment variable to be added to the PubSubPlusEventBroker container |
true |
value | string |
Specifies the Value of an environment variable to be added to the PubSubPlusEventBroker container |
true |
Image defines container image parameters for the event broker.
Name | Type | Description | Required |
---|---|---|---|
pullPolicy | string |
Specifies ImagePullPolicy of the container image for the event broker. Default: IfNotPresent |
false |
pullSecrets | []object |
pullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. |
false |
repository | string |
Defines the container image repo where the event broker image is pulled from |
false |
tag | string |
Specifies the tag of the container image to be used for the event broker. Default: latest |
false |
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
Monitoring specifies a Prometheus monitoring endpoint for the event broker
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Enabled true enables the setup of the Prometheus Exporter. Default: false |
false |
extraEnvVars | []object |
List of extra environment variables to be added to the Prometheus Exporter container. |
false |
image | object |
Image defines container image parameters for the Prometheus Exporter. |
false |
includeRates | boolean |
Defines if Prometheus Exporter should include rates Default: false |
false |
metricsEndpoint | object |
MetricsEndpoint defines parameters to configure monitoring for the Prometheus Exporter. |
false |
sslVerify | boolean |
Defines if Prometheus Exporter verifies SSL Default: false |
false |
timeOut | number |
Timeout configuration for Prometheus Exporter scrapper Format: int32 Default: 5 |
false |
MonitoringExtraEnvVar defines environment variables to be added to the Prometheus Exporter container for Monitoring
Name | Type | Description | Required |
---|---|---|---|
name | string |
Specifies the Name of an environment variable to be added to the Prometheus Exporter container for Monitoring |
true |
value | string |
Specifies the Value of an environment variable to be added to the Prometheus Exporter container for Monitoring |
true |
Image defines container image parameters for the Prometheus Exporter.
Name | Type | Description | Required |
---|---|---|---|
pullPolicy | string |
Specifies ImagePullPolicy of the container image for the Prometheus Exporter. Default: IfNotPresent |
false |
pullSecrets | []object |
pullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. |
false |
repository | string |
Defines the container image repo where the Prometheus Exporter image is pulled from |
false |
tag | string |
Specifies the tag of the container image to be used for the Prometheus Exporter. Default: latest |
false |
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
MetricsEndpoint defines parameters to configure monitoring for the Prometheus Exporter.
Name | Type | Description | Required |
---|---|---|---|
containerPort | number |
ContainerPort is the port number to expose on the Prometheus Exporter pod. Format: int32 Default: 9628 |
false |
endpointTlsConfigPrivateKeyName | string |
EndpointTlsConfigPrivateKeyName is the file name of the Private Key used to set up TLS configuration Default: tls.key |
false |
endpointTlsConfigSecret | string |
EndpointTLSConfigSecret defines TLS secret name to set up TLS configuration |
false |
endpointTlsConfigServerCertName | string |
EndpointTlsConfigServerCertName is the file name of the Server Certificate used to set up TLS configuration Default: tls.crt |
false |
listenTLS | boolean |
Defines if Metrics Service Endpoint uses TLS configuration Default: false |
false |
name | string |
Name is a unique name for the port that can be referred to by services. |
false |
protocol | enum |
Protocol for port. Must be UDP, TCP, or SCTP. Enum: TCP, UDP, SCTP Default: TCP |
false |
servicePort | number |
ServicePort is the port number to expose on the service Format: int32 Default: 9628 |
false |
serviceType | string |
Defines the service type for the Metrics Service Endpoint Default: ClusterIP |
false |
NodeAssignment defines labels to constrain PubSubPlusEventBroker nodes to specific nodes
Name | Type | Description | Required |
---|---|---|---|
name | enum |
Defines the name of broker node type that has the nodeAssignment spec defined Enum: Primary, Backup, Monitor |
true |
spec | object |
If provided defines the labels to constrain the PubSubPlusEventBroker node to specific nodes |
true |
If provided defines the labels to constrain the PubSubPlusEventBroker node to specific nodes
Name | Type | Description | Required |
---|---|---|---|
affinity | object |
Affinity if provided defines the conditional approach to assign PubSubPlusEventBroker nodes to specific nodes to which they can be scheduled Default: map[] |
false |
nodeSelector | map[string]string |
NodeSelector if provided defines the exact labels of nodes to which PubSubPlusEventBroker nodes can be scheduled Default: map[] |
false |
tolerations | []object |
Toleration if provided defines the exact properties of the PubSubPlusEventBroker nodes can be scheduled on nodes with d matching taint. |
false |
Affinity if provided defines the conditional approach to assign PubSubPlusEventBroker nodes to specific nodes to which they can be scheduled
Name | Type | Description | Required |
---|---|---|---|
nodeAffinity | object |
Describes node affinity scheduling rules for the pod. |
false |
podAffinity | object |
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). |
false |
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)). |
false |
Describes node affinity scheduling rules for the pod.
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
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. |
false |
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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
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).
Name | Type | Description | Required |
---|---|---|---|
preference | object |
A node selector term, associated with the corresponding weight. |
true |
weight | integer |
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32 |
true |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference
A node selector term, associated with the corresponding weight.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
A list of node selector requirements by node's labels. |
false |
matchFields | []object |
A list of node selector requirements by node's fields. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
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.
Name | Type | Description | Required |
---|---|---|---|
nodeSelectorTerms | []object |
Required. A list of node selector terms. The terms are ORed. |
true |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]
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.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
A list of node selector requirements by node's labels. |
false |
matchFields | []object |
A list of node selector requirements by node's fields. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []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. |
false |
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
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. |
false |
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 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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Name | Type | Description | Required |
---|---|---|---|
podAffinityTerm | object |
Required. A pod affinity term, associated with the corresponding weight. |
true |
weight | integer |
weight associated with matching the corresponding podAffinityTerm,
in the range 1-100. Format: int32 |
true |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
Required. A pod affinity term, associated with the corresponding weight.
Name | Type | Description | Required |
---|---|---|---|
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. |
true |
labelSelector | object |
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods. |
false |
matchLabelKeys | []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. |
false |
mismatchLabelKeys | []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. |
false |
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. |
false |
namespaces | []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". |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
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.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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 matches that of any node on which a pod of the set of pods is running
Name | Type | Description | Required |
---|---|---|---|
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. |
true |
labelSelector | object |
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods. |
false |
matchLabelKeys | []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. |
false |
mismatchLabelKeys | []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. |
false |
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. |
false |
namespaces | []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". |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
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.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []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. |
false |
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
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. |
false |
requiredDuringSchedulingIgnoredDuringExecution | []object |
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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Name | Type | Description | Required |
---|---|---|---|
podAffinityTerm | object |
Required. A pod affinity term, associated with the corresponding weight. |
true |
weight | integer |
weight associated with matching the corresponding podAffinityTerm,
in the range 1-100. Format: int32 |
true |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
Required. A pod affinity term, associated with the corresponding weight.
Name | Type | Description | Required |
---|---|---|---|
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. |
true |
labelSelector | object |
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods. |
false |
matchLabelKeys | []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. |
false |
mismatchLabelKeys | []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. |
false |
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. |
false |
namespaces | []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". |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
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.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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 matches that of any node on which a pod of the set of pods is running
Name | Type | Description | Required |
---|---|---|---|
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. |
true |
labelSelector | object |
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods. |
false |
matchLabelKeys | []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. |
false |
mismatchLabelKeys | []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. |
false |
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. |
false |
namespaces | []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". |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
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.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]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. |
false |
PubSubPlusEventBroker.spec.nodeAssignment[index].spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []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. |
false |
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .
Name | Type | Description | Required |
---|---|---|---|
effect | string |
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
false |
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. |
false |
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. |
false |
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. Format: int64 |
false |
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. |
false |
SecurityContext defines the pod security context for the event broker.
Name | Type | Description | Required |
---|---|---|---|
fsGroup | number |
Specifies fsGroup in pod security context. 0 or unset defaults either to 1000002, or if OpenShift detected to unspecified (see documentation) Format: int64 |
false |
runAsUser | number |
Specifies runAsUser in pod security context. 0 or unset defaults either to 1000001, or if OpenShift detected to unspecified (see documentation) Format: int64 |
false |
Service defines broker service details.
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string |
Annotations allows adding provider-specific service annotations Default: map[] |
false |
ports | []object |
Ports specifies the ports to expose PubSubPlusEventBroker services. Default: [map[containerPort:2222 name:tcp-ssh protocol:TCP servicePort:2222] map[containerPort:8080 name:tcp-semp protocol:TCP servicePort:8080] map[containerPort:1943 name:tls-semp protocol:TCP servicePort:1943] map[containerPort:55555 name:tcp-smf protocol:TCP servicePort:55555] map[containerPort:55003 name:tcp-smfcomp protocol:TCP servicePort:55003] map[containerPort:55443 name:tls-smf protocol:TCP servicePort:55443] map[containerPort:55556 name:tcp-smfroute protocol:TCP servicePort:55556] map[containerPort:8008 name:tcp-web protocol:TCP servicePort:8008] map[containerPort:1443 name:tls-web protocol:TCP servicePort:1443] map[containerPort:9000 name:tcp-rest protocol:TCP servicePort:9000] map[containerPort:9443 name:tls-rest protocol:TCP servicePort:9443] map[containerPort:5672 name:tcp-amqp protocol:TCP servicePort:5672] map[containerPort:5671 name:tls-amqp protocol:TCP servicePort:5671] map[containerPort:1883 name:tcp-mqtt protocol:TCP servicePort:1883] map[containerPort:8883 name:tls-mqtt protocol:TCP servicePort:8883] map[containerPort:8000 name:tcp-mqttweb protocol:TCP servicePort:8000] map[containerPort:8443 name:tls-mqttweb protocol:TCP servicePort:8443]] |
false |
type | string |
ServiceType specifies how to expose the broker services. Options include ClusterIP, NodePort, LoadBalancer (default). Default: LoadBalancer |
false |
Port defines parameters configure Service details for the Broker
Name | Type | Description | Required |
---|---|---|---|
containerPort | number |
Port number to expose on the pod. Format: int32 |
true |
name | string |
Unique name for the port that can be referred to by services. |
true |
protocol | enum |
Protocol for port. Must be UDP, TCP, or SCTP. Enum: TCP, UDP, SCTP Default: TCP |
true |
servicePort | number |
Port number to expose on the service Format: int32 |
true |
ServiceAccount defines a ServiceAccount dedicated to the PubSubPlusEventBroker
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name specifies the name of an existing ServiceAccount dedicated to the PubSubPlusEventBroker.
If this value is missing a new ServiceAccount will be created. |
true |
Storage defines storage details for the broker.
Name | Type | Description | Required |
---|---|---|---|
customVolumeMount | []object |
CustomVolumeMount can be used to show the data volume should be mounted instead of using a storage class. |
false |
messagingNodeStorageSize | string |
MessagingNodeStorageSize if provided will assign the minimum persistent storage to be used by the message nodes. Default: 30Gi |
false |
monitorNodeStorageSize | string |
MonitorNodeStorageSize if provided this will create and assign the minimum recommended storage to Monitor pods. Default: 3Gi |
false |
slow | boolean |
Slow indicate slow storage is in use, an example is NFS. Default: false |
false |
useStorageClass | string |
UseStrorageClass Name of the StorageClass to be used to request persistent storage volumes. If undefined, the "default" StorageClass will be used. |
false |
StorageCustomVolumeMount defines Image details and pulling configurations
Name | Type | Description | Required |
---|---|---|---|
name | enum |
Defines the name of PubSubPlusEventBroker node type that has the customVolumeMount spec defined Enum: Primary, Backup, Monitor |
false |
persistentVolumeClaim | object |
Defines the customVolumeMount that can be used mount the data volume instead of using a storage class |
false |
Defines the customVolumeMount that can be used mount the data volume instead of using a storage class
Name | Type | Description | Required |
---|---|---|---|
claimName | string |
Defines the claimName of a custom PersistentVolumeClaim to be used instead |
true |
SystemScaling provides exact fine-grained specification of the event broker scaling parameters and the assigned CPU / memory resources to the Pod.
Name | Type | Description | Required |
---|---|---|---|
maxConnections | integer |
Default: 100 |
false |
maxQueueMessages | integer |
Default: 100 |
false |
maxSpoolUsage | integer |
Default: 1000 |
false |
messagingNodeCpu | string |
Default: 2 |
false |
messagingNodeMemory | string |
Default: 4025Mi |
false |
TLS provides TLS configuration for the event broker.
Name | Type | Description | Required |
---|---|---|---|
certFilename | string |
Name of the Certificate file in the `serverCertificatesSecret` Default: tls.key |
false |
certKeyFilename | string |
Name of the Key file in the `serverCertificatesSecret` Default: tls.crt |
false |
enabled | boolean |
Enabled true enables TLS for the broker. Default: false |
false |
serverTlsConfigSecret | string |
Specifies the tls configuration secret to be used for the broker Default: example-tls-secret |
false |
EventBrokerStatus defines the observed state of the PubSubPlusEventBroker
Name | Type | Description | Required |
---|---|---|---|
broker | object |
Broker section provides the broker status |
false |
conditions | []object |
Conditions provide information about the observed status of the deployment |
false |
podsList | []string |
PodsList are the names of the eventbroker and optionally the monitoring pods |
false |
prometheusMonitoring | object |
Monitoring sectionprovides monitoring support status |
false |
Broker section provides the broker status
Name | Type | Description | Required |
---|---|---|---|
adminCredentialsSecret | string |
|
false |
brokerImage | string |
|
false |
haDeployment | string |
|
false |
serviceName | string |
|
false |
serviceType | string |
|
false |
statefulSets | []string |
|
false |
tlsSecret | string |
|
false |
tlsSupport | string |
|
false |
This struct is intended for direct use as an array at the field path .status.conditions. For example,
type FooStatus struct{
// Represents the observations of a foo's current state.
// Known .status.conditions.type are: "Available", "Progressing", and "Degraded"
// +patchMergeKey=type
// +patchStrategy=merge
// +listType=map
// +listMapKey=type
Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
// other fields
}
Name | Type | Description | Required |
---|---|---|---|
lastTransitionTime | string |
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time |
true |
message | string |
message is a human readable message indicating details about the transition.
This may be an empty string. |
true |
reason | string |
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty. |
true |
status | enum |
status of the condition, one of True, False, Unknown. Enum: True, False, Unknown |
true |
type | string |
type of condition in CamelCase or in foo.example.com/CamelCase.
---
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
useful (see .node.status.conditions), the ability to deconflict is important.
The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) |
true |
observedGeneration | integer |
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance. Format: int64 Minimum: 0 |
false |
Monitoring sectionprovides monitoring support status
Name | Type | Description | Required |
---|---|---|---|
enabled | string |
|
false |
exporterImage | string |
|
false |
serviceName | string |
|
false |