mirrors/kube-arangodb
1
0
Fork 0
mirror of https://github.com/arangodb/kube-arangodb.git synced 2024-12-14 11:57:37 +00:00
Code Activity
kube-arangodb/docs/api/ArangoDeployment.V1.md

6537 lines
232 KiB
Markdown
Raw Normal View History

[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
# API Reference for ArangoDeployment V1
## Spec
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.affinity
Type: `core.PodAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Affinity specified additional affinity settings in ArangoDB Pod definitions
Links:
* [Documentation of core.PodAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.allowMemberRecreation
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AllowMemberRecreation allows to recreate member.
This setting changes the member recreation logic based on group:
- For Sync Masters, Sync Workers, Coordinator and DB-Servers it determines if a member can be recreated in case of failure (default `true`)
- For Agents and Single this value is hardcoded to `false` and the value provided in spec is ignored.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.annotations
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Annotations specified the annotations added to Pods in this group.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Annotations are merged with `spec.annotations`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.annotationsIgnoreList
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.annotationsMode
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AnnotationsMode Define annotations mode which should be use while overriding annotations
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.antiAffinity
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.PodAntiAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions
Links:
* [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.args
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Args setting specifies additional command-line arguments passed to all servers of this group.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `[]`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.count
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Count setting specifies the number of servers to start for the given group.
For the Agent group, this value must be a positive, odd number.
The default value is `3` for all groups except `single` (there the default is `1`
for `spec.mode: Single` and `2` for `spec.mode: ActiveFailover`).
For the `syncworkers` group, it is highly recommended to use the same number
as for the `dbservers` group.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.entrypoint
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Entrypoint overrides container executable
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.envs\[int\].name
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.envs\[int\].value
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.ephemeralVolumes.apps.size
Type: `resource.Quantity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Size define size of the ephemeral volume
Links:
* [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.ephemeralVolumes.temp.size
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `resource.Quantity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Size define size of the ephemeral volume
Links:
* [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.exporterPort
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExporterPort define Port used by exporter
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.extendedRotationCheck
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExtendedRotationCheck extend checks for rotation
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.externalPortEnabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExternalPortEnabled if external port should be enabled. If is set to false, ports needs to be exposed via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.indexMethod
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
IndexMethod define group Indexing method
[Feature] Add IndexMethod docs (#1437)
2023-10-12 14:37:40 +00:00
Possible Values:
* random (default) - Pick random ID for member. Enforced on the Community Operator.
* ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.initContainers.containers
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Containers contains list of containers
Links:
* [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.initContainers.mode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Mode keep container replace mode
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.internalPort
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.internalPortProtocol
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.labels
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Labels specified the labels added to Pods in this group.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.labelsIgnoreList
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
LabelsIgnoreList list regexp or plain definitions which labels should be ignored
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.labelsMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
LabelsMode Define labels mode which should be use while overriding labels
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.maxCount
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
MaxCount specifies a maximum for the count of servers. If set, a specification is invalid if `count > maxCount`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.memoryReservation
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107)</sup>
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
[Feature] Extract CalculateMemoryReservation function into ArangoDeployment Group Spec (#1472)
2023-11-06 08:16:38 +00:00
MemoryReservation determines the system reservation of memory while calculating `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` value.
If this field is set, `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` is reduced by a specified value in percent.
Accepted Range <0, 50>. If the value is outside the accepted range, it is adjusted to the closest value.
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `0`
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.minCount
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
MinCount specifies a minimum for the count of servers. If set, a specification is invalid if `count < minCount`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.nodeAffinity
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.NodeAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions
Links:
* [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.nodeSelector
Type: `map[string]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
NodeSelector setting specifies a set of labels to be used as `nodeSelector` for Pods of this node.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Links:
* [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.numactl.args
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Args define list of the numactl process
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `[]`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.numactl.enabled
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Enabled define if numactl should be enabled
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.numactl.path
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Path define numactl path within the container
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `/usr/bin/numactl`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.overrideDetectedNumberOfCores
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
OverrideDetectedNumberOfCores determines if number of cores should be overridden based on values in resources.
If is set to true and Container CPU Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` to the value from the Container CPU Limits.
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `true`
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.overrideDetectedTotalMemory
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
OverrideDetectedTotalMemory determines if memory should be overridden based on values in resources.
If is set to true and Container Memory Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` to the value from the Container Memory Limits.
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `true`
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.podModes.network
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31)</sup>
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.podModes.pid
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.port
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Port define Port used by member
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.priorityClassName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
PriorityClassName specifies a priority class name
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Will be forwarded to the pod spec.
Links:
* [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/)
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.probes.livenessProbeDisabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
LivenessProbeDisabled if set to true, the operator does not generate a liveness probe for new pods belonging to this group
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.probes.livenessProbeSpec.failureThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.probes.livenessProbeSpec.initialDelaySeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.probes.livenessProbeSpec.periodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.probes.livenessProbeSpec.successThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.probes.livenessProbeSpec.timeoutSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.probes.ReadinessProbeDisabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
OldReadinessProbeDisabled if true readinessProbes are disabled
Fail CircleCI build if there are changes after running generators (#1489)
2023-11-15 13:11:11 +00:00
Deprecated: This field is deprecated, kept only for backward compatibility.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.probes.readinessProbeDisabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.probes.readinessProbeSpec.failureThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.probes.readinessProbeSpec.initialDelaySeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.probes.readinessProbeSpec.periodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.probes.readinessProbeSpec.successThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.probes.readinessProbeSpec.timeoutSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.probes.startupProbeDisabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
StartupProbeDisabled if true startupProbes are disabled
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.probes.startupProbeSpec.failureThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.probes.startupProbeSpec.initialDelaySeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.probes.startupProbeSpec.periodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.probes.startupProbeSpec.successThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.probes.startupProbeSpec.timeoutSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.pvcResizeMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
VolumeResizeMode specified resize mode for PVCs and PVs
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Possible Values:
* runtime (default) - PVC will be resized in Pod runtime (EKS, GKE)
* rotate - Pod will be shutdown and PVC will be resized (AKS)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.resources
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Resources holds resource requests & limits
Links:
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.schedulerName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SchedulerName define scheduler name used for group
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.securityContext.addCapabilities
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Capability` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AddCapabilities add new capabilities to containers
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.securityContext.allowPrivilegeEscalation
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AllowPrivilegeEscalation Controls whether a process can gain more privileges than its parent process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.securityContext.dropAllCapabilities
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
DropAllCapabilities specifies if capabilities should be dropped for this pod containers
Deprecated: This field is added for backward compatibility. Will be removed in 1.1.0.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.securityContext.fsGroup
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FSGroup is a special supplemental group that applies to all containers in a pod.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.securityContext.privileged
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Privileged If true, runs container in privileged mode. Processes in privileged containers are
essentially equivalent to root on the host.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.securityContext.readOnlyRootFilesystem
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
ReadOnlyRootFilesystem if true, mounts the container's root filesystem as read-only.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.securityContext.runAsGroup
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsGroup is the GID to run the entrypoint of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.securityContext.runAsNonRoot
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsNonRoot if true, indicates that the container must run as a non-root user.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.securityContext.runAsUser
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsUser is the UID to run the entrypoint of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.securityContext.seccompProfile
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.SeccompProfile` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.
Links:
* [Documentation of core.SeccompProfile](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#seccompprofile-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.securityContext.seLinuxOptions
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.SELinuxOptions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SELinuxOptions are the labels to be applied to the container
Links:
* [Documentation of core.SELinuxOptions](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#selinuxoptions-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.securityContext.supplementalGroups
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SupplementalGroups is a list of groups applied to the first process run in each container, in addition to the container's primary GID,
the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.securityContext.sysctls
[Feature] Expose core.PodSecurityContext Sysctl options (#1360)
2023-07-20 11:25:54 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `map[string]intstr.IntOrString` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77)</sup>
[Feature] Expose core.PodSecurityContext Sysctl options (#1360)
2023-07-20 11:25:54 +00:00
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
sysctls (by the container runtime) might fail to launch.
Map Value can be String or Int
Links:
* [Documentation](https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/)
Example:
```yaml
sysctls:
"kernel.shm_rmid_forced": "0"
"net.core.somaxconn": 1024
"kernel.msgmax": "65536"
```
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.serviceAccountName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
ServiceAccountName setting specifies the `serviceAccountName` for the `Pods` created
for each server of this group. If empty, it defaults to using the
`default` service account.
Using an alternative `ServiceAccount` is typically used to separate access rights.
The ArangoDB deployments need some very minimal access rights. With the
deployment of the operator, we grant the rights to 'get' all 'pod' resources.
If you are using a different service account, please grant these rights
to that service account.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.shutdownDelay
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ShutdownDelay define how long operator should delay finalizer removal after shutdown
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.shutdownMethod
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ShutdownMethod describe procedure of member shutdown taken by Operator
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.sidecarCoreNames
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SidecarCoreNames is a list of sidecar containers which must run in the pod.
Some names (e.g.: "server", "worker") are reserved, and they don't have any impact.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.sidecars
Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Sidecars specifies a list of additional containers to be started
Links:
* [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.storageClassName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
StorageClassName specifies the classname for storage of the servers.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.terminationGracePeriodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.tolerations
Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Tolerations specifies the tolerations added to Pods in this group.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
By default, suitable tolerations are set for the following keys with the `NoExecute` effect:
- `node.kubernetes.io/not-ready`
- `node.kubernetes.io/unreachable`
- `node.alpha.kubernetes.io/unreachable` (will be removed in future version)
For more information on tolerations, consult the https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Links:
* [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.volumeAllowShrink
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Deprecated: VolumeAllowShrink allows shrink the volume
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.volumeClaimTemplate
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.PersistentVolumeClaim` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
VolumeClaimTemplate specifies a volumeClaimTemplate used by operator to create to volume claims for pods of this group.
This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`.
The default value describes a volume with `8Gi` storage, `ReadWriteOnce` access mode and volume mode set to `PersistentVolumeFilesystem`.
If this field is not set and `spec.<group>.resources.requests.storage` is set, then a default volume claim
with size as specified by `spec.<group>.resources.requests.storage` will be created. In that case `storage`
and `iops` is not forwarded to the pods resource requirements.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Links:
* [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.volumeMounts
Type: `[]ServerGroupSpecVolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
VolumeMounts define list of volume mounts mounted into server container
Links:
* [Documentation of ServerGroupSpecVolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volumemount-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.volumes\[int\].configMap
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.ConfigMapVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ConfigMap which should be mounted into pod
Links:
* [Documentation of core.ConfigMapVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#configmapvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.volumes\[int\].emptyDir
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.EmptyDirVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
EmptyDir
Links:
* [Documentation of core.EmptyDirVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#emptydirvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.volumes\[int\].hostPath
Type: `core.HostPathVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
HostPath
Links:
* [Documentation of core.HostPathVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#hostpathvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.volumes\[int\].name
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Name of volume
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.agents.volumes\[int\].persistentVolumeClaim
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.PersistentVolumeClaimVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
PersistentVolumeClaim
Links:
* [Documentation of core.PersistentVolumeClaimVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.agents.volumes\[int\].secret
Type: `core.SecretVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Secret which should be mounted into pod
Links:
* [Documentation of core.SecretVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#secretvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.allowUnsafeUpgrade
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L163)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AllowUnsafeUpgrade determines if upgrade on missing member or with not in sync shards is allowed
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.annotations
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L126)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
Annotations specifies the annotations added to all ArangoDeployment owned resources (pods, services, PVC’s, PDB’s).
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.annotationsIgnoreList
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L129)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.annotationsMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L135)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
AnnotationsMode defines annotations mode which should be use while overriding annotations.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
Possible Values:
* disabled (default) - Disable annotations/labels override. Default if there is no annotations/labels set in ArangoDeployment
* append - Add new annotations/labels without affecting old ones
* replace - Replace existing annotations/labels
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.architecture
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L265)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
Architecture defines the list of supported architectures.
First element on the list is marked as default architecture.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Possible values are:
- `amd64`: Use processors with the x86-64 architecture.
- `arm64`: Use processors with the 64-bit ARM architecture.
The setting expects a list of strings, but you should only specify a single
list item for the architecture, except when you want to migrate from one
architecture to the other. The first list item defines the new default
architecture for the deployment that you want to migrate to.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
Links:
Remove obsolete docs, restructure for better UX (#1447)
2023-10-19 07:14:14 +00:00
* [Architecture Change](/docs/how-to/arch_change.md)
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `['amd64']`
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.auth.jwtSecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/authentication_spec.go#L40)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
JWTSecretName setting specifies the name of a kubernetes `Secret` that contains
the JWT token used for accessing all ArangoDB servers.
When no name is specified, it defaults to `<deployment-name>-jwt`.
To disable authentication, set this value to `None`.
If you specify a name of a `Secret`, that secret must have the token
in a data field named `token`.
If you specify a name of a `Secret` that does not exist, a random token is created
and stored in a `Secret` with given name.
Changing a JWT token results in restarting of a whole cluster.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.bootstrap.passwordSecretNames
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `map[string]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/bootstrap.go#L62)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
PasswordSecretNames contains a map of username to password-secret-name
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
This setting specifies a secret name for the credentials per specific users.
When a deployment is created the operator will setup the user accounts
according to the credentials given by the secret. If the secret doesn't exist
the operator creates a secret with a random password.
There are two magic values for the secret name:
- `None` specifies no action. This disables root password randomization. This is the default value. (Thus the root password is empty - not recommended)
- `Auto` specifies automatic name generation, which is `<deploymentname>-root-password`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Links:
* [How to set root user password](/docs/how-to/set_root_user_password.md)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.chaos.enabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/chaos_spec.go#L33)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Enabled switches the chaos monkey for a deployment on or off.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.chaos.interval
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/chaos_spec.go#L35)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Interval is the time between events
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.chaos.kill-pod-probability
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/chaos_spec.go#L37)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
KillPodProbability is the chance of a pod being killed during an event
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.ClusterDomain
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L237)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ClusterDomain define domain used in the kubernetes cluster.
Required only of domain is not set to default (cluster.local)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `cluster.local`
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.communicationMethod
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L245)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
CommunicationMethod define communication method used in deployment
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
Possible Values:
* headless (default) - Define old communication mechanism, based on headless service.
* dns - Define ClusterIP Service DNS based communication.
* short-dns - Define ClusterIP Service DNS based communication. Use namespaced short DNS (used in migration)
* headless-dns - Define Headless Service DNS based communication.
* ip - Define ClusterIP Service IP based communication.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.affinity
Type: `core.PodAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Affinity specified additional affinity settings in ArangoDB Pod definitions
Links:
* [Documentation of core.PodAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.allowMemberRecreation
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AllowMemberRecreation allows to recreate member.
This setting changes the member recreation logic based on group:
- For Sync Masters, Sync Workers, Coordinator and DB-Servers it determines if a member can be recreated in case of failure (default `true`)
- For Agents and Single this value is hardcoded to `false` and the value provided in spec is ignored.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.annotations
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Annotations specified the annotations added to Pods in this group.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Annotations are merged with `spec.annotations`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.annotationsIgnoreList
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.annotationsMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AnnotationsMode Define annotations mode which should be use while overriding annotations
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.antiAffinity
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.PodAntiAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions
Links:
* [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.args
Type: `[]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Args setting specifies additional command-line arguments passed to all servers of this group.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `[]`
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.count
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Count setting specifies the number of servers to start for the given group.
For the Agent group, this value must be a positive, odd number.
The default value is `3` for all groups except `single` (there the default is `1`
for `spec.mode: Single` and `2` for `spec.mode: ActiveFailover`).
For the `syncworkers` group, it is highly recommended to use the same number
as for the `dbservers` group.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.entrypoint
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Entrypoint overrides container executable
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.envs\[int\].name
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.envs\[int\].value
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27)</sup>
***
### .spec.coordinators.ephemeralVolumes.apps.size
Type: `resource.Quantity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Size define size of the ephemeral volume
Links:
* [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.ephemeralVolumes.temp.size
Type: `resource.Quantity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Size define size of the ephemeral volume
Links:
* [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.exporterPort
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExporterPort define Port used by exporter
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.extendedRotationCheck
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExtendedRotationCheck extend checks for rotation
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.externalPortEnabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExternalPortEnabled if external port should be enabled. If is set to false, ports needs to be exposed via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.indexMethod
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
IndexMethod define group Indexing method
[Feature] Add IndexMethod docs (#1437)
2023-10-12 14:37:40 +00:00
Possible Values:
* random (default) - Pick random ID for member. Enforced on the Community Operator.
* ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.initContainers.containers
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Containers contains list of containers
Links:
* [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.initContainers.mode
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Mode keep container replace mode
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.internalPort
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.internalPortProtocol
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.labels
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Labels specified the labels added to Pods in this group.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.labelsIgnoreList
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
LabelsIgnoreList list regexp or plain definitions which labels should be ignored
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.labelsMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
LabelsMode Define labels mode which should be use while overriding labels
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.maxCount
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
MaxCount specifies a maximum for the count of servers. If set, a specification is invalid if `count > maxCount`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.memoryReservation
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107)</sup>
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
[Feature] Extract CalculateMemoryReservation function into ArangoDeployment Group Spec (#1472)
2023-11-06 08:16:38 +00:00
MemoryReservation determines the system reservation of memory while calculating `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` value.
If this field is set, `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` is reduced by a specified value in percent.
Accepted Range <0, 50>. If the value is outside the accepted range, it is adjusted to the closest value.
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `0`
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.minCount
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
MinCount specifies a minimum for the count of servers. If set, a specification is invalid if `count < minCount`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.nodeAffinity
Type: `core.NodeAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions
Links:
* [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.nodeSelector
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `map[string]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
NodeSelector setting specifies a set of labels to be used as `nodeSelector` for Pods of this node.
Links:
* [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/)
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.numactl.args
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Args define list of the numactl process
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `[]`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.numactl.enabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Enabled define if numactl should be enabled
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.numactl.path
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Path define numactl path within the container
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `/usr/bin/numactl`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.overrideDetectedNumberOfCores
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable
OverrideDetectedNumberOfCores determines if number of cores should be overridden based on values in resources.
If is set to true and Container CPU Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` to the value from the Container CPU Limits.
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `true`
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.overrideDetectedTotalMemory
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable
OverrideDetectedTotalMemory determines if memory should be overridden based on values in resources.
If is set to true and Container Memory Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` to the value from the Container Memory Limits.
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `true`
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.podModes.network
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.podModes.pid
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.port
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Port define Port used by member
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.priorityClassName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
PriorityClassName specifies a priority class name
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Will be forwarded to the pod spec.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Links:
* [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.probes.livenessProbeDisabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
LivenessProbeDisabled if set to true, the operator does not generate a liveness probe for new pods belonging to this group
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.probes.livenessProbeSpec.failureThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.probes.livenessProbeSpec.initialDelaySeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.probes.livenessProbeSpec.periodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.probes.livenessProbeSpec.successThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.probes.livenessProbeSpec.timeoutSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.probes.ReadinessProbeDisabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
OldReadinessProbeDisabled if true readinessProbes are disabled
Fail CircleCI build if there are changes after running generators (#1489)
2023-11-15 13:11:11 +00:00
Deprecated: This field is deprecated, kept only for backward compatibility.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.probes.readinessProbeDisabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.probes.readinessProbeSpec.failureThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.probes.readinessProbeSpec.initialDelaySeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.probes.readinessProbeSpec.periodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.probes.readinessProbeSpec.successThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.probes.readinessProbeSpec.timeoutSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.probes.startupProbeDisabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
StartupProbeDisabled if true startupProbes are disabled
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.probes.startupProbeSpec.failureThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.probes.startupProbeSpec.initialDelaySeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.probes.startupProbeSpec.periodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.probes.startupProbeSpec.successThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.probes.startupProbeSpec.timeoutSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.pvcResizeMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
VolumeResizeMode specified resize mode for PVCs and PVs
Possible Values:
* runtime (default) - PVC will be resized in Pod runtime (EKS, GKE)
* rotate - Pod will be shutdown and PVC will be resized (AKS)
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.resources
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Resources holds resource requests & limits
Links:
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.schedulerName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SchedulerName define scheduler name used for group
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.securityContext.addCapabilities
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Capability` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AddCapabilities add new capabilities to containers
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.securityContext.allowPrivilegeEscalation
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AllowPrivilegeEscalation Controls whether a process can gain more privileges than its parent process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.securityContext.dropAllCapabilities
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
DropAllCapabilities specifies if capabilities should be dropped for this pod containers
Deprecated: This field is added for backward compatibility. Will be removed in 1.1.0.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.securityContext.fsGroup
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FSGroup is a special supplemental group that applies to all containers in a pod.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.securityContext.privileged
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Privileged If true, runs container in privileged mode. Processes in privileged containers are
essentially equivalent to root on the host.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.securityContext.readOnlyRootFilesystem
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
ReadOnlyRootFilesystem if true, mounts the container's root filesystem as read-only.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.securityContext.runAsGroup
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsGroup is the GID to run the entrypoint of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.securityContext.runAsNonRoot
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsNonRoot if true, indicates that the container must run as a non-root user.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.securityContext.runAsUser
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsUser is the UID to run the entrypoint of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.securityContext.seccompProfile
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.SeccompProfile` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.
Links:
* [Documentation of core.SeccompProfile](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#seccompprofile-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.securityContext.seLinuxOptions
Type: `core.SELinuxOptions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SELinuxOptions are the labels to be applied to the container
Links:
* [Documentation of core.SELinuxOptions](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#selinuxoptions-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.securityContext.supplementalGroups
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SupplementalGroups is a list of groups applied to the first process run in each container, in addition to the container's primary GID,
the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.securityContext.sysctls
[Feature] Expose core.PodSecurityContext Sysctl options (#1360)
2023-07-20 11:25:54 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `map[string]intstr.IntOrString` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77)</sup>
[Feature] Expose core.PodSecurityContext Sysctl options (#1360)
2023-07-20 11:25:54 +00:00
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
sysctls (by the container runtime) might fail to launch.
Map Value can be String or Int
Links:
* [Documentation](https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/)
Example:
```yaml
sysctls:
"kernel.shm_rmid_forced": "0"
"net.core.somaxconn": 1024
"kernel.msgmax": "65536"
```
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.serviceAccountName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
ServiceAccountName setting specifies the `serviceAccountName` for the `Pods` created
for each server of this group. If empty, it defaults to using the
`default` service account.
Using an alternative `ServiceAccount` is typically used to separate access rights.
The ArangoDB deployments need some very minimal access rights. With the
deployment of the operator, we grant the rights to 'get' all 'pod' resources.
If you are using a different service account, please grant these rights
to that service account.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.shutdownDelay
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ShutdownDelay define how long operator should delay finalizer removal after shutdown
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.shutdownMethod
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ShutdownMethod describe procedure of member shutdown taken by Operator
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.sidecarCoreNames
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SidecarCoreNames is a list of sidecar containers which must run in the pod.
Some names (e.g.: "server", "worker") are reserved, and they don't have any impact.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.sidecars
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Sidecars specifies a list of additional containers to be started
Links:
* [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.storageClassName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
StorageClassName specifies the classname for storage of the servers.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.terminationGracePeriodSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.tolerations
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Tolerations specifies the tolerations added to Pods in this group.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
By default, suitable tolerations are set for the following keys with the `NoExecute` effect:
- `node.kubernetes.io/not-ready`
- `node.kubernetes.io/unreachable`
- `node.alpha.kubernetes.io/unreachable` (will be removed in future version)
For more information on tolerations, consult the https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Links:
* [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.volumeAllowShrink
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Deprecated: VolumeAllowShrink allows shrink the volume
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.volumeClaimTemplate
Type: `core.PersistentVolumeClaim` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
VolumeClaimTemplate specifies a volumeClaimTemplate used by operator to create to volume claims for pods of this group.
This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`.
The default value describes a volume with `8Gi` storage, `ReadWriteOnce` access mode and volume mode set to `PersistentVolumeFilesystem`.
If this field is not set and `spec.<group>.resources.requests.storage` is set, then a default volume claim
with size as specified by `spec.<group>.resources.requests.storage` will be created. In that case `storage`
and `iops` is not forwarded to the pods resource requirements.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Links:
* [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.volumeMounts
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]ServerGroupSpecVolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
VolumeMounts define list of volume mounts mounted into server container
Links:
* [Documentation of ServerGroupSpecVolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volumemount-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.volumes\[int\].configMap
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.ConfigMapVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ConfigMap which should be mounted into pod
Links:
* [Documentation of core.ConfigMapVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#configmapvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.volumes\[int\].emptyDir
Type: `core.EmptyDirVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
EmptyDir
Links:
* [Documentation of core.EmptyDirVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#emptydirvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.volumes\[int\].hostPath
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.HostPathVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
HostPath
Links:
* [Documentation of core.HostPathVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#hostpathvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.volumes\[int\].name
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Name of volume
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.coordinators.volumes\[int\].persistentVolumeClaim
Type: `core.PersistentVolumeClaimVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
PersistentVolumeClaim
Links:
* [Documentation of core.PersistentVolumeClaimVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.coordinators.volumes\[int\].secret
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.SecretVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Secret which should be mounted into pod
Links:
* [Documentation of core.SecretVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#secretvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.database.maintenance
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/database_spec.go#L25)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Maintenance manage maintenance mode on Cluster side. Requires maintenance feature to be enabled
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.affinity
Type: `core.PodAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Affinity specified additional affinity settings in ArangoDB Pod definitions
Links:
* [Documentation of core.PodAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.allowMemberRecreation
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AllowMemberRecreation allows to recreate member.
This setting changes the member recreation logic based on group:
- For Sync Masters, Sync Workers, Coordinator and DB-Servers it determines if a member can be recreated in case of failure (default `true`)
- For Agents and Single this value is hardcoded to `false` and the value provided in spec is ignored.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.annotations
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Annotations specified the annotations added to Pods in this group.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Annotations are merged with `spec.annotations`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.annotationsIgnoreList
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.annotationsMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AnnotationsMode Define annotations mode which should be use while overriding annotations
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.antiAffinity
Type: `core.PodAntiAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions
Links:
* [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.args
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Args setting specifies additional command-line arguments passed to all servers of this group.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `[]`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.count
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Count setting specifies the number of servers to start for the given group.
For the Agent group, this value must be a positive, odd number.
The default value is `3` for all groups except `single` (there the default is `1`
for `spec.mode: Single` and `2` for `spec.mode: ActiveFailover`).
For the `syncworkers` group, it is highly recommended to use the same number
as for the `dbservers` group.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.entrypoint
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Entrypoint overrides container executable
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.envs\[int\].name
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.envs\[int\].value
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.ephemeralVolumes.apps.size
Type: `resource.Quantity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Size define size of the ephemeral volume
Links:
* [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.ephemeralVolumes.temp.size
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `resource.Quantity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Size define size of the ephemeral volume
Links:
* [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.exporterPort
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExporterPort define Port used by exporter
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.extendedRotationCheck
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExtendedRotationCheck extend checks for rotation
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.externalPortEnabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExternalPortEnabled if external port should be enabled. If is set to false, ports needs to be exposed via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.indexMethod
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
IndexMethod define group Indexing method
[Feature] Add IndexMethod docs (#1437)
2023-10-12 14:37:40 +00:00
Possible Values:
* random (default) - Pick random ID for member. Enforced on the Community Operator.
* ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.initContainers.containers
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Containers contains list of containers
Links:
* [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.initContainers.mode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Mode keep container replace mode
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.internalPort
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.internalPortProtocol
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.labels
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Labels specified the labels added to Pods in this group.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.labelsIgnoreList
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
LabelsIgnoreList list regexp or plain definitions which labels should be ignored
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.labelsMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
LabelsMode Define labels mode which should be use while overriding labels
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.maxCount
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
MaxCount specifies a maximum for the count of servers. If set, a specification is invalid if `count > maxCount`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.memoryReservation
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107)</sup>
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
[Feature] Extract CalculateMemoryReservation function into ArangoDeployment Group Spec (#1472)
2023-11-06 08:16:38 +00:00
MemoryReservation determines the system reservation of memory while calculating `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` value.
If this field is set, `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` is reduced by a specified value in percent.
Accepted Range <0, 50>. If the value is outside the accepted range, it is adjusted to the closest value.
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `0`
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.minCount
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
MinCount specifies a minimum for the count of servers. If set, a specification is invalid if `count < minCount`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.nodeAffinity
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.NodeAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions
Links:
* [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.nodeSelector
Type: `map[string]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
NodeSelector setting specifies a set of labels to be used as `nodeSelector` for Pods of this node.
Links:
* [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/)
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.numactl.args
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Args define list of the numactl process
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `[]`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.numactl.enabled
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Enabled define if numactl should be enabled
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.numactl.path
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Path define numactl path within the container
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `/usr/bin/numactl`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.overrideDetectedNumberOfCores
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
OverrideDetectedNumberOfCores determines if number of cores should be overridden based on values in resources.
If is set to true and Container CPU Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` to the value from the Container CPU Limits.
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `true`
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.overrideDetectedTotalMemory
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable
OverrideDetectedTotalMemory determines if memory should be overridden based on values in resources.
If is set to true and Container Memory Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` to the value from the Container Memory Limits.
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `true`
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.podModes.network
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.podModes.pid
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32)</sup>
***
### .spec.dbservers.port
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Port define Port used by member
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.priorityClassName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
PriorityClassName specifies a priority class name
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Will be forwarded to the pod spec.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Links:
* [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.probes.livenessProbeDisabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
LivenessProbeDisabled if set to true, the operator does not generate a liveness probe for new pods belonging to this group
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.probes.livenessProbeSpec.failureThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.probes.livenessProbeSpec.initialDelaySeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.probes.livenessProbeSpec.periodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.probes.livenessProbeSpec.successThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.probes.livenessProbeSpec.timeoutSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.probes.ReadinessProbeDisabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
OldReadinessProbeDisabled if true readinessProbes are disabled
Fail CircleCI build if there are changes after running generators (#1489)
2023-11-15 13:11:11 +00:00
Deprecated: This field is deprecated, kept only for backward compatibility.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.probes.readinessProbeDisabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.probes.readinessProbeSpec.failureThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.probes.readinessProbeSpec.initialDelaySeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.probes.readinessProbeSpec.periodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.probes.readinessProbeSpec.successThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.probes.readinessProbeSpec.timeoutSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.probes.startupProbeDisabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
StartupProbeDisabled if true startupProbes are disabled
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.probes.startupProbeSpec.failureThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.probes.startupProbeSpec.initialDelaySeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.probes.startupProbeSpec.periodSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.probes.startupProbeSpec.successThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.probes.startupProbeSpec.timeoutSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.pvcResizeMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
VolumeResizeMode specified resize mode for PVCs and PVs
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Possible Values:
* runtime (default) - PVC will be resized in Pod runtime (EKS, GKE)
* rotate - Pod will be shutdown and PVC will be resized (AKS)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.resources
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Resources holds resource requests & limits
Links:
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.schedulerName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SchedulerName define scheduler name used for group
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.securityContext.addCapabilities
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Capability` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AddCapabilities add new capabilities to containers
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.securityContext.allowPrivilegeEscalation
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AllowPrivilegeEscalation Controls whether a process can gain more privileges than its parent process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.securityContext.dropAllCapabilities
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
DropAllCapabilities specifies if capabilities should be dropped for this pod containers
Deprecated: This field is added for backward compatibility. Will be removed in 1.1.0.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.securityContext.fsGroup
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FSGroup is a special supplemental group that applies to all containers in a pod.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.securityContext.privileged
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Privileged If true, runs container in privileged mode. Processes in privileged containers are
essentially equivalent to root on the host.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.securityContext.readOnlyRootFilesystem
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
ReadOnlyRootFilesystem if true, mounts the container's root filesystem as read-only.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.securityContext.runAsGroup
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsGroup is the GID to run the entrypoint of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.securityContext.runAsNonRoot
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsNonRoot if true, indicates that the container must run as a non-root user.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.securityContext.runAsUser
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsUser is the UID to run the entrypoint of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.securityContext.seccompProfile
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.SeccompProfile` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.
Links:
* [Documentation of core.SeccompProfile](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#seccompprofile-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.securityContext.seLinuxOptions
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.SELinuxOptions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SELinuxOptions are the labels to be applied to the container
Links:
* [Documentation of core.SELinuxOptions](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#selinuxoptions-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.securityContext.supplementalGroups
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SupplementalGroups is a list of groups applied to the first process run in each container, in addition to the container's primary GID,
the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.securityContext.sysctls
[Feature] Expose core.PodSecurityContext Sysctl options (#1360)
2023-07-20 11:25:54 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `map[string]intstr.IntOrString` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77)</sup>
[Feature] Expose core.PodSecurityContext Sysctl options (#1360)
2023-07-20 11:25:54 +00:00
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
sysctls (by the container runtime) might fail to launch.
Map Value can be String or Int
Links:
* [Documentation](https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/)
Example:
```yaml
sysctls:
"kernel.shm_rmid_forced": "0"
"net.core.somaxconn": 1024
"kernel.msgmax": "65536"
```
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.serviceAccountName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
ServiceAccountName setting specifies the `serviceAccountName` for the `Pods` created
for each server of this group. If empty, it defaults to using the
`default` service account.
Using an alternative `ServiceAccount` is typically used to separate access rights.
The ArangoDB deployments need some very minimal access rights. With the
deployment of the operator, we grant the rights to 'get' all 'pod' resources.
If you are using a different service account, please grant these rights
to that service account.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.shutdownDelay
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ShutdownDelay define how long operator should delay finalizer removal after shutdown
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.shutdownMethod
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ShutdownMethod describe procedure of member shutdown taken by Operator
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.sidecarCoreNames
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SidecarCoreNames is a list of sidecar containers which must run in the pod.
Some names (e.g.: "server", "worker") are reserved, and they don't have any impact.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.sidecars
Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Sidecars specifies a list of additional containers to be started
Links:
* [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.storageClassName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
StorageClassName specifies the classname for storage of the servers.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.terminationGracePeriodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.tolerations
Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Tolerations specifies the tolerations added to Pods in this group.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
By default, suitable tolerations are set for the following keys with the `NoExecute` effect:
- `node.kubernetes.io/not-ready`
- `node.kubernetes.io/unreachable`
- `node.alpha.kubernetes.io/unreachable` (will be removed in future version)
For more information on tolerations, consult the https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Links:
* [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.volumeAllowShrink
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Deprecated: VolumeAllowShrink allows shrink the volume
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.volumeClaimTemplate
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.PersistentVolumeClaim` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
VolumeClaimTemplate specifies a volumeClaimTemplate used by operator to create to volume claims for pods of this group.
This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`.
The default value describes a volume with `8Gi` storage, `ReadWriteOnce` access mode and volume mode set to `PersistentVolumeFilesystem`.
If this field is not set and `spec.<group>.resources.requests.storage` is set, then a default volume claim
with size as specified by `spec.<group>.resources.requests.storage` will be created. In that case `storage`
and `iops` is not forwarded to the pods resource requirements.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Links:
* [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.volumeMounts
Type: `[]ServerGroupSpecVolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
VolumeMounts define list of volume mounts mounted into server container
Links:
* [Documentation of ServerGroupSpecVolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volumemount-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.volumes\[int\].configMap
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.ConfigMapVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ConfigMap which should be mounted into pod
Links:
* [Documentation of core.ConfigMapVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#configmapvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.volumes\[int\].emptyDir
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.EmptyDirVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
EmptyDir
Links:
* [Documentation of core.EmptyDirVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#emptydirvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.volumes\[int\].hostPath
Type: `core.HostPathVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
HostPath
Links:
* [Documentation of core.HostPathVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#hostpathvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.volumes\[int\].name
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Name of volume
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.dbservers.volumes\[int\].persistentVolumeClaim
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.PersistentVolumeClaimVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
PersistentVolumeClaim
Links:
* [Documentation of core.PersistentVolumeClaimVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.dbservers.volumes\[int\].secret
Type: `core.SecretVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Secret which should be mounted into pod
Links:
* [Documentation of core.SecretVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#secretvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.disableIPv6
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L109)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
DisableIPv6 setting prevents the use of IPv6 addresses by ArangoDB servers.
This setting cannot be changed after the deployment has been created.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.downtimeAllowed
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L104)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
DowntimeAllowed setting is used to allow automatic reconciliation actions that yield some downtime of the ArangoDB deployment.
When this setting is set to false, no automatic action that may result in downtime is allowed.
If the need for such an action is detected, an event is added to the ArangoDeployment.
Once this setting is set to true, the automatic action is executed.
Operations that may result in downtime are:
- Rotating TLS CA certificate
Note: It is still possible that there is some downtime when the Kubernetes cluster is down, or in a bad state, irrespective of the value of this setting.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.environment
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L65)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
Environment setting specifies the type of environment in which the deployment is created.
Possible Values:
* Development (default) - This value optimizes the deployment for development use. It is possible to run a deployment on a small number of nodes (e.g. minikube).
* Production - This value optimizes the deployment for production use. It puts required affinity constraints on all pods to avoid Agents & DB-Servers from running on the same machine.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.externalAccess.advertisedEndpoint
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L58)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AdvertisedEndpoint is passed to the coordinators/single servers for advertising a specific endpoint
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.externalAccess.loadBalancerIP
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L48)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
LoadBalancerIP define optional IP used to configure a load-balancer on, in case of Auto or LoadBalancer type.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
If you do not specify this setting, an IP will be chosen automatically by the load-balancer provisioner.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.externalAccess.loadBalancerSourceRanges
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L55)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
LoadBalancerSourceRanges define LoadBalancerSourceRanges used for LoadBalancer Service type
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature.
[Docs] Update docs for DeploymentSpec (#1367)
2023-07-27 09:52:16 +00:00
Links:
* [Cloud Provider Firewall](https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/)
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.externalAccess.managedServiceNames
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L62)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ManagedServiceNames keeps names of services which are not managed by KubeArangoDB.
It is only relevant when type of service is `managed`.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.externalAccess.nodePort
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L44)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
NodePort define optional port used in case of Auto or NodePort type.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
This setting is used when `spec.externalAccess.type` is set to `NodePort` or `Auto`.
If you do not specify this setting, a random port will be chosen automatically.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.externalAccess.type
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L39)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
Type specifies the type of Service that will be created to provide access to the ArangoDB deployment from outside the Kubernetes cluster.
[Docs] Update docs for DeploymentSpec (#1367)
2023-07-27 09:52:16 +00:00
Possible Values:
* Auto (default) - Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
* None - limit access to application running inside the Kubernetes cluster.
* LoadBalancer - Create a Service of type LoadBalancer for the ArangoDB deployment.
* NodePort - Create a Service of type NodePort for the ArangoDB deployment.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.features.foxx.queues
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_features.go#L24)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.id.affinity
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.PodAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L44)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Affinity specified additional affinity settings in ArangoDB Pod definitions
Links:
* [Documentation of core.PodAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.id.antiAffinity
Type: `core.PodAntiAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L40)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions
Links:
* [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.id.entrypoint
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L28)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Entrypoint overrides container executable
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.id.nodeAffinity
Type: `core.NodeAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L48)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions
Links:
* [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.id.nodeSelector
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L34)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
NodeSelector specifies a set of selectors for nodes
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.id.priorityClassName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L36)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
PriorityClassName specifies a priority class name
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.id.resources
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L56)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Resources holds resource requests & limits
Links:
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.id.securityContext.addCapabilities
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Capability` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AddCapabilities add new capabilities to containers
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.id.securityContext.allowPrivilegeEscalation
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AllowPrivilegeEscalation Controls whether a process can gain more privileges than its parent process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.id.securityContext.dropAllCapabilities
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
DropAllCapabilities specifies if capabilities should be dropped for this pod containers
Deprecated: This field is added for backward compatibility. Will be removed in 1.1.0.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.id.securityContext.fsGroup
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FSGroup is a special supplemental group that applies to all containers in a pod.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.id.securityContext.privileged
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Privileged If true, runs container in privileged mode. Processes in privileged containers are
essentially equivalent to root on the host.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.id.securityContext.readOnlyRootFilesystem
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
ReadOnlyRootFilesystem if true, mounts the container's root filesystem as read-only.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.id.securityContext.runAsGroup
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsGroup is the GID to run the entrypoint of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.id.securityContext.runAsNonRoot
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsNonRoot if true, indicates that the container must run as a non-root user.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.id.securityContext.runAsUser
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsUser is the UID to run the entrypoint of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.id.securityContext.seccompProfile
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.SeccompProfile` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.
Links:
* [Documentation of core.SeccompProfile](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#seccompprofile-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.id.securityContext.seLinuxOptions
Type: `core.SELinuxOptions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SELinuxOptions are the labels to be applied to the container
Links:
* [Documentation of core.SELinuxOptions](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#selinuxoptions-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.id.securityContext.supplementalGroups
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SupplementalGroups is a list of groups applied to the first process run in each container, in addition to the container's primary GID,
the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.id.securityContext.sysctls
[Feature] Expose core.PodSecurityContext Sysctl options (#1360)
2023-07-20 11:25:54 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `map[string]intstr.IntOrString` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77)</sup>
[Feature] Expose core.PodSecurityContext Sysctl options (#1360)
2023-07-20 11:25:54 +00:00
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
sysctls (by the container runtime) might fail to launch.
Map Value can be String or Int
Links:
* [Documentation](https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/)
Example:
```yaml
sysctls:
"kernel.shm_rmid_forced": "0"
"net.core.somaxconn": 1024
"kernel.msgmax": "65536"
```
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.id.serviceAccountName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L50)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ServiceAccountName specifies the name of the service account used for Pods in this group.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.id.tolerations
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L32)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Tolerations specifies the tolerations added to Pods in this group.
Links:
* [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.image
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L78)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
Image specifies the docker image to use for all ArangoDB servers.
In a development environment this setting defaults to arangodb/arangodb:latest.
For production environments this is a required setting without a default value.
It is highly recommend to use explicit version (not latest) for production environments.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.imageDiscoveryMode
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L94)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add enum type (#1364)
2023-07-24 14:53:50 +00:00
ImageDiscoveryMode specifies the image discovery mode.
Possible Values:
* kubelet (default) - Use sha256 of the discovered image in the pods
* direct - Use image provided in the spec.image directly in the pods
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.imagePullPolicy
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.PullPolicy` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L86)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
ImagePullPolicy specifies the pull policy for the docker image to use for all ArangoDB servers.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
Links:
* [Documentation of core.PullPolicy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy)
Possible Values:
* Always (default) - Means that kubelet always attempts to pull the latest image. Container will fail If the pull fails.
* Never - Means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present
* IfNotPresent - Means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.imagePullSecrets
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L89)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
ImagePullSecrets specifies the list of image pull secrets for the docker image to use for all ArangoDB servers.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.labels
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L138)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
Labels specifies the labels added to Pods in this group.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.labelsIgnoreList
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L141)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
LabelsIgnoreList list regexp or plain definitions which labels should be ignored
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.labelsMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L147)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
LabelsMode Define labels mode which should be use while overriding labels
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
Possible Values:
* disabled (default) - Disable annotations/labels override. Default if there is no annotations/labels set in ArangoDeployment
* append - Add new annotations/labels without affecting old ones
* replace - Replace existing annotations/labels
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.license.secretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/license_spec.go#L33)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SecretName setting specifies the name of a kubernetes `Secret` that contains
the license key token used for enterprise images. This value is not used for
the Community Edition.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.lifecycle.resources
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/lifecycle_spec.go#L31)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Resources holds resource requests & limits
Links:
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.memberPropagationMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L220)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
MemberPropagationMode defines how changes to pod spec should be propogated.
Changes to a pod’s configuration require a restart of that pod in almost all cases.
Pods are restarted eagerly by default, which can cause more restarts than desired, especially when updating arangod as well as the operator.
The propagation of the configuration changes can be deferred to the next restart, either triggered manually by the user or by another operation like an upgrade.
This reduces the number of restarts for upgrading both the server and the operator from two to one.
Possible Values:
* always (default) - Restart the member as soon as a configuration change is discovered
* on-restart - Wait until the next restart to change the member configuration
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.metrics.authentication.jwtTokenSecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L34)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
JWTTokenSecretName contains the name of the JWT kubernetes secret used for authentication
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.metrics.enabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L81)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Enabled if this is set to `true`, the operator runs a sidecar container for
every Agent, DB-Server, Coordinator and Single server.
Links:
* [Metrics collection](/docs/metrics.md)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.metrics.image
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L83)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
deprecated
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.metrics.mode
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L90)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
deprecated
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.metrics.port
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L99)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.metrics.resources
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L88)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Resources holds resource requests & limits
Links:
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.metrics.serviceMonitor.enabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_service_monitor_spec.go#L24)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.metrics.serviceMonitor.labels
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_service_monitor_spec.go#L25)</sup>
***
### .spec.metrics.tls
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L95)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TLS defines if TLS should be enabled on Metrics exporter endpoint.
This option will enable TLS only if TLS is enabled on ArangoDeployment,
otherwise `true` value will not take any effect.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `true`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.mode
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L60)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Doc] Add Immutable fields (#1365)
2023-07-24 16:52:51 +00:00
Mode specifies the type of ArangoDB deployment to create.
Possible Values:
* Cluster (default) - Full cluster. Defaults to 3 Agents, 3 DB-Servers & 3 Coordinators.
* ActiveFailover - Active-failover single pair. Defaults to 3 Agents and 2 single servers.
* Single - Single server only (note this does not provide high availability or reliability).
This field is **immutable**: Change of the ArangoDeployment Mode is not possible after creation.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.networkAttachedVolumes
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L123)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
NetworkAttachedVolumes
If set to `true`, a ResignLeadership operation will be triggered when a DB-Server pod is evicted (rather than a CleanOutServer operation).
Furthermore, the pod will simply be redeployed on a different node, rather than cleaned and retired and replaced by a new member.
You must only set this option to true if your persistent volumes are “movable” in the sense that they can be mounted from a different k8s node, like in the case of network attached volumes.
If your persistent volumes are tied to a specific pod, you must leave this option on false.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `true`
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.rebalancer.enabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/rebalancer_spec.go#L26)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.rebalancer.optimizers.leader
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/rebalancer_spec.go#L74)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.rebalancer.parallelMoves
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/rebalancer_spec.go#L28)</sup>
***
### .spec.rebalancer.readers.count
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/rebalancer_spec.go#L62)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
deprecated does not work in Rebalancer V2
Count Enable Shard Count machanism
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.recovery.autoRecover
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/recovery_spec.go#L26)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.restoreEncryptionSecret
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L160)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
RestoreEncryptionSecret specifies optional name of secret which contains encryption key used for restore
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.restoreFrom
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L157)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
RestoreFrom setting specifies a `ArangoBackup` resource name the cluster should be restored from.
After a restore or failure to do so, the status of the deployment contains information about the restore operation in the restore key.
It will contain some of the following fields:
- `requestedFrom`: name of the ArangoBackup used to restore from.
- `message`: optional message explaining why the restore failed.
- `state`: state indicating if the restore was successful or not. Possible values: Restoring, Restored, RestoreFailed
If the restoreFrom key is removed from the spec, the restore key is deleted as well.
A new restore attempt is made if and only if either in the status restore is not set or if spec.restoreFrom and status.requestedFrom are different.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.rocksdb.encryption.keySecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/rocksdb_spec.go#L37)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
KeySecretName setting specifies the name of a Kubernetes `Secret` that contains an encryption key used for encrypting all data stored by ArangoDB servers.
When an encryption key is used, encryption of the data in the cluster is enabled, without it encryption is disabled.
The default value is empty.
This requires the Enterprise Edition.
The encryption key cannot be changed after the cluster has been created.
The secret specified by this setting, must have a data field named 'key' containing an encryption key that is exactly 32 bytes long.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.affinity
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.PodAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Affinity specified additional affinity settings in ArangoDB Pod definitions
Links:
* [Documentation of core.PodAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.allowMemberRecreation
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AllowMemberRecreation allows to recreate member.
This setting changes the member recreation logic based on group:
- For Sync Masters, Sync Workers, Coordinator and DB-Servers it determines if a member can be recreated in case of failure (default `true`)
- For Agents and Single this value is hardcoded to `false` and the value provided in spec is ignored.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.annotations
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Annotations specified the annotations added to Pods in this group.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Annotations are merged with `spec.annotations`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.annotationsIgnoreList
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.annotationsMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AnnotationsMode Define annotations mode which should be use while overriding annotations
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.antiAffinity
Type: `core.PodAntiAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions
Links:
* [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.args
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Args setting specifies additional command-line arguments passed to all servers of this group.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `[]`
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.count
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Count setting specifies the number of servers to start for the given group.
For the Agent group, this value must be a positive, odd number.
The default value is `3` for all groups except `single` (there the default is `1`
for `spec.mode: Single` and `2` for `spec.mode: ActiveFailover`).
For the `syncworkers` group, it is highly recommended to use the same number
as for the `dbservers` group.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.entrypoint
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Entrypoint overrides container executable
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.envs\[int\].name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.envs\[int\].value
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.ephemeralVolumes.apps.size
Type: `resource.Quantity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Size define size of the ephemeral volume
Links:
* [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.ephemeralVolumes.temp.size
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `resource.Quantity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Size define size of the ephemeral volume
Links:
* [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.exporterPort
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExporterPort define Port used by exporter
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.extendedRotationCheck
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExtendedRotationCheck extend checks for rotation
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.externalPortEnabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExternalPortEnabled if external port should be enabled. If is set to false, ports needs to be exposed via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.indexMethod
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
IndexMethod define group Indexing method
[Feature] Add IndexMethod docs (#1437)
2023-10-12 14:37:40 +00:00
Possible Values:
* random (default) - Pick random ID for member. Enforced on the Community Operator.
* ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.initContainers.containers
Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Containers contains list of containers
Links:
* [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.initContainers.mode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Mode keep container replace mode
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.internalPort
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.internalPortProtocol
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.labels
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Labels specified the labels added to Pods in this group.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.labelsIgnoreList
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
LabelsIgnoreList list regexp or plain definitions which labels should be ignored
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.labelsMode
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
LabelsMode Define labels mode which should be use while overriding labels
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.maxCount
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
MaxCount specifies a maximum for the count of servers. If set, a specification is invalid if `count > maxCount`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.memoryReservation
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107)</sup>
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
[Feature] Extract CalculateMemoryReservation function into ArangoDeployment Group Spec (#1472)
2023-11-06 08:16:38 +00:00
MemoryReservation determines the system reservation of memory while calculating `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` value.
If this field is set, `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` is reduced by a specified value in percent.
Accepted Range <0, 50>. If the value is outside the accepted range, it is adjusted to the closest value.
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `0`
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.minCount
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
MinCount specifies a minimum for the count of servers. If set, a specification is invalid if `count < minCount`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.nodeAffinity
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.NodeAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions
Links:
* [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.nodeSelector
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `map[string]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
NodeSelector setting specifies a set of labels to be used as `nodeSelector` for Pods of this node.
Links:
* [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/)
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.numactl.args
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Args define list of the numactl process
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `[]`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.numactl.enabled
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Enabled define if numactl should be enabled
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.numactl.path
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Path define numactl path within the container
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `/usr/bin/numactl`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.overrideDetectedNumberOfCores
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
OverrideDetectedNumberOfCores determines if number of cores should be overridden based on values in resources.
If is set to true and Container CPU Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` to the value from the Container CPU Limits.
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `true`
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.overrideDetectedTotalMemory
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
OverrideDetectedTotalMemory determines if memory should be overridden based on values in resources.
If is set to true and Container Memory Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` to the value from the Container Memory Limits.
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `true`
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.podModes.network
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.podModes.pid
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.port
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Port define Port used by member
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.priorityClassName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
PriorityClassName specifies a priority class name
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Will be forwarded to the pod spec.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Links:
* [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.probes.livenessProbeDisabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
LivenessProbeDisabled if set to true, the operator does not generate a liveness probe for new pods belonging to this group
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.probes.livenessProbeSpec.failureThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.probes.livenessProbeSpec.initialDelaySeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.probes.livenessProbeSpec.periodSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.probes.livenessProbeSpec.successThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.probes.livenessProbeSpec.timeoutSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.probes.ReadinessProbeDisabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
OldReadinessProbeDisabled if true readinessProbes are disabled
Fail CircleCI build if there are changes after running generators (#1489)
2023-11-15 13:11:11 +00:00
Deprecated: This field is deprecated, kept only for backward compatibility.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.probes.readinessProbeDisabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.probes.readinessProbeSpec.failureThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.probes.readinessProbeSpec.initialDelaySeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.probes.readinessProbeSpec.periodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.probes.readinessProbeSpec.successThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.probes.readinessProbeSpec.timeoutSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.probes.startupProbeDisabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
StartupProbeDisabled if true startupProbes are disabled
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.probes.startupProbeSpec.failureThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.probes.startupProbeSpec.initialDelaySeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.probes.startupProbeSpec.periodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.probes.startupProbeSpec.successThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.probes.startupProbeSpec.timeoutSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.pvcResizeMode
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
VolumeResizeMode specified resize mode for PVCs and PVs
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Possible Values:
* runtime (default) - PVC will be resized in Pod runtime (EKS, GKE)
* rotate - Pod will be shutdown and PVC will be resized (AKS)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.resources
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Resources holds resource requests & limits
Links:
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.schedulerName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SchedulerName define scheduler name used for group
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.securityContext.addCapabilities
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Capability` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AddCapabilities add new capabilities to containers
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.securityContext.allowPrivilegeEscalation
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AllowPrivilegeEscalation Controls whether a process can gain more privileges than its parent process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.securityContext.dropAllCapabilities
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
DropAllCapabilities specifies if capabilities should be dropped for this pod containers
Deprecated: This field is added for backward compatibility. Will be removed in 1.1.0.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.securityContext.fsGroup
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FSGroup is a special supplemental group that applies to all containers in a pod.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.securityContext.privileged
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Privileged If true, runs container in privileged mode. Processes in privileged containers are
essentially equivalent to root on the host.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.securityContext.readOnlyRootFilesystem
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
ReadOnlyRootFilesystem if true, mounts the container's root filesystem as read-only.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.securityContext.runAsGroup
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsGroup is the GID to run the entrypoint of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.securityContext.runAsNonRoot
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsNonRoot if true, indicates that the container must run as a non-root user.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.securityContext.runAsUser
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsUser is the UID to run the entrypoint of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.securityContext.seccompProfile
Type: `core.SeccompProfile` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.
Links:
* [Documentation of core.SeccompProfile](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#seccompprofile-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.securityContext.seLinuxOptions
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.SELinuxOptions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SELinuxOptions are the labels to be applied to the container
Links:
* [Documentation of core.SELinuxOptions](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#selinuxoptions-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.securityContext.supplementalGroups
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SupplementalGroups is a list of groups applied to the first process run in each container, in addition to the container's primary GID,
the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.securityContext.sysctls
[Feature] Expose core.PodSecurityContext Sysctl options (#1360)
2023-07-20 11:25:54 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `map[string]intstr.IntOrString` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77)</sup>
[Feature] Expose core.PodSecurityContext Sysctl options (#1360)
2023-07-20 11:25:54 +00:00
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
sysctls (by the container runtime) might fail to launch.
Map Value can be String or Int
Links:
* [Documentation](https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/)
Example:
```yaml
sysctls:
"kernel.shm_rmid_forced": "0"
"net.core.somaxconn": 1024
"kernel.msgmax": "65536"
```
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.serviceAccountName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
ServiceAccountName setting specifies the `serviceAccountName` for the `Pods` created
for each server of this group. If empty, it defaults to using the
`default` service account.
Using an alternative `ServiceAccount` is typically used to separate access rights.
The ArangoDB deployments need some very minimal access rights. With the
deployment of the operator, we grant the rights to 'get' all 'pod' resources.
If you are using a different service account, please grant these rights
to that service account.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.shutdownDelay
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ShutdownDelay define how long operator should delay finalizer removal after shutdown
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.shutdownMethod
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ShutdownMethod describe procedure of member shutdown taken by Operator
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.sidecarCoreNames
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SidecarCoreNames is a list of sidecar containers which must run in the pod.
Some names (e.g.: "server", "worker") are reserved, and they don't have any impact.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.sidecars
Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Sidecars specifies a list of additional containers to be started
Links:
* [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.storageClassName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
StorageClassName specifies the classname for storage of the servers.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.terminationGracePeriodSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.tolerations
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Tolerations specifies the tolerations added to Pods in this group.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
By default, suitable tolerations are set for the following keys with the `NoExecute` effect:
- `node.kubernetes.io/not-ready`
- `node.kubernetes.io/unreachable`
- `node.alpha.kubernetes.io/unreachable` (will be removed in future version)
For more information on tolerations, consult the https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Links:
* [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.volumeAllowShrink
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Deprecated: VolumeAllowShrink allows shrink the volume
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.volumeClaimTemplate
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.PersistentVolumeClaim` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
VolumeClaimTemplate specifies a volumeClaimTemplate used by operator to create to volume claims for pods of this group.
This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`.
The default value describes a volume with `8Gi` storage, `ReadWriteOnce` access mode and volume mode set to `PersistentVolumeFilesystem`.
If this field is not set and `spec.<group>.resources.requests.storage` is set, then a default volume claim
with size as specified by `spec.<group>.resources.requests.storage` will be created. In that case `storage`
and `iops` is not forwarded to the pods resource requirements.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Links:
* [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.volumeMounts
Type: `[]ServerGroupSpecVolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
VolumeMounts define list of volume mounts mounted into server container
Links:
* [Documentation of ServerGroupSpecVolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volumemount-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.volumes\[int\].configMap
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.ConfigMapVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ConfigMap which should be mounted into pod
Links:
* [Documentation of core.ConfigMapVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#configmapvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.volumes\[int\].emptyDir
Type: `core.EmptyDirVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
EmptyDir
Links:
* [Documentation of core.EmptyDirVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#emptydirvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.volumes\[int\].hostPath
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.HostPathVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
HostPath
Links:
* [Documentation of core.HostPathVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#hostpathvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.volumes\[int\].name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Name of volume
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.single.volumes\[int\].persistentVolumeClaim
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.PersistentVolumeClaimVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
PersistentVolumeClaim
Links:
* [Documentation of core.PersistentVolumeClaimVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.single.volumes\[int\].secret
Type: `core.SecretVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Secret which should be mounted into pod
Links:
* [Documentation of core.SecretVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#secretvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.storageEngine
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L72)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
StorageEngine specifies the type of storage engine used for all servers in the cluster.
Possible Values:
* RocksDB (default) - To use the RocksDB storage engine.
* MMFiles - To use the MMFiles storage engine. Deprecated.
(Documentation) Update ArangoBackup and ArangoBackupPolicy CR auto-generated docs (#1452) * (Documentation) Update ArangoBackup and ArangoBackupPolicy CR auto-generated docs * Sort keys before printing sections, do not use maps package
2023-10-20 10:25:30 +00:00
This field is **immutable**: This setting cannot be changed after the cluster has been created.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.sync.auth.clientCASecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_authentication_spec.go#L41)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
ClientCASecretName setting specifies the name of a kubernetes `Secret` that contains
a PEM encoded CA certificate used for client certificate verification
in all ArangoSync master servers.
This is a required setting when `spec.sync.enabled` is `true`.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.sync.auth.jwtSecretName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_authentication_spec.go#L36)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
JWTSecretName setting specifies the name of a kubernetes `Secret` that contains
the JWT token used for accessing all ArangoSync master servers.
When not specified, the `spec.auth.jwtSecretName` value is used.
If you specify a name of a `Secret` that does not exist, a random token is created
and stored in a `Secret` with given name.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.sync.enabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_spec.go#L34)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Enabled setting enables/disables support for data center 2 data center
replication in the cluster. When enabled, the cluster will contain
a number of `syncmaster` & `syncworker` servers.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.sync.externalAccess.accessPackageSecretNames
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_external_access_spec.go#L49)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AccessPackageSecretNames setting specifies the names of zero of more `Secrets` that will be created by the deployment
operator containing "access packages". An access package contains those `Secrets` that are needed
to access the SyncMasters of this `ArangoDeployment`.
By removing a name from this setting, the corresponding `Secret` is also deleted.
Note that to remove all access packages, leave an empty array in place (`[]`).
Completely removing the setting results in not modifying the list.
Links:
* [See the ArangoDeploymentReplication specification](deployment-replication-resource-reference.md)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.sync.externalAccess.advertisedEndpoint
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L58)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AdvertisedEndpoint is passed to the coordinators/single servers for advertising a specific endpoint
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.sync.externalAccess.loadBalancerIP
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L48)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
LoadBalancerIP define optional IP used to configure a load-balancer on, in case of Auto or LoadBalancer type.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
If you do not specify this setting, an IP will be chosen automatically by the load-balancer provisioner.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.sync.externalAccess.loadBalancerSourceRanges
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L55)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
LoadBalancerSourceRanges define LoadBalancerSourceRanges used for LoadBalancer Service type
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature.
[Docs] Update docs for DeploymentSpec (#1367)
2023-07-27 09:52:16 +00:00
Links:
* [Cloud Provider Firewall](https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/)
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.sync.externalAccess.managedServiceNames
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L62)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ManagedServiceNames keeps names of services which are not managed by KubeArangoDB.
It is only relevant when type of service is `managed`.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.sync.externalAccess.masterEndpoint
Type: `[]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_external_access_spec.go#L40)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
MasterEndpoint setting specifies the master endpoint(s) advertised by the ArangoSync SyncMasters.
If not set, this setting defaults to:
- If `spec.sync.externalAccess.loadBalancerIP` is set, it defaults to `https://<load-balancer-ip>:<8629>`.
- Otherwise it defaults to `https://<sync-service-dns-name>:<8629>`.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.sync.externalAccess.nodePort
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L44)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
NodePort define optional port used in case of Auto or NodePort type.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
This setting is used when `spec.externalAccess.type` is set to `NodePort` or `Auto`.
If you do not specify this setting, a random port will be chosen automatically.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.sync.externalAccess.type
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L39)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
Type specifies the type of Service that will be created to provide access to the ArangoDB deployment from outside the Kubernetes cluster.
[Docs] Update docs for DeploymentSpec (#1367)
2023-07-27 09:52:16 +00:00
Possible Values:
* Auto (default) - Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
* None - limit access to application running inside the Kubernetes cluster.
* LoadBalancer - Create a Service of type LoadBalancer for the ArangoDB deployment.
* NodePort - Create a Service of type NodePort for the ArangoDB deployment.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.sync.image
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_spec.go#L40)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.sync.monitoring.tokenSecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_monitoring_spec.go#L34)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TokenSecretName setting specifies the name of a kubernetes `Secret` that contains
the bearer token used for accessing all monitoring endpoints of all arangod/arangosync servers.
When not specified, no monitoring token is used.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.sync.tls.altNames
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L72)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AltNames setting specifies a list of alternate names that will be added to all generated
certificates. These names can be DNS names or email addresses.
The default value is empty.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.sync.tls.caSecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L67)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
CASecretName setting specifies the name of a kubernetes `Secret` that contains
a standard CA certificate + private key used to sign certificates for individual
ArangoDB servers.
When no name is specified, it defaults to `<deployment-name>-ca`.
To disable authentication, set this value to `None`.
If you specify a name of a `Secret` that does not exist, a self-signed CA certificate + key is created
and stored in a `Secret` with given name.
The specified `Secret`, must contain the following data fields:
- `ca.crt` PEM encoded public key of the CA certificate
- `ca.key` PEM encoded private key of the CA certificate
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.sync.tls.mode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L81)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.sync.tls.sni.mapping.\<string\>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_sni_spec.go#L30)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.sync.tls.ttl
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L79)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TTL setting specifies the time to live of all generated server certificates.
When the server certificate is about to expire, it will be automatically replaced
by a new one and the affected server will be restarted.
Note: The time to live of the CA certificate (when created automatically)
will be set to 10 years.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `"2160h" (about 3 months)`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.affinity
Type: `core.PodAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Affinity specified additional affinity settings in ArangoDB Pod definitions
Links:
* [Documentation of core.PodAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.allowMemberRecreation
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AllowMemberRecreation allows to recreate member.
This setting changes the member recreation logic based on group:
- For Sync Masters, Sync Workers, Coordinator and DB-Servers it determines if a member can be recreated in case of failure (default `true`)
- For Agents and Single this value is hardcoded to `false` and the value provided in spec is ignored.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.annotations
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Annotations specified the annotations added to Pods in this group.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Annotations are merged with `spec.annotations`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.annotationsIgnoreList
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.annotationsMode
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AnnotationsMode Define annotations mode which should be use while overriding annotations
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.antiAffinity
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.PodAntiAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions
Links:
* [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.args
Type: `[]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Args setting specifies additional command-line arguments passed to all servers of this group.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `[]`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.count
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Count setting specifies the number of servers to start for the given group.
For the Agent group, this value must be a positive, odd number.
The default value is `3` for all groups except `single` (there the default is `1`
for `spec.mode: Single` and `2` for `spec.mode: ActiveFailover`).
For the `syncworkers` group, it is highly recommended to use the same number
as for the `dbservers` group.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.entrypoint
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Entrypoint overrides container executable
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.envs\[int\].name
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.envs\[int\].value
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.ephemeralVolumes.apps.size
Type: `resource.Quantity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Size define size of the ephemeral volume
Links:
* [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.ephemeralVolumes.temp.size
Type: `resource.Quantity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Size define size of the ephemeral volume
Links:
* [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.exporterPort
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExporterPort define Port used by exporter
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.extendedRotationCheck
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExtendedRotationCheck extend checks for rotation
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.externalPortEnabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExternalPortEnabled if external port should be enabled. If is set to false, ports needs to be exposed via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.indexMethod
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
IndexMethod define group Indexing method
[Feature] Add IndexMethod docs (#1437)
2023-10-12 14:37:40 +00:00
Possible Values:
* random (default) - Pick random ID for member. Enforced on the Community Operator.
* ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.initContainers.containers
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Containers contains list of containers
Links:
* [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.initContainers.mode
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Mode keep container replace mode
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.internalPort
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.internalPortProtocol
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.labels
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Labels specified the labels added to Pods in this group.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.labelsIgnoreList
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
LabelsIgnoreList list regexp or plain definitions which labels should be ignored
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.labelsMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
LabelsMode Define labels mode which should be use while overriding labels
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.maxCount
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
MaxCount specifies a maximum for the count of servers. If set, a specification is invalid if `count > maxCount`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.memoryReservation
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107)</sup>
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
[Feature] Extract CalculateMemoryReservation function into ArangoDeployment Group Spec (#1472)
2023-11-06 08:16:38 +00:00
MemoryReservation determines the system reservation of memory while calculating `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` value.
If this field is set, `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` is reduced by a specified value in percent.
Accepted Range <0, 50>. If the value is outside the accepted range, it is adjusted to the closest value.
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `0`
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.minCount
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
MinCount specifies a minimum for the count of servers. If set, a specification is invalid if `count < minCount`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.nodeAffinity
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.NodeAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions
Links:
* [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.nodeSelector
Type: `map[string]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
NodeSelector setting specifies a set of labels to be used as `nodeSelector` for Pods of this node.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Links:
* [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.numactl.args
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Args define list of the numactl process
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `[]`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.numactl.enabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Enabled define if numactl should be enabled
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.numactl.path
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Path define numactl path within the container
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `/usr/bin/numactl`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.overrideDetectedNumberOfCores
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable
OverrideDetectedNumberOfCores determines if number of cores should be overridden based on values in resources.
If is set to true and Container CPU Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` to the value from the Container CPU Limits.
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `true`
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.overrideDetectedTotalMemory
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable
OverrideDetectedTotalMemory determines if memory should be overridden based on values in resources.
If is set to true and Container Memory Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` to the value from the Container Memory Limits.
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `true`
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.podModes.network
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.podModes.pid
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32)</sup>
***
### .spec.syncmasters.port
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Port define Port used by member
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.priorityClassName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
PriorityClassName specifies a priority class name
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Will be forwarded to the pod spec.
Links:
* [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/)
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.probes.livenessProbeDisabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
LivenessProbeDisabled if set to true, the operator does not generate a liveness probe for new pods belonging to this group
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.probes.livenessProbeSpec.failureThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.probes.livenessProbeSpec.initialDelaySeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.probes.livenessProbeSpec.periodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.probes.livenessProbeSpec.successThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.probes.livenessProbeSpec.timeoutSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.probes.ReadinessProbeDisabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
OldReadinessProbeDisabled if true readinessProbes are disabled
Fail CircleCI build if there are changes after running generators (#1489)
2023-11-15 13:11:11 +00:00
Deprecated: This field is deprecated, kept only for backward compatibility.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.probes.readinessProbeDisabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.probes.readinessProbeSpec.failureThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.probes.readinessProbeSpec.initialDelaySeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.probes.readinessProbeSpec.periodSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.probes.readinessProbeSpec.successThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.probes.readinessProbeSpec.timeoutSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.probes.startupProbeDisabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
StartupProbeDisabled if true startupProbes are disabled
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.probes.startupProbeSpec.failureThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.probes.startupProbeSpec.initialDelaySeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.probes.startupProbeSpec.periodSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.probes.startupProbeSpec.successThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.probes.startupProbeSpec.timeoutSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.pvcResizeMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
VolumeResizeMode specified resize mode for PVCs and PVs
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Possible Values:
* runtime (default) - PVC will be resized in Pod runtime (EKS, GKE)
* rotate - Pod will be shutdown and PVC will be resized (AKS)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.resources
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Resources holds resource requests & limits
Links:
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.schedulerName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SchedulerName define scheduler name used for group
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.securityContext.addCapabilities
Type: `[]core.Capability` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AddCapabilities add new capabilities to containers
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.securityContext.allowPrivilegeEscalation
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AllowPrivilegeEscalation Controls whether a process can gain more privileges than its parent process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.securityContext.dropAllCapabilities
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
DropAllCapabilities specifies if capabilities should be dropped for this pod containers
Deprecated: This field is added for backward compatibility. Will be removed in 1.1.0.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.securityContext.fsGroup
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FSGroup is a special supplemental group that applies to all containers in a pod.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.securityContext.privileged
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Privileged If true, runs container in privileged mode. Processes in privileged containers are
essentially equivalent to root on the host.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.securityContext.readOnlyRootFilesystem
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
ReadOnlyRootFilesystem if true, mounts the container's root filesystem as read-only.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.securityContext.runAsGroup
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsGroup is the GID to run the entrypoint of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.securityContext.runAsNonRoot
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsNonRoot if true, indicates that the container must run as a non-root user.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.securityContext.runAsUser
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsUser is the UID to run the entrypoint of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.securityContext.seccompProfile
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.SeccompProfile` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.
Links:
* [Documentation of core.SeccompProfile](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#seccompprofile-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.securityContext.seLinuxOptions
Type: `core.SELinuxOptions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SELinuxOptions are the labels to be applied to the container
Links:
* [Documentation of core.SELinuxOptions](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#selinuxoptions-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.securityContext.supplementalGroups
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SupplementalGroups is a list of groups applied to the first process run in each container, in addition to the container's primary GID,
the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Expose core.PodSecurityContext Sysctl options (#1360)
2023-07-20 11:25:54 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.securityContext.sysctls
Type: `map[string]intstr.IntOrString` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77)</sup>
[Feature] Expose core.PodSecurityContext Sysctl options (#1360)
2023-07-20 11:25:54 +00:00
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
sysctls (by the container runtime) might fail to launch.
Map Value can be String or Int
Links:
* [Documentation](https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/)
Example:
```yaml
sysctls:
"kernel.shm_rmid_forced": "0"
"net.core.somaxconn": 1024
"kernel.msgmax": "65536"
```
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.serviceAccountName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
ServiceAccountName setting specifies the `serviceAccountName` for the `Pods` created
for each server of this group. If empty, it defaults to using the
`default` service account.
Using an alternative `ServiceAccount` is typically used to separate access rights.
The ArangoDB deployments need some very minimal access rights. With the
deployment of the operator, we grant the rights to 'get' all 'pod' resources.
If you are using a different service account, please grant these rights
to that service account.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.shutdownDelay
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ShutdownDelay define how long operator should delay finalizer removal after shutdown
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.shutdownMethod
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ShutdownMethod describe procedure of member shutdown taken by Operator
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.sidecarCoreNames
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SidecarCoreNames is a list of sidecar containers which must run in the pod.
Some names (e.g.: "server", "worker") are reserved, and they don't have any impact.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.sidecars
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Sidecars specifies a list of additional containers to be started
Links:
* [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.storageClassName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
StorageClassName specifies the classname for storage of the servers.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.terminationGracePeriodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.tolerations
Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Tolerations specifies the tolerations added to Pods in this group.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
By default, suitable tolerations are set for the following keys with the `NoExecute` effect:
- `node.kubernetes.io/not-ready`
- `node.kubernetes.io/unreachable`
- `node.alpha.kubernetes.io/unreachable` (will be removed in future version)
For more information on tolerations, consult the https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Links:
* [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.volumeAllowShrink
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Deprecated: VolumeAllowShrink allows shrink the volume
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.volumeClaimTemplate
Type: `core.PersistentVolumeClaim` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
VolumeClaimTemplate specifies a volumeClaimTemplate used by operator to create to volume claims for pods of this group.
This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`.
The default value describes a volume with `8Gi` storage, `ReadWriteOnce` access mode and volume mode set to `PersistentVolumeFilesystem`.
If this field is not set and `spec.<group>.resources.requests.storage` is set, then a default volume claim
with size as specified by `spec.<group>.resources.requests.storage` will be created. In that case `storage`
and `iops` is not forwarded to the pods resource requirements.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Links:
* [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.volumeMounts
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]ServerGroupSpecVolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
VolumeMounts define list of volume mounts mounted into server container
Links:
* [Documentation of ServerGroupSpecVolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volumemount-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.volumes\[int\].configMap
Type: `core.ConfigMapVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ConfigMap which should be mounted into pod
Links:
* [Documentation of core.ConfigMapVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#configmapvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.volumes\[int\].emptyDir
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.EmptyDirVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
EmptyDir
Links:
* [Documentation of core.EmptyDirVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#emptydirvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.volumes\[int\].hostPath
Type: `core.HostPathVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
HostPath
Links:
* [Documentation of core.HostPathVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#hostpathvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.volumes\[int\].name
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Name of volume
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncmasters.volumes\[int\].persistentVolumeClaim
Type: `core.PersistentVolumeClaimVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
PersistentVolumeClaim
Links:
* [Documentation of core.PersistentVolumeClaimVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncmasters.volumes\[int\].secret
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.SecretVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Secret which should be mounted into pod
Links:
* [Documentation of core.SecretVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#secretvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.affinity
Type: `core.PodAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Affinity specified additional affinity settings in ArangoDB Pod definitions
Links:
* [Documentation of core.PodAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.allowMemberRecreation
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AllowMemberRecreation allows to recreate member.
This setting changes the member recreation logic based on group:
- For Sync Masters, Sync Workers, Coordinator and DB-Servers it determines if a member can be recreated in case of failure (default `true`)
- For Agents and Single this value is hardcoded to `false` and the value provided in spec is ignored.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.annotations
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Annotations specified the annotations added to Pods in this group.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Annotations are merged with `spec.annotations`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.annotationsIgnoreList
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.annotationsMode
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AnnotationsMode Define annotations mode which should be use while overriding annotations
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.antiAffinity
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.PodAntiAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions
Links:
* [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.args
Type: `[]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Args setting specifies additional command-line arguments passed to all servers of this group.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `[]`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.count
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Count setting specifies the number of servers to start for the given group.
For the Agent group, this value must be a positive, odd number.
The default value is `3` for all groups except `single` (there the default is `1`
for `spec.mode: Single` and `2` for `spec.mode: ActiveFailover`).
For the `syncworkers` group, it is highly recommended to use the same number
as for the `dbservers` group.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.entrypoint
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Entrypoint overrides container executable
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.envs\[int\].name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26)</sup>
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.envs\[int\].value
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.ephemeralVolumes.apps.size
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `resource.Quantity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Size define size of the ephemeral volume
Links:
* [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.ephemeralVolumes.temp.size
Type: `resource.Quantity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Size define size of the ephemeral volume
Links:
* [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.exporterPort
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExporterPort define Port used by exporter
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.extendedRotationCheck
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExtendedRotationCheck extend checks for rotation
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.externalPortEnabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ExternalPortEnabled if external port should be enabled. If is set to false, ports needs to be exposed via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.indexMethod
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
IndexMethod define group Indexing method
[Feature] Add IndexMethod docs (#1437)
2023-10-12 14:37:40 +00:00
Possible Values:
* random (default) - Pick random ID for member. Enforced on the Community Operator.
* ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.initContainers.containers
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Containers contains list of containers
Links:
* [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.initContainers.mode
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Mode keep container replace mode
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.internalPort
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.internalPortProtocol
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.labels
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Labels specified the labels added to Pods in this group.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.labelsIgnoreList
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
LabelsIgnoreList list regexp or plain definitions which labels should be ignored
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.labelsMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
LabelsMode Define labels mode which should be use while overriding labels
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.maxCount
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
MaxCount specifies a maximum for the count of servers. If set, a specification is invalid if `count > maxCount`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.memoryReservation
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107)</sup>
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
[Feature] Extract CalculateMemoryReservation function into ArangoDeployment Group Spec (#1472)
2023-11-06 08:16:38 +00:00
MemoryReservation determines the system reservation of memory while calculating `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` value.
If this field is set, `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` is reduced by a specified value in percent.
Accepted Range <0, 50>. If the value is outside the accepted range, it is adjusted to the closest value.
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `0`
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Member Memory Reservation (#1453)
2023-10-20 13:24:06 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.minCount
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
MinCount specifies a minimum for the count of servers. If set, a specification is invalid if `count < minCount`.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.nodeAffinity
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.NodeAffinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions
Links:
* [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.nodeSelector
Type: `map[string]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
NodeSelector setting specifies a set of labels to be used as `nodeSelector` for Pods of this node.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Links:
* [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.numactl.args
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Args define list of the numactl process
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `[]`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.numactl.enabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Enabled define if numactl should be enabled
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.numactl.path
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34)</sup>
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
Path define numactl path within the container
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `/usr/bin/numactl`
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Numactl Options (#1368)
2023-07-28 08:00:57 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.overrideDetectedNumberOfCores
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
OverrideDetectedNumberOfCores determines if number of cores should be overridden based on values in resources.
If is set to true and Container CPU Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` to the value from the Container CPU Limits.
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `true`
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.overrideDetectedTotalMemory
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Documentation] Improve Member Memory docs (#1449)
2023-10-19 09:41:10 +00:00
**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable
OverrideDetectedTotalMemory determines if memory should be overridden based on values in resources.
If is set to true and Container Memory Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` to the value from the Container Memory Limits.
Links:
* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/)
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `true`
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.podModes.network
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.podModes.pid
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.port
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Port define Port used by member
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.priorityClassName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
PriorityClassName specifies a priority class name
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Will be forwarded to the pod spec.
Links:
* [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/)
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.probes.livenessProbeDisabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
LivenessProbeDisabled if set to true, the operator does not generate a liveness probe for new pods belonging to this group
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.probes.livenessProbeSpec.failureThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.probes.livenessProbeSpec.initialDelaySeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.probes.livenessProbeSpec.periodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.probes.livenessProbeSpec.successThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.probes.livenessProbeSpec.timeoutSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.probes.ReadinessProbeDisabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
OldReadinessProbeDisabled if true readinessProbes are disabled
Fail CircleCI build if there are changes after running generators (#1489)
2023-11-15 13:11:11 +00:00
Deprecated: This field is deprecated, kept only for backward compatibility.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.probes.readinessProbeDisabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.probes.readinessProbeSpec.failureThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.probes.readinessProbeSpec.initialDelaySeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.probes.readinessProbeSpec.periodSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.probes.readinessProbeSpec.successThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.probes.readinessProbeSpec.timeoutSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.probes.startupProbeDisabled
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
StartupProbeDisabled if true startupProbes are disabled
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.probes.startupProbeSpec.failureThreshold
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up.
Giving up means restarting the container.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `3`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.probes.startupProbeSpec.initialDelaySeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated.
Minimum value is 0.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.probes.startupProbeSpec.periodSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
PeriodSeconds How often (in seconds) to perform the probe.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `10`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.probes.startupProbeSpec.successThreshold
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `1`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.probes.startupProbeSpec.timeoutSeconds
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TimeoutSeconds specifies number of seconds after which the probe times out
Minimum value is 1.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `2`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.pvcResizeMode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
VolumeResizeMode specified resize mode for PVCs and PVs
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Possible Values:
* runtime (default) - PVC will be resized in Pod runtime (EKS, GKE)
* rotate - Pod will be shutdown and PVC will be resized (AKS)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.resources
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Resources holds resource requests & limits
Links:
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.schedulerName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SchedulerName define scheduler name used for group
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.securityContext.addCapabilities
Type: `[]core.Capability` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
AddCapabilities add new capabilities to containers
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.securityContext.allowPrivilegeEscalation
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AllowPrivilegeEscalation Controls whether a process can gain more privileges than its parent process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.securityContext.dropAllCapabilities
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
DropAllCapabilities specifies if capabilities should be dropped for this pod containers
Deprecated: This field is added for backward compatibility. Will be removed in 1.1.0.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.securityContext.fsGroup
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
FSGroup is a special supplemental group that applies to all containers in a pod.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.securityContext.privileged
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
Privileged If true, runs container in privileged mode. Processes in privileged containers are
essentially equivalent to root on the host.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.securityContext.readOnlyRootFilesystem
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
ReadOnlyRootFilesystem if true, mounts the container's root filesystem as read-only.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.securityContext.runAsGroup
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsGroup is the GID to run the entrypoint of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.securityContext.runAsNonRoot
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsNonRoot if true, indicates that the container must run as a non-root user.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.securityContext.runAsUser
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
RunAsUser is the UID to run the entrypoint of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.securityContext.seccompProfile
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.SeccompProfile` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.
Links:
* [Documentation of core.SeccompProfile](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#seccompprofile-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.securityContext.seLinuxOptions
Type: `core.SELinuxOptions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SELinuxOptions are the labels to be applied to the container
Links:
* [Documentation of core.SELinuxOptions](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#selinuxoptions-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.securityContext.supplementalGroups
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
SupplementalGroups is a list of groups applied to the first process run in each container, in addition to the container's primary GID,
the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Expose core.PodSecurityContext Sysctl options (#1360)
2023-07-20 11:25:54 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.securityContext.sysctls
Type: `map[string]intstr.IntOrString` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77)</sup>
[Feature] Expose core.PodSecurityContext Sysctl options (#1360)
2023-07-20 11:25:54 +00:00
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
sysctls (by the container runtime) might fail to launch.
Map Value can be String or Int
Links:
* [Documentation](https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/)
Example:
```yaml
sysctls:
"kernel.shm_rmid_forced": "0"
"net.core.somaxconn": 1024
"kernel.msgmax": "65536"
```
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.serviceAccountName
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
ServiceAccountName setting specifies the `serviceAccountName` for the `Pods` created
for each server of this group. If empty, it defaults to using the
`default` service account.
Using an alternative `ServiceAccount` is typically used to separate access rights.
The ArangoDB deployments need some very minimal access rights. With the
deployment of the operator, we grant the rights to 'get' all 'pod' resources.
If you are using a different service account, please grant these rights
to that service account.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.shutdownDelay
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ShutdownDelay define how long operator should delay finalizer removal after shutdown
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.shutdownMethod
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ShutdownMethod describe procedure of member shutdown taken by Operator
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.sidecarCoreNames
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
SidecarCoreNames is a list of sidecar containers which must run in the pod.
Some names (e.g.: "server", "worker") are reserved, and they don't have any impact.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.sidecars
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Sidecars specifies a list of additional containers to be started
Links:
* [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.storageClassName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
StorageClassName specifies the classname for storage of the servers.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.terminationGracePeriodSeconds
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.tolerations
Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Tolerations specifies the tolerations added to Pods in this group.
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
By default, suitable tolerations are set for the following keys with the `NoExecute` effect:
- `node.kubernetes.io/not-ready`
- `node.kubernetes.io/unreachable`
- `node.alpha.kubernetes.io/unreachable` (will be removed in future version)
For more information on tolerations, consult the https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Links:
* [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.volumeAllowShrink
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Deprecated: VolumeAllowShrink allows shrink the volume
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.volumeClaimTemplate
Type: `core.PersistentVolumeClaim` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
VolumeClaimTemplate specifies a volumeClaimTemplate used by operator to create to volume claims for pods of this group.
This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`.
The default value describes a volume with `8Gi` storage, `ReadWriteOnce` access mode and volume mode set to `PersistentVolumeFilesystem`.
If this field is not set and `spec.<group>.resources.requests.storage` is set, then a default volume claim
with size as specified by `spec.<group>.resources.requests.storage` will be created. In that case `storage`
and `iops` is not forwarded to the pods resource requirements.
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Links:
* [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.volumeMounts
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]ServerGroupSpecVolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
VolumeMounts define list of volume mounts mounted into server container
Links:
* [Documentation of ServerGroupSpecVolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volumemount-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.volumes\[int\].configMap
Type: `core.ConfigMapVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
ConfigMap which should be mounted into pod
Links:
* [Documentation of core.ConfigMapVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#configmapvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.volumes\[int\].emptyDir
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.EmptyDirVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
EmptyDir
Links:
* [Documentation of core.EmptyDirVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#emptydirvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.volumes\[int\].hostPath
Type: `core.HostPathVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
HostPath
Links:
* [Documentation of core.HostPathVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#hostpathvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.volumes\[int\].name
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Name of volume
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.syncworkers.volumes\[int\].persistentVolumeClaim
Type: `core.PersistentVolumeClaimVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
PersistentVolumeClaim
Links:
* [Documentation of core.PersistentVolumeClaimVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.syncworkers.volumes\[int\].secret
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `core.SecretVolumeSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Secret which should be mounted into pod
Links:
* [Documentation of core.SecretVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#secretvolumesource-v1-core)
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.timeouts.actions
Type: `map[string]meta.Duration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/timeouts.go#L44)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
Actions keep map of the actions timeouts.
Links:
* [List of supported action names](/docs/generated/actions.md)
* [Definition of meta.Duration](https://github.com/kubernetes/apimachinery/blob/v0.26.6/pkg/apis/meta/v1/duration.go)
Example:
```yaml
actions:
AddMember: 30m
```
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.timeouts.maintenanceGracePeriod
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/timeouts.go#L36)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
MaintenanceGracePeriod action timeout
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.timezone
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L269)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Docs] Add docs for DeploymentSpec (#1363)
2023-07-25 08:52:51 +00:00
Timezone if specified, will set a timezone for deployment.
Must be in format accepted by "tzdata", e.g. `America/New_York` or `Europe/London`
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.tls.altNames
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `[]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L72)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
AltNames setting specifies a list of alternate names that will be added to all generated
certificates. These names can be DNS names or email addresses.
The default value is empty.
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.tls.caSecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L67)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
CASecretName setting specifies the name of a kubernetes `Secret` that contains
a standard CA certificate + private key used to sign certificates for individual
ArangoDB servers.
When no name is specified, it defaults to `<deployment-name>-ca`.
To disable authentication, set this value to `None`.
If you specify a name of a `Secret` that does not exist, a self-signed CA certificate + key is created
and stored in a `Secret` with given name.
The specified `Secret`, must contain the following data fields:
- `ca.crt` PEM encoded public key of the CA certificate
- `ca.key` PEM encoded private key of the CA certificate
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.tls.mode
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L81)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.tls.sni.mapping.\<string\>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_sni_spec.go#L30)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.tls.ttl
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L79)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
TTL setting specifies the time to live of all generated server certificates.
When the server certificate is about to expire, it will be automatically replaced
by a new one and the affected server will be restarted.
Note: The time to live of the CA certificate (when created automatically)
will be set to 10 years.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `"2160h" (about 3 months)`
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
2023-10-20 07:28:44 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.topology.enabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/topology_spec.go#L26)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.topology.label
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/topology_spec.go#L28)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.topology.zones
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/topology_spec.go#L27)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
### .spec.upgrade.autoUpgrade
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_upgrade_spec.go#L26)</sup>
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
[Feature] Add spec.upgrade.debugLog option to configure upgrade container logging - GT-356 (#1442)
2023-10-19 09:11:23 +00:00
AutoUpgrade flag specifies if upgrade should be auto-injected, even if is not required (in case of stuck)
[Feature] Generate docs from Objects (#1358)
2023-07-20 02:49:34 +00:00
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
[Feature] Add spec.upgrade.debugLog option to configure upgrade container logging - GT-356 (#1442)
2023-10-19 09:11:23 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
***
[Feature] Add spec.upgrade.debugLog option to configure upgrade container logging - GT-356 (#1442)
2023-10-19 09:11:23 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
2023-11-09 09:23:56 +00:00
### .spec.upgrade.debugLog
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_upgrade_spec.go#L30)</sup>
[Feature] Add spec.upgrade.debugLog option to configure upgrade container logging - GT-356 (#1442)
2023-10-19 09:11:23 +00:00
DebugLog flag specifies if containers running upgrade process should print more debugging information.
This applies only to init containers.
(Documentation) Improvements and fixes for rendered documentation (GH pages) (#1477)
2023-11-07 18:50:23 +00:00
Default Value: `false`
[Feature] Add spec.upgrade.debugLog option to configure upgrade container logging - GT-356 (#1442)
2023-10-19 09:11:23 +00:00
Copy permalink