PullThroughCacheRule

ecr.services.k8s.aws/v1alpha1

TypeLink
GoDocecr-controller/apis/v1alpha1#PullThroughCacheRule

Metadata

PropertyValue
ScopeNamespaced
KindPullThroughCacheRule
ListKindPullThroughCacheRuleList
Pluralpullthroughcacherules
Singularpullthroughcacherule

The details of a pull through cache rule.

Spec

credentialARN: string
credentialRef: 
  from: 
    name: string
    namespace: string
customRoleARN: string
customRoleRef: 
  from: 
    name: string
    namespace: string
ecrRepositoryPrefix: string
registryID: string
upstreamRegistry: string
upstreamRegistryURL: string
upstreamRepositoryPrefix: string
FieldDescription
credentialARN
Optional		string
The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager
secret that identifies the credentials to authenticate to the upstream registry.

Regex Pattern: ^arn:aws:secretsmanager:[a-zA-Z0-9-:]+㊙️ecr\-pullthroughcache\/[a-zA-Z0-9\/_+=.@-]+$
credentialRef
Optional		object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:

from:
name: my-api
credentialRef.from
Optional		object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
credentialRef.from.name
Optional		string
credentialRef.from.namespace
Optional		string
customRoleARN
Optional		string
Amazon Resource Name (ARN) of the IAM role to be assumed by Amazon ECR to
authenticate to the ECR upstream registry. This role must be in the same
account as the registry that you are configuring.
customRoleRef
Optional		object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:

from:
name: my-api
customRoleRef.from
Optional		object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
customRoleRef.from.name
Optional		string
customRoleRef.from.namespace
Optional		string
ecrRepositoryPrefix
Required		string
The repository name prefix to use when caching images from the source registry.

There is always an assumed / applied to the end of the prefix. If you specify
ecr-public as the prefix, Amazon ECR treats that as ecr-public/.

Regex Pattern: `^((?:[a-z0-9]+(?:[.-][a-z0-9]+)/)[a-z0-9]+(?:[.-][a-z0-9]+)*/?
registryID
Optional		string
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.

Regex Pattern: ^[0-9]{12}$
upstreamRegistry
Optional		string
The name of the upstream registry.
upstreamRegistryURL
Required		string
The registry URL of the upstream public registry to use as the source for
the pull through cache rule. The following is the syntax to use for each
supported upstream registry.

* Amazon ECR (ecr) – .dkr.ecr..amazonaws.com

* Amazon ECR Public (ecr-public) – public.ecr.aws

* Docker Hub (docker-hub) – registry-1.docker.io

* GitHub Container Registry (github-container-registry) – ghcr.io

* GitLab Container Registry (gitlab-container-registry) – registry.gitlab.com

* Kubernetes (k8s) – registry.k8s.io

* Microsoft Azure Container Registry (azure-container-registry) – .azurecr.io

* Quay (quay) – quay.io
upstreamRepositoryPrefix
Optional		string
The repository name prefix of the upstream registry to match with the upstream
repository name. When this field isn’t specified, Amazon ECR will use the
ROOT.

Regex Pattern: `^((?:[a-z0-9]+(?:[.-][a-z0-9]+)/)[a-z0-9]+(?:[.-][a-z0-9]+)*/?

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createdAt: string
FieldDescription
ackResourceMetadata
Optional		object
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
ackResourceMetadata.arn
Optional		string
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.
https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID
Required		string
OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.
ackResourceMetadata.region
Required		string
Region is the AWS region in which the resource exists or will exist.
conditions
Optional		array
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
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
createdAt
Optional		string
The date and time, in JavaScript date format, when the pull through cache
rule was created.