- v1alpha1
- AdoptedResource
- EcrServicesK8sAwsV1alpha1PullThroughCacheRuleSpec
- EcrServicesK8sAwsV1alpha1PullThroughCacheRuleStatus
- EcrServicesK8sAwsV1alpha1PullThroughCacheRuleStatusAckResourceMetadata
- EcrServicesK8sAwsV1alpha1PullThroughCacheRuleStatusConditionsItems0
- EcrServicesK8sAwsV1alpha1RepositorySpec
- EcrServicesK8sAwsV1alpha1RepositorySpecEncryptionConfiguration
- EcrServicesK8sAwsV1alpha1RepositorySpecImageScanningConfiguration
- EcrServicesK8sAwsV1alpha1RepositorySpecTagsItems0
- EcrServicesK8sAwsV1alpha1RepositoryStatus
- EcrServicesK8sAwsV1alpha1RepositoryStatusAckResourceMetadata
- EcrServicesK8sAwsV1alpha1RepositoryStatusConditionsItems0
- FieldExport
- PullThroughCacheRule
- Repository
- ServicesK8sAwsV1alpha1AdoptedResourceSpec
- ServicesK8sAwsV1alpha1AdoptedResourceSpecAws
- ServicesK8sAwsV1alpha1AdoptedResourceSpecKubernetes
- ServicesK8sAwsV1alpha1AdoptedResourceSpecKubernetesMetadata
- ServicesK8sAwsV1alpha1AdoptedResourceSpecKubernetesMetadataOwnerReferencesItems0
- ServicesK8sAwsV1alpha1AdoptedResourceStatus
- ServicesK8sAwsV1alpha1AdoptedResourceStatusConditionsItems0
- ServicesK8sAwsV1alpha1FieldExportSpec
- ServicesK8sAwsV1alpha1FieldExportSpecFrom
- ServicesK8sAwsV1alpha1FieldExportSpecFromResource
- ServicesK8sAwsV1alpha1FieldExportSpecTo
- ServicesK8sAwsV1alpha1FieldExportStatus
- ServicesK8sAwsV1alpha1FieldExportStatusConditionsItems0
AdoptedResource is the schema for the AdoptedResource API.
| name | type | description | default value |
|---|---|---|---|
apiVersion required readOnly |
"services.k8s.aws/v1alpha1" | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | "services.k8s.aws/v1alpha1" |
kind required readOnly |
"AdoptedResource" | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | "AdoptedResource" |
| metadata | ObjectMeta | metadata | |
| spec | ServicesK8sAwsV1alpha1AdoptedResourceSpec | spec | |
| status | ServicesK8sAwsV1alpha1AdoptedResourceStatus | status |
PullThroughCacheRuleSpec defines the desired state of PullThroughCacheRule. The details of a pull through cache rule.
| name | type | description | default value |
|---|---|---|---|
ecrRepositoryPrefix required |
str | The repository name prefix to use when caching images from the source registry. | |
| registryID | str | The Amazon Web Services account ID associated with the registry to create the pull through cache rule for. If you do not specify a registry, the default registry is assumed. | |
upstreamRegistryURL required |
str | The registry URL of the upstream public registry to use as the source for the pull through cache rule. |
PullThroughCacheRuleStatus defines the observed state of PullThroughCacheRule
| name | type | description | default value |
|---|---|---|---|
| ackResourceMetadata | EcrServicesK8sAwsV1alpha1PullThroughCacheRuleStatusAckResourceMetadata | ack resource metadata | |
| conditions | [EcrServicesK8sAwsV1alpha1PullThroughCacheRuleStatusConditionsItems0] | All CRS managed by ACK have a common Status.Conditions member that contains a collection of ackv1alpha1.Condition objects that describe the various terminal states of the CR and its backend AWS service API resource |
|
| createdAt | str | The date and time, in JavaScript date format, when the pull through cache rule was created. |
All CRs managed by ACK have a common Status.ACKResourceMetadata member that is used to contain resource sync state, account ownership, constructed ARN for the resource
| name | type | description | default value |
|---|---|---|---|
| arn | str | ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an "adopted" resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR's Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse aws-controllers-k8s/community#270 | |
ownerAccountID required |
str | OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. | |
region required |
str | Region is the AWS region in which the resource exists or will exist. |
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
| name | type | description | default value |
|---|---|---|---|
| lastTransitionTime | str | Last time the condition transitioned from one status to another. | |
| message | str | A human readable message indicating details about the transition. | |
| reason | str | The reason for the condition's last transition. | |
status required |
str | Status of the condition, one of True, False, Unknown. | |
type required |
str |
RepositorySpec defines the desired state of Repository. An object representing a repository.
| name | type | description | default value |
|---|---|---|---|
| encryptionConfiguration | EcrServicesK8sAwsV1alpha1RepositorySpecEncryptionConfiguration | encryption configuration | |
| imageScanningConfiguration | EcrServicesK8sAwsV1alpha1RepositorySpecImageScanningConfiguration | image scanning configuration | |
| imageTagMutability | str | The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten. | |
| lifecyclePolicy | str | The JSON repository policy text to apply to the repository. | |
name required |
str | The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). | |
| policy | str | The JSON repository policy text to apply to the repository. For more information, see Amazon ECR repository policies (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the Amazon Elastic Container Registry User Guide. | |
| registryID | str | The Amazon Web Services account ID associated with the registry to create the repository. If you do not specify a registry, the default registry is assumed. | |
| tags | [EcrServicesK8sAwsV1alpha1RepositorySpecTagsItems0] | The metadata that you apply to the repository to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. |
The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
| name | type | description | default value |
|---|---|---|---|
| encryptionType | str | encryption type | |
| kmsKey | str | kms key |
The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.
| name | type | description | default value |
|---|---|---|---|
| scanOnPush | bool | scan on push |
The metadata to apply to a resource to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
| name | type | description | default value |
|---|---|---|---|
| key | str | key | |
| value | str | value |
RepositoryStatus defines the observed state of Repository
| name | type | description | default value |
|---|---|---|---|
| ackResourceMetadata | EcrServicesK8sAwsV1alpha1RepositoryStatusAckResourceMetadata | ack resource metadata | |
| conditions | [EcrServicesK8sAwsV1alpha1RepositoryStatusConditionsItems0] | All CRS managed by ACK have a common Status.Conditions member that contains a collection of ackv1alpha1.Condition objects that describe the various terminal states of the CR and its backend AWS service API resource |
|
| createdAt | str | The date and time, in JavaScript date format, when the repository was created. | |
| repositoryURI | str | The URI for the repository. You can use this URI for container image push and pull operations. |
All CRs managed by ACK have a common Status.ACKResourceMetadata member that is used to contain resource sync state, account ownership, constructed ARN for the resource
| name | type | description | default value |
|---|---|---|---|
| arn | str | ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an "adopted" resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR's Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse aws-controllers-k8s/community#270 | |
ownerAccountID required |
str | OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. | |
region required |
str | Region is the AWS region in which the resource exists or will exist. |
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
| name | type | description | default value |
|---|---|---|---|
| lastTransitionTime | str | Last time the condition transitioned from one status to another. | |
| message | str | A human readable message indicating details about the transition. | |
| reason | str | The reason for the condition's last transition. | |
status required |
str | Status of the condition, one of True, False, Unknown. | |
type required |
str |
FieldExport is the schema for the FieldExport API.
| name | type | description | default value |
|---|---|---|---|
apiVersion required readOnly |
"services.k8s.aws/v1alpha1" | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | "services.k8s.aws/v1alpha1" |
kind required readOnly |
"FieldExport" | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | "FieldExport" |
| metadata | ObjectMeta | metadata | |
| spec | ServicesK8sAwsV1alpha1FieldExportSpec | spec | |
| status | ServicesK8sAwsV1alpha1FieldExportStatus | status |
PullThroughCacheRule is the Schema for the PullThroughCacheRules API
| name | type | description | default value |
|---|---|---|---|
apiVersion required readOnly |
"ecr.services.k8s.aws/v1alpha1" | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | "ecr.services.k8s.aws/v1alpha1" |
kind required readOnly |
"PullThroughCacheRule" | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | "PullThroughCacheRule" |
| metadata | ObjectMeta | metadata | |
| spec | EcrServicesK8sAwsV1alpha1PullThroughCacheRuleSpec | spec | |
| status | EcrServicesK8sAwsV1alpha1PullThroughCacheRuleStatus | status |
Repository is the Schema for the Repositories API
| name | type | description | default value |
|---|---|---|---|
apiVersion required readOnly |
"ecr.services.k8s.aws/v1alpha1" | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | "ecr.services.k8s.aws/v1alpha1" |
kind required readOnly |
"Repository" | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | "Repository" |
| metadata | ObjectMeta | metadata | |
| spec | EcrServicesK8sAwsV1alpha1RepositorySpec | spec | |
| status | EcrServicesK8sAwsV1alpha1RepositoryStatus | status |
AdoptedResourceSpec defines the desired state of the AdoptedResource.
| name | type | description | default value |
|---|---|---|---|
aws required |
ServicesK8sAwsV1alpha1AdoptedResourceSpecAws | aws | |
kubernetes required |
ServicesK8sAwsV1alpha1AdoptedResourceSpecKubernetes | kubernetes |
AWSIdentifiers provide all unique ways to reference an AWS resource.
| name | type | description | default value |
|---|---|---|---|
| additionalKeys | {str:str} | AdditionalKeys represents any additional arbitrary identifiers used when describing the target resource. | |
| arn | str | ARN is the AWS Resource Name for the resource. It is a globally unique identifier. | |
| nameOrID | str | NameOrId is a user-supplied string identifier for the resource. It may or may not be globally unique, depending on the type of resource. |
ResourceWithMetadata provides the values necessary to create a Kubernetes resource and override any of its metadata values.
| name | type | description | default value |
|---|---|---|---|
group required |
str | group | |
kind required |
str | kind | |
| metadata | ServicesK8sAwsV1alpha1AdoptedResourceSpecKubernetesMetadata | metadata |
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-gen automatically converts this to an arbitrary string-string map. kubernetes-sigs/controller-tools#385 Active discussion about inclusion of this field in the spec is happening in this PR: kubernetes-sigs/controller-tools#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.
| name | type | description | default value |
|---|---|---|---|
| annotations | {str:str} | 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 | |
| generateName | str | 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 |
|
| labels | {str:str} | 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 | |
| name | str | 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 | |
| namespace | str | 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 |
|
| ownerReferences | [ServicesK8sAwsV1alpha1AdoptedResourceSpecKubernetesMetadataOwnerReferencesItems0] | 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. |
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.
| name | type | description | default value |
|---|---|---|---|
apiVersion required |
str | API version of the referent. | |
| blockOwnerDeletion | bool | 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. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | bool | If true, this reference points to the managing controller. | |
kind required |
str | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | |
name required |
str | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
uid required |
str | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
AdoptedResourceStatus defines the observed status of the AdoptedResource.
| name | type | description | default value |
|---|---|---|---|
conditions required |
[ServicesK8sAwsV1alpha1AdoptedResourceStatusConditionsItems0] | A collection of ackv1alpha1.Condition objects that describe the various terminal states of the adopted resource CR and its target custom resource |
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
| name | type | description | default value |
|---|---|---|---|
| lastTransitionTime | str | Last time the condition transitioned from one status to another. | |
| message | str | A human readable message indicating details about the transition. | |
| reason | str | The reason for the condition's last transition. | |
status required |
str | Status of the condition, one of True, False, Unknown. | |
type required |
str |
FieldExportSpec defines the desired state of the FieldExport.
| name | type | description | default value |
|---|---|---|---|
from required |
ServicesK8sAwsV1alpha1FieldExportSpecFrom | from | |
to required |
ServicesK8sAwsV1alpha1FieldExportSpecTo | to |
ResourceFieldSelector provides the values necessary to identify an individual field on an individual K8s resource.
| name | type | description | default value |
|---|---|---|---|
path required |
str | path | |
resource required |
ServicesK8sAwsV1alpha1FieldExportSpecFromResource | resource |
NamespacedResource provides all the values necessary to identify an ACK resource of a given type (within the same namespace as the custom resource containing this type).
| name | type | description | default value |
|---|---|---|---|
group required |
str | group | |
kind required |
str | kind | |
name required |
str | name |
FieldExportTarget provides the values necessary to identify the output path for a field export.
| name | type | description | default value |
|---|---|---|---|
kind required |
"configmap" | "secret" | FieldExportOutputType represents all types that can be produced by a field export operation |
name required |
str | name | |
| namespace | str | Namespace is marked as optional, so we cannot compose NamespacedName |
FieldExportStatus defines the observed status of the FieldExport.
| name | type | description | default value |
|---|---|---|---|
conditions required |
[ServicesK8sAwsV1alpha1FieldExportStatusConditionsItems0] | A collection of ackv1alpha1.Condition objects that describe the various recoverable states of the field CR |
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
| name | type | description | default value |
|---|---|---|---|
| lastTransitionTime | str | Last time the condition transitioned from one status to another. | |
| message | str | A human readable message indicating details about the transition. | |
| reason | str | The reason for the condition's last transition. | |
status required |
str | Status of the condition, one of True, False, Unknown. | |
type required |
str |