match the description for start with that of the stateful set

strangelove-ventures · Dec 4, 2024 · 8a24b65 · 8a24b65
1 parent 212fd65
commit 8a24b65
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/api/v1/cosmosfullnode_types.go b/api/v1/cosmosfullnode_types.go
@@ -34,7 +34,11 @@ const CosmosFullNodeController = "CosmosFullNode"
 
 // Ordinal specifies the configuration for pod ordinal numbers
 type Ordinals struct {
-	// Start specifies the initial ordinal number for pod naming
+	// start is the number representing the first replica's index. It may be used to number replicas from an alternate index (eg: 1-indexed) over the default 0-indexed names,
+	// or to orchestrate progressive movement of replicas from one CosmosFullnode spec to another. If set, replica indices will be in the range:
+	// [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).
+	// If unset, defaults to 0. Replica indices will be in the range:
+	// [0, .spec.replicas).
 	// +kubebuilder:validation:Minimum:=0
 	Start int32 `json:"start,omitempty"`
 }

diff --git a/config/crd/bases/cosmos.strange.love_cosmosfullnodes.yaml b/config/crd/bases/cosmos.strange.love_cosmosfullnodes.yaml
@@ -555,12 +555,16 @@ spec:
                   Example: cosmos-1
                   Used for debugging.
                 type: object
-              ordinals:
+              ordinal:
                 description: Ordinal specifies the configuration for pod ordinal numbers
                 properties:
                   start:
-                    description: Start specifies the initial ordinal number for pod
-                      naming
+                    description: |-
+                      start is the number representing the first replica's index. It may be used to number replicas from an alternate index (eg: 1-indexed) over the default 0-indexed names,
+                      or to orchestrate progressive movement of replicas from one CosmosFullnode spec to another. If set, replica indices will be in the range:
+                      [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).
+                      If unset, defaults to 0. Replica indices will be in the range:
+                      [0, .spec.replicas).
                     format: int32
                     minimum: 0
                     type: integer