image-reflector-controller/docs/api/image-reflector.md

Image reflector API reference

Packages:

• image.toolkit.fluxcd.io/v1beta1

image.toolkit.fluxcd.io/v1beta1

Package v1beta1 contains API types for the image API group, version v1beta1. These types are concerned with reflecting metadata from OCI image repositories into a cluster, so they can be consulted for e.g., automation.

Resource Types:

AlphabeticalPolicy

(Appears on: ImagePolicyChoice)

AlphabeticalPolicy specifies a alphabetical ordering policy.

Field	Description
order string	(Optional) Order specifies the sorting order of the tags. Given the letters of the alphabet as tags, ascending order would select Z, and descending order would select A.

ImagePolicy

ImagePolicy is the Schema for the imagepolicies API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ImagePolicySpec	imageRepositoryRef github.com/fluxcd/pkg/apis/meta.NamespacedObjectReference ImageRepositoryRef points at the object specifying the image being scanned policy ImagePolicyChoice Policy gives the particulars of the policy to be followed in selecting the most recent image filterTags TagFilter (Optional) FilterTags enables filtering for only a subset of tags based on a set of rules. If no rules are provided, all the tags from the repository will be ordered and compared.
status ImagePolicyStatus

ImagePolicyChoice

(Appears on: ImagePolicySpec)

ImagePolicyChoice is a union of all the types of policy that can be supplied.

Field	Description
semver SemVerPolicy	(Optional) SemVer gives a semantic version range to check against the tags available.
alphabetical AlphabeticalPolicy	(Optional) Alphabetical set of rules to use for alphabetical ordering of the tags.
numerical NumericalPolicy	(Optional) Numerical set of rules to use for numerical ordering of the tags.

ImagePolicySpec

(Appears on: ImagePolicy)

ImagePolicySpec defines the parameters for calculating the ImagePolicy

Field	Description
imageRepositoryRef github.com/fluxcd/pkg/apis/meta.NamespacedObjectReference	ImageRepositoryRef points at the object specifying the image being scanned
policy ImagePolicyChoice	Policy gives the particulars of the policy to be followed in selecting the most recent image
filterTags TagFilter	(Optional) FilterTags enables filtering for only a subset of tags based on a set of rules. If no rules are provided, all the tags from the repository will be ordered and compared.

ImagePolicyStatus

(Appears on: ImagePolicy)

ImagePolicyStatus defines the observed state of ImagePolicy

Field	Description
latestImage string	LatestImage gives the first in the list of images scanned by the image repository, when filtered and ordered according to the policy.
observedGeneration int64	(Optional)
conditions []Kubernetes meta/v1.Condition	(Optional)

ImageRepository

ImageRepository is the Schema for the imagerepositories API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ImageRepositorySpec	image string Image is the name of the image repository interval Kubernetes meta/v1.Duration Interval is the length of time to wait between scans of the image repository. timeout Kubernetes meta/v1.Duration (Optional) Timeout for image scanning. Defaults to ‘Interval’ duration. secretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference (Optional) SecretRef can be given the name of a secret containing credentials to use for the image registry. The secret should be created with kubectl create secret docker-registry, or the equivalent. certSecretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference (Optional) CertSecretRef can be given the name of a secret containing either or both of a PEM-encoded client certificate (certFile) and private key (keyFile); a PEM-encoded CA certificate (caFile) and whichever are supplied, will be used for connecting to the registry. The client cert and key are useful if you are authenticating with a certificate; the CA cert is useful if you are using a self-signed server certificate. suspend bool (Optional) This flag tells the controller to suspend subsequent image scans. It does not apply to already started scans. Defaults to false. accessFrom github.com/fluxcd/pkg/apis/acl.AccessFrom (Optional) AccessFrom defines an ACL for allowing cross-namespace references to the ImageRepository object based on the caller’s namespace labels.
status ImageRepositoryStatus

ImageRepositorySpec

(Appears on: ImageRepository)

ImageRepositorySpec defines the parameters for scanning an image repository, e.g., fluxcd/flux.

Field	Description
image string	Image is the name of the image repository
interval Kubernetes meta/v1.Duration	Interval is the length of time to wait between scans of the image repository.
timeout Kubernetes meta/v1.Duration	(Optional) Timeout for image scanning. Defaults to ‘Interval’ duration.
secretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference	(Optional) SecretRef can be given the name of a secret containing credentials to use for the image registry. The secret should be created with kubectl create secret docker-registry, or the equivalent.
certSecretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference	(Optional) CertSecretRef can be given the name of a secret containing either or both of a PEM-encoded client certificate (certFile) and private key (keyFile); a PEM-encoded CA certificate (caFile) and whichever are supplied, will be used for connecting to the registry. The client cert and key are useful if you are authenticating with a certificate; the CA cert is useful if you are using a self-signed server certificate.
suspend bool	(Optional) This flag tells the controller to suspend subsequent image scans. It does not apply to already started scans. Defaults to false.
accessFrom github.com/fluxcd/pkg/apis/acl.AccessFrom	(Optional) AccessFrom defines an ACL for allowing cross-namespace references to the ImageRepository object based on the caller’s namespace labels.

ImageRepositoryStatus

(Appears on: ImageRepository)

ImageRepositoryStatus defines the observed state of ImageRepository

Field	Description
conditions []Kubernetes meta/v1.Condition	(Optional)
observedGeneration int64	(Optional) ObservedGeneration is the last reconciled generation.
canonicalImageName string	(Optional) CanonicalName is the name of the image repository with all the implied bits made explicit; e.g., docker.io/library/alpine rather than alpine.
lastScanResult ScanResult	(Optional) LastScanResult contains the number of fetched tags.
ReconcileRequestStatus github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus	(Members of ReconcileRequestStatus are embedded into this type.)

NumericalPolicy

(Appears on: ImagePolicyChoice)

NumericalPolicy specifies a numerical ordering policy.

Field	Description
order string	(Optional) Order specifies the sorting order of the tags. Given the integer values from 0 to 9 as tags, ascending order would select 9, and descending order would select 0.

ScanResult

(Appears on: ImageRepositoryStatus)

Field	Description
tagCount int
scanTime Kubernetes meta/v1.Time

SemVerPolicy

(Appears on: ImagePolicyChoice)

SemVerPolicy specifies a semantic version policy.

Field	Description
range string	Range gives a semver range for the image tag; the highest version within the range that’s a tag yields the latest image.

TagFilter

(Appears on: ImagePolicySpec)

TagFilter enables filtering tags based on a set of defined rules

Field	Description
pattern string	(Optional) Pattern specifies a regular expression pattern used to filter for image tags.
extract string	(Optional) Extract allows a capture group to be extracted from the specified regular expression pattern, useful before tag evaluation.

This page was automatically generated with gen-crd-api-reference-docs