Skip to content

resources.md

Latest commit

 

History

History
398 lines (364 loc) · 7.17 KB

resources.md

File metadata and controls

398 lines (364 loc) · 7.17 KB

Packages:

resources.gardener.cloud/v1alpha1

Resource Types:

ManagedResource

ManagedResource describes a list of managed resources.

Field Description
metadata
ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ManagedResourceSpec

Spec contains the specification of this managed resource.
status
ManagedResourceStatus

Status contains the status of this managed resource.

ManagedResourceSpec

(Appears on:ManagedResource)

ManagedResourceSpec contains the specification of this managed resource.

Field Description
class
string 		(Optional)

Class holds the resource class used to control the responsibility for multiple resource manager instances
secretRefs
LocalObjectReference array

SecretRefs is a list of secret references.
injectLabels
object (keys:string, values:string) 		(Optional)

InjectLabels injects the provided labels into every resource that is part of the referenced secrets.
forceOverwriteLabels
boolean 		(Optional)

ForceOverwriteLabels specifies that all existing labels should be overwritten. Defaults to false.
forceOverwriteAnnotations
boolean 		(Optional)

ForceOverwriteAnnotations specifies that all existing annotations should be overwritten. Defaults to false.
keepObjects
boolean 		(Optional)

KeepObjects specifies whether the objects should be kept although the managed resource has already been deleted.
Defaults to false.
equivalences
GroupKind array 		(Optional)

Equivalences specifies possible group/kind equivalences for objects.
deletePersistentVolumeClaims
boolean 		(Optional)

DeletePersistentVolumeClaims specifies if PersistentVolumeClaims created by StatefulSets, which are managed by this
resource, should also be deleted when the corresponding StatefulSet is deleted (defaults to false).

ManagedResourceStatus

(Appears on:ManagedResource)

ManagedResourceStatus is the status of a managed resource.

Field Description
conditions
Condition array

observedGeneration
integer

ObservedGeneration is the most recent generation observed for this resource.
resources
ObjectReference array 		(Optional)

Resources is a list of objects that have been created.
secretsDataChecksum
string 		(Optional)

SecretsDataChecksum is the checksum of referenced secrets data.

ObjectReference

(Appears on:ManagedResourceStatus)

ObjectReference is a reference to another object.

Field Description
kind
string 		(Optional)

Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
namespace
string 		(Optional)

Namespace of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
name
string 		(Optional)

Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
uid
UID 		(Optional)

UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
apiVersion
string 		(Optional)

API version of the referent.
resourceVersion
string 		(Optional)

Specific resourceVersion to which this reference is made, if any.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
fieldPath
string 		(Optional)

If referring to a piece of an object instead of an entire object, this string
should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within a pod, this would take on a value like:
"spec.containers\{name\}" (where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]" (container with
index 2 in this pod). This syntax is chosen only to have some well-defined way of
referencing a part of an object.
labels
object (keys:string, values:string)

Labels is a map of labels that were used during last update of the resource.
annotations
object (keys:string, values:string)

Annotations is a map of annotations that were used during last update of the resource.