Skip to content

Commit

Permalink
Showing 4 changed files with 444 additions and 322 deletions.
732 changes: 414 additions & 318 deletions docs/api/ArangoDeployment.V1.md

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions internal/docs_test.go
Original file line number Diff line number Diff line change
@@ -51,6 +51,10 @@ func (d DocDefinitions) Render(t *testing.T) []byte {

write(t, out, "### %s: %s\n\n", el.Path, el.Type)

if d := el.Important; d != nil {
write(t, out, "**Important**: %s\n\n", *d)
}

if len(el.Docs) > 0 {
for _, doc := range el.Docs {
write(t, out, "%s\n", doc)
@@ -129,6 +133,8 @@ type DocDefinition struct {

Links []string

Important *string

Enum []string

Immutable *string
@@ -215,6 +221,10 @@ func generateDocs(t *testing.T, objects map[string]map[string]interface{}, paths
def.Immutable = util.NewType[string](immutable[0])
}

if important, ok := extract(field, "important"); ok {
def.Important = util.NewType[string](important[0])
}

if docs, ok := extractNotTags(field); !ok {
println(def.Path, " is missing documentation!")
} else {
12 changes: 10 additions & 2 deletions pkg/apis/deployment/v1/server_group_spec.go
Original file line number Diff line number Diff line change
@@ -86,9 +86,17 @@ type ServerGroupSpec struct {
// +doc/type: core.ResourceRequirements
// +doc/link: Documentation of core.ResourceRequirements|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core
Resources core.ResourceRequirements `json:"resources,omitempty"`
// OverrideDetectedTotalMemory determines if memory should be overrided based on values in resources.
// 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.
// +doc/important: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable
// +doc/default: true
// +doc/link: Docs of the ArangoDB Envs|https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/
OverrideDetectedTotalMemory *bool `json:"overrideDetectedTotalMemory,omitempty"`
// OverrideDetectedNumberOfCores determines if number of cores should be overrided based on values in resources.
// 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.
// +doc/important: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable
// +doc/default: true
// +doc/link: Docs of the ArangoDB Envs|https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/
OverrideDetectedNumberOfCores *bool `json:"overrideDetectedNumberOfCores,omitempty"`
// Tolerations specifies the tolerations added to Pods in this group.
// +doc/type: []core.Toleration
12 changes: 10 additions & 2 deletions pkg/apis/deployment/v2alpha1/server_group_spec.go
Original file line number Diff line number Diff line change
@@ -86,9 +86,17 @@ type ServerGroupSpec struct {
// +doc/type: core.ResourceRequirements
// +doc/link: Documentation of core.ResourceRequirements|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core
Resources core.ResourceRequirements `json:"resources,omitempty"`
// OverrideDetectedTotalMemory determines if memory should be overrided based on values in resources.
// 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.
// +doc/important: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable
// +doc/default: true
// +doc/link: Docs of the ArangoDB Envs|https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/
OverrideDetectedTotalMemory *bool `json:"overrideDetectedTotalMemory,omitempty"`
// OverrideDetectedNumberOfCores determines if number of cores should be overrided based on values in resources.
// 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.
// +doc/important: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable
// +doc/default: true
// +doc/link: Docs of the ArangoDB Envs|https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/
OverrideDetectedNumberOfCores *bool `json:"overrideDetectedNumberOfCores,omitempty"`
// Tolerations specifies the tolerations added to Pods in this group.
// +doc/type: []core.Toleration

0 comments on commit b991811

Please sign in to comment.