kro.v1alpha1.resourceGraphDefinition

"ResourceGraphDefinition is the core API for defining reusable groups of Kubernetes resources.\nIt allows you to create custom resources that manage multiple underlying resources as a cohesive unit.\nWhen you create a ResourceGraphDefinition, kro automatically generates a CRD and deploys a controller\nto manage instances of your custom resource. Resources can reference each other using CEL expressions,\nand kro ensures they are created in the correct dependency order."

Fields

fn new

new(name)

new returns an instance of ResourceGraphDefinition

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn metadata.withSelfLink

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"ResourceGraphDefinitionSpec defines the desired state of ResourceGraphDefinition.\nIt contains the schema for instances (defining the CRD structure) and the list of\nKubernetes resources that make up the graph."

fn spec.withResources

withResources(resources)

"Resources is the list of Kubernetes resources that will be created and managed\nfor each instance. Resources can reference each other using CEL expressions,\ncreating a dependency graph that determines creation order."

fn spec.withResourcesMixin

withResourcesMixin(resources)

"Resources is the list of Kubernetes resources that will be created and managed\nfor each instance. Resources can reference each other using CEL expressions,\ncreating a dependency graph that determines creation order."

Note: This function appends passed data to existing values

obj spec.resources

"Resources is the list of Kubernetes resources that will be created and managed\nfor each instance. Resources can reference each other using CEL expressions,\ncreating a dependency graph that determines creation order."

fn spec.resources.withForEach

withForEach(forEach)

"ForEach expands this resource into a collection of resources.\nEach entry binds a variable name to a CEL expression that evaluates to an array.\nkro creates one resource instance for each element in the array.\nWith multiple entries, kro creates the cartesian product of all combinations.\nUse the variable directly in template expressions (e.g., ${region}).\nExample: [{\"region\": \"${schema.spec.regions}\"}, {\"tier\": \"${schema.spec.tiers}\"}]"

fn spec.resources.withForEachMixin

withForEachMixin(forEach)

"ForEach expands this resource into a collection of resources.\nEach entry binds a variable name to a CEL expression that evaluates to an array.\nkro creates one resource instance for each element in the array.\nWith multiple entries, kro creates the cartesian product of all combinations.\nUse the variable directly in template expressions (e.g., ${region}).\nExample: [{\"region\": \"${schema.spec.regions}\"}, {\"tier\": \"${schema.spec.tiers}\"}]"

Note: This function appends passed data to existing values

fn spec.resources.withId

withId(id)

"ID is a unique identifier for this resource within the ResourceGraphDefinition.\nIt is used to reference this resource in CEL expressions from other resources.\nExample: \"deployment\", \"service\", \"configmap\"."

fn spec.resources.withIncludeWhen

withIncludeWhen(includeWhen)

"IncludeWhen is a list of CEL expressions that determine whether this resource should be created.\nAll expressions must evaluate to true for the resource to be included.\nIf not specified, the resource is always included.\nExample: [\"schema.spec.enableMonitoring == true\"]"

fn spec.resources.withIncludeWhenMixin

withIncludeWhenMixin(includeWhen)

"IncludeWhen is a list of CEL expressions that determine whether this resource should be created.\nAll expressions must evaluate to true for the resource to be included.\nIf not specified, the resource is always included.\nExample: [\"schema.spec.enableMonitoring == true\"]"

Note: This function appends passed data to existing values

fn spec.resources.withReadyWhen

withReadyWhen(readyWhen)

"ReadyWhen is a list of CEL expressions that determine when this resource is considered ready.\nAll expressions must evaluate to true for the resource to be ready.\nIf not specified, the resource is considered ready when it exists.\nExample: [\"self.status.phase == 'Running'\", \"self.status.readyReplicas > 0\"]"

fn spec.resources.withReadyWhenMixin

withReadyWhenMixin(readyWhen)

"ReadyWhen is a list of CEL expressions that determine when this resource is considered ready.\nAll expressions must evaluate to true for the resource to be ready.\nIf not specified, the resource is considered ready when it exists.\nExample: [\"self.status.phase == 'Running'\", \"self.status.readyReplicas > 0\"]"

Note: This function appends passed data to existing values

fn spec.resources.withTemplate

withTemplate(template)

"Template is the Kubernetes resource manifest to create.\nIt can contain CEL expressions (using ${...} syntax) that reference other resources.\nExactly one of template or externalRef must be provided."

fn spec.resources.withTemplateMixin

withTemplateMixin(template)

"Template is the Kubernetes resource manifest to create.\nIt can contain CEL expressions (using ${...} syntax) that reference other resources.\nExactly one of template or externalRef must be provided."

Note: This function appends passed data to existing values

obj spec.resources.externalRef

"ExternalRef references an existing resource in the cluster instead of creating one.\nThis is useful for reading existing resources and using their values in other resources.\nExactly one of template or externalRef must be provided."

fn spec.resources.externalRef.withApiVersion

withApiVersion(apiVersion)

"APIVersion is the API version of the external resource.\nExample: \"v1\" for core resources, \"apps/v1\" for Deployments."

fn spec.resources.externalRef.withKind

withKind(kind)

"Kind is the kind of the external resource.\nExample: \"Service\", \"ConfigMap\", \"Deployment\"."

obj spec.resources.externalRef.metadata

"Metadata contains the name and optional namespace of the external resource."

fn spec.resources.externalRef.metadata.withName

withName(name)

"Name is the name of the external resource to reference.\nThis field is required."

fn spec.resources.externalRef.metadata.withNamespace

withNamespace(namespace)

"Namespace is the namespace of the external resource.\nIf empty, the instance's namespace will be used."

obj spec.schema

"Schema defines the structure of instances created from this ResourceGraphDefinition.\nIt specifies the API version, kind, and fields (spec/status) for the generated CRD.\nUse SimpleSchema syntax to define the instance schema concisely."

fn spec.schema.withAdditionalPrinterColumns

withAdditionalPrinterColumns(additionalPrinterColumns)

"AdditionalPrinterColumns defines additional printer columns\nthat will be passed down to the created CRD. If set, no\ndefault printer columns will be added to the created CRD,\nand if default printer columns need to be retained, they\nneed to be added explicitly."

fn spec.schema.withAdditionalPrinterColumnsMixin

withAdditionalPrinterColumnsMixin(additionalPrinterColumns)

"AdditionalPrinterColumns defines additional printer columns\nthat will be passed down to the created CRD. If set, no\ndefault printer columns will be added to the created CRD,\nand if default printer columns need to be retained, they\nneed to be added explicitly."

Note: This function appends passed data to existing values

fn spec.schema.withApiVersion

withApiVersion(apiVersion)

"APIVersion is the version identifier for the generated CRD.\nMust follow Kubernetes versioning conventions (v1, v1alpha1, v1beta1, etc.).\nThis field is immutable after creation.\nExample: \"v1alpha1\", \"v1\", \"v2beta1\

fn spec.schema.withGroup

withGroup(group)

"Group is the API group for the generated CRD. Together with APIVersion and Kind,\nit forms the complete GVK (Group-Version-Kind) identifier.\nIf omitted, defaults to \"kro.run\". This field is immutable after creation.\nExample: \"mycompany.io\", \"databases.example.com\

fn spec.schema.withKind

withKind(kind)

"Kind is the name of the custom resource type that will be created.\nThis becomes the kind field of the generated CRD and must be a valid Kubernetes kind name\n(PascalCase, starting with a capital letter). This field is immutable after creation.\nExample: \"WebApplication\", \"Database\", \"MicroService\

fn spec.schema.withSpec

withSpec(spec)

"Spec defines the schema for the instance's spec section using SimpleSchema syntax.\nThis becomes the OpenAPI schema for instances of the generated CRD.\nUse SimpleSchema's concise syntax to define fields, types, defaults, and validations.\nExample: {\"replicas\": \"integer | default=1 | min=1 | max=10\"}"

fn spec.schema.withSpecMixin

withSpecMixin(spec)

"Spec defines the schema for the instance's spec section using SimpleSchema syntax.\nThis becomes the OpenAPI schema for instances of the generated CRD.\nUse SimpleSchema's concise syntax to define fields, types, defaults, and validations.\nExample: {\"replicas\": \"integer | default=1 | min=1 | max=10\"}"

Note: This function appends passed data to existing values

fn spec.schema.withTypes

withTypes(types)

"Types is a map of custom type definitions that can be referenced in the Spec.\nThis allows you to define reusable complex types using SimpleSchema syntax.\nReference custom types in Spec using the type name.\nExample: {\"Server\": {\"host\": \"string\", \"port\": \"integer\"}}"

fn spec.schema.withTypesMixin

withTypesMixin(types)

"Types is a map of custom type definitions that can be referenced in the Spec.\nThis allows you to define reusable complex types using SimpleSchema syntax.\nReference custom types in Spec using the type name.\nExample: {\"Server\": {\"host\": \"string\", \"port\": \"integer\"}}"

Note: This function appends passed data to existing values

obj spec.schema.additionalPrinterColumns

"AdditionalPrinterColumns defines additional printer columns\nthat will be passed down to the created CRD. If set, no\ndefault printer columns will be added to the created CRD,\nand if default printer columns need to be retained, they\nneed to be added explicitly."

fn spec.schema.additionalPrinterColumns.withDescription

withDescription(description)

"description is a human readable description of this column."

fn spec.schema.additionalPrinterColumns.withFormat

withFormat(format)

"format is an optional OpenAPI type definition for this column. The 'name' format is applied\nto the primary identifier column to assist in clients identifying column is the resource name.\nSee https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details."

fn spec.schema.additionalPrinterColumns.withJsonPath

withJsonPath(jsonPath)

"jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against\neach custom resource to produce the value for this column."

fn spec.schema.additionalPrinterColumns.withName

withName(name)

"name is a human readable name for the column."

fn spec.schema.additionalPrinterColumns.withPriority

withPriority(priority)

"priority is an integer defining the relative importance of this column compared to others. Lower\nnumbers are considered higher priority. Columns that may be omitted in limited space scenarios\nshould be given a priority greater than 0."

fn spec.schema.additionalPrinterColumns.withType

withType(type)

"type is an OpenAPI type definition for this column.\nSee https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details."

obj spec.schema.metadata

"Metadata to apply to the generated CRD"

fn spec.schema.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to apply to the generated CRD"

fn spec.schema.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to apply to the generated CRD"

Note: This function appends passed data to existing values

fn spec.schema.metadata.withLabels

withLabels(labels)

"Labels to apply to the generated CRD"

fn spec.schema.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to apply to the generated CRD"

Note: This function appends passed data to existing values