[Maintenance] PropagationMode Enum docs

CHANGELOG.md

@@ -38,6 +38,7 @@
 - (Maintenance) Use GoPretty for the Documentation
 - (Maintenance) Bump Kubernetes dependency to 1.31.2
 - (Documentation) Remove Interactive args for the DebugPackage command
+- (Maintenance) PropagationMode Enum docs
 
 ## [1.2.43](https://github.com/arangodb/kube-arangodb/tree/1.2.43) (2024-10-14)
 - (Feature) ArangoRoute CRD

Makefile

@@ -843,6 +843,7 @@ set-api-version/%:
 	      "$(ROOT)/pkg/apis/backup/" \
 	      "$(ROOT)/pkg/apis/networking/" \
 	      "$(ROOT)/pkg/apis/scheduler/" \
+	      "$(ROOT)/pkg/apis/platform/" \
 	      "$(ROOT)/pkg/upgrade/" \
 	  | cut -d ':' -f 1 | sort | uniq \
 	  | xargs -n 1 $(SED) -i "s#github.com/arangodb/kube-arangodb/pkg/apis/$*/v[A-Za-z0-9]\+#github.com/arangodb/kube-arangodb/pkg/apis/$*/v$(API_VERSION)#g"
@@ -858,6 +859,7 @@ set-api-version/%:
 	      "$(ROOT)/pkg/apis/backup/" \
 	      "$(ROOT)/pkg/apis/networking/" \
 	      "$(ROOT)/pkg/apis/scheduler/" \
+	      "$(ROOT)/pkg/apis/platform/" \
 	      "$(ROOT)/pkg/upgrade/" \
 	  | cut -d ':' -f 1 | sort | uniq \
 	  | xargs -n 1 $(SED) -i "s#DatabaseV[A-Za-z0-9]\+()\.#DatabaseV$(API_VERSION)().#g"
@@ -873,6 +875,7 @@ set-api-version/%:
 		  "$(ROOT)/pkg/apis/backup/" \
 	      "$(ROOT)/pkg/apis/networking/" \
 	      "$(ROOT)/pkg/apis/scheduler/" \
+	      "$(ROOT)/pkg/apis/platform/" \
 	      "$(ROOT)/pkg/upgrade/" \
 	  | cut -d ':' -f 1 | sort | uniq \
 	  | xargs -n 1 $(SED) -i "s#ReplicationV[A-Za-z0-9]\+()\.#ReplicationV$(API_VERSION)().#g"

docs/api/ArangoDeployment.V1.md

@@ -169,7 +169,7 @@ Possible Values:
 
 ### .spec.agents.initContainers.containers
 
-Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L91)</sup>
+Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L93)</sup>
 
 Containers contains list of containers
 
@@ -180,10 +180,14 @@ Links:
 
 ### .spec.agents.initContainers.mode
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L94)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L98)</sup>
 
 Mode keep container replace mode
 
+Possible Values: 
+* `"update"` (default) - Enforce update of pod if init container has been changed
+* `"ignore"` - Ignores init container changes in pod recreation flow
+
 ***
 
 ### .spec.agents.internalPort
@@ -1235,7 +1239,7 @@ Possible Values:
 
 ### .spec.coordinators.initContainers.containers
 
-Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L91)</sup>
+Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L93)</sup>
 
 Containers contains list of containers
 
@@ -1246,10 +1250,14 @@ Links:
 
 ### .spec.coordinators.initContainers.mode
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L94)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L98)</sup>
 
 Mode keep container replace mode
 
+Possible Values: 
+* `"update"` (default) - Enforce update of pod if init container has been changed
+* `"ignore"` - Ignores init container changes in pod recreation flow
+
 ***
 
 ### .spec.coordinators.internalPort
@@ -2169,7 +2177,7 @@ Possible Values:
 
 ### .spec.dbservers.initContainers.containers
 
-Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L91)</sup>
+Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L93)</sup>
 
 Containers contains list of containers
 
@@ -2180,10 +2188,14 @@ Links:
 
 ### .spec.dbservers.initContainers.mode
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L94)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L98)</sup>
 
 Mode keep container replace mode
 
+Possible Values: 
+* `"update"` (default) - Enforce update of pod if init container has been changed
+* `"ignore"` - Ignores init container changes in pod recreation flow
+
 ***
 
 ### .spec.dbservers.internalPort
@@ -3235,7 +3247,7 @@ Possible Values:
 
 ### .spec.gateways.initContainers.containers
 
-Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L91)</sup>
+Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L93)</sup>
 
 Containers contains list of containers
 
@@ -3246,10 +3258,14 @@ Links:
 
 ### .spec.gateways.initContainers.mode
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L94)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L98)</sup>
 
 Mode keep container replace mode
 
+Possible Values: 
+* `"update"` (default) - Enforce update of pod if init container has been changed
+* `"ignore"` - Ignores init container changes in pod recreation flow
+
 ***
 
 ### .spec.gateways.internalPort
@@ -4912,7 +4928,7 @@ Possible Values:
 
 ### .spec.single.initContainers.containers
 
-Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L91)</sup>
+Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L93)</sup>
 
 Containers contains list of containers
 
@@ -4923,10 +4939,14 @@ Links:
 
 ### .spec.single.initContainers.mode
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L94)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L98)</sup>
 
 Mode keep container replace mode
 
+Possible Values: 
+* `"update"` (default) - Enforce update of pod if init container has been changed
+* `"ignore"` - Ignores init container changes in pod recreation flow
+
 ***
 
 ### .spec.single.internalPort
@@ -6047,7 +6067,7 @@ Possible Values:
 
 ### .spec.syncmasters.initContainers.containers
 
-Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L91)</sup>
+Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L93)</sup>
 
 Containers contains list of containers
 
@@ -6058,10 +6078,14 @@ Links:
 
 ### .spec.syncmasters.initContainers.mode
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L94)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L98)</sup>
 
 Mode keep container replace mode
 
+Possible Values: 
+* `"update"` (default) - Enforce update of pod if init container has been changed
+* `"ignore"` - Ignores init container changes in pod recreation flow
+
 ***
 
 ### .spec.syncmasters.internalPort
@@ -6973,7 +6997,7 @@ Possible Values:
 
 ### .spec.syncworkers.initContainers.containers
 
-Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L91)</sup>
+Type: `[]core.Container` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L93)</sup>
 
 Containers contains list of containers
 
@@ -6984,10 +7008,14 @@ Links:
 
 ### .spec.syncworkers.initContainers.mode
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L94)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/deployment/v1/server_group_init_containers.go#L98)</sup>
 
 Mode keep container replace mode
 
+Possible Values: 
+* `"update"` (default) - Enforce update of pod if init container has been changed
+* `"ignore"` - Ignores init container changes in pod recreation flow
+
 ***
 
 ### .spec.syncworkers.internalPort

pkg/apis/deployment/v1/server_group_init_containers.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2025 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -58,7 +58,7 @@ type ServerGroupInitContainerMode string
 
 func (s *ServerGroupInitContainerMode) Get() ServerGroupInitContainerMode {
 	if s == nil {
-		return ServerGroupInitContainerUpdateMode // default
+		return ServerGroupInitContainerDefaultMode // default
 	}
 
 	return *s
@@ -78,6 +78,8 @@ func (s *ServerGroupInitContainerMode) Validate() error {
 }
 
 const (
+	// ServerGroupInitContainerDefaultMode default mode
+	ServerGroupInitContainerDefaultMode = ServerGroupInitContainerIgnoreMode
 	// ServerGroupInitContainerIgnoreMode ignores init container changes in pod recreation flow
 	ServerGroupInitContainerIgnoreMode ServerGroupInitContainerMode = "ignore"
 	// ServerGroupInitContainerUpdateMode enforce update of pod if init container has been changed
@@ -91,6 +93,8 @@ type ServerGroupInitContainers struct {
 	Containers []core.Container `json:"containers,omitempty"`
 
 	// Mode keep container replace mode
+	// +doc/enum: update|Enforce update of pod if init container has been changed
+	// +doc/enum: ignore|Ignores init container changes in pod recreation flow
 	Mode *ServerGroupInitContainerMode `json:"mode,omitempty"`
 }
 

pkg/apis/deployment/v2alpha1/server_group_init_containers.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2025 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -58,7 +58,7 @@ type ServerGroupInitContainerMode string
 
 func (s *ServerGroupInitContainerMode) Get() ServerGroupInitContainerMode {
 	if s == nil {
-		return ServerGroupInitContainerUpdateMode // default
+		return ServerGroupInitContainerDefaultMode // default
 	}
 
 	return *s
@@ -78,6 +78,8 @@ func (s *ServerGroupInitContainerMode) Validate() error {
 }
 
 const (
+	// ServerGroupInitContainerDefaultMode default mode
+	ServerGroupInitContainerDefaultMode = ServerGroupInitContainerIgnoreMode
 	// ServerGroupInitContainerIgnoreMode ignores init container changes in pod recreation flow
 	ServerGroupInitContainerIgnoreMode ServerGroupInitContainerMode = "ignore"
 	// ServerGroupInitContainerUpdateMode enforce update of pod if init container has been changed
@@ -91,6 +93,8 @@ type ServerGroupInitContainers struct {
 	Containers []core.Container `json:"containers,omitempty"`
 
 	// Mode keep container replace mode
+	// +doc/enum: update|Enforce update of pod if init container has been changed
+	// +doc/enum: ignore|Ignores init container changes in pod recreation flow
 	Mode *ServerGroupInitContainerMode `json:"mode,omitempty"`
 }