Skip to content

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:

FieldDescriptionDefaultValidation
type ConditionTypeStatus of cluster condition.
status ConditionStatusStatus of the condition, one of True, False, Unknown.
lastUpdateTime stringThe last time this condition was updated.
lastTransitionTime stringLast time the condition transitioned from one status to another.
reason stringThe reason for the condition's last transition.
message stringA 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

FieldDescriptionDefaultValidation
apiVersion stringapps.emqx.io/v1beta3
kind stringEmqxBroker
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec EmqxBrokerSpec
status Status

EmqxBrokerModule

Appears in:

FieldDescriptionDefaultValidation
name string
enable boolean

EmqxBrokerSpec

EmqxBrokerSpec defines the desired state of EmqxBroker

Appears in:

FieldDescriptionDefaultValidation
replicas integer3
imagePullSecrets LocalObjectReference arrayImagePullSecrets 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 PersistentVolumeClaimSpecPersistent describes the common attributes of storage devices
env EnvVar arrayList of environment variables to set in the container.
affinity AffinityIf specified, the pod's scheduling constraints
toleRations Toleration arrayIf 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 arrayList 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 arrayExtraContainers represents extra containers to be added to the pod.
See https://github.com/emqx/emqx-operator/issues/252
emqxTemplate EmqxBrokerTemplate

EmqxBrokerTemplate

Appears in:

FieldDescriptionDefaultValidation
registry stringRegistry 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 stringRequired: {}
imagePullPolicy PullPolicyImage 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 stringUsername for EMQX Dashboard and APIadmin
password stringPassword for EMQX Dashboard and APIpublic
extraVolumes Volume arraySee https://github.com/emqx/emqx-operator/pull/72
extraVolumeMounts VolumeMount arraySee https://github.com/emqx/emqx-operator/pull/72
config EmqxConfigConfig represents the configurations of EMQX
More info: https://www.emqx.io/docs/en/v4.4/configuration/configuration.html
args string arrayArguments 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 PodSecurityContextSecurityContext 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 ResourceRequirementsCompute Resources required by EMQX container.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
readinessProbe ProbePeriodic 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 ProbePeriodic 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 ProbeStartupProbe 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 ServiceTemplateServiceTemplate defines a logical set of ports and a policy by which to access them
acl string arrayACL defines ACL rules
More info: https://www.emqx.io/docs/en/v4.4/advanced/acl.html
modules EmqxBrokerModule arrayModules define functional modules for EMQX broker

EmqxConfig

Underlying type: object

Appears in:

EmqxEnterprise

EmqxEnterprise is the Schema for the emqxEnterprises API

FieldDescriptionDefaultValidation
apiVersion stringapps.emqx.io/v1beta3
kind stringEmqxEnterprise
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec EmqxEnterpriseSpec
status Status

EmqxEnterpriseModule

Appears in:

FieldDescriptionDefaultValidation
name string
enable boolean
configs RawExtension

EmqxEnterpriseSpec

EmqxEnterpriseSpec defines the desired state of EmqxEnterprise

Appears in:

FieldDescriptionDefaultValidation
replicas integer3
imagePullSecrets LocalObjectReference arrayImagePullSecrets 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 PersistentVolumeClaimSpecPersistent describes the common attributes of storage devices
env EnvVar arrayList of environment variables to set in the container.
affinity AffinityIf specified, the pod's scheduling constraints
toleRations Toleration arrayIf 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 arrayList 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 arrayExtraContainers represents extra containers to be added to the pod.
See https://github.com/emqx/emqx-operator/issues/252
emqxTemplate EmqxEnterpriseTemplate

EmqxEnterpriseTemplate

Appears in:

FieldDescriptionDefaultValidation
registry stringRegistry 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 stringRequired: {}
imagePullPolicy PullPolicyImage 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 stringUsername for EMQX Dashboard and APIadmin
password stringPassword for EMQX Dashboard and APIpublic
extraVolumes Volume arraySee https://github.com/emqx/emqx-operator/pull/72
extraVolumeMounts VolumeMount arraySee https://github.com/emqx/emqx-operator/pull/72
config EmqxConfigConfig represents the configurations of EMQX
More info: https://docs.emqx.com/en/enterprise/v4.4/configuration/configuration.html
args string arrayArguments 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 PodSecurityContextSecurityContext 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 ResourceRequirementsCompute Resources required by EMQX container.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
readinessProbe ProbePeriodic 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 ProbePeriodic 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 ProbeStartupProbe 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 ServiceTemplateServiceTemplate defines a logical set of ports and a policy by which to access them
acl string arrayACL defines ACL rules
More info: https://docs.emqx.com/en/enterprise/v4.4/modules/internal_acl.html#builtin-acl-file-2
modules EmqxEnterpriseModule arrayModules define functional modules for EMQX Enterprise broker
More info: https://docs.emqx.com/en/enterprise/v4.4/modules/modules.html
license LicenseLicense for EMQX Enterprise broker

EmqxNode

Appears in:

FieldDescriptionDefaultValidation
node stringEMQX node name
node_status stringEMQX node status
otp_release stringErlang/OTP version used by EMQX
version stringEMQX version

EmqxPlugin

EmqxPlugin is the Schema for the emqxplugins API

FieldDescriptionDefaultValidation
apiVersion stringapps.emqx.io/v1beta3
kind stringEmqxPlugin
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec EmqxPluginSpec
status EmqxPluginStatus

EmqxPluginSpec

EmqxPluginSpec defines the desired state of EmqxPlugin

Appears in:

FieldDescriptionDefaultValidation
pluginName stringMore info: https://www.emqx.io/docs/en/v4.4/advanced/plugins.html#list-of-pluginsRequired: {}
selector object (keys:string, values:string)Selector matches the labels of the EMQXRequired: {}
config object (keys:string, values:string)Config defines the configurations of the EMQX plugins

EmqxPluginStatus

EmqxPluginStatus defines the observed state of EmqxPlugin

Appears in:

FieldDescriptionDefaultValidation
phase phase

License

Appears in:

FieldDescriptionDefaultValidation
data integer arrayData 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 stringStringData 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 stringSecretName 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:

FieldDescriptionDefaultValidation
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec ServiceSpec

Status

Emqx Status defines the observed state of EMQX

Appears in:

FieldDescriptionDefaultValidation
conditions Condition arrayRepresents the latest available observations of a EMQX current state.
emqxNodes EmqxNode arrayNodes of the EMQX cluster
replicas integerreplicas is the number of Pods created by the EMQX Custom Resource controller.
readyReplicas integerreadyReplicas is the number of pods created for this EMQX Custom Resource with a EMQX Ready.