Skip to content

Commit

Permalink
docs: update reference docs
Browse files Browse the repository at this point in the history 
Signed-off-by: Rory Z <[email protected]>
  • Loading branch information
@Rory-Z
Rory-Z committed Oct 24, 2023
1 parent 86c6962 commit fe6a7b6
Show file tree
Hide file tree
Showing 8 changed files with 50 additions and 22 deletions.
18 changes: 15 additions & 3 deletions docs/en_US/reference/v1beta3-reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ _Appears in:_

#### ConditionType

_Underlying type:_ `string`
_Underlying type:_ _string_

ConditionType defines the condition that the RF can have

Expand Down Expand Up @@ -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/ |
Expand All @@ -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
Expand Down Expand Up @@ -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/ |
Expand Down Expand Up @@ -315,6 +325,8 @@ _Appears in:_





#### ServiceTemplate


Expand Down
8 changes: 5 additions & 3 deletions docs/en_US/reference/v1beta4-reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ _Appears in:_

#### ConditionType

_Underlying type:_ `string`
_Underlying type:_ _string_

ConditionType defines the condition that the RF can have

Expand Down Expand Up @@ -432,6 +432,8 @@ _Appears in:_





#### Rebalance


Expand Down Expand Up @@ -471,7 +473,7 @@ _Appears in:_

#### RebalanceConditionType

_Underlying type:_ `string`
_Underlying type:_ _string_



Expand All @@ -498,7 +500,7 @@ RebalanceList contains a list of Rebalance

#### RebalancePhase

_Underlying type:_ `string`
_Underlying type:_ _string_



Expand Down
2 changes: 1 addition & 1 deletion docs/en_US/reference/v2alpha1-reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ _Appears in:_

#### ConditionType

_Underlying type:_ `string`
_Underlying type:_ _string_



Expand Down
8 changes: 4 additions & 4 deletions docs/en_US/reference/v2beta1-reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,8 @@ _Appears in:_

| Field | Description |
| --- | --- |
| `controllerUID` _UID_ | |
| `podUID` _UID_ | |
| `controllerUID` _[UID](#uid)_ | |
| `podUID` _[UID](#uid)_ | |
| `node` _string_ | EMQX node name, example: [email protected] |
| `node_status` _string_ | EMQX node status, example: Running |
| `otp_release` _string_ | Erlang/OTP version used by EMQX, example: 24.2/12.2 |
Expand Down Expand Up @@ -364,7 +364,7 @@ _Appears in:_

#### RebalanceConditionType

_Underlying type:_ `string`
_Underlying type:_ _string_



Expand All @@ -391,7 +391,7 @@ RebalanceList contains a list of Rebalance

#### RebalancePhase

_Underlying type:_ `string`
_Underlying type:_ _string_



Expand Down
18 changes: 15 additions & 3 deletions docs/zh_CN/reference/v1beta3-reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ _Appears in:_

#### ConditionType

_Underlying type:_ `string`
_Underlying type:_ _string_

ConditionType defines the condition that the RF can have

Expand Down Expand Up @@ -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/ |
Expand All @@ -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
Expand Down Expand Up @@ -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/ |
Expand Down Expand Up @@ -315,6 +325,8 @@ _Appears in:_





#### ServiceTemplate


Expand Down
8 changes: 5 additions & 3 deletions docs/zh_CN/reference/v1beta4-reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ _Appears in:_

#### ConditionType

_Underlying type:_ `string`
_Underlying type:_ _string_

ConditionType defines the condition that the RF can have

Expand Down Expand Up @@ -432,6 +432,8 @@ _Appears in:_





#### Rebalance


Expand Down Expand Up @@ -471,7 +473,7 @@ _Appears in:_

#### RebalanceConditionType

_Underlying type:_ `string`
_Underlying type:_ _string_



Expand All @@ -498,7 +500,7 @@ RebalanceList contains a list of Rebalance

#### RebalancePhase

_Underlying type:_ `string`
_Underlying type:_ _string_



Expand Down
2 changes: 1 addition & 1 deletion docs/zh_CN/reference/v2alpha1-reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ _Appears in:_

#### ConditionType

_Underlying type:_ `string`
_Underlying type:_ _string_



Expand Down
8 changes: 4 additions & 4 deletions docs/zh_CN/reference/v2beta1-reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,8 @@ _Appears in:_

| Field | Description |
| --- | --- |
| `controllerUID` _UID_ | |
| `podUID` _UID_ | |
| `controllerUID` _[UID](#uid)_ | |
| `podUID` _[UID](#uid)_ | |
| `node` _string_ | EMQX node name, example: [email protected] |
| `node_status` _string_ | EMQX node status, example: Running |
| `otp_release` _string_ | Erlang/OTP version used by EMQX, example: 24.2/12.2 |
Expand Down Expand Up @@ -364,7 +364,7 @@ _Appears in:_

#### RebalanceConditionType

_Underlying type:_ `string`
_Underlying type:_ _string_



Expand All @@ -391,7 +391,7 @@ RebalanceList contains a list of Rebalance

#### RebalancePhase

_Underlying type:_ `string`
_Underlying type:_ _string_



Expand Down

0 comments on commit fe6a7b6

Please sign in to comment.