# 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. |
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 | |
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 | |
emqxTemplate EmqxBrokerTemplate |
# EmqxBrokerTemplate
Appears in:
| Field | Description |
|---|---|
image string | |
imagePullPolicy PullPolicy (opens new window) | |
extraVolumes Volume (opens new window) array | |
extraVolumeMounts VolumeMount (opens new window) array | |
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:
| 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 | |
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 | |
emqxTemplate EmqxEnterpriseTemplate |
# EmqxEnterpriseTemplate
Appears in:
| Field | Description |
|---|---|
image string | |
imagePullPolicy PullPolicy (opens new window) | |
extraVolumes Volume (opens new window) array | |
extraVolumeMounts VolumeMount (opens new window) array | |
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 |
# EmqxPlugin
EmqxPlugin is the Schema for the emqxplugins API
Appears in:
| 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 |
# EmqxPluginList
EmqxPluginList contains a list of EmqxPlugin
| Field | Description |
|---|---|
apiVersion string | apps.emqx.io/v1beta3 |
kind string | EmqxPluginList |
metadata ListMeta (opens new window) | Refer to Kubernetes API documentation for fields of metadata. |
items EmqxPlugin array |
# EmqxPluginSpec
EmqxPluginSpec defines the desired state of EmqxPlugin
Appears in:
| Field | Description |
|---|---|
pluginName string | |
selector object (keys:string, values:string) | |
config object (keys:string, values:string) |
# License
Appears in:
| Field | Description |
|---|---|
data integer array | |
stringData string |
# 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 | INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run "operator-sdk generate k8s" to regenerate code after modifying this file Add custom validation using kubebuilder tags: https://book.kubebuilder.io/beyond_basics/generating_crd.html |
What’s on this page