HelmRepository

io.fluxcd.toolkit.source.v1beta2.HelmRepository

HelmRepository is the Schema for the helmrepositories 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 = "HelmRepository"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

specobjectHelmRepositorySpec specifies the required configuration to produce an Artifact for a Helm repository index YAML.

accessFromobjectAccessFrom specifies an Access Control List for allowing cross-namespace references to this object. NOTE: Not implemented, provisional as of https://github.com/fluxcd/flux2/pull/2092

namespaceSelectors[]object requiredNamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation.

matchLabelsmap[string]stringMatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

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`.It takes precedence over the values specified in the Secret referred to by `.spec.secretRef`.

namestring requiredName of the referent.

insecurebooleanInsecure allows connecting to a non-TLS HTTP container registry. This field is only taken into account if the .spec.type field is set to 'oci'.

intervalstringInterval at which the HelmRepository URL is checked for updates. This interval is approximate and may be subject to jitter to ensure efficient use of resources.

passCredentialsbooleanPassCredentials allows the credentials from the SecretRef to be passed on to a host that does not match the host as defined in URL. This may be required if the host of the advertised chart URLs in the index differ from the defined URL. Enabling this should be done with caution, as it can potentially result in credentials getting stolen in a MITM-attack.

providerstringProvider used for authentication, can be 'aws', 'azure', 'gcp' or 'generic'. This field is optional, and only taken into account if the .spec.type field is set to 'oci'. When not specified, defaults to 'generic'.

secretRefobjectSecretRef specifies the Secret containing authentication credentials for the HelmRepository. For HTTP/S basic auth the secret must contain 'username' and 'password' fields. Support for TLS auth using the 'certFile' and 'keyFile', and/or 'caFile' keys is deprecated. Please use `.spec.certSecretRef` instead.

namestring requiredName of the referent.

suspendbooleanSuspend tells the controller to suspend the reconciliation of this HelmRepository.

timeoutstringTimeout is used for the index fetch operation for an HTTPS helm repository, and for remote OCI Repository operations like pulling for an OCI helm chart by the associated HelmChart. Its default value is 60s.

typestringType of the HelmRepository. When this field is set to "oci", the URL field value must be prefixed with "oci://".

urlstring requiredURL of the Helm repository, a valid URL contains at least a protocol and host.

statusobject read-onlyHelmRepositoryStatus records the observed state of the HelmRepository.

artifactobject read-onlyArtifact represents the last successful HelmRepository reconciliation.

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 HelmRepository.

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.

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 of the HelmRepository object.

urlstring read-onlyURL is the dynamic fetch link for the latest Artifact. It is provided on a "best effort" basis, and using the precise HelmRepositoryStatus.Artifact data is recommended.