Skip to content
On this page

API Reference

Packages

apps.emqx.io/v2beta1

Package v2beta1 contains API Schema definitions for the apps v2beta1 API group

Resource Types

BootstrapAPIKey

Appears in:

FieldDescription
key string
secret string

Config

Appears in:

FieldDescription
mode string
data stringEMQX config, HOCON format, like etc/emqx.conf file

EMQX

EMQX is the Schema for the emqxes API

Appears in:

FieldDescription
apiVersion stringapps.emqx.io/v2beta1
kind stringEMQX
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec EMQXSpecSpec defines the desired identities of EMQX nodes in this set.
status EMQXStatusStatus is the current status of EMQX nodes. This data may be out of date by some window of time.

EMQXCoreTemplate

Appears in:

FieldDescription
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec EMQXCoreTemplateSpecSpecification of the desired behavior of the EMQX core node. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

EMQXCoreTemplateSpec

Appears in:

FieldDescription
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/config/assign-pod-node/
nodeName stringNodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
affinity AffinityAffinity for pod assignment ref: https://kubernetes.io/docs/concepts/config/assign-pod-node/#affinity-and-anti-affinity
toleRations Toleration arrayIf specified, the pod's tolerations. The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator . TODO: should use tolerations instead, this field just for compatible with old version, will delete in future.
tolerations Toleration arrayIf specified, the pod's tolerations. The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .
replicas integerReplicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. Defaults to 2.
command string arrayEntrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
args string arrayArguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
ports ContainerPort arrayList of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.
env EnvVar arrayList of environment variables to set in the container. Cannot be updated.
envFrom EnvFromSource arrayList of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
resources ResourceRequirementsCompute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/config/manage-resources-containers/
podSecurityContext PodSecurityContextSecurityContext holds pod-level security attributes and common container settings.
containerSecurityContext SecurityContextSecurityContext 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/
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. Cannot be updated. 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
extraVolumes Volume arraySee https://github.com/emqx/emqx-operator/pull/72
extraVolumeMounts VolumeMount arraySee https://github.com/emqx/emqx-operator/pull/72
livenessProbe ProbePeriodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
readinessProbe ProbePeriodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. 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. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
lifecycle LifecycleActions that the management system should take in response to container lifecycle events. Cannot be updated.
volumeClaimTemplates PersistentVolumeClaimSpecVolumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name. More than EMQXReplicantTemplateSpec

EMQXList

EMQXList contains a list of EMQX

FieldDescription
apiVersion stringapps.emqx.io/v2beta1
kind stringEMQXList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items EMQX array

EMQXNode

Appears in:

FieldDescription
controllerUID UID
podUID UID
node stringEMQX node name, example: emqx@127.0.0.1
node_status stringEMQX node status, example: Running
otp_release stringErlang/OTP version used by EMQX, example: 24.2/12.2
version stringEMQX version
role stringEMQX cluster node role, enum: "core" "replicant"
edition stringEMQX cluster node edition, enum: "Opensource" "Enterprise"
uptime integerEMQX node uptime, milliseconds
connections integerIn EMQX's API of /api/v5/nodes, the connections field means the number of MQTT session count,
live_connections integerIn EMQX's API of /api/v5/nodes, the live_connections field means the number of connected MQTT clients. THe live_connections just work in EMQX 5.1 or later.

EMQXNodesStatus

Appears in:

FieldDescription
replicas integer
readyReplicas integer
currentRevision string
currentReplicas integer
updateRevision string
updateReplicas integer
collisionCount integer

EMQXReplicantTemplate

Appears in:

FieldDescription
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec EMQXReplicantTemplateSpecSpecification of the desired behavior of the EMQX replicant node. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

EMQXReplicantTemplateSpec

Appears in:

FieldDescription
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/config/assign-pod-node/
nodeName stringNodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
affinity AffinityAffinity for pod assignment ref: https://kubernetes.io/docs/concepts/config/assign-pod-node/#affinity-and-anti-affinity
toleRations Toleration arrayIf specified, the pod's tolerations. The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator . TODO: should use tolerations instead, this field just for compatible with old version, will delete in future.
tolerations Toleration arrayIf specified, the pod's tolerations. The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .
replicas integerReplicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. Defaults to 2.
command string arrayEntrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
args string arrayArguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
ports ContainerPort arrayList of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.
env EnvVar arrayList of environment variables to set in the container. Cannot be updated.
envFrom EnvFromSource arrayList of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
resources ResourceRequirementsCompute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/config/manage-resources-containers/
podSecurityContext PodSecurityContextSecurityContext holds pod-level security attributes and common container settings.
containerSecurityContext SecurityContextSecurityContext 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/
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. Cannot be updated. 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
extraVolumes Volume arraySee https://github.com/emqx/emqx-operator/pull/72
extraVolumeMounts VolumeMount arraySee https://github.com/emqx/emqx-operator/pull/72
livenessProbe ProbePeriodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
readinessProbe ProbePeriodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. 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. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
lifecycle LifecycleActions that the management system should take in response to container lifecycle events. Cannot be updated.

EMQXSpec

EMQXSpec defines the desired state of EMQX

Appears in:

FieldDescription
image stringEMQX image name. More info: https://kubernetes.io/docs/concepts/containers/images
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
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
serviceAccountName stringService Account Name This associates the ReplicaSet or StatefulSet with the specified Service Account for authentication purposes. More info: https://kubernetes.io/docs/concepts/security/service-accounts
bootstrapAPIKeys BootstrapAPIKey arrayEMQX bootstrap user Cannot be updated.
config ConfigEMQX config
clusterDomain string
revisionHistoryLimit integerThe number of old ReplicaSets, old StatefulSet and old PersistentVolumeClaim to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.
updateStrategy UpdateStrategyUpdateStrategy is the object that describes the EMQX blue-green update strategy
coreTemplate EMQXCoreTemplateCoreTemplate is the object that describes the EMQX core node that will be created
replicantTemplate EMQXReplicantTemplateReplicantTemplate is the object that describes the EMQX replicant node that will be created
dashboardServiceTemplate ServiceTemplateDashboardServiceTemplate is the object that describes the EMQX dashboard service that will be created This service always selector the EMQX core node
listenersServiceTemplate ServiceTemplateListenersServiceTemplate is the object that describes the EMQX listener service that will be created If the EMQX replicant node exist, this service will selector the EMQX replicant node Else this service will selector EMQX core node

EMQXStatus

EMQXStatus defines the observed state of EMQX

Appears in:

FieldDescription
conditions Condition arrayRepresents the latest available observations of a EMQX Custom Resource current state.
coreNodes EMQXNode array
coreNodesStatus EMQXNodesStatus
replicantNodes EMQXNode array
replicantNodesStatus EMQXNodesStatus
nodEvacuationsStatus NodeEvacuationStatus array

EvacuationStrategy

Appears in:

FieldDescription
waitTakeover integer
connEvictRate integerJust work in EMQX Enterprise.
sessEvictRate integerJust work in EMQX Enterprise.

NodeEvacuationStats

Appears in:

FieldDescription
initial_sessions integer
initial_connected integer
current_sessions integer
current_connected integer

NodeEvacuationStatus

Appears in:

FieldDescription
node string
stats NodeEvacuationStats
state string
session_recipients string array
session_goal integer
session_eviction_rate integer
connection_goal integer
connection_eviction_rate integer

Rebalance

Rebalance is the Schema for the rebalances API

Appears in:

FieldDescription
apiVersion stringapps.emqx.io/v2beta1
kind stringRebalance
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec RebalanceSpec
status RebalanceStatus

RebalanceCondition

RebalanceCondition describes current state of a EMQX rebalancing job.

Appears in:

FieldDescription
type RebalanceConditionTypeStatus of rebalance condition type. one of Processing, Complete, Failed.
status ConditionStatusStatus of the condition, one of True, False, Unknown.
lastUpdateTime TimeThe last time this condition was updated.
lastTransitionTime TimeLast 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.

RebalanceConditionType

Underlying type: string

Appears in:

RebalanceList

RebalanceList contains a list of Rebalance

FieldDescription
apiVersion stringapps.emqx.io/v2beta1
kind stringRebalanceList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items Rebalance array

RebalancePhase

Underlying type: string

Appears in:

RebalanceSpec

RebalanceSpec defines the desired state of Rebalance

Appears in:

FieldDescription
instanceKind stringInstanceKind is used to distinguish between EMQX and EMQXEnterprise. When it is set to "EMQX", it means that the EMQX CR is v2beta1, and when it is set to "EmqxEnterprise", it means that the EmqxEnterprise CR is v1beta4.
instanceName stringInstanceName represents the name of EMQX CR, just work for EMQX Enterprise
rebalanceStrategy RebalanceStrategyRebalanceStrategy represents the strategy of EMQX rebalancing More info: https://docs.emqx.com/en/enterprise/v4.4/advanced/rebalancing.html#rebalancing

RebalanceState

Rebalance defines the observed Rebalancing state of EMQX

Appears in:

FieldDescription
state stringState represents the state of emqx cluster rebalancing.
session_eviction_rate integerSessionEvictionRate represents the node session evacuation rate per second.
recipients string arrayRecipients represent the target node for rebalancing.
node stringNode represents the rebalancing scheduling node.
donors string arrayDonors represent the source nodes for rebalancing.
coordinator_node stringCoordinatorNode represents the node currently undergoing rebalancing.
connection_eviction_rate integerConnectionEvictionRate represents the node session evacuation rate per second.

RebalanceStatus

RebalanceStatus represents the current state of Rebalance

Appears in:

FieldDescription
conditions RebalanceCondition arrayThe latest available observations of an object's current state. When Rebalance fails, the condition will have type "Failed" and status false. When Rebalance is in processing, the condition will have a type "Processing" and status true. When Rebalance is completed, the condition will have a type "Complete" and status true.
phase RebalancePhasePhase represents the phase of Rebalance.
rebalanceStates RebalanceState array
startedTime TimeStartedTime Represents the time when rebalance job start.
completedTime TimeCompletedTime Represents the time when the rebalance job was completed.

RebalanceStrategy

RebalanceStrategy represents the strategy of EMQX rebalancing

Appears in:

FieldDescription
connEvictRate integerConnEvictRate represents the source node client disconnect rate per second. same to conn-evict-rate in EMQX Rebalancing The value must be greater than 0
sessEvictRate integerSessEvictRate represents the source node session evacuation rate per second. same to sess-evict-rate in EMQX Rebalancing The value must be greater than 0 Defaults to 500.
waitTakeover integerWaitTakeover represents the time in seconds to wait for a client to reconnect to take over the session after all connections are disconnected. same to wait-takeover in EMQX Rebalancing The value must be greater than 0 Defaults to 60 seconds.
waitHealthCheck integerWaitHealthCheck represents the time (in seconds) to wait for the LB to remove the source node from the list of active backend nodes. After the specified waiting time is exceeded,the rebalancing task will start. same to wait-health-check in EMQX Rebalancing The value must be greater than 0 Defaults to 60 seconds.
absConnThreshold integerAbsConnThreshold represents the absolute threshold for checking connection balance. same to abs-conn-threshold in EMQX Rebalancing The value must be greater than 0 Defaults to 1000.
relConnThreshold stringRelConnThreshold represents the relative threshold for checkin connection balance. same to rel-conn-threshold in EMQX Rebalancing the usage of float highly discouraged, as support for them varies across languages. So we define the RelConnThreshold field as string type and you not float type The value must be greater than "1.0" Defaults to "1.1".
absSessThreshold integerAbsSessThreshold represents the absolute threshold for checking session connection balance. same to abs-sess-threshold in EMQX Rebalancing The value must be greater than 0 Default to 1000.
relSessThreshold stringRelSessThreshold represents the relative threshold for checking session connection balance. same to rel-sess-threshold in EMQX Rebalancing the usage of float highly discouraged, as support for them varies across languages. So we define the RelSessThreshold field as string type and you not float type The value must be greater than "1.0" Defaults to "1.1".

ServiceTemplate

Appears in:

FieldDescription
enabled booleanEMQX Operator will create a service for EMQX nodes. This is a pointer to distinguish between false and not specified.
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec ServiceSpecSpec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

UpdateStrategy

Appears in:

FieldDescription
type string
initialDelaySeconds integerNumber of seconds before evacuation connection start.
evacuationStrategy EvacuationStrategyNumber of seconds before evacuation connection timeout.