API Reference

Packages

• apps.emqx.io/v1beta3

apps.emqx.io/v1beta3

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

Resource Types

• EmqxBroker
• EmqxEnterprise
• EmqxPlugin

Condition

Condition saves the state information of the EMQX cluster

Appears in:

• Status

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:

• Condition

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:

• EmqxBrokerModuleList
• EmqxBrokerTemplate

Field	Description
name string
enable boolean

EmqxBrokerSpec

EmqxBrokerSpec defines the desired state of EmqxBroker

Appears in:

• EmqxBroker

Field	Description
replicas integer
imagePullSecrets LocalObjectReference (opens new window) array
persistent PersistentVolumeClaimSpec (opens new window)
env EnvVar (opens new window) array
affinity Affinity (opens new window)
toleRations Toleration (opens new window) array
nodeName string
nodeSelector object (keys:string, values:string)
initContainers Container (opens new window) array
extraContainers Container (opens new window) array	Extra Containers to be added to the pod. See https://github.com/emqx/emqx-operator/issues/252
emqxTemplate EmqxBrokerTemplate

EmqxBrokerTemplate

Appears in:

• EmqxBrokerSpec

Field	Description
image string
imagePullPolicy PullPolicy (opens new window)
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)
args string array
securityContext PodSecurityContext (opens new window)
resources ResourceRequirements (opens new window)
readinessProbe Probe (opens new window)
livenessProbe Probe (opens new window)
startupProbe Probe (opens new window)
serviceTemplate ServiceTemplate
acl string array
modules EmqxBrokerModule array

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:

• EmqxEnterpriseModuleList
• EmqxEnterpriseTemplate

Field	Description
name string
enable boolean
configs RawExtension

EmqxEnterpriseSpec

EmqxEnterpriseSpec defines the desired state of EmqxEnterprise

Appears in:

• EmqxEnterprise

Field	Description
replicas integer
imagePullSecrets LocalObjectReference (opens new window) array
persistent PersistentVolumeClaimSpec (opens new window)
env EnvVar (opens new window) array
affinity Affinity (opens new window)
toleRations Toleration (opens new window) array
nodeName string
nodeSelector object (keys:string, values:string)
initContainers Container (opens new window) array
extraContainers Container (opens new window) array	Extra Containers to be added to the pod. See https://github.com/emqx/emqx-operator/issues/252
emqxTemplate EmqxEnterpriseTemplate

EmqxEnterpriseTemplate

Appears in:

• EmqxEnterpriseSpec

Field	Description
image string
imagePullPolicy PullPolicy (opens new window)
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)
args string array
securityContext PodSecurityContext (opens new window)
resources ResourceRequirements (opens new window)
readinessProbe Probe (opens new window)
livenessProbe Probe (opens new window)
startupProbe Probe (opens new window)
serviceTemplate ServiceTemplate
acl string array
modules EmqxEnterpriseModule array
license License

EmqxNode

Appears in:

• Status

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:

• EmqxPlugin

Field	Description
pluginName string
selector object (keys:string, values:string)
config object (keys:string, values:string)

EmqxPluginStatus

EmqxPluginStatus defines the observed state of EmqxPlugin

Appears in:

• EmqxPlugin

Field	Description
phase phase

License

Appears in:

• EmqxEnterpriseTemplate

Field	Description
data integer array
stringData string

ServiceTemplate

Appears in:

• EmqxBrokerTemplate
• EmqxEnterpriseTemplate

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:

• EmqxBroker
• EmqxEnterprise

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.