# API Reference
# Packages
# apps.emqx.io/v1beta3
Package v1beta3 contains API Schema definitions for the apps v1beta3 API group
# Resource Types
# Condition
Condition saves the state information of the EMQX cluster
Appears in:
| Field | Description |
|---|---|
type ConditionType | Status of cluster condition. |
status ConditionStatus (opens new window) | Status of the condition, one of True, False, Unknown. |
lastUpdateTime string | The last time this condition was updated. |
lastTransitionTime string | Last time the condition transitioned from one status to another. |
reason string | The reason for the condition's last transition. |
message string | A human readable message indicating details about the transition. |
# ConditionType
Underlying type: string
ConditionType defines the condition that the RF can have
Appears in:
# EmqxBroker
EmqxBroker is the Schema for the emqxbrokers API
| Field | Description |
|---|---|
apiVersion string | apps.emqx.io/v1beta3 |
kind string | EmqxBroker |
metadata ObjectMeta (opens new window) | Refer to Kubernetes API documentation for fields of metadata. |
spec EmqxBrokerSpec | |
status Status |
# EmqxBrokerModule
Appears in:
| Field | Description |
|---|---|
name string | |
enable boolean |
# EmqxBrokerSpec
EmqxBrokerSpec defines the desired state of EmqxBroker
Appears in:
| Field | Description |
|---|---|
replicas integer | |
imagePullSecrets LocalObjectReference (opens new window) array | ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod |
persistent PersistentVolumeClaimSpec (opens new window) | Persistent describes the common attributes of storage devices |
env EnvVar (opens new window) array | List of environment variables to set in the container. |
affinity Affinity (opens new window) | If specified, the pod's scheduling constraints |
toleRations Toleration (opens new window) array | If specified, the pod's tolerations. |
nodeName string | |
nodeSelector object (keys:string, values:string) | NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
initContainers Container (opens new window) array | List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
extraContainers Container (opens new window) array | ExtraContainers represents extra containers to be added to the pod. See https://github.com/emqx/emqx-operator/issues/252 |
emqxTemplate EmqxBrokerTemplate |
# EmqxBrokerTemplate
Appears in:
| Field | Description |
|---|---|
registry string | Registry will used for EMQX owner image, like ${registry}/emqx/emqx and ${registry}/emqx/emqx-operator-reloader, but it will not be used by other images, like sidecar container or else. |
image string | |
imagePullPolicy PullPolicy (opens new window) | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
username string | Username for EMQX Dashboard and API |
password string | Password for EMQX Dashboard and API |
extraVolumes Volume (opens new window) array | See https://github.com/emqx/emqx-operator/pull/72 |
extraVolumeMounts VolumeMount (opens new window) array | See https://github.com/emqx/emqx-operator/pull/72 |
config object (keys:string, values:string) | Config represents the configurations of EMQX More info: https://www.emqx.io/docs/en/v4.4/configuration/configuration.html |
args string array | Arguments to the entrypoint. The container image's CMD is used if this is not provided. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
securityContext PodSecurityContext (opens new window) | SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
resources ResourceRequirements (opens new window) | Compute Resources required by EMQX container. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
readinessProbe Probe (opens new window) | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
livenessProbe Probe (opens new window) | Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
startupProbe Probe (opens new window) | StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
serviceTemplate ServiceTemplate | ServiceTemplate defines a logical set of ports and a policy by which to access them |
acl string array | ACL defines ACL rules More info: https://www.emqx.io/docs/en/v4.4/advanced/acl.html |
modules EmqxBrokerModule array | Modules define functional modules for EMQX broker |
# EmqxEnterprise
EmqxEnterprise is the Schema for the emqxEnterprises API
| Field | Description |
|---|---|
apiVersion string | apps.emqx.io/v1beta3 |
kind string | EmqxEnterprise |
metadata ObjectMeta (opens new window) | Refer to Kubernetes API documentation for fields of metadata. |
spec EmqxEnterpriseSpec | |
status Status |
# EmqxEnterpriseModule
Appears in:
| Field | Description |
|---|---|
name string | |
enable boolean | |
configs RawExtension |
# EmqxEnterpriseSpec
EmqxEnterpriseSpec defines the desired state of EmqxEnterprise
Appears in:
| Field | Description |
|---|---|
replicas integer | |
imagePullSecrets LocalObjectReference (opens new window) array | ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod |
persistent PersistentVolumeClaimSpec (opens new window) | Persistent describes the common attributes of storage devices |
env EnvVar (opens new window) array | List of environment variables to set in the container. |
affinity Affinity (opens new window) | If specified, the pod's scheduling constraints |
toleRations Toleration (opens new window) array | If specified, the pod's tolerations. |
nodeName string | |
nodeSelector object (keys:string, values:string) | NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
initContainers Container (opens new window) array | List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
extraContainers Container (opens new window) array | ExtraContainers represents extra containers to be added to the pod. See https://github.com/emqx/emqx-operator/issues/252 |
emqxTemplate EmqxEnterpriseTemplate |
# EmqxEnterpriseTemplate
Appears in:
| Field | Description |
|---|---|
registry string | Registry will used for EMQX owner image, like ${registry}/emqx/emqx-ee and ${registry}/emqx/emqx-operator-reloader, but it will not be used by other images, like sidecar container or else. |
image string | |
imagePullPolicy PullPolicy (opens new window) | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
username string | Username for EMQX Dashboard and API |
password string | Password for EMQX Dashboard and API |
extraVolumes Volume (opens new window) array | See https://github.com/emqx/emqx-operator/pull/72 |
extraVolumeMounts VolumeMount (opens new window) array | See https://github.com/emqx/emqx-operator/pull/72 |
config object (keys:string, values:string) | Config represents the configurations of EMQX More info: https://docs.emqx.com/en/enterprise/v4.4/configuration/configuration.html |
args string array | Arguments to the entrypoint. The container image's CMD is used if this is not provided. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
securityContext PodSecurityContext (opens new window) | SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
resources ResourceRequirements (opens new window) | Compute Resources required by EMQX container. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
readinessProbe Probe (opens new window) | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
livenessProbe Probe (opens new window) | Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
startupProbe Probe (opens new window) | StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
serviceTemplate ServiceTemplate | ServiceTemplate defines a logical set of ports and a policy by which to access them |
acl string array | ACL defines ACL rules More info: https://docs.emqx.com/en/enterprise/v4.4/modules/internal_acl.html#builtin-acl-file-2 |
modules EmqxEnterpriseModule array | Modules define functional modules for EMQX Enterprise broker More info: https://docs.emqx.com/en/enterprise/v4.4/modules/modules.html |
license License | License for EMQX Enterprise broker |
# EmqxNode
Appears in:
| Field | Description |
|---|---|
node string | EMQX node name |
node_status string | EMQX node status |
otp_release string | Erlang/OTP version used by EMQX |
version string | EMQX version |
# EmqxPlugin
EmqxPlugin is the Schema for the emqxplugins API
| Field | Description |
|---|---|
apiVersion string | apps.emqx.io/v1beta3 |
kind string | EmqxPlugin |
metadata ObjectMeta (opens new window) | Refer to Kubernetes API documentation for fields of metadata. |
spec EmqxPluginSpec | |
status EmqxPluginStatus |
# EmqxPluginSpec
EmqxPluginSpec defines the desired state of EmqxPlugin
Appears in:
| Field | Description |
|---|---|
pluginName string | More info: https://www.emqx.io/docs/en/v4.4/advanced/plugins.html#list-of-plugins |
selector object (keys:string, values:string) | Selector matches the labels of the EMQX |
config object (keys:string, values:string) | Config defines the configurations of the EMQX plugins |
# EmqxPluginStatus
EmqxPluginStatus defines the observed state of EmqxPlugin
Appears in:
| Field | Description |
|---|---|
phase phase |
# License
Appears in:
| Field | Description |
|---|---|
data integer array | Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 |
stringData string | StringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. |
secretName string | SecretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
# ServiceTemplate
Appears in:
| Field | Description |
|---|---|
metadata ObjectMeta (opens new window) | Refer to Kubernetes API documentation for fields of metadata. |
spec ServiceSpec (opens new window) |
# Status
Emqx Status defines the observed state of EMQX
Appears in:
| Field | Description |
|---|---|
conditions Condition array | Represents the latest available observations of a EMQX current state. |
emqxNodes EmqxNode array | Nodes of the EMQX cluster |
replicas integer | replicas is the number of Pods created by the EMQX Custom Resource controller. |
readyReplicas integer | readyReplicas is the number of pods created for this EMQX Custom Resource with a EMQX Ready. |