Image reflector API reference v1
Packages:
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:Action
(string alias)
Action describes an observable stage of the reconcile loop for the image API group, reported on the events the controller emits for ImageRepository and ImagePolicy objects.
AlphabeticalPolicy
(Appears on: ImagePolicyChoice)
AlphabeticalPolicy specifies a alphabetical ordering policy.
| Field | Description |
|---|---|
orderstring | (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 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadataKubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
metadata field. | ||||||||||||
specImagePolicySpec |
| ||||||||||||
statusImagePolicyStatus |
ImagePolicyChoice
(Appears on: ImagePolicySpec)
ImagePolicyChoice is a union of all the types of policy that can be supplied.
| Field | Description |
|---|---|
semverSemVerPolicy | (Optional) SemVer gives a semantic version range to check against the tags available. |
alphabeticalAlphabeticalPolicy | (Optional) Alphabetical set of rules to use for alphabetical ordering of the tags. |
numericalNumericalPolicy | (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 |
|---|---|
imageRepositoryRefgithub.com/fluxcd/pkg/apis/meta.NamespacedObjectReference | ImageRepositoryRef points at the object specifying the image being scanned |
policyImagePolicyChoice | Policy gives the particulars of the policy to be followed in selecting the most recent image |
filterTagsTagFilter | (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. |
digestReflectionPolicyReflectionPolicy | DigestReflectionPolicy governs the setting of the 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. |
intervalKubernetes 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. |
suspendbool | (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 |
|---|---|
latestRefImageRef | LatestRef gives the first in the list of images scanned by the image repository, when filtered and ordered according to the policy. |
observedPreviousRefImageRef | (Optional) ObservedPreviousRef is the observed previous LatestRef. It is used to keep track of the previous and current images. |
observedGenerationint64 | (Optional) |
conditions[]Kubernetes meta/v1.Condition | (Optional) |
ReconcileRequestStatusgithub.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus | (Members of |
ImageRef
(Appears on: ImagePolicyStatus)
ImageRef represents an image reference.
| Field | Description |
|---|---|
namestring | Name is the bare image’s name. |
tagstring | Tag is the image’s tag. |
digeststring | (Optional) Digest is the image’s digest. |
ImageRepository
ImageRepository is the Schema for the imagerepositories API
| Field | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadataKubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
metadata field. | ||||||||||||||||||||||||
specImageRepositorySpec |
| ||||||||||||||||||||||||
statusImageRepositoryStatus |
ImageRepositorySpec
(Appears on: ImageRepository)
ImageRepositorySpec defines the parameters for scanning an image
repository, e.g., fluxcd/flux.
| Field | Description |
|---|---|
imagestring | Image is the name of the image repository |
intervalKubernetes meta/v1.Duration | Interval is the length of time to wait between scans of the image repository. |
timeoutKubernetes meta/v1.Duration | (Optional) Timeout for image scanning. Defaults to ‘Interval’ duration. |
secretRefgithub.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 |
proxySecretRefgithub.com/fluxcd/pkg/apis/meta.LocalObjectReference | (Optional) ProxySecretRef specifies the Secret containing the proxy configuration to use while communicating with the container registry. |
serviceAccountNamestring | (Optional) ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate the image pull, either with the pull secrets attached to the service account or with an object identity. For more information about object identity: https://fluxcd.io/flux/integrations/object-identity/ |
certSecretRefgithub.com/fluxcd/pkg/apis/meta.LocalObjectReference | (Optional) CertSecretRef can be given the name of a Secret containing either or both of
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 Note: Support for the |
suspendbool | (Optional) This flag tells the controller to suspend subsequent image scans. It does not apply to already started scans. Defaults to false. |
accessFromgithub.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. |
providerstring | (Optional) The provider used for authentication, can be ‘aws’, ‘azure’, ‘gcp’ or ‘generic’. When not specified, defaults to ‘generic’. |
insecurebool | (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) |
observedGenerationint64 | (Optional) ObservedGeneration is the last reconciled generation. |
canonicalImageNamestring | (Optional) CanonicalName is the name of the image repository with all the
implied bits made explicit; e.g., |
lastScanResultScanResult | (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 status.lastScanResult. |
ReconcileRequestStatusgithub.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus | (Members of |
NumericalPolicy
(Appears on: ImagePolicyChoice)
NumericalPolicy specifies a numerical ordering policy.
| Field | Description |
|---|---|
orderstring | (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 |
|---|---|
revisionstring | (Optional) Revision is a stable hash of the scanned tags. |
tagCountint | TagCount is the number of tags found in the last scan. |
scanTimeKubernetes 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 |
|---|---|
rangestring | 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 |
|---|---|
patternstring | (Optional) Pattern specifies a regular expression pattern used to filter for image tags. |
extractstring | (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