ResourceGraphDefinition
The ResourceGraphDefinition (RGD) is kro's core API for defining custom Kubernetes resources that orchestrate multiple underlying resources.
API Specification
API Version
kro.run/v1alpha1Kind
ResourceGraphDefinitionScope
ClusterFields Reference
Spec
| Field | Type | Description |
|---|---|---|
resources | []object | The resources that are part of the resourcegraphdefinition. |
externalRef | object | ExternalRef is a reference to an external resource. It allows the user to specify the Kind, Version, Name and Namespace of the resource to be read and used in the Graph. |
idrequired | string | No description |
includeWhen | []string | No description |
readyWhen | []string | No description |
template | object | No description |
schemarequired | object | The schema of the resourcegraphdefinition, which includes the apiVersion, kind, spec, status, types, and some validation rules. |
additionalPrinterColumns | []object | AdditionalPrinterColumns defines additional printer columns that will be passed down to the created CRD. If set, no default printer columns will be added to the created CRD, and if default printer columns need to be retained, they need to be added explicitly. |
apiVersionrequiredimmutable | string | The APIVersion of the resourcegraphdefinition. This is used to generate and create the CRD for the resourcegraphdefinition. |
group | string | The group of the resourcegraphdefinition. This is used to set the API group of the generated CRD. If omitted, it defaults to "kro.run". |
kindrequiredimmutable | string | The kind of the resourcegraphdefinition. This is used to generate and create the CRD for the resourcegraphdefinition. |
spec | object | The spec of the resourcegraphdefinition. Typically, this is the spec of the CRD that the resourcegraphdefinition is managing. This is adhering to the SimpleSchema spec |
status | object | The status of the resourcegraphdefinition. This is the status of the CRD that the resourcegraphdefinition is managing. This is adhering to the SimpleSchema spec. |
types | object | Types is a map of custom type definitions. These can be used in the spec of the resourcegraphdefinition. Each type definition is also adhering to the SimpleSchema spec. |
Status
| Field | Type | Description |
|---|---|---|
conditions | []object | Conditions represent the latest available observations of an object's state |
lastTransitionTime | string | Last time the condition transitioned from one status to another. |
message | string | A human-readable message indicating details about the transition. |
observedGeneration | integer | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. |
reason | string | The reason for the condition's last transition. |
statusrequired | string | Status of the condition, one of True, False, Unknown. |
typerequired | string | Type is the type of the Condition |
resources | []object | Resources represents the resources, and their information (dependencies for now) |
dependencies | []object | Dependencies represents the resource dependencies of a resource graph definition |
id | string | ID represents the id of the resources we're providing information for |
state | string | State is the state of the resourcegraphdefinition |
topologicalOrder | []string | TopologicalOrder is the topological order of the resourcegraphdefinition graph |