{ "description": "GarageCluster is the Schema for the garageclusters API", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "type": "object" }, "spec": { "description": "GarageClusterSpec defines the desired state of GarageCluster", "properties": { "admin": { "description": "Admin configures the admin API endpoint and metrics", "properties": { "adminTokenSecretRef": { "description": "AdminTokenSecretRef references a secret containing the admin API token", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": "boolean" } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "bindAddress": { "description": "BindAddress is a custom bind address for the Admin API.\nCan be a TCP address or Unix socket path (e.g., \"unix:///run/garage/admin.sock\").\nIf set, this overrides BindPort.", "type": "string" }, "bindPort": { "default": 3903, "description": "BindPort is the port to bind for admin API", "format": "int32", "maximum": 65535, "minimum": 1, "type": "integer" }, "enabled": { "default": true, "description": "Enabled enables the admin API", "type": "boolean" }, "metricsRequireToken": { "description": "MetricsRequireToken requires authentication for /metrics endpoint", "type": "boolean" }, "metricsTokenSecretRef": { "description": "MetricsTokenSecretRef references a secret containing the metrics token", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": "boolean" } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "traceSink": { "description": "TraceSink is the OpenTelemetry collector address for tracing\nExample: \"http://localhost:4317\"", "type": "string" } }, "type": "object", "additionalProperties": false }, "affinity": { "description": "Affinity for pod scheduling", "properties": { "nodeAffinity": { "description": "Describes node affinity scheduling rules for the pod.", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred.", "items": { "description": "An empty preferred scheduling term matches all objects with implicit weight 0\n(i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).", "properties": { "preference": { "description": "A node selector term, associated with the corresponding weight.", "properties": { "matchExpressions": { "description": "A list of node selector requirements by node's labels.", "items": { "description": "A node selector requirement is a selector that contains values, a key, and an operator\nthat relates the key and values.", "properties": { "key": { "description": "The label key that the selector applies to.", "type": "string" }, "operator": { "description": "Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", "type": "string" }, "values": { "description": "An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "matchFields": { "description": "A list of node selector requirements by node's fields.", "items": { "description": "A node selector requirement is a selector that contains values, a key, and an operator\nthat relates the key and values.", "properties": { "key": { "description": "The label key that the selector applies to.", "type": "string" }, "operator": { "description": "Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", "type": "string" }, "values": { "description": "An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "weight": { "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.", "format": "int32", "type": "integer" } }, "required": [ "preference", "weight" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to an update), the system\nmay or may not try to eventually evict the pod from its node.", "properties": { "nodeSelectorTerms": { "description": "Required. A list of node selector terms. The terms are ORed.", "items": { "description": "A null or empty node selector term matches no objects. The requirements of\nthem are ANDed.\nThe TopologySelectorTerm type implements a subset of the NodeSelectorTerm.", "properties": { "matchExpressions": { "description": "A list of node selector requirements by node's labels.", "items": { "description": "A node selector requirement is a selector that contains values, a key, and an operator\nthat relates the key and values.", "properties": { "key": { "description": "The label key that the selector applies to.", "type": "string" }, "operator": { "description": "Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", "type": "string" }, "values": { "description": "An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "matchFields": { "description": "A list of node selector requirements by node's fields.", "items": { "description": "A node selector requirement is a selector that contains values, a key, and an operator\nthat relates the key and values.", "properties": { "key": { "description": "The label key that the selector applies to.", "type": "string" }, "operator": { "description": "Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", "type": "string" }, "values": { "description": "An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "nodeSelectorTerms" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "podAffinity": { "description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.", "items": { "description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)", "properties": { "podAffinityTerm": { "description": "Required. A pod affinity term, associated with the corresponding weight.", "properties": { "labelSelector": { "description": "A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": "object" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "matchLabelKeys": { "description": "MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "mismatchLabelKeys": { "description": "MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "namespaceSelector": { "description": "A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": "object" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "topologyKey": { "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed.", "type": "string" } }, "required": [ "topologyKey" ], "type": "object", "additionalProperties": false }, "weight": { "description": "weight associated with matching the corresponding podAffinityTerm,\nin the range 1-100.", "format": "int32", "type": "integer" } }, "required": [ "podAffinityTerm", "weight" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.", "items": { "description": "Defines a set of pods (namely those matching the labelSelector\nrelative to the given namespace(s)) that this pod should be\nco-located (affinity) or not co-located (anti-affinity) with,\nwhere co-located is defined as running on a node whose value of\nthe label with key matches that of any node on which\na pod of the set of pods is running", "properties": { "labelSelector": { "description": "A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": "object" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "matchLabelKeys": { "description": "MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "mismatchLabelKeys": { "description": "MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "namespaceSelector": { "description": "A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": "object" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "topologyKey": { "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed.", "type": "string" } }, "required": [ "topologyKey" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "type": "object", "additionalProperties": false }, "podAntiAffinity": { "description": "Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and subtracting\n\"weight\" from the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.", "items": { "description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)", "properties": { "podAffinityTerm": { "description": "Required. A pod affinity term, associated with the corresponding weight.", "properties": { "labelSelector": { "description": "A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": "object" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "matchLabelKeys": { "description": "MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "mismatchLabelKeys": { "description": "MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "namespaceSelector": { "description": "A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": "object" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "topologyKey": { "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed.", "type": "string" } }, "required": [ "topologyKey" ], "type": "object", "additionalProperties": false }, "weight": { "description": "weight associated with matching the corresponding podAffinityTerm,\nin the range 1-100.", "format": "int32", "type": "integer" } }, "required": [ "podAffinityTerm", "weight" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.", "items": { "description": "Defines a set of pods (namely those matching the labelSelector\nrelative to the given namespace(s)) that this pod should be\nco-located (affinity) or not co-located (anti-affinity) with,\nwhere co-located is defined as running on a node whose value of\nthe label with key matches that of any node on which\na pod of the set of pods is running", "properties": { "labelSelector": { "description": "A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": "object" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "matchLabelKeys": { "description": "MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "mismatchLabelKeys": { "description": "MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "namespaceSelector": { "description": "A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": "object" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "topologyKey": { "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed.", "type": "string" } }, "required": [ "topologyKey" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "blocks": { "description": "Blocks configures block storage settings", "properties": { "compressionLevel": { "description": "CompressionLevel is the zstd compression level\n1-19: standard, 20-22: ultra, -1 to -99: fast, \"none\": disabled", "type": "string" }, "disableScrub": { "description": "DisableScrub disables automatic monthly data directory scrub", "type": "boolean" }, "maxConcurrentReads": { "description": "MaxConcurrentReads is the maximum simultaneous block file reads", "minimum": 1, "type": "integer" }, "maxConcurrentWritesPerRequest": { "description": "MaxConcurrentWritesPerRequest is the maximum parallel block writes per PUT request.\nHigher values improve throughput but increase memory usage.\nDefault: 3. Recommended: 10-30 for NVMe, 3-10 for HDD.\nAdded in Garage v2.2.0.", "minimum": 1, "type": "integer" }, "ramBufferMax": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "RAMBufferMax is the maximum RAM for buffering blocks", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "size": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Size is the size of data blocks (default: 1M)", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "useLocalTZ": { "description": "UseLocalTZ runs lifecycle worker at midnight in local timezone", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "capacityReservePercent": { "description": "CapacityReservePercent reserves a percentage of PVC capacity for overhead.\nOnly used when LayoutPolicy is \"Auto\".\nFor example, setting this to 10 will report 90% of PVC size as node capacity.\nThis is useful to reserve headroom for filesystem overhead, snapshots, or growth.\nDefault: 0 (use full PVC size as capacity)", "maximum": 50, "minimum": 0, "type": "integer" }, "connectTo": { "description": "ConnectTo specifies the storage cluster this gateway cluster connects to.\nRequired when gateway=true. The gateway cluster will:\n- Use the same RPC secret as the storage cluster\n- Connect to the storage cluster's nodes\n- Register its pods as gateway nodes in the storage cluster's layout", "properties": { "adminApiEndpoint": { "description": "AdminAPIEndpoint is the admin API endpoint for discovering nodes and registering gateways\nRequired if clusterRef is not in the same namespace\nExample: \"http://garage-storage.other-namespace:3903\"", "type": "string" }, "adminTokenSecretRef": { "description": "AdminTokenSecretRef references the admin token for the storage cluster\nIf clusterRef is specified and in same namespace, uses that cluster's token", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": "boolean" } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "bootstrapPeers": { "description": "BootstrapPeers are the initial peers to connect to (for external storage clusters)\nFormat: \"@:\"", "items": { "type": "string" }, "type": "array" }, "clusterRef": { "description": "ClusterRef references a GarageCluster in the same namespace\nThe gateway will use this cluster's RPC secret and connect to its nodes", "properties": { "kubeConfigSecretRef": { "description": "KubeConfigSecretRef references a secret containing kubeconfig for a remote cluster.\nOnly used for cross-cluster references in multi-cluster federation scenarios.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": "boolean" } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "name": { "description": "Name of the GarageCluster", "type": "string" }, "namespace": { "description": "Namespace of the GarageCluster (defaults to the same namespace as the referencing resource)", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "rpcSecretRef": { "description": "RPCSecretRef references a shared RPC secret (for cross-namespace or external clusters)\nIf clusterRef is specified, this is ignored (uses the referenced cluster's secret)", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": "boolean" } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "containerSecurityContext": { "description": "ContainerSecurityContext for Garage containers", "properties": { "allowPrivilegeEscalation": { "description": "AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows.", "type": "boolean" }, "appArmorProfile": { "description": "appArmorProfile is the AppArmor options to use by this container. If set, this profile\noverrides the pod's appArmorProfile.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\".", "type": "string" }, "type": { "description": "type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement.", "type": "string" } }, "required": [ "type" ], "type": "object", "additionalProperties": false }, "capabilities": { "description": "The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "add": { "description": "Added capabilities", "items": { "description": "Capability represent POSIX capabilities type", "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "drop": { "description": "Removed capabilities", "items": { "description": "Capability represent POSIX capabilities type", "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "type": "object", "additionalProperties": false }, "privileged": { "description": "Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows.", "type": "boolean" }, "procMount": { "description": "procMount denotes the type of proc mount to use for the containers.\nThe default value is Default which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\nNote that this field cannot be set when spec.os.name is windows.", "type": "string" }, "readOnlyRootFilesystem": { "description": "Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows.", "type": "boolean" }, "runAsGroup": { "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.", "format": "int64", "type": "integer" }, "runAsNonRoot": { "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.", "type": "boolean" }, "runAsUser": { "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.", "format": "int64", "type": "integer" }, "seLinuxOptions": { "description": "The SELinux context to be applied to the container.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "level": { "description": "Level is SELinux level label that applies to the container.", "type": "string" }, "role": { "description": "Role is a SELinux role label that applies to the container.", "type": "string" }, "type": { "description": "Type is a SELinux type label that applies to the container.", "type": "string" }, "user": { "description": "User is a SELinux user label that applies to the container.", "type": "string" } }, "type": "object", "additionalProperties": false }, "seccompProfile": { "description": "The seccomp options to use by this container. If seccomp options are\nprovided at both the pod & container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type.", "type": "string" }, "type": { "description": "type indicates which kind of seccomp profile will be applied.\nValid options are:\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied.", "type": "string" } }, "required": [ "type" ], "type": "object", "additionalProperties": false }, "windowsOptions": { "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux.", "properties": { "gmsaCredentialSpec": { "description": "GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field.", "type": "string" }, "gmsaCredentialSpecName": { "description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.", "type": "string" }, "hostProcess": { "description": "HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true.", "type": "boolean" }, "runAsUserName": { "description": "The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "database": { "description": "Database configures the metadata database engine", "properties": { "engine": { "default": "lmdb", "description": "Engine specifies the database engine to use", "enum": [ "lmdb", "sqlite", "fjall" ], "type": "string" }, "fjallBlockCacheSize": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "FjallBlockCacheSize is the block cache size for Fjall", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "lmdbMapSize": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "LMDBMapSize is the virtual memory region size for LMDB", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true } }, "type": "object", "additionalProperties": false }, "defaultNodeTags": { "description": "DefaultNodeTags are tags applied to all auto-managed nodes.\nOnly used when LayoutPolicy is \"Auto\".\nFor per-node tags, use LayoutPolicy \"Manual\" with GarageNode resources.", "items": { "type": "string" }, "type": "array" }, "discovery": { "description": "Discovery configures peer discovery mechanisms", "properties": { "consul": { "description": "Consul configures Consul-based peer discovery", "properties": { "api": { "default": "catalog", "description": "API specifies the service registration API (\"catalog\" or \"agent\")", "enum": [ "catalog", "agent" ], "type": "string" }, "caCert": { "description": "CACert is the CA certificate for TLS connection", "type": "string" }, "caCertSecretRef": { "description": "CACertSecretRef references a secret containing the CA certificate", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": "boolean" } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "clientCertSecretRef": { "description": "ClientCertSecretRef references a secret containing client TLS cert", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": "boolean" } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "clientKeySecretRef": { "description": "ClientKeySecretRef references a secret containing client TLS key", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": "boolean" } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "datacenters": { "description": "Datacenters for WAN federation", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enabled enables Consul-based discovery", "type": "boolean" }, "httpAddr": { "description": "HTTPAddr is the full HTTP(S) address of Consul server", "type": "string" }, "meta": { "additionalProperties": { "type": "string" }, "description": "Meta is service metadata key-value pairs", "type": "object" }, "serviceName": { "description": "ServiceName for Garage RPC port registration", "type": "string" }, "tags": { "description": "Tags are additional service tags", "items": { "type": "string" }, "type": "array" }, "tlsSkipVerify": { "description": "TLSSkipVerify skips TLS hostname verification", "type": "boolean" }, "tokenSecretRef": { "description": "TokenSecretRef references a secret containing the bearer token", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": "boolean" } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "kubernetes": { "description": "Kubernetes configures Kubernetes-based peer discovery", "properties": { "enabled": { "description": "Enabled enables Kubernetes-based discovery", "type": "boolean" }, "namespace": { "description": "Namespace for Garage custom resources", "type": "string" }, "serviceName": { "description": "ServiceName label to filter custom resources", "type": "string" }, "skipCRD": { "description": "SkipCRD skips automatic CRD creation/patching", "type": "boolean" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "gateway": { "description": "Gateway marks this cluster as a gateway-only cluster.\nGateway clusters don't store data - they only handle API requests.\nWhen true:\n- Creates a StatefulSet with metadata PVC only (for node identity persistence)\n- Data storage uses EmptyDir (gateways don't store blocks)\n- Pods are registered as gateway nodes in the layout (capacity=null)\n- Must specify connectTo to reference a storage cluster", "type": "boolean" }, "image": { "default": "dxflrs/garage:v2.2.0", "description": "Image specifies the Garage container image to use.\nTakes precedence over imageRepository if both are set.", "type": "string" }, "imagePullPolicy": { "default": "IfNotPresent", "description": "ImagePullPolicy specifies the image pull policy", "type": "string" }, "imagePullSecrets": { "description": "ImagePullSecrets specifies secrets for pulling images from private registries", "items": { "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "type": "array" }, "imageRepository": { "description": "ImageRepository overrides just the repository portion of the default Garage image,\npreserving the default tag for automatic version upgrades.\nFor example, setting this to \"my-mirror/garage\" with the default tag v2.2.0\nproduces \"my-mirror/garage:v2.2.0\".\nIgnored if image is set.", "type": "string" }, "k2vApi": { "description": "K2VAPI configures the K2V (key-value) API endpoint.\nOmit to disable K2V.", "properties": { "bindAddress": { "description": "BindAddress is a custom bind address for the K2V API.\nCan be a TCP address or Unix socket path (e.g., \"unix:///run/garage/k2v.sock\").\nIf set, this overrides BindPort.", "type": "string" }, "bindPort": { "default": 3904, "description": "BindPort is the port to bind for K2V API", "format": "int32", "maximum": 65535, "minimum": 1, "type": "integer" } }, "type": "object", "additionalProperties": false }, "layoutManagement": { "description": "LayoutManagement controls how the cluster layout is managed", "properties": { "autoApply": { "description": "AutoApply automatically applies staged layout changes", "type": "boolean" }, "minNodesHealthy": { "description": "MinNodesHealthy is the minimum healthy nodes required before applying layout changes", "type": "integer" } }, "type": "object", "additionalProperties": false }, "layoutPolicy": { "default": "Auto", "description": "LayoutPolicy controls whether node layouts are automatically managed or manually configured.\n- \"Auto\": The controller automatically assigns all local pods to the layout using the\n cluster's zone and derives capacity from data PVC size. No GarageNode resources needed.\n- \"Manual\": You must create GarageNode resources for each node you want in the layout.\n Use this for fine-grained control over zones, capacities, or external nodes.", "enum": [ "Auto", "Manual" ], "type": "string" }, "logging": { "description": "Logging configures logging behavior for Garage nodes", "properties": { "journald": { "description": "Journald enables logging to systemd journald (requires Garage built with journald feature)", "type": "boolean" }, "level": { "description": "Level sets the log level using RUST_LOG format.\n\nExamples:\n- \"info\": Default info level for all components\n- \"debug\": Debug level for all components\n- \"garage=debug\": Debug only for garage module\n- \"garage=debug,netapp=info\": Fine-grained per-component levels\n- \"garage=trace,netapp=debug,rusoto=warn\": Multiple components\n\nSee https://docs.rs/env_logger for full syntax.", "type": "string" }, "syslog": { "description": "Syslog enables logging to syslog (requires Garage built with syslog feature)", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "network": { "description": "Network configures RPC and API networking", "properties": { "bootstrapPeers": { "description": "BootstrapPeers lists initial peers for cluster formation.\n\nFormat: \"@:\"\n\nExample:\n- \"563e1ac825ee3323aa441e72c26d1030d6d4414aeb3dd25287c531e7fc2bc95d@10.0.0.1:3901\"\n- \"ec79480e0ce52ae26fd00c9da684e4fa56f77571b9b8560382f859930e63571d@garage-2.example.com:3901\"", "items": { "type": "string" }, "type": "array" }, "rpcBindAddress": { "description": "RPCBindAddress is a custom bind address for the RPC server.\nCan be a TCP address (e.g., \"0.0.0.0:3901\", \"[::]:3901\").\nIf set, this overrides RPCBindPort.", "type": "string" }, "rpcBindOutgoing": { "description": "RPCBindOutgoing pre-binds outgoing sockets to same IP", "type": "boolean" }, "rpcBindPort": { "default": 3901, "description": "RPCBindPort is the port for inter-cluster RPC", "format": "int32", "maximum": 65535, "minimum": 1, "type": "integer" }, "rpcPingTimeoutMs": { "description": "RPCPingTimeoutMs sets the RPC ping timeout in milliseconds", "format": "int64", "type": "integer" }, "rpcPublicAddr": { "description": "RPCPublicAddr is the external address for other nodes to contact this node", "type": "string" }, "rpcPublicAddrSubnet": { "description": "RPCPublicAddrSubnet filters autodiscovered IPs to specific subnet", "type": "string" }, "rpcSecretRef": { "description": "RPCSecret is a reference to a secret containing the RPC secret\nThe secret must have a key 'rpc-secret' with a 32-byte hex-encoded value", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": "boolean" } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "rpcTimeoutMs": { "description": "RPCTimeoutMs sets the RPC call timeout in milliseconds", "format": "int64", "type": "integer" }, "service": { "description": "Service configures the Kubernetes Service for the cluster", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations for the service", "type": "object" }, "externalTrafficPolicy": { "description": "ExternalTrafficPolicy for LoadBalancer/NodePort", "type": "string" }, "loadBalancerIP": { "description": "LoadBalancerIP for LoadBalancer type", "type": "string" }, "loadBalancerSourceRanges": { "description": "LoadBalancerSourceRanges for LoadBalancer type", "items": { "type": "string" }, "type": "array" }, "type": { "default": "ClusterIP", "description": "Type of service", "enum": [ "ClusterIP", "NodePort", "LoadBalancer" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "nodeSelector": { "additionalProperties": { "type": "string" }, "description": "NodeSelector for pod scheduling", "type": "object" }, "podAnnotations": { "additionalProperties": { "type": "string" }, "description": "PodAnnotations to add to Garage pods", "type": "object" }, "podDisruptionBudget": { "description": "PodDisruptionBudget configures the PodDisruptionBudget for the cluster", "properties": { "enabled": { "default": true, "description": "Enabled enables PodDisruptionBudget creation", "type": "boolean" }, "maxUnavailable": { "description": "MaxUnavailable specifies the maximum number of pods that can be unavailable\nCan be an absolute number (e.g., 1) or a percentage (e.g., \"25%\")\nMutually exclusive with MinAvailable", "type": "string" }, "minAvailable": { "description": "MinAvailable specifies the minimum number of pods that must be available\nCan be an absolute number (e.g., 2) or a percentage (e.g., \"50%\")\nMutually exclusive with MaxUnavailable", "type": "string" } }, "type": "object", "additionalProperties": false }, "podLabels": { "additionalProperties": { "type": "string" }, "description": "PodLabels to add to Garage pods", "type": "object" }, "priorityClassName": { "description": "PriorityClassName for Garage pods", "type": "string" }, "publicEndpoint": { "description": "PublicEndpoint configures how remote clusters reach this cluster's nodes\nRequired for multi-cluster federation", "properties": { "externalIP": { "description": "ExternalIP configuration", "properties": { "addressTemplate": { "description": "AddressTemplate uses go template to generate addresses from pod info\nExample: \"garage-{{.Index}}.example.com\"", "type": "string" }, "addresses": { "additionalProperties": { "type": "string" }, "description": "Addresses maps pod names to external IPs", "type": "object" } }, "type": "object", "additionalProperties": false }, "loadBalancer": { "description": "LoadBalancer configuration", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations for the LoadBalancer service", "type": "object" }, "perNode": { "description": "PerNode creates a separate LoadBalancer per node (more expensive but ensures direct routing)", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "nodePort": { "description": "NodePort configuration", "properties": { "basePort": { "description": "BasePort is the starting NodePort (each node gets BasePort + index)", "format": "int32", "maximum": 32767, "minimum": 30000, "type": "integer" }, "externalAddresses": { "description": "ExternalAddresses are the external IPs/hostnames of the Kubernetes nodes", "items": { "type": "string" }, "type": "array" } }, "required": [ "externalAddresses" ], "type": "object", "additionalProperties": false }, "type": { "description": "Type specifies how nodes are exposed", "enum": [ "LoadBalancer", "NodePort", "ExternalIP", "Headless" ], "type": "string" } }, "required": [ "type" ], "type": "object", "additionalProperties": false }, "remoteClusters": { "description": "RemoteClusters are Garage clusters in other Kubernetes clusters\nThe operator will auto-discover nodes and coordinate layout", "items": { "description": "RemoteClusterConfig defines a Garage cluster in another Kubernetes cluster", "properties": { "connection": { "description": "Connection defines how to connect to this remote cluster", "properties": { "adminApiEndpoint": { "description": "AdminAPIEndpoint is the admin API endpoint of the remote cluster\nThis should be a reachable HTTP/HTTPS URL (e.g., via Tailscale, LoadBalancer, or port-forward)\nExample: \"http://garage-remote.tailscale:3903\"", "type": "string" }, "adminTokenSecretRef": { "description": "AdminTokenSecretRef references the admin token for the remote cluster's API\nIf not specified, uses the local cluster's admin token (for shared-token setups)", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": "boolean" } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false } }, "required": [ "adminApiEndpoint" ], "type": "object", "additionalProperties": false }, "defaultCapacity": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "DefaultCapacity is the default storage capacity to assign to remote nodes\nthat don't yet have a role in the layout. If not specified, defaults to 100Gi.\nSet to \"0\" to add nodes as gateway-only (no storage).", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "name": { "description": "Name is a friendly name for this remote cluster", "type": "string" }, "zone": { "description": "Zone is the zone name for nodes in this remote cluster", "type": "string" } }, "required": [ "connection", "name", "zone" ], "type": "object", "additionalProperties": false }, "type": "array" }, "replicas": { "default": 3, "description": "Replicas is the number of Garage nodes to deploy in this cluster", "format": "int32", "minimum": 1, "type": "integer" }, "replication": { "description": "Replication configures data replication settings", "properties": { "consistencyMode": { "default": "consistent", "description": "ConsistencyMode controls quorum behavior for read/write operations.\n\nValues:\n- \"consistent\" (default): Require quorum for both reads and writes.\n Safest option, ensures strong consistency.\n- \"degraded\": Allow reads from single node when quorum unavailable.\n May return stale data during network partitions.\n- \"dangerous\": Allow reads AND writes without quorum.\n WARNING: May lose data during failures!", "enum": [ "consistent", "degraded", "dangerous" ], "type": "string" }, "factor": { "default": 3, "description": "Factor is the replication factor (1, 2, 3, 5, 7, etc.)\nMust be the same on all nodes in the cluster", "maximum": 7, "minimum": 1, "type": "integer" }, "zoneRedundancy": { "description": "ZoneRedundancy controls how data is distributed across zones.\n\nValues:\n- \"Maximum\": Maximize redundancy by placing replicas in as many zones as possible\n- \"AtLeast(n)\": Require replicas to be in at least n different zones\n\nThe value n must not exceed the replication factor.\n\nExamples:\n- \"Maximum\" (default): Best effort zone distribution\n- \"AtLeast(1)\": No zone constraint (all replicas can be in one zone)\n- \"AtLeast(2)\": Survives 1 zone failure (requires 2+ zones)\n- \"AtLeast(3)\": Survives 2 zone failures (requires 3+ zones)", "pattern": "^(Maximum|AtLeast\\([1-7]\\))$", "type": "string" } }, "required": [ "factor" ], "type": "object", "additionalProperties": false }, "resources": { "description": "Resources specifies compute resources for Garage pods", "properties": { "claims": { "description": "Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis field depends on the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.", "items": { "description": "ResourceClaim references one entry in PodSpec.ResourceClaims.", "properties": { "name": { "description": "Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container.", "type": "string" }, "request": { "description": "Request is the name chosen for a request in the referenced claim.\nIf empty, everything from the claim is made available, otherwise\nonly the result of this request.", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" }, "limits": { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": "object" }, "requests": { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": "object" } }, "type": "object", "additionalProperties": false }, "s3Api": { "description": "S3API configures the S3-compatible API endpoint", "properties": { "bindAddress": { "description": "BindAddress is a custom bind address for the S3 API.\nCan be a TCP address (e.g., \"0.0.0.0:3900\", \"[::]:3900\") or\na Unix socket path (e.g., \"unix:///run/garage/s3.sock\").\nIf set, this overrides BindPort.", "type": "string" }, "bindPort": { "default": 3900, "description": "BindPort is the port to bind for S3 API", "format": "int32", "maximum": 65535, "minimum": 1, "type": "integer" }, "region": { "default": "garage", "description": "Region is the AWS S3 region name to use", "type": "string" }, "rootDomain": { "description": "RootDomain is the root domain suffix for vhost-style S3 access.\nWhen set, buckets can be accessed via ..\n\nExamples:\n- \".s3.garage.tld\" -> Access bucket \"mybucket\" at \"mybucket.s3.garage.tld\"\n- \".s3.example.com\" -> Access bucket \"data\" at \"data.s3.example.com\"\n\nNote: Include the leading dot.", "type": "string" } }, "required": [ "region" ], "type": "object", "additionalProperties": false }, "security": { "description": "Security configures security-related settings", "properties": { "allowPunycode": { "description": "AllowPunycode allows punycode in bucket names", "type": "boolean" }, "allowWorldReadableSecrets": { "description": "AllowWorldReadableSecrets bypasses permission check for secret files", "type": "boolean" }, "tls": { "description": "TLS configures TLS settings", "properties": { "caSecretRef": { "description": "CASecretRef references a secret containing the CA certificate for verifying peer nodes", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": "boolean" } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "certSecretRef": { "description": "CertSecretRef references a secret containing the TLS certificate for RPC", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": "boolean" } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "enabled": { "description": "Enabled enables TLS for inter-node RPC communication.\nNOTE: This does NOT enable TLS for S3/Admin APIs - use a service mesh or load balancer for that.", "type": "boolean" }, "keySecretRef": { "description": "KeySecretRef references a secret containing the TLS private key for RPC", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": "boolean" } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "securityContext": { "description": "SecurityContext for Garage pods", "properties": { "appArmorProfile": { "description": "appArmorProfile is the AppArmor options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\".", "type": "string" }, "type": { "description": "type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement.", "type": "string" } }, "required": [ "type" ], "type": "object", "additionalProperties": false }, "fsGroup": { "description": "A special supplemental group that applies to all containers in a pod.\nSome volume types allow the Kubelet to change the ownership of that volume\nto be owned by the pod:\n\n1. The owning GID will be the FSGroup\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\n3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\nNote that this field cannot be set when spec.os.name is windows.", "format": "int64", "type": "integer" }, "fsGroupChangePolicy": { "description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume\nbefore being exposed inside Pod. This field will only apply to\nvolume types which support fsGroup based ownership(and permissions).\nIt will have no effect on ephemeral volume types such as: secret, configmaps\nand emptydir.\nValid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.\nNote that this field cannot be set when spec.os.name is windows.", "type": "string" }, "runAsGroup": { "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows.", "format": "int64", "type": "integer" }, "runAsNonRoot": { "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.", "type": "boolean" }, "runAsUser": { "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows.", "format": "int64", "type": "integer" }, "seLinuxChangePolicy": { "description": "seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod.\nIt has no effect on nodes that do not support SELinux or to volumes does not support SELinux.\nValid values are \"MountOption\" and \"Recursive\".\n\n\"Recursive\" means relabeling of all files on all Pod volumes by the container runtime.\nThis may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.\n\n\"MountOption\" mounts all eligible Pod volumes with `-o context` mount option.\nThis requires all Pods that share the same volume to use the same SELinux label.\nIt is not possible to share the same volume among privileged and unprivileged Pods.\nEligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes\nwhose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their\nCSIDriver instance. Other volumes are always re-labelled recursively.\n\"MountOption\" value is allowed only when SELinuxMount feature gate is enabled.\n\nIf not specified and SELinuxMount feature gate is enabled, \"MountOption\" is used.\nIf not specified and SELinuxMount feature gate is disabled, \"MountOption\" is used for ReadWriteOncePod volumes\nand \"Recursive\" for all other volumes.\n\nThis field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.\n\nAll Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state.\nNote that this field cannot be set when spec.os.name is windows.", "type": "string" }, "seLinuxOptions": { "description": "The SELinux context to be applied to all containers.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in SecurityContext. If set in\nboth SecurityContext and PodSecurityContext, the value specified in SecurityContext\ntakes precedence for that container.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "level": { "description": "Level is SELinux level label that applies to the container.", "type": "string" }, "role": { "description": "Role is a SELinux role label that applies to the container.", "type": "string" }, "type": { "description": "Type is a SELinux type label that applies to the container.", "type": "string" }, "user": { "description": "User is a SELinux user label that applies to the container.", "type": "string" } }, "type": "object", "additionalProperties": false }, "seccompProfile": { "description": "The seccomp options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type.", "type": "string" }, "type": { "description": "type indicates which kind of seccomp profile will be applied.\nValid options are:\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied.", "type": "string" } }, "required": [ "type" ], "type": "object", "additionalProperties": false }, "supplementalGroups": { "description": "A list of groups applied to the first process run in each container, in\naddition to the container's primary GID and fsGroup (if specified). If\nthe SupplementalGroupsPolicy feature is enabled, the\nsupplementalGroupsPolicy field determines whether these are in addition\nto or instead of any group memberships defined in the container image.\nIf unspecified, no additional groups are added, though group memberships\ndefined in the container image may still be used, depending on the\nsupplementalGroupsPolicy field.\nNote that this field cannot be set when spec.os.name is windows.", "items": { "format": "int64", "type": "integer" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "supplementalGroupsPolicy": { "description": "Defines how supplemental groups of the first container processes are calculated.\nValid values are \"Merge\" and \"Strict\". If not specified, \"Merge\" is used.\n(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled\nand the container runtime must implement support for this feature.\nNote that this field cannot be set when spec.os.name is windows.", "type": "string" }, "sysctls": { "description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows.", "items": { "description": "Sysctl defines a kernel parameter to be set", "properties": { "name": { "description": "Name of a property to set", "type": "string" }, "value": { "description": "Value of a property to set", "type": "string" } }, "required": [ "name", "value" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "windowsOptions": { "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options within a container's SecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux.", "properties": { "gmsaCredentialSpec": { "description": "GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field.", "type": "string" }, "gmsaCredentialSpecName": { "description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.", "type": "string" }, "hostProcess": { "description": "HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true.", "type": "boolean" }, "runAsUserName": { "description": "The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "serviceAccountName": { "description": "ServiceAccountName for Garage pods", "type": "string" }, "serviceAnnotations": { "additionalProperties": { "type": "string" }, "description": "ServiceAnnotations to add to Garage services", "type": "object" }, "storage": { "description": "Storage configures storage settings for metadata and data.\nOptional - sensible defaults are provided:\n- Storage clusters: 10Gi metadata, 100Gi data\n- Gateway clusters: 1Gi metadata only (data uses EmptyDir)", "properties": { "data": { "description": "Data configures data block storage", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations to set on the data PVC. Only valid when Type=PersistentVolumeClaim.", "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Labels to set on the data PVC. Only valid when Type=PersistentVolumeClaim.", "type": "object" }, "paths": { "description": "Paths specifies multiple data directories with capacities\nFor advanced multi-disk configurations. Only valid when Type=PersistentVolumeClaim.", "items": { "description": "DataPath specifies a data directory with capacity", "properties": { "capacity": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Capacity of the drive (required unless readOnly)", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "path": { "description": "Path to the data directory", "type": "string" }, "readOnly": { "description": "ReadOnly marks directory as legacy read-only for migrations", "type": "boolean" }, "volume": { "description": "Volume configuration if using PVC", "properties": { "accessModes": { "description": "AccessModes for the PVC. Only valid when Type=PersistentVolumeClaim.", "items": { "type": "string" }, "type": "array" }, "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations to set on the PVC. Only valid when Type=PersistentVolumeClaim.", "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Labels to set on the PVC. Only valid when Type=PersistentVolumeClaim.", "type": "object" }, "selector": { "description": "Selector to select PVs. Only valid when Type=PersistentVolumeClaim.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": "object" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "size": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Size of the volume.\n- For PVC: storage request (defaults to 10Gi for metadata if not specified)\n- For EmptyDir: optional sizeLimit (if omitted, uses available node resources)", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "storageClassName": { "description": "StorageClassName for the PVC. Only valid when Type=PersistentVolumeClaim.", "type": "string" }, "type": { "default": "PersistentVolumeClaim", "description": "Type specifies the volume type: PersistentVolumeClaim (default) or EmptyDir.\nWhen EmptyDir, data is lost on pod restart - only use for testing.", "enum": [ "PersistentVolumeClaim", "EmptyDir" ], "type": "string" }, "volumeClaimTemplateSpec": { "description": "VolumeClaimTemplateSpec allows full customization of the PVC.\nOnly valid when Type=PersistentVolumeClaim.", "properties": { "accessModes": { "description": "accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "dataSource": { "description": "dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource.", "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.", "type": "string" }, "kind": { "description": "Kind is the type of resource being referenced", "type": "string" }, "name": { "description": "Name is the name of resource being referenced", "type": "string" } }, "required": [ "kind", "name" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "dataSourceRef": { "description": "dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.", "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.", "type": "string" }, "kind": { "description": "Kind is the type of resource being referenced", "type": "string" }, "name": { "description": "Name is the name of resource being referenced", "type": "string" }, "namespace": { "description": "Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.", "type": "string" } }, "required": [ "kind", "name" ], "type": "object", "additionalProperties": false }, "resources": { "description": "resources represents the minimum resources the volume should have.\nUsers are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources", "properties": { "limits": { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": "object" }, "requests": { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": "object" } }, "type": "object", "additionalProperties": false }, "selector": { "description": "selector is a label query over volumes to consider for binding.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": "object" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "storageClassName": { "description": "storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1", "type": "string" }, "volumeAttributesClassName": { "description": "volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string or nil value indicates that no\nVolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,\nthis field can be reset to its previous value (including nil) to cancel the modification.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/", "type": "string" }, "volumeMode": { "description": "volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec.", "type": "string" }, "volumeName": { "description": "volumeName is the binding reference to the PersistentVolume backing this claim.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "required": [ "path" ], "type": "object", "additionalProperties": false }, "type": "array" }, "size": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Size of the data volume. For PVC: storage request. For EmptyDir: sizeLimit (optional).", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "storageClassName": { "description": "StorageClassName for the data PVC. Only valid when Type=PersistentVolumeClaim.", "type": "string" }, "type": { "default": "PersistentVolumeClaim", "description": "Type specifies the volume type: PersistentVolumeClaim (default) or EmptyDir.\nWhen EmptyDir, data is lost on pod restart - only use for testing.", "enum": [ "PersistentVolumeClaim", "EmptyDir" ], "type": "string" } }, "type": "object", "additionalProperties": false }, "dataFsync": { "description": "DataFsync enables fsync for data block writes", "type": "boolean" }, "metadata": { "description": "Metadata configures metadata storage", "properties": { "accessModes": { "description": "AccessModes for the PVC. Only valid when Type=PersistentVolumeClaim.", "items": { "type": "string" }, "type": "array" }, "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations to set on the PVC. Only valid when Type=PersistentVolumeClaim.", "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Labels to set on the PVC. Only valid when Type=PersistentVolumeClaim.", "type": "object" }, "selector": { "description": "Selector to select PVs. Only valid when Type=PersistentVolumeClaim.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": "object" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "size": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Size of the volume.\n- For PVC: storage request (defaults to 10Gi for metadata if not specified)\n- For EmptyDir: optional sizeLimit (if omitted, uses available node resources)", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "storageClassName": { "description": "StorageClassName for the PVC. Only valid when Type=PersistentVolumeClaim.", "type": "string" }, "type": { "default": "PersistentVolumeClaim", "description": "Type specifies the volume type: PersistentVolumeClaim (default) or EmptyDir.\nWhen EmptyDir, data is lost on pod restart - only use for testing.", "enum": [ "PersistentVolumeClaim", "EmptyDir" ], "type": "string" }, "volumeClaimTemplateSpec": { "description": "VolumeClaimTemplateSpec allows full customization of the PVC.\nOnly valid when Type=PersistentVolumeClaim.", "properties": { "accessModes": { "description": "accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "dataSource": { "description": "dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource.", "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.", "type": "string" }, "kind": { "description": "Kind is the type of resource being referenced", "type": "string" }, "name": { "description": "Name is the name of resource being referenced", "type": "string" } }, "required": [ "kind", "name" ], "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "dataSourceRef": { "description": "dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.", "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.", "type": "string" }, "kind": { "description": "Kind is the type of resource being referenced", "type": "string" }, "name": { "description": "Name is the name of resource being referenced", "type": "string" }, "namespace": { "description": "Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.", "type": "string" } }, "required": [ "kind", "name" ], "type": "object", "additionalProperties": false }, "resources": { "description": "resources represents the minimum resources the volume should have.\nUsers are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources", "properties": { "limits": { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": "object" }, "requests": { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": "object" } }, "type": "object", "additionalProperties": false }, "selector": { "description": "selector is a label query over volumes to consider for binding.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": "object" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "storageClassName": { "description": "storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1", "type": "string" }, "volumeAttributesClassName": { "description": "volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string or nil value indicates that no\nVolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,\nthis field can be reset to its previous value (including nil) to cancel the modification.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/", "type": "string" }, "volumeMode": { "description": "volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec.", "type": "string" }, "volumeName": { "description": "volumeName is the binding reference to the PersistentVolume backing this claim.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "metadataAutoSnapshotInterval": { "description": "MetadataAutoSnapshotInterval enables automatic metadata snapshots\nFormat: \"6h\", \"1d\", etc.", "type": "string" }, "metadataFsync": { "description": "MetadataFsync enables fsync for metadata transactions", "type": "boolean" }, "metadataSnapshotsDir": { "description": "MetadataSnapshotsDir specifies directory for metadata snapshots", "type": "string" }, "pvcRetentionPolicy": { "description": "PVCRetentionPolicy controls whether PVCs are deleted when the StatefulSet is deleted or scaled down.\nRequires Kubernetes 1.23+. If not specified, defaults to Retain for both policies.", "properties": { "whenDeleted": { "default": "Retain", "description": "WhenDeleted specifies what happens to PVCs when the StatefulSet is deleted.\n- \"Retain\" (default): PVCs are kept for manual cleanup or data recovery\n- \"Delete\": PVCs are automatically deleted with the StatefulSet", "enum": [ "Retain", "Delete" ], "type": "string" }, "whenScaled": { "default": "Retain", "description": "WhenScaled specifies what happens to PVCs when the StatefulSet is scaled down.\n- \"Retain\" (default): PVCs are kept when scaling down (allows scale back up)\n- \"Delete\": PVCs for removed replicas are deleted", "enum": [ "Retain", "Delete" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "tolerations": { "description": "Tolerations for pod scheduling", "items": { "description": "The pod this Toleration is attached to tolerates any taint that matches\nthe triple using the matching operator .", "properties": { "effect": { "description": "Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.", "type": "string" }, "key": { "description": "Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys.", "type": "string" }, "operator": { "description": "Operator represents a key's relationship to the value.\nValid operators are Exists, Equal, Lt, and Gt. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category.\nLt and Gt perform numeric comparisons (requires feature gate TaintTolerationComparisonOperators).", "type": "string" }, "tolerationSeconds": { "description": "TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system.", "format": "int64", "type": "integer" }, "value": { "description": "Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "topologySpreadConstraints": { "description": "TopologySpreadConstraints for pod scheduling", "items": { "description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.", "properties": { "labelSelector": { "description": "LabelSelector is used to find matching pods.\nPods that match this label selector are counted to determine the number of pods\nin their corresponding topology domain.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": "object" } }, "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "matchLabelKeys": { "description": "MatchLabelKeys is a set of pod label keys to select the pods over which\nspreading will be calculated. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are ANDed with labelSelector\nto select the group of existing pods over which spreading will be calculated\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nMatchLabelKeys cannot be set when LabelSelector isn't set.\nKeys that don't exist in the incoming pod labels will\nbe ignored. A null or empty list means only match against labelSelector.\n\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "maxSkew": { "description": "MaxSkew describes the degree to which pods may be unevenly distributed.\nWhen `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference\nbetween the number of matching pods in the target topology and the global minimum.\nThe global minimum is the minimum number of matching pods in an eligible domain\nor zero if the number of eligible domains is less than MinDomains.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 2/2/1:\nIn this case, the global minimum is 1.\n| zone1 | zone2 | zone3 |\n| P P | P P | P |\n- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;\nscheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)\nviolate MaxSkew(1).\n- if MaxSkew is 2, incoming pod can be scheduled onto any zone.\nWhen `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence\nto topologies that satisfy it.\nIt's a required field. Default value is 1 and 0 is not allowed.", "format": "int32", "type": "integer" }, "minDomains": { "description": "MinDomains indicates a minimum number of eligible domains.\nWhen the number of eligible domains with matching topology keys is less than minDomains,\nPod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed.\nAnd when the number of eligible domains with matching topology keys equals or greater than minDomains,\nthis value has no effect on scheduling.\nAs a result, when the number of eligible domains is less than minDomains,\nscheduler won't schedule more than maxSkew Pods to those domains.\nIf value is nil, the constraint behaves as if MinDomains is equal to 1.\nValid values are integers greater than 0.\nWhen value is not nil, WhenUnsatisfiable must be DoNotSchedule.\n\nFor example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same\nlabelSelector spread as 2/2/2:\n| zone1 | zone2 | zone3 |\n| P P | P P | P P |\nThe number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0.\nIn this situation, new pod with the same labelSelector cannot be scheduled,\nbecause computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,\nit will violate MaxSkew.", "format": "int32", "type": "integer" }, "nodeAffinityPolicy": { "description": "NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector\nwhen calculating pod topology spread skew. Options are:\n- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.\n- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\n\nIf this value is nil, the behavior is equivalent to the Honor policy.", "type": "string" }, "nodeTaintsPolicy": { "description": "NodeTaintsPolicy indicates how we will treat node taints when calculating\npod topology spread skew. Options are:\n- Honor: nodes without taints, along with tainted nodes for which the incoming pod\nhas a toleration, are included.\n- Ignore: node taints are ignored. All nodes are included.\n\nIf this value is nil, the behavior is equivalent to the Ignore policy.", "type": "string" }, "topologyKey": { "description": "TopologyKey is the key of node labels. Nodes that have a label with this key\nand identical values are considered to be in the same topology.\nWe consider each as a \"bucket\", and try to put balanced number\nof pods into each bucket.\nWe define a domain as a particular instance of a topology.\nAlso, we define an eligible domain as a domain whose nodes meet the requirements of\nnodeAffinityPolicy and nodeTaintsPolicy.\ne.g. If TopologyKey is \"kubernetes.io/hostname\", each Node is a domain of that topology.\nAnd, if TopologyKey is \"topology.kubernetes.io/zone\", each zone is a domain of that topology.\nIt's a required field.", "type": "string" }, "whenUnsatisfiable": { "description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy\nthe spread constraint.\n- DoNotSchedule (default) tells the scheduler not to schedule it.\n- ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod\nif and only if every possible node assignment for that pod would violate\n\"MaxSkew\" on some topology.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 3/1/1:\n| zone1 | zone2 | zone3 |\n| P P P | P | P |\nIf WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled\nto zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies\nMaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler\nwon't make it *more* imbalanced.\nIt's a required field.", "type": "string" } }, "required": [ "maxSkew", "topologyKey", "whenUnsatisfiable" ], "type": "object", "additionalProperties": false }, "type": "array" }, "webApi": { "description": "WebAPI configures the static website hosting endpoint.\nEnabled by default with rootDomain \"...svc\".\nSet webApi.disabled: true to turn off.", "properties": { "addHostToMetrics": { "description": "AddHostToMetrics adds the domain name to metrics labels for per-domain tracking.", "type": "boolean" }, "bindAddress": { "description": "BindAddress is a custom bind address for the Web API.\nCan be a TCP address or Unix socket path (e.g., \"unix:///run/garage/web.sock\").\nIf set, this overrides BindPort.", "type": "string" }, "bindPort": { "default": 3902, "description": "BindPort is the port to bind for web serving", "format": "int32", "maximum": 65535, "minimum": 1, "type": "integer" }, "disabled": { "description": "Disabled disables the web endpoint entirely.", "type": "boolean" }, "rootDomain": { "description": "RootDomain is the root domain suffix for bucket website access.\nBucket websites are accessible via ..\nDefaults to \"...svc\" if not specified.\n\nExamples:\n- \".web.garage.tld\" -> Access bucket \"site\" website at \"site.web.garage.tld\"\n- \".sites.example.com\" -> Access bucket \"blog\" at \"blog.sites.example.com\"\n\nNote: Include the leading dot.", "type": "string" } }, "type": "object", "additionalProperties": false }, "zone": { "description": "Zone is the zone name for all nodes in this cluster.\nUsed for fault tolerance - Garage distributes replicas across zones.\nRequired for multi-cluster federation.\n\nExamples: \"us-east-1\", \"rack-a\", \"dc1\", \"zone-a\"", "type": "string" } }, "required": [ "replicas", "replication" ], "type": "object", "additionalProperties": false }, "status": { "description": "GarageClusterStatus defines the observed state of GarageCluster", "properties": { "activeRepairs": { "description": "ActiveRepairs contains currently running repair operations", "items": { "description": "RepairStatus contains status of a repair operation", "properties": { "nodeId": { "description": "NodeID is the node running this repair", "type": "string" }, "progress": { "description": "Progress is a human-readable progress description", "type": "string" }, "startedAt": { "description": "StartedAt is when the repair started", "format": "date-time", "type": "string" }, "type": { "description": "Type is the repair operation type (Tables, Blocks, Scrub, Rebalance, etc.)", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "blockErrorDetails": { "description": "BlockErrorDetails provides detailed information about block errors", "properties": { "count": { "description": "Count is the total number of blocks with errors", "format": "int32", "type": "integer" }, "lastErrorAt": { "description": "LastErrorAt is when the most recent block error occurred", "format": "date-time", "type": "string" }, "topErrors": { "description": "TopErrors contains details about the most problematic blocks\nLimited to top 10 blocks by error count", "items": { "description": "BlockErrorDetail contains information about a specific block error", "properties": { "blockHash": { "description": "BlockHash is the hash of the affected block", "type": "string" }, "errorCount": { "description": "ErrorCount is the number of times this block failed to sync", "format": "int32", "type": "integer" }, "lastAttempt": { "description": "LastAttempt is when the last sync attempt occurred", "format": "date-time", "type": "string" }, "lastError": { "description": "LastError is the most recent error message for this block", "type": "string" }, "nextRetry": { "description": "NextRetry is when the next sync retry is scheduled", "format": "date-time", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "blockErrors": { "description": "BlockErrors is the count of blocks with sync errors across all nodes", "format": "int32", "type": "integer" }, "buildInfo": { "description": "BuildInfo contains Garage build information", "properties": { "features": { "description": "Features lists enabled Cargo features", "items": { "type": "string" }, "type": "array" }, "rustVersion": { "description": "RustVersion is the Rust compiler version used to build Garage", "type": "string" }, "version": { "description": "Version is the Garage version string (e.g., \"v1.0.1\")", "type": "string" } }, "type": "object", "additionalProperties": false }, "clusterId": { "description": "ClusterID is the unique identifier of the Garage cluster", "type": "string" }, "conditions": { "description": "Conditions represent the current state of the cluster", "items": { "description": "Condition contains details for one aspect of the current state of this API Resource.", "properties": { "lastTransitionTime": { "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "format": "date-time", "type": "string" }, "message": { "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", "maxLength": 32768, "type": "string" }, "observedGeneration": { "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", "format": "int64", "minimum": 0, "type": "integer" }, "reason": { "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", "maxLength": 1024, "minLength": 1, "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "type": "string" }, "status": { "description": "status of the condition, one of True, False, Unknown.", "enum": [ "True", "False", "Unknown" ], "type": "string" }, "type": { "description": "type of condition in CamelCase or in foo.example.com/CamelCase.", "maxLength": 316, "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "type": "string" } }, "required": [ "lastTransitionTime", "message", "reason", "status", "type" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-map-keys": [ "type" ], "x-kubernetes-list-type": "map" }, "drainingNodes": { "description": "DrainingNodes is the count of nodes that are draining data from an older layout version.\nThese nodes had a storage role in a previous layout and are migrating data to other nodes.\nA non-zero value indicates a layout transition is in progress.", "type": "integer" }, "endpoints": { "description": "Endpoints contains service endpoints", "properties": { "admin": { "description": "Admin is the admin API endpoint", "type": "string" }, "k2v": { "description": "K2V is the K2V API endpoint", "type": "string" }, "metrics": { "description": "Metrics is the Prometheus metrics endpoint (typically Admin + /metrics)", "type": "string" }, "rpc": { "description": "RPC is the internal RPC endpoint", "type": "string" }, "s3": { "description": "S3 is the S3 API endpoint", "type": "string" }, "web": { "description": "Web is the web hosting endpoint", "type": "string" } }, "type": "object", "additionalProperties": false }, "health": { "description": "Health contains cluster health information", "properties": { "available": { "description": "Available indicates if quorum is available", "type": "boolean" }, "connectedNodes": { "description": "ConnectedNodes is the number of currently connected nodes", "type": "integer" }, "healthy": { "description": "Healthy indicates if all nodes are connected", "type": "boolean" }, "knownNodes": { "description": "KnownNodes is the number of nodes seen in cluster", "type": "integer" }, "partitions": { "description": "Partitions is the total partitions in layout", "type": "integer" }, "partitionsAllOk": { "description": "PartitionsAllOK is partitions with all nodes connected", "type": "integer" }, "partitionsQuorum": { "description": "PartitionsQuorum is partitions with quorum connectivity", "type": "integer" }, "status": { "description": "Status is the overall cluster status", "type": "string" }, "storageNodes": { "description": "StorageNodes is the number of storage nodes in layout", "type": "integer" }, "storageNodesOk": { "description": "StorageNodesOK is the number of connected storage nodes", "type": "integer" } }, "type": "object", "additionalProperties": false }, "layoutHistory": { "description": "LayoutHistory contains layout version history", "properties": { "currentVersion": { "description": "CurrentVersion is the current layout version", "format": "int64", "type": "integer" }, "minAck": { "description": "MinAck is the minimum acknowledged layout version by all nodes", "format": "int64", "type": "integer" }, "versions": { "description": "Versions contains the history of layout versions", "items": { "description": "LayoutVersionInfo contains information about a layout version", "properties": { "gatewayNodes": { "description": "GatewayNodes is the number of gateway nodes in this version", "type": "integer" }, "status": { "description": "Status is the version status (Current, Draining, Historical)", "type": "string" }, "storageNodes": { "description": "StorageNodes is the number of storage nodes in this version", "type": "integer" }, "version": { "description": "Version is the layout version number", "format": "int64", "type": "integer" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "layoutPreview": { "description": "LayoutPreview shows what would change if staged layout is applied", "properties": { "dataTransferEstimate": { "description": "DataTransferEstimate is a human-readable estimate of data movement (e.g., \"~50 GB\")", "type": "string" }, "nodesAdded": { "description": "NodesAdded shows node IDs that would be added to the layout", "items": { "type": "string" }, "type": "array" }, "nodesModified": { "description": "NodesModified shows node IDs with changed configuration (zone, capacity, tags)", "items": { "type": "string" }, "type": "array" }, "nodesRemoved": { "description": "NodesRemoved shows node IDs that would be removed from the layout", "items": { "type": "string" }, "type": "array" }, "partitionTransfers": { "description": "PartitionTransfers is the estimated number of partition transfers", "format": "int32", "type": "integer" }, "zonesAffected": { "description": "ZonesAffected shows which zones would be affected by the changes", "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "layoutVersion": { "description": "LayoutVersion is the current layout version", "format": "int64", "type": "integer" }, "lifecycleStatus": { "description": "LifecycleStatus contains the status of bucket lifecycle operations", "properties": { "lastCompleted": { "description": "LastCompleted is when the last lifecycle worker run completed\n(from lifecycle-last-completed worker variable)", "format": "date-time", "type": "string" } }, "type": "object", "additionalProperties": false }, "nodes": { "description": "Nodes contains status information for each node", "items": { "description": "NodeStatus contains status information for a Garage node", "properties": { "capacity": { "description": "Capacity is the storage capacity of the node", "type": "string" }, "connected": { "description": "Connected indicates if the node is connected to the cluster", "type": "boolean" }, "dataDiskAvailable": { "description": "DataDiskAvailable is the available space on data disk", "type": "string" }, "dataDiskTotal": { "description": "DataDiskTotal is the total space on data disk", "type": "string" }, "gateway": { "description": "Gateway indicates if the node is gateway-only", "type": "boolean" }, "metadataDiskAvailable": { "description": "MetadataDiskAvailable is the available space on metadata disk", "type": "string" }, "metadataDiskTotal": { "description": "MetadataDiskTotal is the total space on metadata disk", "type": "string" }, "nodeId": { "description": "NodeID is the public key of the node", "type": "string" }, "podName": { "description": "PodName is the name of the pod running this node", "type": "string" }, "version": { "description": "Version is the Garage version running on this node", "type": "string" }, "zone": { "description": "Zone is the zone assignment of the node", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "observedGeneration": { "description": "ObservedGeneration is the last observed generation", "format": "int64", "type": "integer" }, "phase": { "description": "Phase represents the current phase of the cluster", "type": "string" }, "readyReplicas": { "description": "ReadyReplicas is the number of ready Garage pods", "format": "int32", "type": "integer" }, "remoteClusters": { "description": "RemoteClusters contains status of remote clusters in the federation", "items": { "description": "RemoteClusterStatus is the status of a remote cluster", "properties": { "connected": { "description": "Connected indicates if we can reach this cluster", "type": "boolean" }, "healthyNodes": { "description": "HealthyNodes is the number of healthy nodes", "type": "integer" }, "lastSeen": { "description": "LastSeen is when we last successfully connected", "format": "date-time", "type": "string" }, "name": { "description": "Name is the cluster name", "type": "string" }, "nodes": { "description": "Nodes is the number of nodes in this cluster", "type": "integer" }, "zone": { "description": "Zone is the cluster's zone", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "replicas": { "description": "Replicas is the total number of Garage pods targeted by this cluster", "format": "int32", "type": "integer" }, "resyncQueueLength": { "description": "ResyncQueueLength is the total block resync queue depth across all nodes", "format": "int64", "type": "integer" }, "scrubStatus": { "description": "ScrubStatus contains the status of data scrub operations", "properties": { "corruptedBlocks": { "description": "CorruptedBlocks is the number of corrupted blocks found in the last scrub\n(from scrub-corruptions_detected worker variable)", "format": "int32", "type": "integer" }, "lastCompleted": { "description": "LastCompleted is when the last scrub completed (from scrub-last-completed worker variable)", "format": "date-time", "type": "string" }, "nextRun": { "description": "NextRun is when the next scrub is scheduled to run (from scrub-next-run worker variable)", "format": "date-time", "type": "string" }, "nodeStatuses": { "description": "NodeStatuses contains per-node scrub status", "items": { "description": "NodeScrubStatus contains scrub status for a single node", "properties": { "errorsFound": { "description": "ErrorsFound is the number of errors found on this node", "format": "int32", "type": "integer" }, "itemsChecked": { "description": "ItemsChecked is the number of items checked", "format": "int64", "type": "integer" }, "nodeId": { "description": "NodeID is the node identifier", "type": "string" }, "progress": { "description": "Progress percentage (0-100)", "type": "integer" }, "running": { "description": "Running indicates if scrub is running on this node", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "paused": { "description": "Paused indicates if the scrub is paused", "type": "boolean" }, "progress": { "description": "Progress is a human-readable progress description (e.g., \"45% complete\")", "type": "string" }, "running": { "description": "Running indicates if a scrub is currently running on any node", "type": "boolean" }, "tranquilityLevel": { "description": "TranquilityLevel is the current tranquility setting (higher = less aggressive)", "type": "integer" } }, "type": "object", "additionalProperties": false }, "selector": { "description": "Selector is the serialized label selector for pods managed by this cluster.\nRequired for the scale subresource to work with HPA/VPA.", "type": "string" }, "stagedLayoutVersion": { "description": "StagedLayoutVersion is the staged layout version pending application", "format": "int64", "type": "integer" }, "stagedRoles": { "description": "StagedRoles is the number of roles in the staged layout", "format": "int32", "type": "integer" }, "storageStats": { "description": "StorageStats contains cluster-wide storage statistics", "properties": { "availableCapacity": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "AvailableCapacity is the available storage across all nodes", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "healthyPartitions": { "description": "HealthyPartitions is the number of partitions with full redundancy", "format": "int32", "type": "integer" }, "totalCapacity": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "TotalCapacity is the total storage capacity across all nodes", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "totalPartitions": { "description": "TotalPartitions is the total number of partitions in the layout", "format": "int32", "type": "integer" }, "usedCapacity": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "UsedCapacity is the used storage across all nodes", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true } }, "type": "object", "additionalProperties": false }, "totalNodes": { "description": "TotalNodes is the total nodes across all clusters (local + remote)", "type": "integer" }, "workerCount": { "description": "WorkerCount is the total number of background workers", "format": "int32", "type": "integer" }, "workers": { "description": "Workers contains detailed information about background workers", "properties": { "busy": { "description": "Busy is the number of busy/active workers", "format": "int32", "type": "integer" }, "errored": { "description": "Errored is the number of workers with errors", "format": "int32", "type": "integer" }, "errors": { "description": "Errors contains details about worker errors", "items": { "description": "WorkerError contains information about a worker error", "properties": { "consecutiveErrors": { "description": "ConsecutiveErrors is the count of consecutive errors", "format": "int32", "type": "integer" }, "lastError": { "description": "LastError is the last error message", "type": "string" }, "lastErrorSecsAgo": { "description": "LastErrorSecsAgo is seconds since the last error", "format": "int64", "type": "integer" }, "name": { "description": "Name is the worker name", "type": "string" }, "workerId": { "description": "WorkerID is the worker identifier", "format": "int64", "type": "integer" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "idle": { "description": "Idle is the number of idle workers", "format": "int32", "type": "integer" }, "total": { "description": "Total is the total number of background workers", "format": "int32", "type": "integer" }, "variables": { "additionalProperties": { "type": "string" }, "description": "Variables contains runtime worker configuration variables\nThese can be adjusted through the Admin API to tune background worker behavior", "type": "object" } }, "type": "object", "additionalProperties": false }, "workersFailed": { "description": "WorkersFailed is the number of failed workers", "format": "int32", "type": "integer" } }, "required": [ "replicas", "selector" ], "type": "object", "additionalProperties": false } }, "required": [ "spec" ], "type": "object" }