Flux: Image reflector API reference v1

Mon, 01 Jan 0001 00:00:00 +0000

Packages:

image.toolkit.fluxcd.io/v1

image.toolkit.fluxcd.io/v1

Package v1 contains API types for the image API group, version v1. 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.
`digestReflectionPolicy` ReflectionPolicy	DigestReflectionPolicy governs the setting of the `.status.latestRef.digest` field. Never: The digest field will always be set to the empty string. IfNotPresent: The digest field will be set to the digest of the elected latest image if the field is empty and the image did not change. Always: The digest field will always be set to the digest of the elected latest image. Default: Never.
`interval` Kubernetes meta/v1.Duration	(Optional) Interval is the length of time to wait between refreshing the digest of the latest tag when the reflection policy is set to “Always”. Defaults to 10m.
`suspend` bool	(Optional) This flag tells the controller to suspend subsequent policy reconciliations. It does not apply to already started reconciliations. Defaults to false.

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.
`digestReflectionPolicy` ReflectionPolicy	DigestReflectionPolicy governs the setting of the `.status.latestRef.digest` field. Never: The digest field will always be set to the empty string. IfNotPresent: The digest field will be set to the digest of the elected latest image if the field is empty and the image did not change. Always: The digest field will always be set to the digest of the elected latest image. Default: Never.
`interval` Kubernetes meta/v1.Duration	(Optional) Interval is the length of time to wait between refreshing the digest of the latest tag when the reflection policy is set to “Always”. Defaults to 10m.
`suspend` bool	(Optional) This flag tells the controller to suspend subsequent policy reconciliations. It does not apply to already started reconciliations. Defaults to false.

ImagePolicyStatus

(Appears on: ImagePolicy)

ImagePolicyStatus defines the observed state of ImagePolicy

Field	Description
`latestRef` ImageRef	LatestRef gives the first in the list of images scanned by the image repository, when filtered and ordered according to the policy.
`observedPreviousRef` ImageRef	(Optional) ObservedPreviousRef is the observed previous LatestRef. It is used to keep track of the previous and current images.
`observedGeneration` int64	(Optional)
`conditions` []Kubernetes meta/v1.Condition	(Optional)
`ReconcileRequestStatus` github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus	(Members of `ReconcileRequestStatus` are embedded into this type.)

ImageRef

(Appears on: ImagePolicyStatus)

ImageRef represents an image reference.

Field	Description
`name` string	Name is the bare image’s name.
`tag` string	Tag is the image’s tag.
`digest` string	(Optional) Digest is the image’s digest.

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.
`proxySecretRef` github.com/fluxcd/pkg/apis/meta.LocalObjectReference	(Optional) ProxySecretRef specifies the Secret containing the proxy configuration to use while communicating with the container registry.
`serviceAccountName` string	(Optional) ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate the image pull if the service account has attached pull secrets.
`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 (`tls.crt`) and private key (`tls.key`); a PEM-encoded CA certificate (`ca.crt`) 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. The Secret must be of type `Opaque` or `kubernetes.io/tls`. Note: Support for the `caFile`, `certFile` and `keyFile` keys has been deprecated.
`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.
`exclusionList` []string	(Optional) ExclusionList is a list of regex strings used to exclude certain tags from being stored in the database.
`provider` string	(Optional) The provider used for authentication, can be ‘aws’, ‘azure’, ‘gcp’ or ‘generic’. When not specified, defaults to ‘generic’.
`insecure` bool	(Optional) Insecure allows connecting to a non-TLS HTTP container registry.

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.
`proxySecretRef` github.com/fluxcd/pkg/apis/meta.LocalObjectReference	(Optional) ProxySecretRef specifies the Secret containing the proxy configuration to use while communicating with the container registry.
`serviceAccountName` string	(Optional) ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate the image pull if the service account has attached pull secrets.
`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 (`tls.crt`) and private key (`tls.key`); a PEM-encoded CA certificate (`ca.crt`) 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. The Secret must be of type `Opaque` or `kubernetes.io/tls`. Note: Support for the `caFile`, `certFile` and `keyFile` keys has been deprecated.
`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.
`exclusionList` []string	(Optional) ExclusionList is a list of regex strings used to exclude certain tags from being stored in the database.
`provider` string	(Optional) The provider used for authentication, can be ‘aws’, ‘azure’, ‘gcp’ or ‘generic’. When not specified, defaults to ‘generic’.
`insecure` bool	(Optional) Insecure allows connecting to a non-TLS HTTP container registry.

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.
`observedExclusionList` []string	ObservedExclusionList is a list of observed exclusion list. It reflects the exclusion rules used for the observed scan result in spec.lastScanResult.
`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.

ReflectionPolicy (`string` alias)

(Appears on: ImagePolicySpec)

ReflectionPolicy describes a policy for if/when to reflect a value from the registry in a certain resource field.

ScanResult

(Appears on: ImageRepositoryStatus)

ScanResult contains information about the last scan of the image repository. TODO: Make all fields except for LatestTags required in v1.

Field	Description
`revision` string	(Optional) Revision is a stable hash of the scanned tags.
`tagCount` int	TagCount is the number of tags found in the last scan.
`scanTime` Kubernetes meta/v1.Time	(Optional) ScanTime is the time when the last scan was performed.
`latestTags` []string	(Optional) LatestTags is a small sample of the tags found in the last scan. It’s the first 10 tags when sorting all the tags in descending alphabetical order.

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

Flux – Image Reflector API Reference

Flux: Image reflector API reference v1

image.toolkit.fluxcd.io/v1

AlphabeticalPolicy

ImagePolicy

ImagePolicyChoice

ImagePolicySpec

ImagePolicyStatus

ImageRef

ImageRepository

ImageRepositorySpec

ImageRepositoryStatus

NumericalPolicy

ReflectionPolicy (string alias)

ScanResult

SemVerPolicy

TagFilter

ReflectionPolicy (`string` alias)