diff --git a/docs/en_US/reference/v1beta3-reference.md b/docs/en_US/reference/v1beta3-reference.md index f458f17b5..80c551d0c 100644 --- a/docs/en_US/reference/v1beta3-reference.md +++ b/docs/en_US/reference/v1beta3-reference.md @@ -36,7 +36,7 @@ _Appears in:_ #### ConditionType -_Underlying type:_ `string` +_Underlying type:_ _string_ ConditionType defines the condition that the RF can have @@ -124,7 +124,7 @@ _Appears in:_ | `password` _string_ | Password for EMQX Dashboard and API | | `extraVolumes` _[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#volume-v1-core) array_ | See https://github.com/emqx/emqx-operator/pull/72 | | `extraVolumeMounts` _[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#volumemount-v1-core) array_ | See https://github.com/emqx/emqx-operator/pull/72 | -| `config` _object (keys:string, values:string)_ | Config represents the configurations of EMQX More info: https://www.emqx.io/docs/en/v4.4/configuration/configuration.html | +| `config` _[EmqxConfig](#emqxconfig)_ | Config represents the configurations of EMQX More info: https://www.emqx.io/docs/en/v4.4/configuration/configuration.html | | `args` _string array_ | Arguments 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` _[PodSecurityContext](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#podsecuritycontext-v1-core)_ | SecurityContext 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` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#resourcerequirements-v1-core)_ | Compute Resources required by EMQX container. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | @@ -136,6 +136,16 @@ _Appears in:_ | `modules` _[EmqxBrokerModule](#emqxbrokermodule) array_ | Modules define functional modules for EMQX broker | +#### EmqxConfig + +_Underlying type:_ _object_ + + + +_Appears in:_ +- [EmqxBrokerTemplate](#emqxbrokertemplate) +- [EmqxEnterpriseTemplate](#emqxenterprisetemplate) + #### EmqxEnterprise @@ -216,7 +226,7 @@ _Appears in:_ | `password` _string_ | Password for EMQX Dashboard and API | | `extraVolumes` _[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#volume-v1-core) array_ | See https://github.com/emqx/emqx-operator/pull/72 | | `extraVolumeMounts` _[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#volumemount-v1-core) array_ | See https://github.com/emqx/emqx-operator/pull/72 | -| `config` _object (keys:string, values:string)_ | Config represents the configurations of EMQX More info: https://docs.emqx.com/en/enterprise/v4.4/configuration/configuration.html | +| `config` _[EmqxConfig](#emqxconfig)_ | Config represents the configurations of EMQX More info: https://docs.emqx.com/en/enterprise/v4.4/configuration/configuration.html | | `args` _string array_ | Arguments 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` _[PodSecurityContext](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#podsecuritycontext-v1-core)_ | SecurityContext 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` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#resourcerequirements-v1-core)_ | Compute Resources required by EMQX container. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | @@ -315,6 +325,8 @@ _Appears in:_ + + #### ServiceTemplate diff --git a/docs/en_US/reference/v1beta4-reference.md b/docs/en_US/reference/v1beta4-reference.md index e11861f57..1e2d3f8f4 100644 --- a/docs/en_US/reference/v1beta4-reference.md +++ b/docs/en_US/reference/v1beta4-reference.md @@ -54,7 +54,7 @@ _Appears in:_ #### ConditionType -_Underlying type:_ `string` +_Underlying type:_ _string_ ConditionType defines the condition that the RF can have @@ -432,6 +432,8 @@ _Appears in:_ + + #### Rebalance @@ -471,7 +473,7 @@ _Appears in:_ #### RebalanceConditionType -_Underlying type:_ `string` +_Underlying type:_ _string_ @@ -498,7 +500,7 @@ RebalanceList contains a list of Rebalance #### RebalancePhase -_Underlying type:_ `string` +_Underlying type:_ _string_ diff --git a/docs/en_US/reference/v2alpha1-reference.md b/docs/en_US/reference/v2alpha1-reference.md index 492ac9b7d..d0018a972 100644 --- a/docs/en_US/reference/v2alpha1-reference.md +++ b/docs/en_US/reference/v2alpha1-reference.md @@ -50,7 +50,7 @@ _Appears in:_ #### ConditionType -_Underlying type:_ `string` +_Underlying type:_ _string_ diff --git a/docs/en_US/reference/v2beta1-reference.md b/docs/en_US/reference/v2beta1-reference.md index 028520247..90a247fcc 100644 --- a/docs/en_US/reference/v2beta1-reference.md +++ b/docs/en_US/reference/v2beta1-reference.md @@ -142,8 +142,8 @@ _Appears in:_ | Field | Description | | --- | --- | -| `controllerUID` _UID_ | | -| `podUID` _UID_ | | +| `controllerUID` _[UID](#uid)_ | | +| `podUID` _[UID](#uid)_ | | | `node` _string_ | EMQX node name, example: emqx@127.0.0.1 | | `node_status` _string_ | EMQX node status, example: Running | | `otp_release` _string_ | Erlang/OTP version used by EMQX, example: 24.2/12.2 | @@ -364,7 +364,7 @@ _Appears in:_ #### RebalanceConditionType -_Underlying type:_ `string` +_Underlying type:_ _string_ @@ -391,7 +391,7 @@ RebalanceList contains a list of Rebalance #### RebalancePhase -_Underlying type:_ `string` +_Underlying type:_ _string_ diff --git a/docs/zh_CN/reference/v1beta3-reference.md b/docs/zh_CN/reference/v1beta3-reference.md index f458f17b5..80c551d0c 100644 --- a/docs/zh_CN/reference/v1beta3-reference.md +++ b/docs/zh_CN/reference/v1beta3-reference.md @@ -36,7 +36,7 @@ _Appears in:_ #### ConditionType -_Underlying type:_ `string` +_Underlying type:_ _string_ ConditionType defines the condition that the RF can have @@ -124,7 +124,7 @@ _Appears in:_ | `password` _string_ | Password for EMQX Dashboard and API | | `extraVolumes` _[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#volume-v1-core) array_ | See https://github.com/emqx/emqx-operator/pull/72 | | `extraVolumeMounts` _[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#volumemount-v1-core) array_ | See https://github.com/emqx/emqx-operator/pull/72 | -| `config` _object (keys:string, values:string)_ | Config represents the configurations of EMQX More info: https://www.emqx.io/docs/en/v4.4/configuration/configuration.html | +| `config` _[EmqxConfig](#emqxconfig)_ | Config represents the configurations of EMQX More info: https://www.emqx.io/docs/en/v4.4/configuration/configuration.html | | `args` _string array_ | Arguments 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` _[PodSecurityContext](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#podsecuritycontext-v1-core)_ | SecurityContext 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` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#resourcerequirements-v1-core)_ | Compute Resources required by EMQX container. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | @@ -136,6 +136,16 @@ _Appears in:_ | `modules` _[EmqxBrokerModule](#emqxbrokermodule) array_ | Modules define functional modules for EMQX broker | +#### EmqxConfig + +_Underlying type:_ _object_ + + + +_Appears in:_ +- [EmqxBrokerTemplate](#emqxbrokertemplate) +- [EmqxEnterpriseTemplate](#emqxenterprisetemplate) + #### EmqxEnterprise @@ -216,7 +226,7 @@ _Appears in:_ | `password` _string_ | Password for EMQX Dashboard and API | | `extraVolumes` _[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#volume-v1-core) array_ | See https://github.com/emqx/emqx-operator/pull/72 | | `extraVolumeMounts` _[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#volumemount-v1-core) array_ | See https://github.com/emqx/emqx-operator/pull/72 | -| `config` _object (keys:string, values:string)_ | Config represents the configurations of EMQX More info: https://docs.emqx.com/en/enterprise/v4.4/configuration/configuration.html | +| `config` _[EmqxConfig](#emqxconfig)_ | Config represents the configurations of EMQX More info: https://docs.emqx.com/en/enterprise/v4.4/configuration/configuration.html | | `args` _string array_ | Arguments 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` _[PodSecurityContext](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#podsecuritycontext-v1-core)_ | SecurityContext 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` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#resourcerequirements-v1-core)_ | Compute Resources required by EMQX container. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | @@ -315,6 +325,8 @@ _Appears in:_ + + #### ServiceTemplate diff --git a/docs/zh_CN/reference/v1beta4-reference.md b/docs/zh_CN/reference/v1beta4-reference.md index e11861f57..1e2d3f8f4 100644 --- a/docs/zh_CN/reference/v1beta4-reference.md +++ b/docs/zh_CN/reference/v1beta4-reference.md @@ -54,7 +54,7 @@ _Appears in:_ #### ConditionType -_Underlying type:_ `string` +_Underlying type:_ _string_ ConditionType defines the condition that the RF can have @@ -432,6 +432,8 @@ _Appears in:_ + + #### Rebalance @@ -471,7 +473,7 @@ _Appears in:_ #### RebalanceConditionType -_Underlying type:_ `string` +_Underlying type:_ _string_ @@ -498,7 +500,7 @@ RebalanceList contains a list of Rebalance #### RebalancePhase -_Underlying type:_ `string` +_Underlying type:_ _string_ diff --git a/docs/zh_CN/reference/v2alpha1-reference.md b/docs/zh_CN/reference/v2alpha1-reference.md index 492ac9b7d..d0018a972 100644 --- a/docs/zh_CN/reference/v2alpha1-reference.md +++ b/docs/zh_CN/reference/v2alpha1-reference.md @@ -50,7 +50,7 @@ _Appears in:_ #### ConditionType -_Underlying type:_ `string` +_Underlying type:_ _string_ diff --git a/docs/zh_CN/reference/v2beta1-reference.md b/docs/zh_CN/reference/v2beta1-reference.md index 028520247..90a247fcc 100644 --- a/docs/zh_CN/reference/v2beta1-reference.md +++ b/docs/zh_CN/reference/v2beta1-reference.md @@ -142,8 +142,8 @@ _Appears in:_ | Field | Description | | --- | --- | -| `controllerUID` _UID_ | | -| `podUID` _UID_ | | +| `controllerUID` _[UID](#uid)_ | | +| `podUID` _[UID](#uid)_ | | | `node` _string_ | EMQX node name, example: emqx@127.0.0.1 | | `node_status` _string_ | EMQX node status, example: Running | | `otp_release` _string_ | Erlang/OTP version used by EMQX, example: 24.2/12.2 | @@ -364,7 +364,7 @@ _Appears in:_ #### RebalanceConditionType -_Underlying type:_ `string` +_Underlying type:_ _string_ @@ -391,7 +391,7 @@ RebalanceList contains a list of Rebalance #### RebalancePhase -_Underlying type:_ `string` +_Underlying type:_ _string_