# API Reference
# Packages
# apps.emqx.io/v1beta2
Package v1beta2 contains API Schema definitions for the apps v1beta2 API group
# Resource Types
# ACL
Appears in:
| Field | Description |
|---|---|
permission string | |
username string | |
clientid string | |
ipaddress string | |
action string | |
topics Topics |
# Certificate
Appears in:
| Field | Description |
|---|---|
wss CertificateConf | |
mqtts CertificateConf |
# CertificateConf
Appears in:
| Field | Description |
|---|---|
data CertificateData | |
stringData CertificateStringData |
# CertificateData
Appears in:
| Field | Description |
|---|---|
ca.crt integer array | |
tls.crt integer array | |
tls.key integer array |
# CertificateStringData
Appears in:
| Field | Description |
|---|---|
ca.crt string | |
tls.crt string | |
tls.key string |
# 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/v1beta2 |
kind string | EmqxBroker |
metadata ObjectMeta (opens new window) | Refer to Kubernetes API documentation for fields of metadata. |
spec EmqxBrokerSpec | |
status Status |
# EmqxBrokerSpec
EmqxBrokerSpec defines the desired state of EmqxBroker
Appears in:
| Field | Description |
|---|---|
replicas integer | The fields of Broker. The replicas of emqx broker |
image string | |
imagePullPolicy PullPolicy (opens new window) | |
imagePullSecrets LocalObjectReference (opens new window) array | |
serviceAccountName string | |
resources ResourceRequirements (opens new window) | The service account name which is being bind with the service account of the crd instance. |
storage PersistentVolumeClaimSpec (opens new window) | |
labels object (keys:string, values:string) | The labels configure must be specified. |
annotations object (keys:string, values:string) | |
affinity Affinity (opens new window) | |
toleRations Toleration (opens new window) array | |
nodeName string | |
nodeSelector object (keys:string, values:string) | |
extraVolumes Volume (opens new window) array | |
extraVolumeMounts VolumeMount (opens new window) array | |
env EnvVar (opens new window) array | |
securityContext PodSecurityContext (opens new window) | |
emqxTemplate EmqxBrokerTemplate | |
telegrafTemplate TelegrafTemplate |
# EmqxBrokerTemplate
Appears in:
| Field | Description |
|---|---|
listener Listener | |
acl ACL array | |
modules EmqxBrokerModule array | |
plugins Plugin array |
# EmqxEnterprise
EmqxEnterprise is the Schema for the emqxenterprises API
| Field | Description |
|---|---|
apiVersion string | apps.emqx.io/v1beta2 |
kind string | EmqxEnterprise |
metadata ObjectMeta (opens new window) | Refer to Kubernetes API documentation for fields of metadata. |
spec EmqxEnterpriseSpec | |
status Status |
# EmqxEnterpriseSpec
EmqxEnterpriseSpec defines the desired state of EmqxEnterprise
Appears in:
| Field | Description |
|---|---|
replicas integer | The fields of Broker. The replicas of emqx broker |
image string | |
imagePullPolicy PullPolicy (opens new window) | |
imagePullSecrets LocalObjectReference (opens new window) array | |
serviceAccountName string | |
resources ResourceRequirements (opens new window) | The service account name which is being bind with the service account of the crd instance. |
storage PersistentVolumeClaimSpec (opens new window) | |
labels object (keys:string, values:string) | The labels configure must be specified. |
annotations object (keys:string, values:string) | |
affinity Affinity (opens new window) | |
toleRations Toleration (opens new window) array | |
nodeName string | |
nodeSelector object (keys:string, values:string) | |
extraVolumes Volume (opens new window) array | |
extraVolumeMounts VolumeMount (opens new window) array | |
env EnvVar (opens new window) array | |
securityContext PodSecurityContext (opens new window) | |
emqxTemplate EmqxEnterpriseTemplate | |
telegrafTemplate TelegrafTemplate |
# EmqxEnterpriseTemplate
Appears in:
| Field | Description |
|---|---|
license string | |
listener Listener | |
acl ACL array | |
modules EmqxEnterpriseModule array | |
plugins Plugin array |
# Listener
Appears in:
| Field | Description |
|---|---|
labels object (keys:string, values:string) | |
annotations object (keys:string, values:string) | |
type ServiceType (opens new window) | |
loadBalancerIP string | |
loadBalancerSourceRanges string array | |
externalIPs string array | |
ports Ports | |
nodePorts Ports | |
certificate Certificate |
# Plugin
Appears in:
| Field | Description |
|---|---|
name string | |
enable boolean |
# Ports
Appears in:
| Field | Description |
|---|---|
mqtt integer | |
mqtts integer | |
ws integer | |
wss integer | |
dashboard integer | |
api integer |
# 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 |
# TelegrafTemplate
Appears in:
| Field | Description |
|---|---|
image string | |
conf string | |
resources ResourceRequirements (opens new window) | |
imagePullPolicy PullPolicy (opens new window) |
# Topics
Appears in:
| Field | Description |
|---|---|
filter string array | |
equal string array |
What’s on this page