OCIRepository

io.fluxcd.toolkit.source.v1beta2.OCIRepository

OCIRepository is the Schema for the ocirepositories API

apiVersionstring = "source.toolkit.fluxcd.io/v1beta2"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
kindstring = "OCIRepository"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
metadataobject
specobjectOCIRepositorySpec defines the desired state of OCIRepository
certSecretRefobjectCertSecretRef 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 have been deprecated.
namestring requiredName of the referent.
ignorestringIgnore overrides the set of excluded patterns in the .sourceignore format (which is the same as .gitignore). If not provided, a default will be used, consult the documentation for your version to find out what those are.
insecurebooleanInsecure allows connecting to a non-TLS HTTP container registry.
intervalstring requiredInterval at which the OCIRepository URL is checked for updates. This interval is approximate and may be subject to jitter to ensure efficient use of resources.
layerSelectorobjectLayerSelector specifies which layer should be extracted from the OCI artifact. When not specified, the first layer found in the artifact is selected.
mediaTypestringMediaType specifies the OCI media type of the layer which should be extracted from the OCI Artifact. The first layer matching this type is selected.
operationstringOperation specifies how the selected layer should be processed. By default, the layer compressed content is extracted to storage. When the operation is set to 'copy', the layer compressed content is persisted to storage as it is.
providerstringThe provider used for authentication, can be 'aws', 'azure', 'gcp' or 'generic'. When not specified, defaults to 'generic'.
proxySecretRefobjectProxySecretRef specifies the Secret containing the proxy configuration to use while communicating with the container registry.
namestring requiredName of the referent.
refobjectThe OCI reference to pull and monitor for changes, defaults to the latest tag.
digeststringDigest is the image digest to pull, takes precedence over SemVer. The value should be in the format 'sha256:<HASH>'.
semverstringSemVer is the range of tags to pull selecting the latest within the range, takes precedence over Tag.
semverFilterstringSemverFilter is a regex pattern to filter the tags within the SemVer range.
tagstringTag is the image tag to pull, defaults to latest.
secretRefobjectSecretRef contains the secret name containing the registry login credentials to resolve image metadata. The secret must be of type kubernetes.io/dockerconfigjson.
namestring requiredName of the referent.
serviceAccountNamestringServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate the image pull if the service account has attached pull secrets. For more information: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#add-imagepullsecrets-to-a-service-account
suspendbooleanThis flag tells the controller to suspend the reconciliation of this source.
timeoutstringThe timeout for remote OCI Repository operations like pulling, defaults to 60s.
urlstring requiredURL is a reference to an OCI artifact repository hosted on a remote container registry.
verifyobjectVerify contains the secret name containing the trusted public keys used to verify the signature and specifies which provider to use to check whether OCI image is authentic.
matchOIDCIdentity[]objectMatchOIDCIdentity specifies the identity matching criteria to use while verifying an OCI artifact which was signed using Cosign keyless signing. The artifact's identity is deemed to be verified if any of the specified matchers match against the identity.
issuerstring requiredIssuer specifies the regex pattern to match against to verify the OIDC issuer in the Fulcio certificate. The pattern must be a valid Go regular expression.
subjectstring requiredSubject specifies the regex pattern to match against to verify the identity subject in the Fulcio certificate. The pattern must be a valid Go regular expression.
providerstring requiredProvider specifies the technology used to sign the OCI Artifact.
secretRefobjectSecretRef specifies the Kubernetes Secret containing the trusted public keys.
namestring requiredName of the referent.
statusobject read-onlyOCIRepositoryStatus defines the observed state of OCIRepository
artifactobject read-onlyArtifact represents the output of the last successful OCI Repository sync.
digeststring required read-onlyDigest is the digest of the file in the form of '<algorithm>:<checksum>'.
lastUpdateTimestring (date-time) required read-onlyLastUpdateTime is the timestamp corresponding to the last update of the Artifact.
metadatamap[string]string read-onlyMetadata holds upstream information such as OCI annotations.
pathstring required read-onlyPath is the relative file path of the Artifact. It can be used to locate the file in the root of the Artifact storage on the local file system of the controller managing the Source.
revisionstring required read-onlyRevision is a human-readable identifier traceable in the origin source system. It can be a Git commit SHA, Git tag, a Helm chart version, etc.
sizeinteger (int64) read-onlySize is the number of bytes in the file.
urlstring required read-onlyURL is the HTTP address of the Artifact as exposed by the controller managing the Source. It can be used to retrieve the Artifact for consumption, e.g. by another controller applying the Artifact contents.
conditions[]object read-onlyConditions holds the conditions for the OCIRepository.
lastTransitionTimestring (date-time) required read-onlylastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
messagestring required read-onlymessage is a human readable message indicating details about the transition. This may be an empty string.
observedGenerationinteger (int64) read-onlyobservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reasonstring required read-onlyreason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
statusstring required read-onlystatus of the condition, one of True, False, Unknown.
typestring required read-onlytype of condition in CamelCase or in foo.example.com/CamelCase.
contentConfigChecksumstring read-onlyContentConfigChecksum is a checksum of all the configurations related to the content of the source artifact:
  • .spec.ignore
  • .spec.layerSelector
observed in .status.observedGeneration version of the object. This can be used to determine if the content configuration has changed and the artifact needs to be rebuilt. It has the format of `<algo>:<checksum>`, for example: `sha256:<checksum>`.Deprecated: Replaced with explicit fields for observed artifact content config in the status.
lastHandledReconcileAtstring read-onlyLastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.
observedGenerationinteger (int64) read-onlyObservedGeneration is the last observed generation.
observedIgnorestring read-onlyObservedIgnore is the observed exclusion patterns used for constructing the source artifact.
observedLayerSelectorobject read-onlyObservedLayerSelector is the observed layer selector used for constructing the source artifact.
mediaTypestring read-onlyMediaType specifies the OCI media type of the layer which should be extracted from the OCI Artifact. The first layer matching this type is selected.
operationstring read-onlyOperation specifies how the selected layer should be processed. By default, the layer compressed content is extracted to storage. When the operation is set to 'copy', the layer compressed content is persisted to storage as it is.
urlstring read-onlyURL is the download link for the artifact output of the last OCI Repository sync.