AdoptedResource
services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | runtime/apis/core/v1alpha1#AdoptedResource |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | AdoptedResource |
| ListKind | AdoptedResourceList |
| Plural | adoptedresources |
| Singular | adoptedresource |
Spec
aws:
additionalKeys: {}
arn: string
nameOrID: string
kubernetes:
group: string
kind: string
metadata:
annotations: {}
generateName: string
labels: {}
name: string
namespace: string
ownerReferences:
- apiVersion: string
blockOwnerDeletion: boolean
controller: boolean
kind: string
name: string
uid: string
| Field | Description |
|---|---|
| aws Required | object AWSIdentifiers provide all unique ways to reference an AWS resource. |
| aws.additionalKeys Optional | object AdditionalKeys represents any additional arbitrary identifiers used when describing the target resource. |
| aws.arn Optional | string ARN is the AWS Resource Name for the resource. It is a globally unique identifier. |
| aws.nameOrID Optional | string NameOrId is a user-supplied string identifier for the resource. It may or may not be globally unique, depending on the type of resource. |
| kubernetes Required | object ResourceWithMetadata provides the values necessary to create a Kubernetes resource and override any of its metadata values. |
| kubernetes.group Required | string |
| kubernetes.kind Required | string |
| kubernetes.metadata Optional | object ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. It is not possible to use metav1.ObjectMeta inside spec, as the controller-genautomatically converts this to an arbitrary string-string map. https://github.com/kubernetes-sigs/controller-tools/issues/385 Active discussion about inclusion of this field in the spec is happening in this PR: https://github.com/kubernetes-sigs/controller-tools/pull/395 Until this is allowed, or if it never is, we will produce a subset of the object meta that contains only the fields which the user is allowed to modify in the metadata. |
| kubernetes.metadata.annotations Optional | object 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 |
| kubernetes.metadata.generateName Optional | string 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. If 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). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency |
| kubernetes.metadata.labels Optional | object 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 |
| kubernetes.metadata.name Optional | string 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 |
| kubernetes.metadata.namespace Optional | string Namespace defines the space within 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. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces |
| kubernetes.metadata.ownerReferences Optional | array 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. |
| kubernetes.metadata.ownerReferences.[] Required | object OwnerReference contains enough information to let you identify an owning |
| object. An owning object must be in the same namespace as the dependent, or | |
| be cluster-scoped, so there is no namespace field. | |
| kubernetes.metadata.ownerReferences.[].blockOwnerDeletion Optional | boolean If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs “delete” permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. |
| kubernetes.metadata.ownerReferences.[].controller Optional | boolean If true, this reference points to the managing controller. |
| kubernetes.metadata.ownerReferences.[].kind Optional | string Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| kubernetes.metadata.ownerReferences.[].name Optional | string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
| kubernetes.metadata.ownerReferences.[].uid Optional | string UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids |
Status
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
| Field | Description |
|---|---|
| conditions Required | array A collection of ackv1alpha1.Condition objects that describe the variousterminal states of the adopted resource CR and its target custom resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |