diff --git a/2.2.1/_gen/helm/main.libsonnet b/2.2.1/_gen/helm/main.libsonnet new file mode 100644 index 0000000..6388aae --- /dev/null +++ b/2.2.1/_gen/helm/main.libsonnet @@ -0,0 +1,6 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='helm', url='', help=''), + v2beta1: (import 'v2beta1/main.libsonnet'), + v2beta2: (import 'v2beta2/main.libsonnet'), +} diff --git a/2.2.1/_gen/helm/v2beta1/helmRelease.libsonnet b/2.2.1/_gen/helm/v2beta1/helmRelease.libsonnet new file mode 100644 index 0000000..07f0665 --- /dev/null +++ b/2.2.1/_gen/helm/v2beta1/helmRelease.libsonnet @@ -0,0 +1,393 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='helmRelease', url='', help='"HelmRelease is the Schema for the helmreleases API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of HelmRelease', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'helm.toolkit.fluxcd.io/v2beta1', + kind: 'HelmRelease', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"HelmReleaseSpec defines the desired state of a Helm release."'), + spec: { + '#chart':: d.obj(help='"Chart defines the template of the v1beta2.HelmChart that should be created for this HelmRelease."'), + chart: { + '#metadata':: d.obj(help='"ObjectMeta holds the template for metadata like labels and annotations."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { spec+: { chart+: { metadata+: { annotations: annotations } } } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { spec+: { chart+: { metadata+: { annotations+: annotations } } } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { chart+: { metadata+: { labels: labels } } } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { chart+: { metadata+: { labels+: labels } } } }, + }, + '#spec':: d.obj(help='"Spec holds the template for the v1beta2.HelmChartSpec for this HelmRelease."'), + spec: { + '#sourceRef':: d.obj(help='"The name and namespace of the v1beta2.Source the chart is available at."'), + sourceRef: { + '#withApiVersion':: d.fn(help='"APIVersion of the referent."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { spec+: { chart+: { spec+: { sourceRef+: { apiVersion: apiVersion } } } } }, + '#withKind':: d.fn(help='"Kind of the referent."', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { chart+: { spec+: { sourceRef+: { kind: kind } } } } }, + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { chart+: { spec+: { sourceRef+: { name: name } } } } }, + '#withNamespace':: d.fn(help='"Namespace of the referent."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { chart+: { spec+: { sourceRef+: { namespace: namespace } } } } }, + }, + '#verify':: d.obj(help='"Verify 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. This field is only supported for OCI sources. Chart dependencies, which are not bundled in the umbrella chart artifact, are not verified."'), + verify: { + '#secretRef':: d.obj(help='"SecretRef specifies the Kubernetes Secret containing the trusted public keys."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { chart+: { spec+: { verify+: { secretRef+: { name: name } } } } } }, + }, + '#withProvider':: d.fn(help='"Provider specifies the technology used to sign the OCI Helm chart."', args=[d.arg(name='provider', type=d.T.string)]), + withProvider(provider): { spec+: { chart+: { spec+: { verify+: { provider: provider } } } } }, + }, + '#withChart':: d.fn(help='"The name or path the Helm chart is available at in the SourceRef."', args=[d.arg(name='chart', type=d.T.string)]), + withChart(chart): { spec+: { chart+: { spec+: { chart: chart } } } }, + '#withInterval':: d.fn(help="\"Interval at which to check the v1beta2.Source for updates. Defaults to 'HelmReleaseSpec.Interval'.\"", args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { chart+: { spec+: { interval: interval } } } }, + '#withReconcileStrategy':: d.fn(help="\"Determines what enables the creation of a new artifact. Valid values are ('ChartVersion', 'Revision'). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted.\"", args=[d.arg(name='reconcileStrategy', type=d.T.string)]), + withReconcileStrategy(reconcileStrategy): { spec+: { chart+: { spec+: { reconcileStrategy: reconcileStrategy } } } }, + '#withValuesFile':: d.fn(help='"Alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Deprecated in favor of ValuesFiles, for backwards compatibility the file defined here is merged before the ValuesFiles items. Ignored when omitted."', args=[d.arg(name='valuesFile', type=d.T.string)]), + withValuesFile(valuesFile): { spec+: { chart+: { spec+: { valuesFile: valuesFile } } } }, + '#withValuesFiles':: d.fn(help='"Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted."', args=[d.arg(name='valuesFiles', type=d.T.array)]), + withValuesFiles(valuesFiles): { spec+: { chart+: { spec+: { valuesFiles: if std.isArray(v=valuesFiles) then valuesFiles else [valuesFiles] } } } }, + '#withValuesFilesMixin':: d.fn(help='"Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='valuesFiles', type=d.T.array)]), + withValuesFilesMixin(valuesFiles): { spec+: { chart+: { spec+: { valuesFiles+: if std.isArray(v=valuesFiles) then valuesFiles else [valuesFiles] } } } }, + '#withVersion':: d.fn(help='"Version semver expression, ignored for charts from v1beta2.GitRepository and v1beta2.Bucket sources. Defaults to latest when omitted."', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { spec+: { chart+: { spec+: { version: version } } } }, + }, + }, + '#dependsOn':: d.obj(help='"DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled."'), + dependsOn: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent, when not specified it acts as LocalObjectReference."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + }, + '#driftDetection':: d.obj(help='"DriftDetection holds the configuration for detecting and handling differences between the manifest in the Helm storage and the resources currently existing in the cluster. \\n Note: this field is provisional to the v2beta2 API, and not actively used by v2beta1 HelmReleases."'), + driftDetection: { + '#ignore':: d.obj(help='"Ignore contains a list of rules for specifying which changes to ignore during diffing."'), + ignore: { + '#target':: d.obj(help='"Target is a selector for specifying Kubernetes objects to which this rule applies. If Target is not set, the Paths will be ignored for all Kubernetes objects within the manifest of the Helm release."'), + target: { + '#withAnnotationSelector':: d.fn(help='"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations."', args=[d.arg(name='annotationSelector', type=d.T.string)]), + withAnnotationSelector(annotationSelector): { target+: { annotationSelector: annotationSelector } }, + '#withGroup':: d.fn(help='"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { target+: { group: group } }, + '#withKind':: d.fn(help='"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { target+: { kind: kind } }, + '#withLabelSelector':: d.fn(help='"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels."', args=[d.arg(name='labelSelector', type=d.T.string)]), + withLabelSelector(labelSelector): { target+: { labelSelector: labelSelector } }, + '#withName':: d.fn(help='"Name to match resources with."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { target+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace to select resources from."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { target+: { namespace: namespace } }, + '#withVersion':: d.fn(help='"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { target+: { version: version } }, + }, + '#withPaths':: d.fn(help='"Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from consideration in a Kubernetes object."', args=[d.arg(name='paths', type=d.T.array)]), + withPaths(paths): { paths: if std.isArray(v=paths) then paths else [paths] }, + '#withPathsMixin':: d.fn(help='"Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from consideration in a Kubernetes object."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='paths', type=d.T.array)]), + withPathsMixin(paths): { paths+: if std.isArray(v=paths) then paths else [paths] }, + }, + '#withIgnore':: d.fn(help='"Ignore contains a list of rules for specifying which changes to ignore during diffing."', args=[d.arg(name='ignore', type=d.T.array)]), + withIgnore(ignore): { spec+: { driftDetection+: { ignore: if std.isArray(v=ignore) then ignore else [ignore] } } }, + '#withIgnoreMixin':: d.fn(help='"Ignore contains a list of rules for specifying which changes to ignore during diffing."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ignore', type=d.T.array)]), + withIgnoreMixin(ignore): { spec+: { driftDetection+: { ignore+: if std.isArray(v=ignore) then ignore else [ignore] } } }, + '#withMode':: d.fn(help='"Mode defines how differences should be handled between the Helm manifest and the manifest currently applied to the cluster. If not explicitly set, it defaults to DiffModeDisabled."', args=[d.arg(name='mode', type=d.T.string)]), + withMode(mode): { spec+: { driftDetection+: { mode: mode } } }, + }, + '#install':: d.obj(help='"Install holds the configuration for Helm install actions for this HelmRelease."'), + install: { + '#remediation':: d.obj(help='"Remediation holds the remediation configuration for when the Helm install action for the HelmRelease fails. The default is to not perform any action."'), + remediation: { + '#withIgnoreTestFailures':: d.fn(help="\"IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an install action but fail. Defaults to 'Test.IgnoreFailures'.\"", args=[d.arg(name='ignoreTestFailures', type=d.T.boolean)]), + withIgnoreTestFailures(ignoreTestFailures): { spec+: { install+: { remediation+: { ignoreTestFailures: ignoreTestFailures } } } }, + '#withRemediateLastFailure':: d.fn(help="\"RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false'.\"", args=[d.arg(name='remediateLastFailure', type=d.T.boolean)]), + withRemediateLastFailure(remediateLastFailure): { spec+: { install+: { remediation+: { remediateLastFailure: remediateLastFailure } } } }, + '#withRetries':: d.fn(help="\"Retries is the number of retries that should be attempted on failures before bailing. Remediation, using an uninstall, is performed between each attempt. Defaults to '0', a negative integer equals to unlimited retries.\"", args=[d.arg(name='retries', type=d.T.integer)]), + withRetries(retries): { spec+: { install+: { remediation+: { retries: retries } } } }, + }, + '#withCrds':: d.fn(help="\"CRDs upgrade CRDs from the Helm Chart's crds directory according to the CRD upgrade policy provided here. Valid values are `Skip`, `Create` or `CreateReplace`. Default is `Create` and if omitted CRDs are installed but not updated. \\n Skip: do neither install nor replace (update) any CRDs. \\n Create: new CRDs are created, existing CRDs are neither updated nor deleted. \\n CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted. \\n By default, CRDs are applied (installed) during Helm install action. With this option users can opt-in to CRD replace existing CRDs on Helm install actions, which is not (yet) natively supported by Helm. https://helm.sh/docs/chart_best_practices/custom_resource_definitions.\"", args=[d.arg(name='crds', type=d.T.string)]), + withCrds(crds): { spec+: { install+: { crds: crds } } }, + '#withCreateNamespace':: d.fn(help='"CreateNamespace tells the Helm install action to create the HelmReleaseSpec.TargetNamespace if it does not exist yet. On uninstall, the namespace will not be garbage collected."', args=[d.arg(name='createNamespace', type=d.T.boolean)]), + withCreateNamespace(createNamespace): { spec+: { install+: { createNamespace: createNamespace } } }, + '#withDisableHooks':: d.fn(help='"DisableHooks prevents hooks from running during the Helm install action."', args=[d.arg(name='disableHooks', type=d.T.boolean)]), + withDisableHooks(disableHooks): { spec+: { install+: { disableHooks: disableHooks } } }, + '#withDisableOpenAPIValidation':: d.fn(help='"DisableOpenAPIValidation prevents the Helm install action from validating rendered templates against the Kubernetes OpenAPI Schema."', args=[d.arg(name='disableOpenAPIValidation', type=d.T.boolean)]), + withDisableOpenAPIValidation(disableOpenAPIValidation): { spec+: { install+: { disableOpenAPIValidation: disableOpenAPIValidation } } }, + '#withDisableWait':: d.fn(help='"DisableWait disables the waiting for resources to be ready after a Helm install has been performed."', args=[d.arg(name='disableWait', type=d.T.boolean)]), + withDisableWait(disableWait): { spec+: { install+: { disableWait: disableWait } } }, + '#withDisableWaitForJobs':: d.fn(help='"DisableWaitForJobs disables waiting for jobs to complete after a Helm install has been performed."', args=[d.arg(name='disableWaitForJobs', type=d.T.boolean)]), + withDisableWaitForJobs(disableWaitForJobs): { spec+: { install+: { disableWaitForJobs: disableWaitForJobs } } }, + '#withReplace':: d.fn(help="\"Replace tells the Helm install action to re-use the 'ReleaseName', but only if that name is a deleted release which remains in the history.\"", args=[d.arg(name='replace', type=d.T.boolean)]), + withReplace(replace): { spec+: { install+: { replace: replace } } }, + '#withSkipCRDs':: d.fn(help='"SkipCRDs tells the Helm install action to not install any CRDs. By default, CRDs are installed if not already present. \\n Deprecated use CRD policy (`crds`) attribute with value `Skip` instead."', args=[d.arg(name='skipCRDs', type=d.T.boolean)]), + withSkipCRDs(skipCRDs): { spec+: { install+: { skipCRDs: skipCRDs } } }, + '#withTimeout':: d.fn(help="\"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm install action. Defaults to 'HelmReleaseSpec.Timeout'.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { install+: { timeout: timeout } } }, + }, + '#kubeConfig':: d.obj(help='"KubeConfig for reconciling the HelmRelease on a remote cluster. When used in combination with HelmReleaseSpec.ServiceAccountName, forces the controller to act on behalf of that Service Account at the target cluster. If the --default-service-account flag is set, its value will be used as a controller level fallback for when HelmReleaseSpec.ServiceAccountName is empty."'), + kubeConfig: { + '#secretRef':: d.obj(help="\"SecretRef holds the name of a secret that contains a key with the kubeconfig file as the value. If no key is set, the key will default to 'value'. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific `cmd-path` auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling Kubernetes resources.\""), + secretRef: { + '#withKey':: d.fn(help='"Key in the Secret, when not specified an implementation-specific default key is used."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { kubeConfig+: { secretRef+: { key: key } } } }, + '#withName':: d.fn(help='"Name of the Secret."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { kubeConfig+: { secretRef+: { name: name } } } }, + }, + }, + '#postRenderers':: d.obj(help='"PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition."'), + postRenderers: { + '#kustomize':: d.obj(help='"Kustomization to apply as PostRenderer."'), + kustomize: { + '#images':: d.obj(help='"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify."'), + images: { + '#withDigest':: d.fn(help='"Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored."', args=[d.arg(name='digest', type=d.T.string)]), + withDigest(digest): { digest: digest }, + '#withName':: d.fn(help='"Name is a tag-less image name."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNewName':: d.fn(help='"NewName is the value used to replace the original name."', args=[d.arg(name='newName', type=d.T.string)]), + withNewName(newName): { newName: newName }, + '#withNewTag':: d.fn(help='"NewTag is the value used to replace the original tag."', args=[d.arg(name='newTag', type=d.T.string)]), + withNewTag(newTag): { newTag: newTag }, + }, + '#patches':: d.obj(help='"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."'), + patches: { + '#target':: d.obj(help='"Target points to the resources that the patch document should be applied to."'), + target: { + '#withAnnotationSelector':: d.fn(help='"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations."', args=[d.arg(name='annotationSelector', type=d.T.string)]), + withAnnotationSelector(annotationSelector): { target+: { annotationSelector: annotationSelector } }, + '#withGroup':: d.fn(help='"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { target+: { group: group } }, + '#withKind':: d.fn(help='"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { target+: { kind: kind } }, + '#withLabelSelector':: d.fn(help='"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels."', args=[d.arg(name='labelSelector', type=d.T.string)]), + withLabelSelector(labelSelector): { target+: { labelSelector: labelSelector } }, + '#withName':: d.fn(help='"Name to match resources with."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { target+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace to select resources from."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { target+: { namespace: namespace } }, + '#withVersion':: d.fn(help='"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { target+: { version: version } }, + }, + '#withPatch':: d.fn(help='"Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects."', args=[d.arg(name='patch', type=d.T.string)]), + withPatch(patch): { patch: patch }, + }, + '#patchesJson6902':: d.obj(help='"JSON 6902 patches, defined as inline YAML objects."'), + patchesJson6902: { + '#patch':: d.obj(help='"Patch contains the JSON6902 patch document with an array of operation objects."'), + patch: { + '#withFrom':: d.fn(help='"From contains a JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations."', args=[d.arg(name='from', type=d.T.string)]), + withFrom(from): { from: from }, + '#withOp':: d.fn(help='"Op indicates the operation to perform. Its value MUST be one of \\"add\\", \\"remove\\", \\"replace\\", \\"move\\", \\"copy\\", or \\"test\\". https://datatracker.ietf.org/doc/html/rfc6902#section-4"', args=[d.arg(name='op', type=d.T.string)]), + withOp(op): { op: op }, + '#withPath':: d.fn(help='"Path contains the JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + '#withValue':: d.fn(help='"Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations."', args=[d.arg(name='value', type=d.T.any)]), + withValue(value): { value: value }, + }, + '#target':: d.obj(help='"Target points to the resources that the patch document should be applied to."'), + target: { + '#withAnnotationSelector':: d.fn(help='"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations."', args=[d.arg(name='annotationSelector', type=d.T.string)]), + withAnnotationSelector(annotationSelector): { target+: { annotationSelector: annotationSelector } }, + '#withGroup':: d.fn(help='"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { target+: { group: group } }, + '#withKind':: d.fn(help='"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { target+: { kind: kind } }, + '#withLabelSelector':: d.fn(help='"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels."', args=[d.arg(name='labelSelector', type=d.T.string)]), + withLabelSelector(labelSelector): { target+: { labelSelector: labelSelector } }, + '#withName':: d.fn(help='"Name to match resources with."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { target+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace to select resources from."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { target+: { namespace: namespace } }, + '#withVersion':: d.fn(help='"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { target+: { version: version } }, + }, + '#withPatch':: d.fn(help='"Patch contains the JSON6902 patch document with an array of operation objects."', args=[d.arg(name='patch', type=d.T.array)]), + withPatch(patch): { patch: if std.isArray(v=patch) then patch else [patch] }, + '#withPatchMixin':: d.fn(help='"Patch contains the JSON6902 patch document with an array of operation objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patch', type=d.T.array)]), + withPatchMixin(patch): { patch+: if std.isArray(v=patch) then patch else [patch] }, + }, + '#withImages':: d.fn(help='"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify."', args=[d.arg(name='images', type=d.T.array)]), + withImages(images): { kustomize+: { images: if std.isArray(v=images) then images else [images] } }, + '#withImagesMixin':: d.fn(help='"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='images', type=d.T.array)]), + withImagesMixin(images): { kustomize+: { images+: if std.isArray(v=images) then images else [images] } }, + '#withPatches':: d.fn(help='"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."', args=[d.arg(name='patches', type=d.T.array)]), + withPatches(patches): { kustomize+: { patches: if std.isArray(v=patches) then patches else [patches] } }, + '#withPatchesJson6902':: d.fn(help='"JSON 6902 patches, defined as inline YAML objects."', args=[d.arg(name='patchesJson6902', type=d.T.array)]), + withPatchesJson6902(patchesJson6902): { kustomize+: { patchesJson6902: if std.isArray(v=patchesJson6902) then patchesJson6902 else [patchesJson6902] } }, + '#withPatchesJson6902Mixin':: d.fn(help='"JSON 6902 patches, defined as inline YAML objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patchesJson6902', type=d.T.array)]), + withPatchesJson6902Mixin(patchesJson6902): { kustomize+: { patchesJson6902+: if std.isArray(v=patchesJson6902) then patchesJson6902 else [patchesJson6902] } }, + '#withPatchesMixin':: d.fn(help='"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patches', type=d.T.array)]), + withPatchesMixin(patches): { kustomize+: { patches+: if std.isArray(v=patches) then patches else [patches] } }, + '#withPatchesStrategicMerge':: d.fn(help='"Strategic merge patches, defined as inline YAML objects."', args=[d.arg(name='patchesStrategicMerge', type=d.T.array)]), + withPatchesStrategicMerge(patchesStrategicMerge): { kustomize+: { patchesStrategicMerge: if std.isArray(v=patchesStrategicMerge) then patchesStrategicMerge else [patchesStrategicMerge] } }, + '#withPatchesStrategicMergeMixin':: d.fn(help='"Strategic merge patches, defined as inline YAML objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patchesStrategicMerge', type=d.T.array)]), + withPatchesStrategicMergeMixin(patchesStrategicMerge): { kustomize+: { patchesStrategicMerge+: if std.isArray(v=patchesStrategicMerge) then patchesStrategicMerge else [patchesStrategicMerge] } }, + }, + }, + '#rollback':: d.obj(help='"Rollback holds the configuration for Helm rollback actions for this HelmRelease."'), + rollback: { + '#withCleanupOnFail':: d.fn(help='"CleanupOnFail allows deletion of new resources created during the Helm rollback action when it fails."', args=[d.arg(name='cleanupOnFail', type=d.T.boolean)]), + withCleanupOnFail(cleanupOnFail): { spec+: { rollback+: { cleanupOnFail: cleanupOnFail } } }, + '#withDisableHooks':: d.fn(help='"DisableHooks prevents hooks from running during the Helm rollback action."', args=[d.arg(name='disableHooks', type=d.T.boolean)]), + withDisableHooks(disableHooks): { spec+: { rollback+: { disableHooks: disableHooks } } }, + '#withDisableWait':: d.fn(help='"DisableWait disables the waiting for resources to be ready after a Helm rollback has been performed."', args=[d.arg(name='disableWait', type=d.T.boolean)]), + withDisableWait(disableWait): { spec+: { rollback+: { disableWait: disableWait } } }, + '#withDisableWaitForJobs':: d.fn(help='"DisableWaitForJobs disables waiting for jobs to complete after a Helm rollback has been performed."', args=[d.arg(name='disableWaitForJobs', type=d.T.boolean)]), + withDisableWaitForJobs(disableWaitForJobs): { spec+: { rollback+: { disableWaitForJobs: disableWaitForJobs } } }, + '#withForce':: d.fn(help='"Force forces resource updates through a replacement strategy."', args=[d.arg(name='force', type=d.T.boolean)]), + withForce(force): { spec+: { rollback+: { force: force } } }, + '#withRecreate':: d.fn(help='"Recreate performs pod restarts for the resource if applicable."', args=[d.arg(name='recreate', type=d.T.boolean)]), + withRecreate(recreate): { spec+: { rollback+: { recreate: recreate } } }, + '#withTimeout':: d.fn(help="\"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm rollback action. Defaults to 'HelmReleaseSpec.Timeout'.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { rollback+: { timeout: timeout } } }, + }, + '#test':: d.obj(help='"Test holds the configuration for Helm test actions for this HelmRelease."'), + test: { + '#withEnable':: d.fn(help='"Enable enables Helm test actions for this HelmRelease after an Helm install or upgrade action has been performed."', args=[d.arg(name='enable', type=d.T.boolean)]), + withEnable(enable): { spec+: { test+: { enable: enable } } }, + '#withIgnoreFailures':: d.fn(help="\"IgnoreFailures tells the controller to skip remediation when the Helm tests are run but fail. Can be overwritten for tests run after install or upgrade actions in 'Install.IgnoreTestFailures' and 'Upgrade.IgnoreTestFailures'.\"", args=[d.arg(name='ignoreFailures', type=d.T.boolean)]), + withIgnoreFailures(ignoreFailures): { spec+: { test+: { ignoreFailures: ignoreFailures } } }, + '#withTimeout':: d.fn(help="\"Timeout is the time to wait for any individual Kubernetes operation during the performance of a Helm test action. Defaults to 'HelmReleaseSpec.Timeout'.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { test+: { timeout: timeout } } }, + }, + '#uninstall':: d.obj(help='"Uninstall holds the configuration for Helm uninstall actions for this HelmRelease."'), + uninstall: { + '#withDeletionPropagation':: d.fn(help='"DeletionPropagation specifies the deletion propagation policy when a Helm uninstall is performed."', args=[d.arg(name='deletionPropagation', type=d.T.string)]), + withDeletionPropagation(deletionPropagation): { spec+: { uninstall+: { deletionPropagation: deletionPropagation } } }, + '#withDisableHooks':: d.fn(help='"DisableHooks prevents hooks from running during the Helm rollback action."', args=[d.arg(name='disableHooks', type=d.T.boolean)]), + withDisableHooks(disableHooks): { spec+: { uninstall+: { disableHooks: disableHooks } } }, + '#withDisableWait':: d.fn(help='"DisableWait disables waiting for all the resources to be deleted after a Helm uninstall is performed."', args=[d.arg(name='disableWait', type=d.T.boolean)]), + withDisableWait(disableWait): { spec+: { uninstall+: { disableWait: disableWait } } }, + '#withKeepHistory':: d.fn(help='"KeepHistory tells Helm to remove all associated resources and mark the release as deleted, but retain the release history."', args=[d.arg(name='keepHistory', type=d.T.boolean)]), + withKeepHistory(keepHistory): { spec+: { uninstall+: { keepHistory: keepHistory } } }, + '#withTimeout':: d.fn(help="\"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm uninstall action. Defaults to 'HelmReleaseSpec.Timeout'.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { uninstall+: { timeout: timeout } } }, + }, + '#upgrade':: d.obj(help='"Upgrade holds the configuration for Helm upgrade actions for this HelmRelease."'), + upgrade: { + '#remediation':: d.obj(help='"Remediation holds the remediation configuration for when the Helm upgrade action for the HelmRelease fails. The default is to not perform any action."'), + remediation: { + '#withIgnoreTestFailures':: d.fn(help="\"IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an upgrade action but fail. Defaults to 'Test.IgnoreFailures'.\"", args=[d.arg(name='ignoreTestFailures', type=d.T.boolean)]), + withIgnoreTestFailures(ignoreTestFailures): { spec+: { upgrade+: { remediation+: { ignoreTestFailures: ignoreTestFailures } } } }, + '#withRemediateLastFailure':: d.fn(help="\"RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false' unless 'Retries' is greater than 0.\"", args=[d.arg(name='remediateLastFailure', type=d.T.boolean)]), + withRemediateLastFailure(remediateLastFailure): { spec+: { upgrade+: { remediation+: { remediateLastFailure: remediateLastFailure } } } }, + '#withRetries':: d.fn(help="\"Retries is the number of retries that should be attempted on failures before bailing. Remediation, using 'Strategy', is performed between each attempt. Defaults to '0', a negative integer equals to unlimited retries.\"", args=[d.arg(name='retries', type=d.T.integer)]), + withRetries(retries): { spec+: { upgrade+: { remediation+: { retries: retries } } } }, + '#withStrategy':: d.fn(help="\"Strategy to use for failure remediation. Defaults to 'rollback'.\"", args=[d.arg(name='strategy', type=d.T.string)]), + withStrategy(strategy): { spec+: { upgrade+: { remediation+: { strategy: strategy } } } }, + }, + '#withCleanupOnFail':: d.fn(help='"CleanupOnFail allows deletion of new resources created during the Helm upgrade action when it fails."', args=[d.arg(name='cleanupOnFail', type=d.T.boolean)]), + withCleanupOnFail(cleanupOnFail): { spec+: { upgrade+: { cleanupOnFail: cleanupOnFail } } }, + '#withCrds':: d.fn(help="\"CRDs upgrade CRDs from the Helm Chart's crds directory according to the CRD upgrade policy provided here. Valid values are `Skip`, `Create` or `CreateReplace`. Default is `Skip` and if omitted CRDs are neither installed nor upgraded. \\n Skip: do neither install nor replace (update) any CRDs. \\n Create: new CRDs are created, existing CRDs are neither updated nor deleted. \\n CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted. \\n By default, CRDs are not applied during Helm upgrade action. With this option users can opt-in to CRD upgrade, which is not (yet) natively supported by Helm. https://helm.sh/docs/chart_best_practices/custom_resource_definitions.\"", args=[d.arg(name='crds', type=d.T.string)]), + withCrds(crds): { spec+: { upgrade+: { crds: crds } } }, + '#withDisableHooks':: d.fn(help='"DisableHooks prevents hooks from running during the Helm upgrade action."', args=[d.arg(name='disableHooks', type=d.T.boolean)]), + withDisableHooks(disableHooks): { spec+: { upgrade+: { disableHooks: disableHooks } } }, + '#withDisableOpenAPIValidation':: d.fn(help='"DisableOpenAPIValidation prevents the Helm upgrade action from validating rendered templates against the Kubernetes OpenAPI Schema."', args=[d.arg(name='disableOpenAPIValidation', type=d.T.boolean)]), + withDisableOpenAPIValidation(disableOpenAPIValidation): { spec+: { upgrade+: { disableOpenAPIValidation: disableOpenAPIValidation } } }, + '#withDisableWait':: d.fn(help='"DisableWait disables the waiting for resources to be ready after a Helm upgrade has been performed."', args=[d.arg(name='disableWait', type=d.T.boolean)]), + withDisableWait(disableWait): { spec+: { upgrade+: { disableWait: disableWait } } }, + '#withDisableWaitForJobs':: d.fn(help='"DisableWaitForJobs disables waiting for jobs to complete after a Helm upgrade has been performed."', args=[d.arg(name='disableWaitForJobs', type=d.T.boolean)]), + withDisableWaitForJobs(disableWaitForJobs): { spec+: { upgrade+: { disableWaitForJobs: disableWaitForJobs } } }, + '#withForce':: d.fn(help='"Force forces resource updates through a replacement strategy."', args=[d.arg(name='force', type=d.T.boolean)]), + withForce(force): { spec+: { upgrade+: { force: force } } }, + '#withPreserveValues':: d.fn(help="\"PreserveValues will make Helm reuse the last release's values and merge in overrides from 'Values'. Setting this flag makes the HelmRelease non-declarative.\"", args=[d.arg(name='preserveValues', type=d.T.boolean)]), + withPreserveValues(preserveValues): { spec+: { upgrade+: { preserveValues: preserveValues } } }, + '#withTimeout':: d.fn(help="\"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm upgrade action. Defaults to 'HelmReleaseSpec.Timeout'.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { upgrade+: { timeout: timeout } } }, + }, + '#valuesFrom':: d.obj(help='"ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged."'), + valuesFrom: { + '#withKind':: d.fn(help="\"Kind of the values referent, valid values are ('Secret', 'ConfigMap').\"", args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { kind: kind }, + '#withName':: d.fn(help='"Name of the values referent. Should reside in the same namespace as the referring resource."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withOptional':: d.fn(help='"Optional marks this ValuesReference as optional. When set, a not found error for the values reference is ignored, but any ValuesKey, TargetPath or transient error will still result in a reconciliation failure."', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { optional: optional }, + '#withTargetPath':: d.fn(help="\"TargetPath is the YAML dot notation path the value should be merged at. When set, the ValuesKey is expected to be a single flat value. Defaults to 'None', which results in the values getting merged at the root.\"", args=[d.arg(name='targetPath', type=d.T.string)]), + withTargetPath(targetPath): { targetPath: targetPath }, + '#withValuesKey':: d.fn(help="\"ValuesKey is the data key where the values.yaml or a specific value can be found at. Defaults to 'values.yaml'. When set, must be a valid Data Key, consisting of alphanumeric characters, '-', '_' or '.'.\"", args=[d.arg(name='valuesKey', type=d.T.string)]), + withValuesKey(valuesKey): { valuesKey: valuesKey }, + }, + '#withDependsOn':: d.fn(help='"DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled."', args=[d.arg(name='dependsOn', type=d.T.array)]), + withDependsOn(dependsOn): { spec+: { dependsOn: if std.isArray(v=dependsOn) then dependsOn else [dependsOn] } }, + '#withDependsOnMixin':: d.fn(help='"DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='dependsOn', type=d.T.array)]), + withDependsOnMixin(dependsOn): { spec+: { dependsOn+: if std.isArray(v=dependsOn) then dependsOn else [dependsOn] } }, + '#withInterval':: d.fn(help='"Interval at which to reconcile the Helm release. This interval is approximate and may be subject to jitter to ensure efficient use of resources."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withMaxHistory':: d.fn(help="\"MaxHistory is the number of revisions saved by Helm for this HelmRelease. Use '0' for an unlimited number of revisions; defaults to '10'.\"", args=[d.arg(name='maxHistory', type=d.T.integer)]), + withMaxHistory(maxHistory): { spec+: { maxHistory: maxHistory } }, + '#withPersistentClient':: d.fn(help="\"PersistentClient tells the controller to use a persistent Kubernetes client for this release. When enabled, the client will be reused for the duration of the reconciliation, instead of being created and destroyed for each (step of a) Helm action. \\n This can improve performance, but may cause issues with some Helm charts that for example do create Custom Resource Definitions during installation outside Helm's CRD lifecycle hooks, which are then not observed to be available by e.g. post-install hooks. \\n If not set, it defaults to true.\"", args=[d.arg(name='persistentClient', type=d.T.boolean)]), + withPersistentClient(persistentClient): { spec+: { persistentClient: persistentClient } }, + '#withPostRenderers':: d.fn(help='"PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition."', args=[d.arg(name='postRenderers', type=d.T.array)]), + withPostRenderers(postRenderers): { spec+: { postRenderers: if std.isArray(v=postRenderers) then postRenderers else [postRenderers] } }, + '#withPostRenderersMixin':: d.fn(help='"PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='postRenderers', type=d.T.array)]), + withPostRenderersMixin(postRenderers): { spec+: { postRenderers+: if std.isArray(v=postRenderers) then postRenderers else [postRenderers] } }, + '#withReleaseName':: d.fn(help="\"ReleaseName used for the Helm release. Defaults to a composition of '[TargetNamespace-]Name'.\"", args=[d.arg(name='releaseName', type=d.T.string)]), + withReleaseName(releaseName): { spec+: { releaseName: releaseName } }, + '#withServiceAccountName':: d.fn(help='"The name of the Kubernetes service account to impersonate when reconciling this HelmRelease."', args=[d.arg(name='serviceAccountName', type=d.T.string)]), + withServiceAccountName(serviceAccountName): { spec+: { serviceAccountName: serviceAccountName } }, + '#withStorageNamespace':: d.fn(help='"StorageNamespace used for the Helm storage. Defaults to the namespace of the HelmRelease."', args=[d.arg(name='storageNamespace', type=d.T.string)]), + withStorageNamespace(storageNamespace): { spec+: { storageNamespace: storageNamespace } }, + '#withSuspend':: d.fn(help='"Suspend tells the controller to suspend reconciliation for this HelmRelease, it does not apply to already started reconciliations. Defaults to false."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTargetNamespace':: d.fn(help='"TargetNamespace to target when performing operations for the HelmRelease. Defaults to the namespace of the HelmRelease."', args=[d.arg(name='targetNamespace', type=d.T.string)]), + withTargetNamespace(targetNamespace): { spec+: { targetNamespace: targetNamespace } }, + '#withTimeout':: d.fn(help="\"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm action. Defaults to '5m0s'.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + '#withValues':: d.fn(help='"Values holds the values for this Helm release."', args=[d.arg(name='values', type=d.T.any)]), + withValues(values): { spec+: { values: values } }, + '#withValuesFrom':: d.fn(help='"ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged."', args=[d.arg(name='valuesFrom', type=d.T.array)]), + withValuesFrom(valuesFrom): { spec+: { valuesFrom: if std.isArray(v=valuesFrom) then valuesFrom else [valuesFrom] } }, + '#withValuesFromMixin':: d.fn(help='"ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='valuesFrom', type=d.T.array)]), + withValuesFromMixin(valuesFrom): { spec+: { valuesFrom+: if std.isArray(v=valuesFrom) then valuesFrom else [valuesFrom] } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/helm/v2beta1/main.libsonnet b/2.2.1/_gen/helm/v2beta1/main.libsonnet new file mode 100644 index 0000000..9782e04 --- /dev/null +++ b/2.2.1/_gen/helm/v2beta1/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v2beta1', url='', help=''), + helmRelease: (import 'helmRelease.libsonnet'), +} diff --git a/2.2.1/_gen/helm/v2beta2/helmRelease.libsonnet b/2.2.1/_gen/helm/v2beta2/helmRelease.libsonnet new file mode 100644 index 0000000..4c39b44 --- /dev/null +++ b/2.2.1/_gen/helm/v2beta2/helmRelease.libsonnet @@ -0,0 +1,404 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='helmRelease', url='', help='"HelmRelease is the Schema for the helmreleases API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of HelmRelease', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'helm.toolkit.fluxcd.io/v2beta2', + kind: 'HelmRelease', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"HelmReleaseSpec defines the desired state of a Helm release."'), + spec: { + '#chart':: d.obj(help='"Chart defines the template of the v1beta2.HelmChart that should be created for this HelmRelease."'), + chart: { + '#metadata':: d.obj(help='"ObjectMeta holds the template for metadata like labels and annotations."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { spec+: { chart+: { metadata+: { annotations: annotations } } } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { spec+: { chart+: { metadata+: { annotations+: annotations } } } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { chart+: { metadata+: { labels: labels } } } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { chart+: { metadata+: { labels+: labels } } } }, + }, + '#spec':: d.obj(help='"Spec holds the template for the v1beta2.HelmChartSpec for this HelmRelease."'), + spec: { + '#sourceRef':: d.obj(help='"The name and namespace of the v1.Source the chart is available at."'), + sourceRef: { + '#withApiVersion':: d.fn(help='"APIVersion of the referent."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { spec+: { chart+: { spec+: { sourceRef+: { apiVersion: apiVersion } } } } }, + '#withKind':: d.fn(help='"Kind of the referent."', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { chart+: { spec+: { sourceRef+: { kind: kind } } } } }, + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { chart+: { spec+: { sourceRef+: { name: name } } } } }, + '#withNamespace':: d.fn(help='"Namespace of the referent."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { chart+: { spec+: { sourceRef+: { namespace: namespace } } } } }, + }, + '#verify':: d.obj(help='"Verify 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. This field is only supported for OCI sources. Chart dependencies, which are not bundled in the umbrella chart artifact, are not verified."'), + verify: { + '#secretRef':: d.obj(help='"SecretRef specifies the Kubernetes Secret containing the trusted public keys."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { chart+: { spec+: { verify+: { secretRef+: { name: name } } } } } }, + }, + '#withProvider':: d.fn(help='"Provider specifies the technology used to sign the OCI Helm chart."', args=[d.arg(name='provider', type=d.T.string)]), + withProvider(provider): { spec+: { chart+: { spec+: { verify+: { provider: provider } } } } }, + }, + '#withChart':: d.fn(help='"The name or path the Helm chart is available at in the SourceRef."', args=[d.arg(name='chart', type=d.T.string)]), + withChart(chart): { spec+: { chart+: { spec+: { chart: chart } } } }, + '#withInterval':: d.fn(help="\"Interval at which to check the v1.Source for updates. Defaults to 'HelmReleaseSpec.Interval'.\"", args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { chart+: { spec+: { interval: interval } } } }, + '#withReconcileStrategy':: d.fn(help="\"Determines what enables the creation of a new artifact. Valid values are ('ChartVersion', 'Revision'). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted.\"", args=[d.arg(name='reconcileStrategy', type=d.T.string)]), + withReconcileStrategy(reconcileStrategy): { spec+: { chart+: { spec+: { reconcileStrategy: reconcileStrategy } } } }, + '#withValuesFile':: d.fn(help='"Alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Deprecated in favor of ValuesFiles, for backwards compatibility the file defined here is merged before the ValuesFiles items. Ignored when omitted."', args=[d.arg(name='valuesFile', type=d.T.string)]), + withValuesFile(valuesFile): { spec+: { chart+: { spec+: { valuesFile: valuesFile } } } }, + '#withValuesFiles':: d.fn(help='"Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted."', args=[d.arg(name='valuesFiles', type=d.T.array)]), + withValuesFiles(valuesFiles): { spec+: { chart+: { spec+: { valuesFiles: if std.isArray(v=valuesFiles) then valuesFiles else [valuesFiles] } } } }, + '#withValuesFilesMixin':: d.fn(help='"Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='valuesFiles', type=d.T.array)]), + withValuesFilesMixin(valuesFiles): { spec+: { chart+: { spec+: { valuesFiles+: if std.isArray(v=valuesFiles) then valuesFiles else [valuesFiles] } } } }, + '#withVersion':: d.fn(help='"Version semver expression, ignored for charts from v1beta2.GitRepository and v1beta2.Bucket sources. Defaults to latest when omitted."', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { spec+: { chart+: { spec+: { version: version } } } }, + }, + }, + '#dependsOn':: d.obj(help='"DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled."'), + dependsOn: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent, when not specified it acts as LocalObjectReference."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + }, + '#driftDetection':: d.obj(help='"DriftDetection holds the configuration for detecting and handling differences between the manifest in the Helm storage and the resources currently existing in the cluster."'), + driftDetection: { + '#ignore':: d.obj(help='"Ignore contains a list of rules for specifying which changes to ignore during diffing."'), + ignore: { + '#target':: d.obj(help='"Target is a selector for specifying Kubernetes objects to which this rule applies. If Target is not set, the Paths will be ignored for all Kubernetes objects within the manifest of the Helm release."'), + target: { + '#withAnnotationSelector':: d.fn(help='"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations."', args=[d.arg(name='annotationSelector', type=d.T.string)]), + withAnnotationSelector(annotationSelector): { target+: { annotationSelector: annotationSelector } }, + '#withGroup':: d.fn(help='"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { target+: { group: group } }, + '#withKind':: d.fn(help='"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { target+: { kind: kind } }, + '#withLabelSelector':: d.fn(help='"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels."', args=[d.arg(name='labelSelector', type=d.T.string)]), + withLabelSelector(labelSelector): { target+: { labelSelector: labelSelector } }, + '#withName':: d.fn(help='"Name to match resources with."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { target+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace to select resources from."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { target+: { namespace: namespace } }, + '#withVersion':: d.fn(help='"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { target+: { version: version } }, + }, + '#withPaths':: d.fn(help='"Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from consideration in a Kubernetes object."', args=[d.arg(name='paths', type=d.T.array)]), + withPaths(paths): { paths: if std.isArray(v=paths) then paths else [paths] }, + '#withPathsMixin':: d.fn(help='"Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from consideration in a Kubernetes object."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='paths', type=d.T.array)]), + withPathsMixin(paths): { paths+: if std.isArray(v=paths) then paths else [paths] }, + }, + '#withIgnore':: d.fn(help='"Ignore contains a list of rules for specifying which changes to ignore during diffing."', args=[d.arg(name='ignore', type=d.T.array)]), + withIgnore(ignore): { spec+: { driftDetection+: { ignore: if std.isArray(v=ignore) then ignore else [ignore] } } }, + '#withIgnoreMixin':: d.fn(help='"Ignore contains a list of rules for specifying which changes to ignore during diffing."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ignore', type=d.T.array)]), + withIgnoreMixin(ignore): { spec+: { driftDetection+: { ignore+: if std.isArray(v=ignore) then ignore else [ignore] } } }, + '#withMode':: d.fn(help='"Mode defines how differences should be handled between the Helm manifest and the manifest currently applied to the cluster. If not explicitly set, it defaults to DiffModeDisabled."', args=[d.arg(name='mode', type=d.T.string)]), + withMode(mode): { spec+: { driftDetection+: { mode: mode } } }, + }, + '#install':: d.obj(help='"Install holds the configuration for Helm install actions for this HelmRelease."'), + install: { + '#remediation':: d.obj(help='"Remediation holds the remediation configuration for when the Helm install action for the HelmRelease fails. The default is to not perform any action."'), + remediation: { + '#withIgnoreTestFailures':: d.fn(help="\"IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an install action but fail. Defaults to 'Test.IgnoreFailures'.\"", args=[d.arg(name='ignoreTestFailures', type=d.T.boolean)]), + withIgnoreTestFailures(ignoreTestFailures): { spec+: { install+: { remediation+: { ignoreTestFailures: ignoreTestFailures } } } }, + '#withRemediateLastFailure':: d.fn(help="\"RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false'.\"", args=[d.arg(name='remediateLastFailure', type=d.T.boolean)]), + withRemediateLastFailure(remediateLastFailure): { spec+: { install+: { remediation+: { remediateLastFailure: remediateLastFailure } } } }, + '#withRetries':: d.fn(help="\"Retries is the number of retries that should be attempted on failures before bailing. Remediation, using an uninstall, is performed between each attempt. Defaults to '0', a negative integer equals to unlimited retries.\"", args=[d.arg(name='retries', type=d.T.integer)]), + withRetries(retries): { spec+: { install+: { remediation+: { retries: retries } } } }, + }, + '#withCrds':: d.fn(help="\"CRDs upgrade CRDs from the Helm Chart's crds directory according to the CRD upgrade policy provided here. Valid values are `Skip`, `Create` or `CreateReplace`. Default is `Create` and if omitted CRDs are installed but not updated. \\n Skip: do neither install nor replace (update) any CRDs. \\n Create: new CRDs are created, existing CRDs are neither updated nor deleted. \\n CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted. \\n By default, CRDs are applied (installed) during Helm install action. With this option users can opt in to CRD replace existing CRDs on Helm install actions, which is not (yet) natively supported by Helm. https://helm.sh/docs/chart_best_practices/custom_resource_definitions.\"", args=[d.arg(name='crds', type=d.T.string)]), + withCrds(crds): { spec+: { install+: { crds: crds } } }, + '#withCreateNamespace':: d.fn(help='"CreateNamespace tells the Helm install action to create the HelmReleaseSpec.TargetNamespace if it does not exist yet. On uninstall, the namespace will not be garbage collected."', args=[d.arg(name='createNamespace', type=d.T.boolean)]), + withCreateNamespace(createNamespace): { spec+: { install+: { createNamespace: createNamespace } } }, + '#withDisableHooks':: d.fn(help='"DisableHooks prevents hooks from running during the Helm install action."', args=[d.arg(name='disableHooks', type=d.T.boolean)]), + withDisableHooks(disableHooks): { spec+: { install+: { disableHooks: disableHooks } } }, + '#withDisableOpenAPIValidation':: d.fn(help='"DisableOpenAPIValidation prevents the Helm install action from validating rendered templates against the Kubernetes OpenAPI Schema."', args=[d.arg(name='disableOpenAPIValidation', type=d.T.boolean)]), + withDisableOpenAPIValidation(disableOpenAPIValidation): { spec+: { install+: { disableOpenAPIValidation: disableOpenAPIValidation } } }, + '#withDisableWait':: d.fn(help='"DisableWait disables the waiting for resources to be ready after a Helm install has been performed."', args=[d.arg(name='disableWait', type=d.T.boolean)]), + withDisableWait(disableWait): { spec+: { install+: { disableWait: disableWait } } }, + '#withDisableWaitForJobs':: d.fn(help='"DisableWaitForJobs disables waiting for jobs to complete after a Helm install has been performed."', args=[d.arg(name='disableWaitForJobs', type=d.T.boolean)]), + withDisableWaitForJobs(disableWaitForJobs): { spec+: { install+: { disableWaitForJobs: disableWaitForJobs } } }, + '#withReplace':: d.fn(help="\"Replace tells the Helm install action to re-use the 'ReleaseName', but only if that name is a deleted release which remains in the history.\"", args=[d.arg(name='replace', type=d.T.boolean)]), + withReplace(replace): { spec+: { install+: { replace: replace } } }, + '#withSkipCRDs':: d.fn(help='"SkipCRDs tells the Helm install action to not install any CRDs. By default, CRDs are installed if not already present. \\n Deprecated use CRD policy (`crds`) attribute with value `Skip` instead."', args=[d.arg(name='skipCRDs', type=d.T.boolean)]), + withSkipCRDs(skipCRDs): { spec+: { install+: { skipCRDs: skipCRDs } } }, + '#withTimeout':: d.fn(help="\"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm install action. Defaults to 'HelmReleaseSpec.Timeout'.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { install+: { timeout: timeout } } }, + }, + '#kubeConfig':: d.obj(help='"KubeConfig for reconciling the HelmRelease on a remote cluster. When used in combination with HelmReleaseSpec.ServiceAccountName, forces the controller to act on behalf of that Service Account at the target cluster. If the --default-service-account flag is set, its value will be used as a controller level fallback for when HelmReleaseSpec.ServiceAccountName is empty."'), + kubeConfig: { + '#secretRef':: d.obj(help="\"SecretRef holds the name of a secret that contains a key with the kubeconfig file as the value. If no key is set, the key will default to 'value'. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific `cmd-path` auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling Kubernetes resources.\""), + secretRef: { + '#withKey':: d.fn(help='"Key in the Secret, when not specified an implementation-specific default key is used."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { kubeConfig+: { secretRef+: { key: key } } } }, + '#withName':: d.fn(help='"Name of the Secret."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { kubeConfig+: { secretRef+: { name: name } } } }, + }, + }, + '#postRenderers':: d.obj(help='"PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition."'), + postRenderers: { + '#kustomize':: d.obj(help='"Kustomization to apply as PostRenderer."'), + kustomize: { + '#images':: d.obj(help='"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify."'), + images: { + '#withDigest':: d.fn(help='"Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored."', args=[d.arg(name='digest', type=d.T.string)]), + withDigest(digest): { digest: digest }, + '#withName':: d.fn(help='"Name is a tag-less image name."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNewName':: d.fn(help='"NewName is the value used to replace the original name."', args=[d.arg(name='newName', type=d.T.string)]), + withNewName(newName): { newName: newName }, + '#withNewTag':: d.fn(help='"NewTag is the value used to replace the original tag."', args=[d.arg(name='newTag', type=d.T.string)]), + withNewTag(newTag): { newTag: newTag }, + }, + '#patches':: d.obj(help='"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."'), + patches: { + '#target':: d.obj(help='"Target points to the resources that the patch document should be applied to."'), + target: { + '#withAnnotationSelector':: d.fn(help='"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations."', args=[d.arg(name='annotationSelector', type=d.T.string)]), + withAnnotationSelector(annotationSelector): { target+: { annotationSelector: annotationSelector } }, + '#withGroup':: d.fn(help='"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { target+: { group: group } }, + '#withKind':: d.fn(help='"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { target+: { kind: kind } }, + '#withLabelSelector':: d.fn(help='"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels."', args=[d.arg(name='labelSelector', type=d.T.string)]), + withLabelSelector(labelSelector): { target+: { labelSelector: labelSelector } }, + '#withName':: d.fn(help='"Name to match resources with."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { target+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace to select resources from."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { target+: { namespace: namespace } }, + '#withVersion':: d.fn(help='"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { target+: { version: version } }, + }, + '#withPatch':: d.fn(help='"Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects."', args=[d.arg(name='patch', type=d.T.string)]), + withPatch(patch): { patch: patch }, + }, + '#patchesJson6902':: d.obj(help='"JSON 6902 patches, defined as inline YAML objects. Deprecated: use Patches instead."'), + patchesJson6902: { + '#patch':: d.obj(help='"Patch contains the JSON6902 patch document with an array of operation objects."'), + patch: { + '#withFrom':: d.fn(help='"From contains a JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations."', args=[d.arg(name='from', type=d.T.string)]), + withFrom(from): { from: from }, + '#withOp':: d.fn(help='"Op indicates the operation to perform. Its value MUST be one of \\"add\\", \\"remove\\", \\"replace\\", \\"move\\", \\"copy\\", or \\"test\\". https://datatracker.ietf.org/doc/html/rfc6902#section-4"', args=[d.arg(name='op', type=d.T.string)]), + withOp(op): { op: op }, + '#withPath':: d.fn(help='"Path contains the JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + '#withValue':: d.fn(help='"Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations."', args=[d.arg(name='value', type=d.T.any)]), + withValue(value): { value: value }, + }, + '#target':: d.obj(help='"Target points to the resources that the patch document should be applied to."'), + target: { + '#withAnnotationSelector':: d.fn(help='"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations."', args=[d.arg(name='annotationSelector', type=d.T.string)]), + withAnnotationSelector(annotationSelector): { target+: { annotationSelector: annotationSelector } }, + '#withGroup':: d.fn(help='"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { target+: { group: group } }, + '#withKind':: d.fn(help='"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { target+: { kind: kind } }, + '#withLabelSelector':: d.fn(help='"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels."', args=[d.arg(name='labelSelector', type=d.T.string)]), + withLabelSelector(labelSelector): { target+: { labelSelector: labelSelector } }, + '#withName':: d.fn(help='"Name to match resources with."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { target+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace to select resources from."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { target+: { namespace: namespace } }, + '#withVersion':: d.fn(help='"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { target+: { version: version } }, + }, + '#withPatch':: d.fn(help='"Patch contains the JSON6902 patch document with an array of operation objects."', args=[d.arg(name='patch', type=d.T.array)]), + withPatch(patch): { patch: if std.isArray(v=patch) then patch else [patch] }, + '#withPatchMixin':: d.fn(help='"Patch contains the JSON6902 patch document with an array of operation objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patch', type=d.T.array)]), + withPatchMixin(patch): { patch+: if std.isArray(v=patch) then patch else [patch] }, + }, + '#withImages':: d.fn(help='"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify."', args=[d.arg(name='images', type=d.T.array)]), + withImages(images): { kustomize+: { images: if std.isArray(v=images) then images else [images] } }, + '#withImagesMixin':: d.fn(help='"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='images', type=d.T.array)]), + withImagesMixin(images): { kustomize+: { images+: if std.isArray(v=images) then images else [images] } }, + '#withPatches':: d.fn(help='"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."', args=[d.arg(name='patches', type=d.T.array)]), + withPatches(patches): { kustomize+: { patches: if std.isArray(v=patches) then patches else [patches] } }, + '#withPatchesJson6902':: d.fn(help='"JSON 6902 patches, defined as inline YAML objects. Deprecated: use Patches instead."', args=[d.arg(name='patchesJson6902', type=d.T.array)]), + withPatchesJson6902(patchesJson6902): { kustomize+: { patchesJson6902: if std.isArray(v=patchesJson6902) then patchesJson6902 else [patchesJson6902] } }, + '#withPatchesJson6902Mixin':: d.fn(help='"JSON 6902 patches, defined as inline YAML objects. Deprecated: use Patches instead."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patchesJson6902', type=d.T.array)]), + withPatchesJson6902Mixin(patchesJson6902): { kustomize+: { patchesJson6902+: if std.isArray(v=patchesJson6902) then patchesJson6902 else [patchesJson6902] } }, + '#withPatchesMixin':: d.fn(help='"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patches', type=d.T.array)]), + withPatchesMixin(patches): { kustomize+: { patches+: if std.isArray(v=patches) then patches else [patches] } }, + '#withPatchesStrategicMerge':: d.fn(help='"Strategic merge patches, defined as inline YAML objects. Deprecated: use Patches instead."', args=[d.arg(name='patchesStrategicMerge', type=d.T.array)]), + withPatchesStrategicMerge(patchesStrategicMerge): { kustomize+: { patchesStrategicMerge: if std.isArray(v=patchesStrategicMerge) then patchesStrategicMerge else [patchesStrategicMerge] } }, + '#withPatchesStrategicMergeMixin':: d.fn(help='"Strategic merge patches, defined as inline YAML objects. Deprecated: use Patches instead."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patchesStrategicMerge', type=d.T.array)]), + withPatchesStrategicMergeMixin(patchesStrategicMerge): { kustomize+: { patchesStrategicMerge+: if std.isArray(v=patchesStrategicMerge) then patchesStrategicMerge else [patchesStrategicMerge] } }, + }, + }, + '#rollback':: d.obj(help='"Rollback holds the configuration for Helm rollback actions for this HelmRelease."'), + rollback: { + '#withCleanupOnFail':: d.fn(help='"CleanupOnFail allows deletion of new resources created during the Helm rollback action when it fails."', args=[d.arg(name='cleanupOnFail', type=d.T.boolean)]), + withCleanupOnFail(cleanupOnFail): { spec+: { rollback+: { cleanupOnFail: cleanupOnFail } } }, + '#withDisableHooks':: d.fn(help='"DisableHooks prevents hooks from running during the Helm rollback action."', args=[d.arg(name='disableHooks', type=d.T.boolean)]), + withDisableHooks(disableHooks): { spec+: { rollback+: { disableHooks: disableHooks } } }, + '#withDisableWait':: d.fn(help='"DisableWait disables the waiting for resources to be ready after a Helm rollback has been performed."', args=[d.arg(name='disableWait', type=d.T.boolean)]), + withDisableWait(disableWait): { spec+: { rollback+: { disableWait: disableWait } } }, + '#withDisableWaitForJobs':: d.fn(help='"DisableWaitForJobs disables waiting for jobs to complete after a Helm rollback has been performed."', args=[d.arg(name='disableWaitForJobs', type=d.T.boolean)]), + withDisableWaitForJobs(disableWaitForJobs): { spec+: { rollback+: { disableWaitForJobs: disableWaitForJobs } } }, + '#withForce':: d.fn(help='"Force forces resource updates through a replacement strategy."', args=[d.arg(name='force', type=d.T.boolean)]), + withForce(force): { spec+: { rollback+: { force: force } } }, + '#withRecreate':: d.fn(help='"Recreate performs pod restarts for the resource if applicable."', args=[d.arg(name='recreate', type=d.T.boolean)]), + withRecreate(recreate): { spec+: { rollback+: { recreate: recreate } } }, + '#withTimeout':: d.fn(help="\"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm rollback action. Defaults to 'HelmReleaseSpec.Timeout'.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { rollback+: { timeout: timeout } } }, + }, + '#test':: d.obj(help='"Test holds the configuration for Helm test actions for this HelmRelease."'), + test: { + '#filters':: d.obj(help='"Filters is a list of tests to run or exclude from running."'), + filters: { + '#withExclude':: d.fn(help='"Exclude specifies whether the named test should be excluded."', args=[d.arg(name='exclude', type=d.T.boolean)]), + withExclude(exclude): { exclude: exclude }, + '#withName':: d.fn(help='"Name is the name of the test."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withEnable':: d.fn(help='"Enable enables Helm test actions for this HelmRelease after an Helm install or upgrade action has been performed."', args=[d.arg(name='enable', type=d.T.boolean)]), + withEnable(enable): { spec+: { test+: { enable: enable } } }, + '#withFilters':: d.fn(help='"Filters is a list of tests to run or exclude from running."', args=[d.arg(name='filters', type=d.T.array)]), + withFilters(filters): { spec+: { test+: { filters: if std.isArray(v=filters) then filters else [filters] } } }, + '#withFiltersMixin':: d.fn(help='"Filters is a list of tests to run or exclude from running."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='filters', type=d.T.array)]), + withFiltersMixin(filters): { spec+: { test+: { filters+: if std.isArray(v=filters) then filters else [filters] } } }, + '#withIgnoreFailures':: d.fn(help="\"IgnoreFailures tells the controller to skip remediation when the Helm tests are run but fail. Can be overwritten for tests run after install or upgrade actions in 'Install.IgnoreTestFailures' and 'Upgrade.IgnoreTestFailures'.\"", args=[d.arg(name='ignoreFailures', type=d.T.boolean)]), + withIgnoreFailures(ignoreFailures): { spec+: { test+: { ignoreFailures: ignoreFailures } } }, + '#withTimeout':: d.fn(help="\"Timeout is the time to wait for any individual Kubernetes operation during the performance of a Helm test action. Defaults to 'HelmReleaseSpec.Timeout'.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { test+: { timeout: timeout } } }, + }, + '#uninstall':: d.obj(help='"Uninstall holds the configuration for Helm uninstall actions for this HelmRelease."'), + uninstall: { + '#withDeletionPropagation':: d.fn(help='"DeletionPropagation specifies the deletion propagation policy when a Helm uninstall is performed."', args=[d.arg(name='deletionPropagation', type=d.T.string)]), + withDeletionPropagation(deletionPropagation): { spec+: { uninstall+: { deletionPropagation: deletionPropagation } } }, + '#withDisableHooks':: d.fn(help='"DisableHooks prevents hooks from running during the Helm rollback action."', args=[d.arg(name='disableHooks', type=d.T.boolean)]), + withDisableHooks(disableHooks): { spec+: { uninstall+: { disableHooks: disableHooks } } }, + '#withDisableWait':: d.fn(help='"DisableWait disables waiting for all the resources to be deleted after a Helm uninstall is performed."', args=[d.arg(name='disableWait', type=d.T.boolean)]), + withDisableWait(disableWait): { spec+: { uninstall+: { disableWait: disableWait } } }, + '#withKeepHistory':: d.fn(help='"KeepHistory tells Helm to remove all associated resources and mark the release as deleted, but retain the release history."', args=[d.arg(name='keepHistory', type=d.T.boolean)]), + withKeepHistory(keepHistory): { spec+: { uninstall+: { keepHistory: keepHistory } } }, + '#withTimeout':: d.fn(help="\"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm uninstall action. Defaults to 'HelmReleaseSpec.Timeout'.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { uninstall+: { timeout: timeout } } }, + }, + '#upgrade':: d.obj(help='"Upgrade holds the configuration for Helm upgrade actions for this HelmRelease."'), + upgrade: { + '#remediation':: d.obj(help='"Remediation holds the remediation configuration for when the Helm upgrade action for the HelmRelease fails. The default is to not perform any action."'), + remediation: { + '#withIgnoreTestFailures':: d.fn(help="\"IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an upgrade action but fail. Defaults to 'Test.IgnoreFailures'.\"", args=[d.arg(name='ignoreTestFailures', type=d.T.boolean)]), + withIgnoreTestFailures(ignoreTestFailures): { spec+: { upgrade+: { remediation+: { ignoreTestFailures: ignoreTestFailures } } } }, + '#withRemediateLastFailure':: d.fn(help="\"RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false' unless 'Retries' is greater than 0.\"", args=[d.arg(name='remediateLastFailure', type=d.T.boolean)]), + withRemediateLastFailure(remediateLastFailure): { spec+: { upgrade+: { remediation+: { remediateLastFailure: remediateLastFailure } } } }, + '#withRetries':: d.fn(help="\"Retries is the number of retries that should be attempted on failures before bailing. Remediation, using 'Strategy', is performed between each attempt. Defaults to '0', a negative integer equals to unlimited retries.\"", args=[d.arg(name='retries', type=d.T.integer)]), + withRetries(retries): { spec+: { upgrade+: { remediation+: { retries: retries } } } }, + '#withStrategy':: d.fn(help="\"Strategy to use for failure remediation. Defaults to 'rollback'.\"", args=[d.arg(name='strategy', type=d.T.string)]), + withStrategy(strategy): { spec+: { upgrade+: { remediation+: { strategy: strategy } } } }, + }, + '#withCleanupOnFail':: d.fn(help='"CleanupOnFail allows deletion of new resources created during the Helm upgrade action when it fails."', args=[d.arg(name='cleanupOnFail', type=d.T.boolean)]), + withCleanupOnFail(cleanupOnFail): { spec+: { upgrade+: { cleanupOnFail: cleanupOnFail } } }, + '#withCrds':: d.fn(help="\"CRDs upgrade CRDs from the Helm Chart's crds directory according to the CRD upgrade policy provided here. Valid values are `Skip`, `Create` or `CreateReplace`. Default is `Skip` and if omitted CRDs are neither installed nor upgraded. \\n Skip: do neither install nor replace (update) any CRDs. \\n Create: new CRDs are created, existing CRDs are neither updated nor deleted. \\n CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted. \\n By default, CRDs are not applied during Helm upgrade action. With this option users can opt-in to CRD upgrade, which is not (yet) natively supported by Helm. https://helm.sh/docs/chart_best_practices/custom_resource_definitions.\"", args=[d.arg(name='crds', type=d.T.string)]), + withCrds(crds): { spec+: { upgrade+: { crds: crds } } }, + '#withDisableHooks':: d.fn(help='"DisableHooks prevents hooks from running during the Helm upgrade action."', args=[d.arg(name='disableHooks', type=d.T.boolean)]), + withDisableHooks(disableHooks): { spec+: { upgrade+: { disableHooks: disableHooks } } }, + '#withDisableOpenAPIValidation':: d.fn(help='"DisableOpenAPIValidation prevents the Helm upgrade action from validating rendered templates against the Kubernetes OpenAPI Schema."', args=[d.arg(name='disableOpenAPIValidation', type=d.T.boolean)]), + withDisableOpenAPIValidation(disableOpenAPIValidation): { spec+: { upgrade+: { disableOpenAPIValidation: disableOpenAPIValidation } } }, + '#withDisableWait':: d.fn(help='"DisableWait disables the waiting for resources to be ready after a Helm upgrade has been performed."', args=[d.arg(name='disableWait', type=d.T.boolean)]), + withDisableWait(disableWait): { spec+: { upgrade+: { disableWait: disableWait } } }, + '#withDisableWaitForJobs':: d.fn(help='"DisableWaitForJobs disables waiting for jobs to complete after a Helm upgrade has been performed."', args=[d.arg(name='disableWaitForJobs', type=d.T.boolean)]), + withDisableWaitForJobs(disableWaitForJobs): { spec+: { upgrade+: { disableWaitForJobs: disableWaitForJobs } } }, + '#withForce':: d.fn(help='"Force forces resource updates through a replacement strategy."', args=[d.arg(name='force', type=d.T.boolean)]), + withForce(force): { spec+: { upgrade+: { force: force } } }, + '#withPreserveValues':: d.fn(help="\"PreserveValues will make Helm reuse the last release's values and merge in overrides from 'Values'. Setting this flag makes the HelmRelease non-declarative.\"", args=[d.arg(name='preserveValues', type=d.T.boolean)]), + withPreserveValues(preserveValues): { spec+: { upgrade+: { preserveValues: preserveValues } } }, + '#withTimeout':: d.fn(help="\"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm upgrade action. Defaults to 'HelmReleaseSpec.Timeout'.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { upgrade+: { timeout: timeout } } }, + }, + '#valuesFrom':: d.obj(help='"ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged."'), + valuesFrom: { + '#withKind':: d.fn(help="\"Kind of the values referent, valid values are ('Secret', 'ConfigMap').\"", args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { kind: kind }, + '#withName':: d.fn(help='"Name of the values referent. Should reside in the same namespace as the referring resource."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withOptional':: d.fn(help='"Optional marks this ValuesReference as optional. When set, a not found error for the values reference is ignored, but any ValuesKey, TargetPath or transient error will still result in a reconciliation failure."', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { optional: optional }, + '#withTargetPath':: d.fn(help="\"TargetPath is the YAML dot notation path the value should be merged at. When set, the ValuesKey is expected to be a single flat value. Defaults to 'None', which results in the values getting merged at the root.\"", args=[d.arg(name='targetPath', type=d.T.string)]), + withTargetPath(targetPath): { targetPath: targetPath }, + '#withValuesKey':: d.fn(help="\"ValuesKey is the data key where the values.yaml or a specific value can be found at. Defaults to 'values.yaml'.\"", args=[d.arg(name='valuesKey', type=d.T.string)]), + withValuesKey(valuesKey): { valuesKey: valuesKey }, + }, + '#withDependsOn':: d.fn(help='"DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled."', args=[d.arg(name='dependsOn', type=d.T.array)]), + withDependsOn(dependsOn): { spec+: { dependsOn: if std.isArray(v=dependsOn) then dependsOn else [dependsOn] } }, + '#withDependsOnMixin':: d.fn(help='"DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='dependsOn', type=d.T.array)]), + withDependsOnMixin(dependsOn): { spec+: { dependsOn+: if std.isArray(v=dependsOn) then dependsOn else [dependsOn] } }, + '#withInterval':: d.fn(help='"Interval at which to reconcile the Helm release."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withMaxHistory':: d.fn(help="\"MaxHistory is the number of revisions saved by Helm for this HelmRelease. Use '0' for an unlimited number of revisions; defaults to '5'.\"", args=[d.arg(name='maxHistory', type=d.T.integer)]), + withMaxHistory(maxHistory): { spec+: { maxHistory: maxHistory } }, + '#withPersistentClient':: d.fn(help="\"PersistentClient tells the controller to use a persistent Kubernetes client for this release. When enabled, the client will be reused for the duration of the reconciliation, instead of being created and destroyed for each (step of a) Helm action. \\n This can improve performance, but may cause issues with some Helm charts that for example do create Custom Resource Definitions during installation outside Helm's CRD lifecycle hooks, which are then not observed to be available by e.g. post-install hooks. \\n If not set, it defaults to true.\"", args=[d.arg(name='persistentClient', type=d.T.boolean)]), + withPersistentClient(persistentClient): { spec+: { persistentClient: persistentClient } }, + '#withPostRenderers':: d.fn(help='"PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition."', args=[d.arg(name='postRenderers', type=d.T.array)]), + withPostRenderers(postRenderers): { spec+: { postRenderers: if std.isArray(v=postRenderers) then postRenderers else [postRenderers] } }, + '#withPostRenderersMixin':: d.fn(help='"PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='postRenderers', type=d.T.array)]), + withPostRenderersMixin(postRenderers): { spec+: { postRenderers+: if std.isArray(v=postRenderers) then postRenderers else [postRenderers] } }, + '#withReleaseName':: d.fn(help="\"ReleaseName used for the Helm release. Defaults to a composition of '[TargetNamespace-]Name'.\"", args=[d.arg(name='releaseName', type=d.T.string)]), + withReleaseName(releaseName): { spec+: { releaseName: releaseName } }, + '#withServiceAccountName':: d.fn(help='"The name of the Kubernetes service account to impersonate when reconciling this HelmRelease."', args=[d.arg(name='serviceAccountName', type=d.T.string)]), + withServiceAccountName(serviceAccountName): { spec+: { serviceAccountName: serviceAccountName } }, + '#withStorageNamespace':: d.fn(help='"StorageNamespace used for the Helm storage. Defaults to the namespace of the HelmRelease."', args=[d.arg(name='storageNamespace', type=d.T.string)]), + withStorageNamespace(storageNamespace): { spec+: { storageNamespace: storageNamespace } }, + '#withSuspend':: d.fn(help='"Suspend tells the controller to suspend reconciliation for this HelmRelease, it does not apply to already started reconciliations. Defaults to false."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTargetNamespace':: d.fn(help='"TargetNamespace to target when performing operations for the HelmRelease. Defaults to the namespace of the HelmRelease."', args=[d.arg(name='targetNamespace', type=d.T.string)]), + withTargetNamespace(targetNamespace): { spec+: { targetNamespace: targetNamespace } }, + '#withTimeout':: d.fn(help="\"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm action. Defaults to '5m0s'.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + '#withValues':: d.fn(help='"Values holds the values for this Helm release."', args=[d.arg(name='values', type=d.T.any)]), + withValues(values): { spec+: { values: values } }, + '#withValuesFrom':: d.fn(help='"ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged."', args=[d.arg(name='valuesFrom', type=d.T.array)]), + withValuesFrom(valuesFrom): { spec+: { valuesFrom: if std.isArray(v=valuesFrom) then valuesFrom else [valuesFrom] } }, + '#withValuesFromMixin':: d.fn(help='"ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='valuesFrom', type=d.T.array)]), + withValuesFromMixin(valuesFrom): { spec+: { valuesFrom+: if std.isArray(v=valuesFrom) then valuesFrom else [valuesFrom] } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/helm/v2beta2/main.libsonnet b/2.2.1/_gen/helm/v2beta2/main.libsonnet new file mode 100644 index 0000000..7a94d75 --- /dev/null +++ b/2.2.1/_gen/helm/v2beta2/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v2beta2', url='', help=''), + helmRelease: (import 'helmRelease.libsonnet'), +} diff --git a/2.2.1/_gen/image/main.libsonnet b/2.2.1/_gen/image/main.libsonnet new file mode 100644 index 0000000..95db944 --- /dev/null +++ b/2.2.1/_gen/image/main.libsonnet @@ -0,0 +1,6 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='image', url='', help=''), + v1beta1: (import 'v1beta1/main.libsonnet'), + v1beta2: (import 'v1beta2/main.libsonnet'), +} diff --git a/2.2.1/_gen/image/v1beta1/imagePolicy.libsonnet b/2.2.1/_gen/image/v1beta1/imagePolicy.libsonnet new file mode 100644 index 0000000..f103dfc --- /dev/null +++ b/2.2.1/_gen/image/v1beta1/imagePolicy.libsonnet @@ -0,0 +1,87 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='imagePolicy', url='', help='"ImagePolicy is the Schema for the imagepolicies API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of ImagePolicy', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'image.toolkit.fluxcd.io/v1beta1', + kind: 'ImagePolicy', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ImagePolicySpec defines the parameters for calculating the ImagePolicy"'), + spec: { + '#filterTags':: d.obj(help='"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."'), + filterTags: { + '#withExtract':: d.fn(help='"Extract allows a capture group to be extracted from the specified regular expression pattern, useful before tag evaluation."', args=[d.arg(name='extract', type=d.T.string)]), + withExtract(extract): { spec+: { filterTags+: { extract: extract } } }, + '#withPattern':: d.fn(help='"Pattern specifies a regular expression pattern used to filter for image tags."', args=[d.arg(name='pattern', type=d.T.string)]), + withPattern(pattern): { spec+: { filterTags+: { pattern: pattern } } }, + }, + '#imageRepositoryRef':: d.obj(help='"ImageRepositoryRef points at the object specifying the image being scanned"'), + imageRepositoryRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { imageRepositoryRef+: { name: name } } }, + '#withNamespace':: d.fn(help='"Namespace of the referent, when not specified it acts as LocalObjectReference."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { imageRepositoryRef+: { namespace: namespace } } }, + }, + '#policy':: d.obj(help='"Policy gives the particulars of the policy to be followed in selecting the most recent image"'), + policy: { + '#alphabetical':: d.obj(help='"Alphabetical set of rules to use for alphabetical ordering of the tags."'), + alphabetical: { + '#withOrder':: d.fn(help='"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."', args=[d.arg(name='order', type=d.T.string)]), + withOrder(order): { spec+: { policy+: { alphabetical+: { order: order } } } }, + }, + '#numerical':: d.obj(help='"Numerical set of rules to use for numerical ordering of the tags."'), + numerical: { + '#withOrder':: d.fn(help='"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."', args=[d.arg(name='order', type=d.T.string)]), + withOrder(order): { spec+: { policy+: { numerical+: { order: order } } } }, + }, + '#semver':: d.obj(help='"SemVer gives a semantic version range to check against the tags available."'), + semver: { + '#withRange':: d.fn(help="\"Range gives a semver range for the image tag; the highest version within the range that's a tag yields the latest image.\"", args=[d.arg(name='range', type=d.T.string)]), + withRange(range): { spec+: { policy+: { semver+: { range: range } } } }, + }, + }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/image/v1beta1/imageRepository.libsonnet b/2.2.1/_gen/image/v1beta1/imageRepository.libsonnet new file mode 100644 index 0000000..293a561 --- /dev/null +++ b/2.2.1/_gen/image/v1beta1/imageRepository.libsonnet @@ -0,0 +1,93 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='imageRepository', url='', help='"ImageRepository is the Schema for the imagerepositories API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of ImageRepository', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'image.toolkit.fluxcd.io/v1beta1', + kind: 'ImageRepository', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ImageRepositorySpec defines the parameters for scanning an image repository, e.g., `fluxcd/flux`."'), + spec: { + '#accessFrom':: d.obj(help="\"AccessFrom defines an ACL for allowing cross-namespace references to the ImageRepository object based on the caller's namespace labels.\""), + accessFrom: { + '#namespaceSelectors':: d.obj(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."'), + namespaceSelectors: { + '#withMatchLabels':: d.fn(help='"MatchLabels 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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + }, + '#withNamespaceSelectors':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectors(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + '#withNamespaceSelectorsMixin':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectorsMixin(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors+: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + }, + '#certSecretRef':: d.obj(help='"CertSecretRef can be given the name of a secret containing either or both of \\n - a PEM-encoded client certificate (`certFile`) and private key (`keyFile`); - a PEM-encoded CA certificate (`caFile`) \\n 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."'), + certSecretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { certSecretRef+: { name: name } } }, + }, + '#secretRef':: d.obj(help='"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."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#withExclusionList':: d.fn(help='"ExclusionList is a list of regex strings used to exclude certain tags from being stored in the database."', args=[d.arg(name='exclusionList', type=d.T.array)]), + withExclusionList(exclusionList): { spec+: { exclusionList: if std.isArray(v=exclusionList) then exclusionList else [exclusionList] } }, + '#withExclusionListMixin':: d.fn(help='"ExclusionList is a list of regex strings used to exclude certain tags from being stored in the database."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='exclusionList', type=d.T.array)]), + withExclusionListMixin(exclusionList): { spec+: { exclusionList+: if std.isArray(v=exclusionList) then exclusionList else [exclusionList] } }, + '#withImage':: d.fn(help='"Image is the name of the image repository"', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { spec+: { image: image } }, + '#withInterval':: d.fn(help='"Interval is the length of time to wait between scans of the image repository."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withServiceAccountName':: d.fn(help='"ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate the image pull if the service account has attached pull secrets."', args=[d.arg(name='serviceAccountName', type=d.T.string)]), + withServiceAccountName(serviceAccountName): { spec+: { serviceAccountName: serviceAccountName } }, + '#withSuspend':: d.fn(help='"This flag tells the controller to suspend subsequent image scans. It does not apply to already started scans. Defaults to false."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTimeout':: d.fn(help="\"Timeout for image scanning. Defaults to 'Interval' duration.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/image/v1beta1/imageUpdateAutomation.libsonnet b/2.2.1/_gen/image/v1beta1/imageUpdateAutomation.libsonnet new file mode 100644 index 0000000..0112f95 --- /dev/null +++ b/2.2.1/_gen/image/v1beta1/imageUpdateAutomation.libsonnet @@ -0,0 +1,127 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='imageUpdateAutomation', url='', help='"ImageUpdateAutomation is the Schema for the imageupdateautomations API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of ImageUpdateAutomation', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'image.toolkit.fluxcd.io/v1beta1', + kind: 'ImageUpdateAutomation', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ImageUpdateAutomationSpec defines the desired state of ImageUpdateAutomation"'), + spec: { + '#git':: d.obj(help='"GitSpec contains all the git-specific definitions. This is technically optional, but in practice mandatory until there are other kinds of source allowed."'), + git: { + '#checkout':: d.obj(help='"Checkout gives the parameters for cloning the git repository, ready to make changes. If not present, the `spec.ref` field from the referenced `GitRepository` or its default will be used."'), + checkout: { + '#ref':: d.obj(help='"Reference gives a branch, tag or commit to clone from the Git repository."'), + ref: { + '#withBranch':: d.fn(help="\"Branch to check out, defaults to 'master' if no other field is defined.\"", args=[d.arg(name='branch', type=d.T.string)]), + withBranch(branch): { spec+: { git+: { checkout+: { ref+: { branch: branch } } } } }, + '#withCommit':: d.fn(help='"Commit SHA to check out, takes precedence over all reference fields. \\n This can be combined with Branch to shallow clone the branch, in which the commit is expected to exist."', args=[d.arg(name='commit', type=d.T.string)]), + withCommit(commit): { spec+: { git+: { checkout+: { ref+: { commit: commit } } } } }, + '#withName':: d.fn(help='"Name of the reference to check out; takes precedence over Branch, Tag and SemVer. \\n It must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description Examples: \\"refs/heads/main\\", \\"refs/tags/v0.1.0\\", \\"refs/pull/420/head\\", \\"refs/merge-requests/1/head\\', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { git+: { checkout+: { ref+: { name: name } } } } }, + '#withSemver':: d.fn(help='"SemVer tag expression to check out, takes precedence over Tag."', args=[d.arg(name='semver', type=d.T.string)]), + withSemver(semver): { spec+: { git+: { checkout+: { ref+: { semver: semver } } } } }, + '#withTag':: d.fn(help='"Tag to check out, takes precedence over Branch."', args=[d.arg(name='tag', type=d.T.string)]), + withTag(tag): { spec+: { git+: { checkout+: { ref+: { tag: tag } } } } }, + }, + }, + '#commit':: d.obj(help='"Commit specifies how to commit to the git repository."'), + commit: { + '#author':: d.obj(help='"Author gives the email and optionally the name to use as the author of commits."'), + author: { + '#withEmail':: d.fn(help='"Email gives the email to provide when making a commit."', args=[d.arg(name='email', type=d.T.string)]), + withEmail(email): { spec+: { git+: { commit+: { author+: { email: email } } } } }, + '#withName':: d.fn(help='"Name gives the name to provide when making a commit."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { git+: { commit+: { author+: { name: name } } } } }, + }, + '#signingKey':: d.obj(help='"SigningKey provides the option to sign commits with a GPG key"'), + signingKey: { + '#secretRef':: d.obj(help="\"SecretRef holds the name to a secret that contains a 'git.asc' key corresponding to the ASCII Armored file containing the GPG signing keypair as the value. It must be in the same namespace as the ImageUpdateAutomation.\""), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { git+: { commit+: { signingKey+: { secretRef+: { name: name } } } } } }, + }, + }, + '#withMessageTemplate':: d.fn(help='"MessageTemplate provides a template for the commit message, into which will be interpolated the details of the change made."', args=[d.arg(name='messageTemplate', type=d.T.string)]), + withMessageTemplate(messageTemplate): { spec+: { git+: { commit+: { messageTemplate: messageTemplate } } } }, + }, + '#push':: d.obj(help='"Push specifies how and where to push commits made by the automation. If missing, commits are pushed (back) to `.spec.checkout.branch` or its default."'), + push: { + '#withBranch':: d.fn(help="\"Branch specifies that commits should be pushed to the branch named. The branch is created using `.spec.checkout.branch` as the starting point, if it doesn't already exist.\"", args=[d.arg(name='branch', type=d.T.string)]), + withBranch(branch): { spec+: { git+: { push+: { branch: branch } } } }, + '#withOptions':: d.fn(help='"Options specifies the push options that are sent to the Git server when performing a push operation. For details, see: https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt"', args=[d.arg(name='options', type=d.T.object)]), + withOptions(options): { spec+: { git+: { push+: { options: options } } } }, + '#withOptionsMixin':: d.fn(help='"Options specifies the push options that are sent to the Git server when performing a push operation. For details, see: https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='options', type=d.T.object)]), + withOptionsMixin(options): { spec+: { git+: { push+: { options+: options } } } }, + '#withRefspec':: d.fn(help='"Refspec specifies the Git Refspec to use for a push operation. If both Branch and Refspec are provided, then the commit is pushed to the branch and also using the specified refspec. For more details about Git Refspecs, see: https://git-scm.com/book/en/v2/Git-Internals-The-Refspec"', args=[d.arg(name='refspec', type=d.T.string)]), + withRefspec(refspec): { spec+: { git+: { push+: { refspec: refspec } } } }, + }, + }, + '#sourceRef':: d.obj(help='"SourceRef refers to the resource giving access details to a git repository."'), + sourceRef: { + '#withApiVersion':: d.fn(help='"API version of the referent."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { spec+: { sourceRef+: { apiVersion: apiVersion } } }, + '#withKind':: d.fn(help='"Kind of the referent."', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { sourceRef+: { kind: kind } } }, + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { sourceRef+: { name: name } } }, + '#withNamespace':: d.fn(help='"Namespace of the referent, defaults to the namespace of the Kubernetes resource object that contains the reference."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { sourceRef+: { namespace: namespace } } }, + }, + '#update':: d.obj(help='"Update gives the specification for how to update the files in the repository. This can be left empty, to use the default value."'), + update: { + '#withPath':: d.fn(help="\"Path to the directory containing the manifests to be updated. Defaults to 'None', which translates to the root path of the GitRepositoryRef.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { spec+: { update+: { path: path } } }, + '#withStrategy':: d.fn(help='"Strategy names the strategy to be used."', args=[d.arg(name='strategy', type=d.T.string)]), + withStrategy(strategy): { spec+: { update+: { strategy: strategy } } }, + }, + '#withInterval':: d.fn(help='"Interval gives an lower bound for how often the automation run should be attempted."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withSuspend':: d.fn(help='"Suspend tells the controller to not run this automation, until it is unset (or set to false). Defaults to false."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/image/v1beta1/main.libsonnet b/2.2.1/_gen/image/v1beta1/main.libsonnet new file mode 100644 index 0000000..7caa989 --- /dev/null +++ b/2.2.1/_gen/image/v1beta1/main.libsonnet @@ -0,0 +1,7 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1beta1', url='', help=''), + imagePolicy: (import 'imagePolicy.libsonnet'), + imageRepository: (import 'imageRepository.libsonnet'), + imageUpdateAutomation: (import 'imageUpdateAutomation.libsonnet'), +} diff --git a/2.2.1/_gen/image/v1beta2/imagePolicy.libsonnet b/2.2.1/_gen/image/v1beta2/imagePolicy.libsonnet new file mode 100644 index 0000000..4900d88 --- /dev/null +++ b/2.2.1/_gen/image/v1beta2/imagePolicy.libsonnet @@ -0,0 +1,87 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='imagePolicy', url='', help='"ImagePolicy is the Schema for the imagepolicies API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of ImagePolicy', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'image.toolkit.fluxcd.io/v1beta2', + kind: 'ImagePolicy', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ImagePolicySpec defines the parameters for calculating the ImagePolicy."'), + spec: { + '#filterTags':: d.obj(help='"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."'), + filterTags: { + '#withExtract':: d.fn(help='"Extract allows a capture group to be extracted from the specified regular expression pattern, useful before tag evaluation."', args=[d.arg(name='extract', type=d.T.string)]), + withExtract(extract): { spec+: { filterTags+: { extract: extract } } }, + '#withPattern':: d.fn(help='"Pattern specifies a regular expression pattern used to filter for image tags."', args=[d.arg(name='pattern', type=d.T.string)]), + withPattern(pattern): { spec+: { filterTags+: { pattern: pattern } } }, + }, + '#imageRepositoryRef':: d.obj(help='"ImageRepositoryRef points at the object specifying the image being scanned"'), + imageRepositoryRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { imageRepositoryRef+: { name: name } } }, + '#withNamespace':: d.fn(help='"Namespace of the referent, when not specified it acts as LocalObjectReference."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { imageRepositoryRef+: { namespace: namespace } } }, + }, + '#policy':: d.obj(help='"Policy gives the particulars of the policy to be followed in selecting the most recent image"'), + policy: { + '#alphabetical':: d.obj(help='"Alphabetical set of rules to use for alphabetical ordering of the tags."'), + alphabetical: { + '#withOrder':: d.fn(help='"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."', args=[d.arg(name='order', type=d.T.string)]), + withOrder(order): { spec+: { policy+: { alphabetical+: { order: order } } } }, + }, + '#numerical':: d.obj(help='"Numerical set of rules to use for numerical ordering of the tags."'), + numerical: { + '#withOrder':: d.fn(help='"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."', args=[d.arg(name='order', type=d.T.string)]), + withOrder(order): { spec+: { policy+: { numerical+: { order: order } } } }, + }, + '#semver':: d.obj(help='"SemVer gives a semantic version range to check against the tags available."'), + semver: { + '#withRange':: d.fn(help="\"Range gives a semver range for the image tag; the highest version within the range that's a tag yields the latest image.\"", args=[d.arg(name='range', type=d.T.string)]), + withRange(range): { spec+: { policy+: { semver+: { range: range } } } }, + }, + }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/image/v1beta2/imageRepository.libsonnet b/2.2.1/_gen/image/v1beta2/imageRepository.libsonnet new file mode 100644 index 0000000..7965ed7 --- /dev/null +++ b/2.2.1/_gen/image/v1beta2/imageRepository.libsonnet @@ -0,0 +1,97 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='imageRepository', url='', help='"ImageRepository is the Schema for the imagerepositories API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of ImageRepository', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'image.toolkit.fluxcd.io/v1beta2', + kind: 'ImageRepository', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ImageRepositorySpec defines the parameters for scanning an image repository, e.g., `fluxcd/flux`."'), + spec: { + '#accessFrom':: d.obj(help="\"AccessFrom defines an ACL for allowing cross-namespace references to the ImageRepository object based on the caller's namespace labels.\""), + accessFrom: { + '#namespaceSelectors':: d.obj(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."'), + namespaceSelectors: { + '#withMatchLabels':: d.fn(help='"MatchLabels 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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + }, + '#withNamespaceSelectors':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectors(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + '#withNamespaceSelectorsMixin':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectorsMixin(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors+: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + }, + '#certSecretRef':: d.obj(help='"CertSecretRef can be given the name of a Secret containing either or both of \\n - a PEM-encoded client certificate (`tls.crt`) and private key (`tls.key`); - a PEM-encoded CA certificate (`ca.crt`) \\n 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`. \\n Note: Support for the `caFile`, `certFile` and `keyFile` keys has been deprecated."'), + certSecretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { certSecretRef+: { name: name } } }, + }, + '#secretRef':: d.obj(help='"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."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#withExclusionList':: d.fn(help='"ExclusionList is a list of regex strings used to exclude certain tags from being stored in the database."', args=[d.arg(name='exclusionList', type=d.T.array)]), + withExclusionList(exclusionList): { spec+: { exclusionList: if std.isArray(v=exclusionList) then exclusionList else [exclusionList] } }, + '#withExclusionListMixin':: d.fn(help='"ExclusionList is a list of regex strings used to exclude certain tags from being stored in the database."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='exclusionList', type=d.T.array)]), + withExclusionListMixin(exclusionList): { spec+: { exclusionList+: if std.isArray(v=exclusionList) then exclusionList else [exclusionList] } }, + '#withImage':: d.fn(help='"Image is the name of the image repository"', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { spec+: { image: image } }, + '#withInsecure':: d.fn(help='"Insecure allows connecting to a non-TLS HTTP container registry."', args=[d.arg(name='insecure', type=d.T.boolean)]), + withInsecure(insecure): { spec+: { insecure: insecure } }, + '#withInterval':: d.fn(help='"Interval is the length of time to wait between scans of the image repository."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withProvider':: d.fn(help="\"The provider used for authentication, can be 'aws', 'azure', 'gcp' or 'generic'. When not specified, defaults to 'generic'.\"", args=[d.arg(name='provider', type=d.T.string)]), + withProvider(provider): { spec+: { provider: provider } }, + '#withServiceAccountName':: d.fn(help='"ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate the image pull if the service account has attached pull secrets."', args=[d.arg(name='serviceAccountName', type=d.T.string)]), + withServiceAccountName(serviceAccountName): { spec+: { serviceAccountName: serviceAccountName } }, + '#withSuspend':: d.fn(help='"This flag tells the controller to suspend subsequent image scans. It does not apply to already started scans. Defaults to false."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTimeout':: d.fn(help="\"Timeout for image scanning. Defaults to 'Interval' duration.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/image/v1beta2/main.libsonnet b/2.2.1/_gen/image/v1beta2/main.libsonnet new file mode 100644 index 0000000..0b07f30 --- /dev/null +++ b/2.2.1/_gen/image/v1beta2/main.libsonnet @@ -0,0 +1,6 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1beta2', url='', help=''), + imagePolicy: (import 'imagePolicy.libsonnet'), + imageRepository: (import 'imageRepository.libsonnet'), +} diff --git a/2.2.1/_gen/kustomize/main.libsonnet b/2.2.1/_gen/kustomize/main.libsonnet new file mode 100644 index 0000000..cca0171 --- /dev/null +++ b/2.2.1/_gen/kustomize/main.libsonnet @@ -0,0 +1,7 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='kustomize', url='', help=''), + v1: (import 'v1/main.libsonnet'), + v1beta1: (import 'v1beta1/main.libsonnet'), + v1beta2: (import 'v1beta2/main.libsonnet'), +} diff --git a/2.2.1/_gen/kustomize/v1/kustomization.libsonnet b/2.2.1/_gen/kustomize/v1/kustomization.libsonnet new file mode 100644 index 0000000..7b68048 --- /dev/null +++ b/2.2.1/_gen/kustomize/v1/kustomization.libsonnet @@ -0,0 +1,208 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='kustomization', url='', help='"Kustomization is the Schema for the kustomizations API."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Kustomization', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'kustomize.toolkit.fluxcd.io/v1', + kind: 'Kustomization', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"KustomizationSpec defines the configuration to calculate the desired state from a Source using Kustomize."'), + spec: { + '#commonMetadata':: d.obj(help='"CommonMetadata specifies the common labels and annotations that are applied to all resources. Any existing label or annotation will be overridden if its key matches a common one."'), + commonMetadata: { + '#withAnnotations':: d.fn(help="\"Annotations to be added to the object's metadata.\"", args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { spec+: { commonMetadata+: { annotations: annotations } } }, + '#withAnnotationsMixin':: d.fn(help="\"Annotations to be added to the object's metadata.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { spec+: { commonMetadata+: { annotations+: annotations } } }, + '#withLabels':: d.fn(help="\"Labels to be added to the object's metadata.\"", args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { commonMetadata+: { labels: labels } } }, + '#withLabelsMixin':: d.fn(help="\"Labels to be added to the object's metadata.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { commonMetadata+: { labels+: labels } } }, + }, + '#decryption':: d.obj(help='"Decrypt Kubernetes secrets before applying them on the cluster."'), + decryption: { + '#secretRef':: d.obj(help='"The secret name containing the private OpenPGP keys used for decryption."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { decryption+: { secretRef+: { name: name } } } }, + }, + '#withProvider':: d.fn(help='"Provider is the name of the decryption engine."', args=[d.arg(name='provider', type=d.T.string)]), + withProvider(provider): { spec+: { decryption+: { provider: provider } } }, + }, + '#dependsOn':: d.obj(help='"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled."'), + dependsOn: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent, when not specified it acts as LocalObjectReference."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + }, + '#healthChecks':: d.obj(help='"A list of resources to be included in the health assessment."'), + healthChecks: { + '#withApiVersion':: d.fn(help='"API version of the referent, if not specified the Kubernetes preferred version will be used."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { apiVersion: apiVersion }, + '#withKind':: d.fn(help='"Kind of the referent."', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { kind: kind }, + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent, when not specified it acts as LocalObjectReference."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + }, + '#images':: d.obj(help='"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify."'), + images: { + '#withDigest':: d.fn(help='"Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored."', args=[d.arg(name='digest', type=d.T.string)]), + withDigest(digest): { digest: digest }, + '#withName':: d.fn(help='"Name is a tag-less image name."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNewName':: d.fn(help='"NewName is the value used to replace the original name."', args=[d.arg(name='newName', type=d.T.string)]), + withNewName(newName): { newName: newName }, + '#withNewTag':: d.fn(help='"NewTag is the value used to replace the original tag."', args=[d.arg(name='newTag', type=d.T.string)]), + withNewTag(newTag): { newTag: newTag }, + }, + '#kubeConfig':: d.obj(help='"The KubeConfig for reconciling the Kustomization on a remote cluster. When used in combination with KustomizationSpec.ServiceAccountName, forces the controller to act on behalf of that Service Account at the target cluster. If the --default-service-account flag is set, its value will be used as a controller level fallback for when KustomizationSpec.ServiceAccountName is empty."'), + kubeConfig: { + '#secretRef':: d.obj(help="\"SecretRef holds the name of a secret that contains a key with the kubeconfig file as the value. If no key is set, the key will default to 'value'. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific `cmd-path` auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling Kubernetes resources.\""), + secretRef: { + '#withKey':: d.fn(help='"Key in the Secret, when not specified an implementation-specific default key is used."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { kubeConfig+: { secretRef+: { key: key } } } }, + '#withName':: d.fn(help='"Name of the Secret."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { kubeConfig+: { secretRef+: { name: name } } } }, + }, + }, + '#patches':: d.obj(help='"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."'), + patches: { + '#target':: d.obj(help='"Target points to the resources that the patch document should be applied to."'), + target: { + '#withAnnotationSelector':: d.fn(help='"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations."', args=[d.arg(name='annotationSelector', type=d.T.string)]), + withAnnotationSelector(annotationSelector): { target+: { annotationSelector: annotationSelector } }, + '#withGroup':: d.fn(help='"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { target+: { group: group } }, + '#withKind':: d.fn(help='"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { target+: { kind: kind } }, + '#withLabelSelector':: d.fn(help='"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels."', args=[d.arg(name='labelSelector', type=d.T.string)]), + withLabelSelector(labelSelector): { target+: { labelSelector: labelSelector } }, + '#withName':: d.fn(help='"Name to match resources with."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { target+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace to select resources from."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { target+: { namespace: namespace } }, + '#withVersion':: d.fn(help='"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { target+: { version: version } }, + }, + '#withPatch':: d.fn(help='"Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects."', args=[d.arg(name='patch', type=d.T.string)]), + withPatch(patch): { patch: patch }, + }, + '#postBuild':: d.obj(help='"PostBuild describes which actions to perform on the YAML manifest generated by building the kustomize overlay."'), + postBuild: { + '#substituteFrom':: d.obj(help='"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names, and they must match the vars declared in the manifests for the substitution to happen."'), + substituteFrom: { + '#withKind':: d.fn(help="\"Kind of the values referent, valid values are ('Secret', 'ConfigMap').\"", args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { kind: kind }, + '#withName':: d.fn(help='"Name of the values referent. Should reside in the same namespace as the referring resource."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withOptional':: d.fn(help='"Optional indicates whether the referenced resource must exist, or whether to tolerate its absence. If true and the referenced resource is absent, proceed as if the resource was present but empty, without any variables defined."', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { optional: optional }, + }, + '#withSubstitute':: d.fn(help='"Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}."', args=[d.arg(name='substitute', type=d.T.object)]), + withSubstitute(substitute): { spec+: { postBuild+: { substitute: substitute } } }, + '#withSubstituteFrom':: d.fn(help='"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names, and they must match the vars declared in the manifests for the substitution to happen."', args=[d.arg(name='substituteFrom', type=d.T.array)]), + withSubstituteFrom(substituteFrom): { spec+: { postBuild+: { substituteFrom: if std.isArray(v=substituteFrom) then substituteFrom else [substituteFrom] } } }, + '#withSubstituteFromMixin':: d.fn(help='"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names, and they must match the vars declared in the manifests for the substitution to happen."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='substituteFrom', type=d.T.array)]), + withSubstituteFromMixin(substituteFrom): { spec+: { postBuild+: { substituteFrom+: if std.isArray(v=substituteFrom) then substituteFrom else [substituteFrom] } } }, + '#withSubstituteMixin':: d.fn(help='"Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='substitute', type=d.T.object)]), + withSubstituteMixin(substitute): { spec+: { postBuild+: { substitute+: substitute } } }, + }, + '#sourceRef':: d.obj(help='"Reference of the source where the kustomization file is."'), + sourceRef: { + '#withApiVersion':: d.fn(help='"API version of the referent."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { spec+: { sourceRef+: { apiVersion: apiVersion } } }, + '#withKind':: d.fn(help='"Kind of the referent."', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { sourceRef+: { kind: kind } } }, + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { sourceRef+: { name: name } } }, + '#withNamespace':: d.fn(help='"Namespace of the referent, defaults to the namespace of the Kubernetes resource object that contains the reference."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { sourceRef+: { namespace: namespace } } }, + }, + '#withComponents':: d.fn(help='"Components specifies relative paths to specifications of other Components."', args=[d.arg(name='components', type=d.T.array)]), + withComponents(components): { spec+: { components: if std.isArray(v=components) then components else [components] } }, + '#withComponentsMixin':: d.fn(help='"Components specifies relative paths to specifications of other Components."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='components', type=d.T.array)]), + withComponentsMixin(components): { spec+: { components+: if std.isArray(v=components) then components else [components] } }, + '#withDependsOn':: d.fn(help='"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled."', args=[d.arg(name='dependsOn', type=d.T.array)]), + withDependsOn(dependsOn): { spec+: { dependsOn: if std.isArray(v=dependsOn) then dependsOn else [dependsOn] } }, + '#withDependsOnMixin':: d.fn(help='"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='dependsOn', type=d.T.array)]), + withDependsOnMixin(dependsOn): { spec+: { dependsOn+: if std.isArray(v=dependsOn) then dependsOn else [dependsOn] } }, + '#withForce':: d.fn(help='"Force instructs the controller to recreate resources when patching fails due to an immutable field change."', args=[d.arg(name='force', type=d.T.boolean)]), + withForce(force): { spec+: { force: force } }, + '#withHealthChecks':: d.fn(help='"A list of resources to be included in the health assessment."', args=[d.arg(name='healthChecks', type=d.T.array)]), + withHealthChecks(healthChecks): { spec+: { healthChecks: if std.isArray(v=healthChecks) then healthChecks else [healthChecks] } }, + '#withHealthChecksMixin':: d.fn(help='"A list of resources to be included in the health assessment."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='healthChecks', type=d.T.array)]), + withHealthChecksMixin(healthChecks): { spec+: { healthChecks+: if std.isArray(v=healthChecks) then healthChecks else [healthChecks] } }, + '#withImages':: d.fn(help='"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify."', args=[d.arg(name='images', type=d.T.array)]), + withImages(images): { spec+: { images: if std.isArray(v=images) then images else [images] } }, + '#withImagesMixin':: d.fn(help='"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='images', type=d.T.array)]), + withImagesMixin(images): { spec+: { images+: if std.isArray(v=images) then images else [images] } }, + '#withInterval':: d.fn(help='"The interval at which to reconcile the Kustomization. This interval is approximate and may be subject to jitter to ensure efficient use of resources."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withPatches':: d.fn(help='"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."', args=[d.arg(name='patches', type=d.T.array)]), + withPatches(patches): { spec+: { patches: if std.isArray(v=patches) then patches else [patches] } }, + '#withPatchesMixin':: d.fn(help='"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patches', type=d.T.array)]), + withPatchesMixin(patches): { spec+: { patches+: if std.isArray(v=patches) then patches else [patches] } }, + '#withPath':: d.fn(help="\"Path to the directory containing the kustomization.yaml file, or the set of plain YAMLs a kustomization.yaml should be generated for. Defaults to 'None', which translates to the root path of the SourceRef.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { spec+: { path: path } }, + '#withPrune':: d.fn(help='"Prune enables garbage collection."', args=[d.arg(name='prune', type=d.T.boolean)]), + withPrune(prune): { spec+: { prune: prune } }, + '#withRetryInterval':: d.fn(help='"The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the KustomizationSpec.Interval value to retry failures."', args=[d.arg(name='retryInterval', type=d.T.string)]), + withRetryInterval(retryInterval): { spec+: { retryInterval: retryInterval } }, + '#withServiceAccountName':: d.fn(help='"The name of the Kubernetes service account to impersonate when reconciling this Kustomization."', args=[d.arg(name='serviceAccountName', type=d.T.string)]), + withServiceAccountName(serviceAccountName): { spec+: { serviceAccountName: serviceAccountName } }, + '#withSuspend':: d.fn(help='"This flag tells the controller to suspend subsequent kustomize executions, it does not apply to already started executions. Defaults to false."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTargetNamespace':: d.fn(help='"TargetNamespace sets or overrides the namespace in the kustomization.yaml file."', args=[d.arg(name='targetNamespace', type=d.T.string)]), + withTargetNamespace(targetNamespace): { spec+: { targetNamespace: targetNamespace } }, + '#withTimeout':: d.fn(help="\"Timeout for validation, apply and health checking operations. Defaults to 'Interval' duration.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + '#withWait':: d.fn(help='"Wait instructs the controller to check the health of all the reconciled resources. When enabled, the HealthChecks are ignored. Defaults to false."', args=[d.arg(name='wait', type=d.T.boolean)]), + withWait(wait): { spec+: { wait: wait } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/kustomize/v1/main.libsonnet b/2.2.1/_gen/kustomize/v1/main.libsonnet new file mode 100644 index 0000000..4ba062d --- /dev/null +++ b/2.2.1/_gen/kustomize/v1/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1', url='', help=''), + kustomization: (import 'kustomization.libsonnet'), +} diff --git a/2.2.1/_gen/kustomize/v1beta1/kustomization.libsonnet b/2.2.1/_gen/kustomize/v1beta1/kustomization.libsonnet new file mode 100644 index 0000000..b177ca4 --- /dev/null +++ b/2.2.1/_gen/kustomize/v1beta1/kustomization.libsonnet @@ -0,0 +1,232 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='kustomization', url='', help='"Kustomization is the Schema for the kustomizations API."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Kustomization', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'kustomize.toolkit.fluxcd.io/v1beta1', + kind: 'Kustomization', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"KustomizationSpec defines the desired state of a kustomization."'), + spec: { + '#decryption':: d.obj(help='"Decrypt Kubernetes secrets before applying them on the cluster."'), + decryption: { + '#secretRef':: d.obj(help='"The secret name containing the private OpenPGP keys used for decryption."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { decryption+: { secretRef+: { name: name } } } }, + }, + '#withProvider':: d.fn(help='"Provider is the name of the decryption engine."', args=[d.arg(name='provider', type=d.T.string)]), + withProvider(provider): { spec+: { decryption+: { provider: provider } } }, + }, + '#dependsOn':: d.obj(help='"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled."'), + dependsOn: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent, when not specified it acts as LocalObjectReference."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + }, + '#healthChecks':: d.obj(help='"A list of resources to be included in the health assessment."'), + healthChecks: { + '#withApiVersion':: d.fn(help='"API version of the referent, if not specified the Kubernetes preferred version will be used."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { apiVersion: apiVersion }, + '#withKind':: d.fn(help='"Kind of the referent."', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { kind: kind }, + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent, when not specified it acts as LocalObjectReference."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + }, + '#images':: d.obj(help='"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify."'), + images: { + '#withDigest':: d.fn(help='"Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored."', args=[d.arg(name='digest', type=d.T.string)]), + withDigest(digest): { digest: digest }, + '#withName':: d.fn(help='"Name is a tag-less image name."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNewName':: d.fn(help='"NewName is the value used to replace the original name."', args=[d.arg(name='newName', type=d.T.string)]), + withNewName(newName): { newName: newName }, + '#withNewTag':: d.fn(help='"NewTag is the value used to replace the original tag."', args=[d.arg(name='newTag', type=d.T.string)]), + withNewTag(newTag): { newTag: newTag }, + }, + '#kubeConfig':: d.obj(help='"The KubeConfig for reconciling the Kustomization on a remote cluster. When specified, KubeConfig takes precedence over ServiceAccountName."'), + kubeConfig: { + '#secretRef':: d.obj(help="\"SecretRef holds the name to a secret that contains a 'value' key with the kubeconfig file as the value. It must be in the same namespace as the Kustomization. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific `cmd-path` auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling the Kustomization.\""), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { kubeConfig+: { secretRef+: { name: name } } } }, + }, + }, + '#patches':: d.obj(help='"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."'), + patches: { + '#target':: d.obj(help='"Target points to the resources that the patch document should be applied to."'), + target: { + '#withAnnotationSelector':: d.fn(help='"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations."', args=[d.arg(name='annotationSelector', type=d.T.string)]), + withAnnotationSelector(annotationSelector): { target+: { annotationSelector: annotationSelector } }, + '#withGroup':: d.fn(help='"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { target+: { group: group } }, + '#withKind':: d.fn(help='"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { target+: { kind: kind } }, + '#withLabelSelector':: d.fn(help='"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels."', args=[d.arg(name='labelSelector', type=d.T.string)]), + withLabelSelector(labelSelector): { target+: { labelSelector: labelSelector } }, + '#withName':: d.fn(help='"Name to match resources with."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { target+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace to select resources from."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { target+: { namespace: namespace } }, + '#withVersion':: d.fn(help='"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { target+: { version: version } }, + }, + '#withPatch':: d.fn(help='"Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects."', args=[d.arg(name='patch', type=d.T.string)]), + withPatch(patch): { patch: patch }, + }, + '#patchesJson6902':: d.obj(help='"JSON 6902 patches, defined as inline YAML objects."'), + patchesJson6902: { + '#patch':: d.obj(help='"Patch contains the JSON6902 patch document with an array of operation objects."'), + patch: { + '#withFrom':: d.fn(help='"From contains a JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations."', args=[d.arg(name='from', type=d.T.string)]), + withFrom(from): { from: from }, + '#withOp':: d.fn(help='"Op indicates the operation to perform. Its value MUST be one of \\"add\\", \\"remove\\", \\"replace\\", \\"move\\", \\"copy\\", or \\"test\\". https://datatracker.ietf.org/doc/html/rfc6902#section-4"', args=[d.arg(name='op', type=d.T.string)]), + withOp(op): { op: op }, + '#withPath':: d.fn(help='"Path contains the JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + '#withValue':: d.fn(help='"Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations."', args=[d.arg(name='value', type=d.T.any)]), + withValue(value): { value: value }, + }, + '#target':: d.obj(help='"Target points to the resources that the patch document should be applied to."'), + target: { + '#withAnnotationSelector':: d.fn(help='"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations."', args=[d.arg(name='annotationSelector', type=d.T.string)]), + withAnnotationSelector(annotationSelector): { target+: { annotationSelector: annotationSelector } }, + '#withGroup':: d.fn(help='"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { target+: { group: group } }, + '#withKind':: d.fn(help='"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { target+: { kind: kind } }, + '#withLabelSelector':: d.fn(help='"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels."', args=[d.arg(name='labelSelector', type=d.T.string)]), + withLabelSelector(labelSelector): { target+: { labelSelector: labelSelector } }, + '#withName':: d.fn(help='"Name to match resources with."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { target+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace to select resources from."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { target+: { namespace: namespace } }, + '#withVersion':: d.fn(help='"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { target+: { version: version } }, + }, + '#withPatch':: d.fn(help='"Patch contains the JSON6902 patch document with an array of operation objects."', args=[d.arg(name='patch', type=d.T.array)]), + withPatch(patch): { patch: if std.isArray(v=patch) then patch else [patch] }, + '#withPatchMixin':: d.fn(help='"Patch contains the JSON6902 patch document with an array of operation objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patch', type=d.T.array)]), + withPatchMixin(patch): { patch+: if std.isArray(v=patch) then patch else [patch] }, + }, + '#postBuild':: d.obj(help='"PostBuild describes which actions to perform on the YAML manifest generated by building the kustomize overlay."'), + postBuild: { + '#substituteFrom':: d.obj(help='"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names and they must match the vars declared in the manifests for the substitution to happen."'), + substituteFrom: { + '#withKind':: d.fn(help="\"Kind of the values referent, valid values are ('Secret', 'ConfigMap').\"", args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { kind: kind }, + '#withName':: d.fn(help='"Name of the values referent. Should reside in the same namespace as the referring resource."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withSubstitute':: d.fn(help='"Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}."', args=[d.arg(name='substitute', type=d.T.object)]), + withSubstitute(substitute): { spec+: { postBuild+: { substitute: substitute } } }, + '#withSubstituteFrom':: d.fn(help='"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names and they must match the vars declared in the manifests for the substitution to happen."', args=[d.arg(name='substituteFrom', type=d.T.array)]), + withSubstituteFrom(substituteFrom): { spec+: { postBuild+: { substituteFrom: if std.isArray(v=substituteFrom) then substituteFrom else [substituteFrom] } } }, + '#withSubstituteFromMixin':: d.fn(help='"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names and they must match the vars declared in the manifests for the substitution to happen."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='substituteFrom', type=d.T.array)]), + withSubstituteFromMixin(substituteFrom): { spec+: { postBuild+: { substituteFrom+: if std.isArray(v=substituteFrom) then substituteFrom else [substituteFrom] } } }, + '#withSubstituteMixin':: d.fn(help='"Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='substitute', type=d.T.object)]), + withSubstituteMixin(substitute): { spec+: { postBuild+: { substitute+: substitute } } }, + }, + '#sourceRef':: d.obj(help='"Reference of the source where the kustomization file is."'), + sourceRef: { + '#withApiVersion':: d.fn(help='"API version of the referent"', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { spec+: { sourceRef+: { apiVersion: apiVersion } } }, + '#withKind':: d.fn(help='"Kind of the referent"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { sourceRef+: { kind: kind } } }, + '#withName':: d.fn(help='"Name of the referent"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { sourceRef+: { name: name } } }, + '#withNamespace':: d.fn(help='"Namespace of the referent, defaults to the Kustomization namespace"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { sourceRef+: { namespace: namespace } } }, + }, + '#withDependsOn':: d.fn(help='"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled."', args=[d.arg(name='dependsOn', type=d.T.array)]), + withDependsOn(dependsOn): { spec+: { dependsOn: if std.isArray(v=dependsOn) then dependsOn else [dependsOn] } }, + '#withDependsOnMixin':: d.fn(help='"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='dependsOn', type=d.T.array)]), + withDependsOnMixin(dependsOn): { spec+: { dependsOn+: if std.isArray(v=dependsOn) then dependsOn else [dependsOn] } }, + '#withForce':: d.fn(help='"Force instructs the controller to recreate resources when patching fails due to an immutable field change."', args=[d.arg(name='force', type=d.T.boolean)]), + withForce(force): { spec+: { force: force } }, + '#withHealthChecks':: d.fn(help='"A list of resources to be included in the health assessment."', args=[d.arg(name='healthChecks', type=d.T.array)]), + withHealthChecks(healthChecks): { spec+: { healthChecks: if std.isArray(v=healthChecks) then healthChecks else [healthChecks] } }, + '#withHealthChecksMixin':: d.fn(help='"A list of resources to be included in the health assessment."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='healthChecks', type=d.T.array)]), + withHealthChecksMixin(healthChecks): { spec+: { healthChecks+: if std.isArray(v=healthChecks) then healthChecks else [healthChecks] } }, + '#withImages':: d.fn(help='"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify."', args=[d.arg(name='images', type=d.T.array)]), + withImages(images): { spec+: { images: if std.isArray(v=images) then images else [images] } }, + '#withImagesMixin':: d.fn(help='"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='images', type=d.T.array)]), + withImagesMixin(images): { spec+: { images+: if std.isArray(v=images) then images else [images] } }, + '#withInterval':: d.fn(help='"The interval at which to reconcile the Kustomization."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withPatches':: d.fn(help='"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."', args=[d.arg(name='patches', type=d.T.array)]), + withPatches(patches): { spec+: { patches: if std.isArray(v=patches) then patches else [patches] } }, + '#withPatchesJson6902':: d.fn(help='"JSON 6902 patches, defined as inline YAML objects."', args=[d.arg(name='patchesJson6902', type=d.T.array)]), + withPatchesJson6902(patchesJson6902): { spec+: { patchesJson6902: if std.isArray(v=patchesJson6902) then patchesJson6902 else [patchesJson6902] } }, + '#withPatchesJson6902Mixin':: d.fn(help='"JSON 6902 patches, defined as inline YAML objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patchesJson6902', type=d.T.array)]), + withPatchesJson6902Mixin(patchesJson6902): { spec+: { patchesJson6902+: if std.isArray(v=patchesJson6902) then patchesJson6902 else [patchesJson6902] } }, + '#withPatchesMixin':: d.fn(help='"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patches', type=d.T.array)]), + withPatchesMixin(patches): { spec+: { patches+: if std.isArray(v=patches) then patches else [patches] } }, + '#withPatchesStrategicMerge':: d.fn(help='"Strategic merge patches, defined as inline YAML objects."', args=[d.arg(name='patchesStrategicMerge', type=d.T.array)]), + withPatchesStrategicMerge(patchesStrategicMerge): { spec+: { patchesStrategicMerge: if std.isArray(v=patchesStrategicMerge) then patchesStrategicMerge else [patchesStrategicMerge] } }, + '#withPatchesStrategicMergeMixin':: d.fn(help='"Strategic merge patches, defined as inline YAML objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patchesStrategicMerge', type=d.T.array)]), + withPatchesStrategicMergeMixin(patchesStrategicMerge): { spec+: { patchesStrategicMerge+: if std.isArray(v=patchesStrategicMerge) then patchesStrategicMerge else [patchesStrategicMerge] } }, + '#withPath':: d.fn(help="\"Path to the directory containing the kustomization.yaml file, or the set of plain YAMLs a kustomization.yaml should be generated for. Defaults to 'None', which translates to the root path of the SourceRef.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { spec+: { path: path } }, + '#withPrune':: d.fn(help='"Prune enables garbage collection."', args=[d.arg(name='prune', type=d.T.boolean)]), + withPrune(prune): { spec+: { prune: prune } }, + '#withRetryInterval':: d.fn(help='"The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the KustomizationSpec.Interval value to retry failures."', args=[d.arg(name='retryInterval', type=d.T.string)]), + withRetryInterval(retryInterval): { spec+: { retryInterval: retryInterval } }, + '#withServiceAccountName':: d.fn(help='"The name of the Kubernetes service account to impersonate when reconciling this Kustomization."', args=[d.arg(name='serviceAccountName', type=d.T.string)]), + withServiceAccountName(serviceAccountName): { spec+: { serviceAccountName: serviceAccountName } }, + '#withSuspend':: d.fn(help='"This flag tells the controller to suspend subsequent kustomize executions, it does not apply to already started executions. Defaults to false."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTargetNamespace':: d.fn(help='"TargetNamespace sets or overrides the namespace in the kustomization.yaml file."', args=[d.arg(name='targetNamespace', type=d.T.string)]), + withTargetNamespace(targetNamespace): { spec+: { targetNamespace: targetNamespace } }, + '#withTimeout':: d.fn(help="\"Timeout for validation, apply and health checking operations. Defaults to 'Interval' duration.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + '#withValidation':: d.fn(help="\"Validate the Kubernetes objects before applying them on the cluster. The validation strategy can be 'client' (local dry-run), 'server' (APIServer dry-run) or 'none'. When 'Force' is 'true', validation will fallback to 'client' if set to 'server' because server-side validation is not supported in this scenario.\"", args=[d.arg(name='validation', type=d.T.string)]), + withValidation(validation): { spec+: { validation: validation } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/kustomize/v1beta1/main.libsonnet b/2.2.1/_gen/kustomize/v1beta1/main.libsonnet new file mode 100644 index 0000000..2ac5dc5 --- /dev/null +++ b/2.2.1/_gen/kustomize/v1beta1/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1beta1', url='', help=''), + kustomization: (import 'kustomization.libsonnet'), +} diff --git a/2.2.1/_gen/kustomize/v1beta2/kustomization.libsonnet b/2.2.1/_gen/kustomize/v1beta2/kustomization.libsonnet new file mode 100644 index 0000000..835d6a9 --- /dev/null +++ b/2.2.1/_gen/kustomize/v1beta2/kustomization.libsonnet @@ -0,0 +1,253 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='kustomization', url='', help='"Kustomization is the Schema for the kustomizations API."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Kustomization', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'kustomize.toolkit.fluxcd.io/v1beta2', + kind: 'Kustomization', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"KustomizationSpec defines the configuration to calculate the desired state from a Source using Kustomize."'), + spec: { + '#commonMetadata':: d.obj(help='"CommonMetadata specifies the common labels and annotations that are applied to all resources. Any existing label or annotation will be overridden if its key matches a common one."'), + commonMetadata: { + '#withAnnotations':: d.fn(help="\"Annotations to be added to the object's metadata.\"", args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { spec+: { commonMetadata+: { annotations: annotations } } }, + '#withAnnotationsMixin':: d.fn(help="\"Annotations to be added to the object's metadata.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { spec+: { commonMetadata+: { annotations+: annotations } } }, + '#withLabels':: d.fn(help="\"Labels to be added to the object's metadata.\"", args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { commonMetadata+: { labels: labels } } }, + '#withLabelsMixin':: d.fn(help="\"Labels to be added to the object's metadata.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { commonMetadata+: { labels+: labels } } }, + }, + '#decryption':: d.obj(help='"Decrypt Kubernetes secrets before applying them on the cluster."'), + decryption: { + '#secretRef':: d.obj(help='"The secret name containing the private OpenPGP keys used for decryption."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { decryption+: { secretRef+: { name: name } } } }, + }, + '#withProvider':: d.fn(help='"Provider is the name of the decryption engine."', args=[d.arg(name='provider', type=d.T.string)]), + withProvider(provider): { spec+: { decryption+: { provider: provider } } }, + }, + '#dependsOn':: d.obj(help='"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled."'), + dependsOn: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent, when not specified it acts as LocalObjectReference."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + }, + '#healthChecks':: d.obj(help='"A list of resources to be included in the health assessment."'), + healthChecks: { + '#withApiVersion':: d.fn(help='"API version of the referent, if not specified the Kubernetes preferred version will be used."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { apiVersion: apiVersion }, + '#withKind':: d.fn(help='"Kind of the referent."', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { kind: kind }, + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent, when not specified it acts as LocalObjectReference."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + }, + '#images':: d.obj(help='"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify."'), + images: { + '#withDigest':: d.fn(help='"Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored."', args=[d.arg(name='digest', type=d.T.string)]), + withDigest(digest): { digest: digest }, + '#withName':: d.fn(help='"Name is a tag-less image name."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNewName':: d.fn(help='"NewName is the value used to replace the original name."', args=[d.arg(name='newName', type=d.T.string)]), + withNewName(newName): { newName: newName }, + '#withNewTag':: d.fn(help='"NewTag is the value used to replace the original tag."', args=[d.arg(name='newTag', type=d.T.string)]), + withNewTag(newTag): { newTag: newTag }, + }, + '#kubeConfig':: d.obj(help='"The KubeConfig for reconciling the Kustomization on a remote cluster. When used in combination with KustomizationSpec.ServiceAccountName, forces the controller to act on behalf of that Service Account at the target cluster. If the --default-service-account flag is set, its value will be used as a controller level fallback for when KustomizationSpec.ServiceAccountName is empty."'), + kubeConfig: { + '#secretRef':: d.obj(help="\"SecretRef holds the name of a secret that contains a key with the kubeconfig file as the value. If no key is set, the key will default to 'value'. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific `cmd-path` auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling Kubernetes resources.\""), + secretRef: { + '#withKey':: d.fn(help='"Key in the Secret, when not specified an implementation-specific default key is used."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { kubeConfig+: { secretRef+: { key: key } } } }, + '#withName':: d.fn(help='"Name of the Secret."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { kubeConfig+: { secretRef+: { name: name } } } }, + }, + }, + '#patches':: d.obj(help='"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."'), + patches: { + '#target':: d.obj(help='"Target points to the resources that the patch document should be applied to."'), + target: { + '#withAnnotationSelector':: d.fn(help='"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations."', args=[d.arg(name='annotationSelector', type=d.T.string)]), + withAnnotationSelector(annotationSelector): { target+: { annotationSelector: annotationSelector } }, + '#withGroup':: d.fn(help='"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { target+: { group: group } }, + '#withKind':: d.fn(help='"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { target+: { kind: kind } }, + '#withLabelSelector':: d.fn(help='"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels."', args=[d.arg(name='labelSelector', type=d.T.string)]), + withLabelSelector(labelSelector): { target+: { labelSelector: labelSelector } }, + '#withName':: d.fn(help='"Name to match resources with."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { target+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace to select resources from."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { target+: { namespace: namespace } }, + '#withVersion':: d.fn(help='"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { target+: { version: version } }, + }, + '#withPatch':: d.fn(help='"Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects."', args=[d.arg(name='patch', type=d.T.string)]), + withPatch(patch): { patch: patch }, + }, + '#patchesJson6902':: d.obj(help='"JSON 6902 patches, defined as inline YAML objects. Deprecated: Use Patches instead."'), + patchesJson6902: { + '#patch':: d.obj(help='"Patch contains the JSON6902 patch document with an array of operation objects."'), + patch: { + '#withFrom':: d.fn(help='"From contains a JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations."', args=[d.arg(name='from', type=d.T.string)]), + withFrom(from): { from: from }, + '#withOp':: d.fn(help='"Op indicates the operation to perform. Its value MUST be one of \\"add\\", \\"remove\\", \\"replace\\", \\"move\\", \\"copy\\", or \\"test\\". https://datatracker.ietf.org/doc/html/rfc6902#section-4"', args=[d.arg(name='op', type=d.T.string)]), + withOp(op): { op: op }, + '#withPath':: d.fn(help='"Path contains the JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + '#withValue':: d.fn(help='"Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations."', args=[d.arg(name='value', type=d.T.any)]), + withValue(value): { value: value }, + }, + '#target':: d.obj(help='"Target points to the resources that the patch document should be applied to."'), + target: { + '#withAnnotationSelector':: d.fn(help='"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations."', args=[d.arg(name='annotationSelector', type=d.T.string)]), + withAnnotationSelector(annotationSelector): { target+: { annotationSelector: annotationSelector } }, + '#withGroup':: d.fn(help='"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { target+: { group: group } }, + '#withKind':: d.fn(help='"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { target+: { kind: kind } }, + '#withLabelSelector':: d.fn(help='"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels."', args=[d.arg(name='labelSelector', type=d.T.string)]), + withLabelSelector(labelSelector): { target+: { labelSelector: labelSelector } }, + '#withName':: d.fn(help='"Name to match resources with."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { target+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace to select resources from."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { target+: { namespace: namespace } }, + '#withVersion':: d.fn(help='"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md"', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { target+: { version: version } }, + }, + '#withPatch':: d.fn(help='"Patch contains the JSON6902 patch document with an array of operation objects."', args=[d.arg(name='patch', type=d.T.array)]), + withPatch(patch): { patch: if std.isArray(v=patch) then patch else [patch] }, + '#withPatchMixin':: d.fn(help='"Patch contains the JSON6902 patch document with an array of operation objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patch', type=d.T.array)]), + withPatchMixin(patch): { patch+: if std.isArray(v=patch) then patch else [patch] }, + }, + '#postBuild':: d.obj(help='"PostBuild describes which actions to perform on the YAML manifest generated by building the kustomize overlay."'), + postBuild: { + '#substituteFrom':: d.obj(help='"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names and they must match the vars declared in the manifests for the substitution to happen."'), + substituteFrom: { + '#withKind':: d.fn(help="\"Kind of the values referent, valid values are ('Secret', 'ConfigMap').\"", args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { kind: kind }, + '#withName':: d.fn(help='"Name of the values referent. Should reside in the same namespace as the referring resource."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withOptional':: d.fn(help='"Optional indicates whether the referenced resource must exist, or whether to tolerate its absence. If true and the referenced resource is absent, proceed as if the resource was present but empty, without any variables defined."', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { optional: optional }, + }, + '#withSubstitute':: d.fn(help='"Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}."', args=[d.arg(name='substitute', type=d.T.object)]), + withSubstitute(substitute): { spec+: { postBuild+: { substitute: substitute } } }, + '#withSubstituteFrom':: d.fn(help='"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names and they must match the vars declared in the manifests for the substitution to happen."', args=[d.arg(name='substituteFrom', type=d.T.array)]), + withSubstituteFrom(substituteFrom): { spec+: { postBuild+: { substituteFrom: if std.isArray(v=substituteFrom) then substituteFrom else [substituteFrom] } } }, + '#withSubstituteFromMixin':: d.fn(help='"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names and they must match the vars declared in the manifests for the substitution to happen."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='substituteFrom', type=d.T.array)]), + withSubstituteFromMixin(substituteFrom): { spec+: { postBuild+: { substituteFrom+: if std.isArray(v=substituteFrom) then substituteFrom else [substituteFrom] } } }, + '#withSubstituteMixin':: d.fn(help='"Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='substitute', type=d.T.object)]), + withSubstituteMixin(substitute): { spec+: { postBuild+: { substitute+: substitute } } }, + }, + '#sourceRef':: d.obj(help='"Reference of the source where the kustomization file is."'), + sourceRef: { + '#withApiVersion':: d.fn(help='"API version of the referent."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { spec+: { sourceRef+: { apiVersion: apiVersion } } }, + '#withKind':: d.fn(help='"Kind of the referent."', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { sourceRef+: { kind: kind } } }, + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { sourceRef+: { name: name } } }, + '#withNamespace':: d.fn(help='"Namespace of the referent, defaults to the namespace of the Kubernetes resource object that contains the reference."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { sourceRef+: { namespace: namespace } } }, + }, + '#withComponents':: d.fn(help='"Components specifies relative paths to specifications of other Components."', args=[d.arg(name='components', type=d.T.array)]), + withComponents(components): { spec+: { components: if std.isArray(v=components) then components else [components] } }, + '#withComponentsMixin':: d.fn(help='"Components specifies relative paths to specifications of other Components."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='components', type=d.T.array)]), + withComponentsMixin(components): { spec+: { components+: if std.isArray(v=components) then components else [components] } }, + '#withDependsOn':: d.fn(help='"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled."', args=[d.arg(name='dependsOn', type=d.T.array)]), + withDependsOn(dependsOn): { spec+: { dependsOn: if std.isArray(v=dependsOn) then dependsOn else [dependsOn] } }, + '#withDependsOnMixin':: d.fn(help='"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='dependsOn', type=d.T.array)]), + withDependsOnMixin(dependsOn): { spec+: { dependsOn+: if std.isArray(v=dependsOn) then dependsOn else [dependsOn] } }, + '#withForce':: d.fn(help='"Force instructs the controller to recreate resources when patching fails due to an immutable field change."', args=[d.arg(name='force', type=d.T.boolean)]), + withForce(force): { spec+: { force: force } }, + '#withHealthChecks':: d.fn(help='"A list of resources to be included in the health assessment."', args=[d.arg(name='healthChecks', type=d.T.array)]), + withHealthChecks(healthChecks): { spec+: { healthChecks: if std.isArray(v=healthChecks) then healthChecks else [healthChecks] } }, + '#withHealthChecksMixin':: d.fn(help='"A list of resources to be included in the health assessment."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='healthChecks', type=d.T.array)]), + withHealthChecksMixin(healthChecks): { spec+: { healthChecks+: if std.isArray(v=healthChecks) then healthChecks else [healthChecks] } }, + '#withImages':: d.fn(help='"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify."', args=[d.arg(name='images', type=d.T.array)]), + withImages(images): { spec+: { images: if std.isArray(v=images) then images else [images] } }, + '#withImagesMixin':: d.fn(help='"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='images', type=d.T.array)]), + withImagesMixin(images): { spec+: { images+: if std.isArray(v=images) then images else [images] } }, + '#withInterval':: d.fn(help='"The interval at which to reconcile the Kustomization."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withPatches':: d.fn(help='"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."', args=[d.arg(name='patches', type=d.T.array)]), + withPatches(patches): { spec+: { patches: if std.isArray(v=patches) then patches else [patches] } }, + '#withPatchesJson6902':: d.fn(help='"JSON 6902 patches, defined as inline YAML objects. Deprecated: Use Patches instead."', args=[d.arg(name='patchesJson6902', type=d.T.array)]), + withPatchesJson6902(patchesJson6902): { spec+: { patchesJson6902: if std.isArray(v=patchesJson6902) then patchesJson6902 else [patchesJson6902] } }, + '#withPatchesJson6902Mixin':: d.fn(help='"JSON 6902 patches, defined as inline YAML objects. Deprecated: Use Patches instead."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patchesJson6902', type=d.T.array)]), + withPatchesJson6902Mixin(patchesJson6902): { spec+: { patchesJson6902+: if std.isArray(v=patchesJson6902) then patchesJson6902 else [patchesJson6902] } }, + '#withPatchesMixin':: d.fn(help='"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patches', type=d.T.array)]), + withPatchesMixin(patches): { spec+: { patches+: if std.isArray(v=patches) then patches else [patches] } }, + '#withPatchesStrategicMerge':: d.fn(help='"Strategic merge patches, defined as inline YAML objects. Deprecated: Use Patches instead."', args=[d.arg(name='patchesStrategicMerge', type=d.T.array)]), + withPatchesStrategicMerge(patchesStrategicMerge): { spec+: { patchesStrategicMerge: if std.isArray(v=patchesStrategicMerge) then patchesStrategicMerge else [patchesStrategicMerge] } }, + '#withPatchesStrategicMergeMixin':: d.fn(help='"Strategic merge patches, defined as inline YAML objects. Deprecated: Use Patches instead."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='patchesStrategicMerge', type=d.T.array)]), + withPatchesStrategicMergeMixin(patchesStrategicMerge): { spec+: { patchesStrategicMerge+: if std.isArray(v=patchesStrategicMerge) then patchesStrategicMerge else [patchesStrategicMerge] } }, + '#withPath':: d.fn(help="\"Path to the directory containing the kustomization.yaml file, or the set of plain YAMLs a kustomization.yaml should be generated for. Defaults to 'None', which translates to the root path of the SourceRef.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { spec+: { path: path } }, + '#withPrune':: d.fn(help='"Prune enables garbage collection."', args=[d.arg(name='prune', type=d.T.boolean)]), + withPrune(prune): { spec+: { prune: prune } }, + '#withRetryInterval':: d.fn(help='"The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the KustomizationSpec.Interval value to retry failures."', args=[d.arg(name='retryInterval', type=d.T.string)]), + withRetryInterval(retryInterval): { spec+: { retryInterval: retryInterval } }, + '#withServiceAccountName':: d.fn(help='"The name of the Kubernetes service account to impersonate when reconciling this Kustomization."', args=[d.arg(name='serviceAccountName', type=d.T.string)]), + withServiceAccountName(serviceAccountName): { spec+: { serviceAccountName: serviceAccountName } }, + '#withSuspend':: d.fn(help='"This flag tells the controller to suspend subsequent kustomize executions, it does not apply to already started executions. Defaults to false."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTargetNamespace':: d.fn(help='"TargetNamespace sets or overrides the namespace in the kustomization.yaml file."', args=[d.arg(name='targetNamespace', type=d.T.string)]), + withTargetNamespace(targetNamespace): { spec+: { targetNamespace: targetNamespace } }, + '#withTimeout':: d.fn(help="\"Timeout for validation, apply and health checking operations. Defaults to 'Interval' duration.\"", args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + '#withValidation':: d.fn(help='"Deprecated: Not used in v1beta2."', args=[d.arg(name='validation', type=d.T.string)]), + withValidation(validation): { spec+: { validation: validation } }, + '#withWait':: d.fn(help='"Wait instructs the controller to check the health of all the reconciled resources. When enabled, the HealthChecks are ignored. Defaults to false."', args=[d.arg(name='wait', type=d.T.boolean)]), + withWait(wait): { spec+: { wait: wait } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/kustomize/v1beta2/main.libsonnet b/2.2.1/_gen/kustomize/v1beta2/main.libsonnet new file mode 100644 index 0000000..1c3848b --- /dev/null +++ b/2.2.1/_gen/kustomize/v1beta2/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1beta2', url='', help=''), + kustomization: (import 'kustomization.libsonnet'), +} diff --git a/2.2.1/_gen/notification/main.libsonnet b/2.2.1/_gen/notification/main.libsonnet new file mode 100644 index 0000000..5d1f8fb --- /dev/null +++ b/2.2.1/_gen/notification/main.libsonnet @@ -0,0 +1,8 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='notification', url='', help=''), + v1: (import 'v1/main.libsonnet'), + v1beta1: (import 'v1beta1/main.libsonnet'), + v1beta2: (import 'v1beta2/main.libsonnet'), + v1beta3: (import 'v1beta3/main.libsonnet'), +} diff --git a/2.2.1/_gen/notification/v1/main.libsonnet b/2.2.1/_gen/notification/v1/main.libsonnet new file mode 100644 index 0000000..a9e21b0 --- /dev/null +++ b/2.2.1/_gen/notification/v1/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1', url='', help=''), + receiver: (import 'receiver.libsonnet'), +} diff --git a/2.2.1/_gen/notification/v1/receiver.libsonnet b/2.2.1/_gen/notification/v1/receiver.libsonnet new file mode 100644 index 0000000..35f74ae --- /dev/null +++ b/2.2.1/_gen/notification/v1/receiver.libsonnet @@ -0,0 +1,89 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='receiver', url='', help='"Receiver is the Schema for the receivers API."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Receiver', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'notification.toolkit.fluxcd.io/v1', + kind: 'Receiver', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ReceiverSpec defines the desired state of the Receiver."'), + spec: { + '#resources':: d.obj(help='"A list of resources to be notified about changes."'), + resources: { + '#withApiVersion':: d.fn(help='"API version of the referent"', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { apiVersion: apiVersion }, + '#withKind':: d.fn(help='"Kind of the referent"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { kind: kind }, + '#withMatchLabels':: d.fn(help='"MatchLabels 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. MatchLabels requires the name to be set to `*`."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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. MatchLabels requires the name to be set to `*`."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + '#withName':: d.fn(help='"Name of the referent If multiple resources are targeted `*` may be set."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + }, + '#secretRef':: d.obj(help='"SecretRef specifies the Secret containing the token used to validate the payload authenticity."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#withEvents':: d.fn(help="\"Events specifies the list of event types to handle, e.g. 'push' for GitHub or 'Push Hook' for GitLab.\"", args=[d.arg(name='events', type=d.T.array)]), + withEvents(events): { spec+: { events: if std.isArray(v=events) then events else [events] } }, + '#withEventsMixin':: d.fn(help="\"Events specifies the list of event types to handle, e.g. 'push' for GitHub or 'Push Hook' for GitLab.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='events', type=d.T.array)]), + withEventsMixin(events): { spec+: { events+: if std.isArray(v=events) then events else [events] } }, + '#withInterval':: d.fn(help='"Interval at which to reconcile the Receiver with its Secret references."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withResources':: d.fn(help='"A list of resources to be notified about changes."', args=[d.arg(name='resources', type=d.T.array)]), + withResources(resources): { spec+: { resources: if std.isArray(v=resources) then resources else [resources] } }, + '#withResourcesMixin':: d.fn(help='"A list of resources to be notified about changes."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='resources', type=d.T.array)]), + withResourcesMixin(resources): { spec+: { resources+: if std.isArray(v=resources) then resources else [resources] } }, + '#withSuspend':: d.fn(help='"Suspend tells the controller to suspend subsequent events handling for this receiver."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withType':: d.fn(help='"Type of webhook sender, used to determine the validation procedure and payload deserialization."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { type: type } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/notification/v1beta1/alert.libsonnet b/2.2.1/_gen/notification/v1beta1/alert.libsonnet new file mode 100644 index 0000000..0b6661a --- /dev/null +++ b/2.2.1/_gen/notification/v1beta1/alert.libsonnet @@ -0,0 +1,89 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='alert', url='', help='"Alert is the Schema for the alerts API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Alert', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'notification.toolkit.fluxcd.io/v1beta1', + kind: 'Alert', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"AlertSpec defines an alerting rule for events involving a list of objects"'), + spec: { + '#eventSources':: d.obj(help='"Filter events based on the involved objects."'), + eventSources: { + '#withApiVersion':: d.fn(help='"API version of the referent"', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { apiVersion: apiVersion }, + '#withKind':: d.fn(help='"Kind of the referent"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { kind: kind }, + '#withMatchLabels':: d.fn(help='"MatchLabels 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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + '#withName':: d.fn(help='"Name of the referent"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + }, + '#providerRef':: d.obj(help='"Send events using this provider."'), + providerRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { providerRef+: { name: name } } }, + }, + '#withEventSeverity':: d.fn(help="\"Filter events based on severity, defaults to ('info'). If set to 'info' no events will be filtered.\"", args=[d.arg(name='eventSeverity', type=d.T.string)]), + withEventSeverity(eventSeverity): { spec+: { eventSeverity: eventSeverity } }, + '#withEventSources':: d.fn(help='"Filter events based on the involved objects."', args=[d.arg(name='eventSources', type=d.T.array)]), + withEventSources(eventSources): { spec+: { eventSources: if std.isArray(v=eventSources) then eventSources else [eventSources] } }, + '#withEventSourcesMixin':: d.fn(help='"Filter events based on the involved objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='eventSources', type=d.T.array)]), + withEventSourcesMixin(eventSources): { spec+: { eventSources+: if std.isArray(v=eventSources) then eventSources else [eventSources] } }, + '#withExclusionList':: d.fn(help='"A list of Golang regular expressions to be used for excluding messages."', args=[d.arg(name='exclusionList', type=d.T.array)]), + withExclusionList(exclusionList): { spec+: { exclusionList: if std.isArray(v=exclusionList) then exclusionList else [exclusionList] } }, + '#withExclusionListMixin':: d.fn(help='"A list of Golang regular expressions to be used for excluding messages."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='exclusionList', type=d.T.array)]), + withExclusionListMixin(exclusionList): { spec+: { exclusionList+: if std.isArray(v=exclusionList) then exclusionList else [exclusionList] } }, + '#withSummary':: d.fn(help='"Short description of the impact and affected cluster."', args=[d.arg(name='summary', type=d.T.string)]), + withSummary(summary): { spec+: { summary: summary } }, + '#withSuspend':: d.fn(help='"This flag tells the controller to suspend subsequent events dispatching. Defaults to false."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/notification/v1beta1/main.libsonnet b/2.2.1/_gen/notification/v1beta1/main.libsonnet new file mode 100644 index 0000000..8dcb983 --- /dev/null +++ b/2.2.1/_gen/notification/v1beta1/main.libsonnet @@ -0,0 +1,7 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1beta1', url='', help=''), + alert: (import 'alert.libsonnet'), + provider: (import 'provider.libsonnet'), + receiver: (import 'receiver.libsonnet'), +} diff --git a/2.2.1/_gen/notification/v1beta1/provider.libsonnet b/2.2.1/_gen/notification/v1beta1/provider.libsonnet new file mode 100644 index 0000000..adf27c4 --- /dev/null +++ b/2.2.1/_gen/notification/v1beta1/provider.libsonnet @@ -0,0 +1,79 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='provider', url='', help='"Provider is the Schema for the providers API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Provider', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'notification.toolkit.fluxcd.io/v1beta1', + kind: 'Provider', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ProviderSpec defines the desired state of Provider"'), + spec: { + '#certSecretRef':: d.obj(help='"CertSecretRef can be given the name of a secret containing a PEM-encoded CA certificate (`caFile`)"'), + certSecretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { certSecretRef+: { name: name } } }, + }, + '#secretRef':: d.obj(help='"Secret reference containing the provider webhook URL using \\"address\\" as data key"'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#withAddress':: d.fn(help='"HTTP/S webhook address of this provider"', args=[d.arg(name='address', type=d.T.string)]), + withAddress(address): { spec+: { address: address } }, + '#withChannel':: d.fn(help='"Alert channel for this provider"', args=[d.arg(name='channel', type=d.T.string)]), + withChannel(channel): { spec+: { channel: channel } }, + '#withProxy':: d.fn(help='"HTTP/S address of the proxy"', args=[d.arg(name='proxy', type=d.T.string)]), + withProxy(proxy): { spec+: { proxy: proxy } }, + '#withSuspend':: d.fn(help='"This flag tells the controller to suspend subsequent events handling. Defaults to false."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTimeout':: d.fn(help='"Timeout for sending alerts to the provider."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + '#withType':: d.fn(help='"Type of provider"', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { type: type } }, + '#withUsername':: d.fn(help='"Bot username for this provider"', args=[d.arg(name='username', type=d.T.string)]), + withUsername(username): { spec+: { username: username } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/notification/v1beta1/receiver.libsonnet b/2.2.1/_gen/notification/v1beta1/receiver.libsonnet new file mode 100644 index 0000000..6e8de16 --- /dev/null +++ b/2.2.1/_gen/notification/v1beta1/receiver.libsonnet @@ -0,0 +1,87 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='receiver', url='', help='"Receiver is the Schema for the receivers API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Receiver', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'notification.toolkit.fluxcd.io/v1beta1', + kind: 'Receiver', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ReceiverSpec defines the desired state of Receiver"'), + spec: { + '#resources':: d.obj(help='"A list of resources to be notified about changes."'), + resources: { + '#withApiVersion':: d.fn(help='"API version of the referent"', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { apiVersion: apiVersion }, + '#withKind':: d.fn(help='"Kind of the referent"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { kind: kind }, + '#withMatchLabels':: d.fn(help='"MatchLabels 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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + '#withName':: d.fn(help='"Name of the referent"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + }, + '#secretRef':: d.obj(help='"Secret reference containing the token used to validate the payload authenticity"'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#withEvents':: d.fn(help="\"A list of events to handle, e.g. 'push' for GitHub or 'Push Hook' for GitLab.\"", args=[d.arg(name='events', type=d.T.array)]), + withEvents(events): { spec+: { events: if std.isArray(v=events) then events else [events] } }, + '#withEventsMixin':: d.fn(help="\"A list of events to handle, e.g. 'push' for GitHub or 'Push Hook' for GitLab.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='events', type=d.T.array)]), + withEventsMixin(events): { spec+: { events+: if std.isArray(v=events) then events else [events] } }, + '#withResources':: d.fn(help='"A list of resources to be notified about changes."', args=[d.arg(name='resources', type=d.T.array)]), + withResources(resources): { spec+: { resources: if std.isArray(v=resources) then resources else [resources] } }, + '#withResourcesMixin':: d.fn(help='"A list of resources to be notified about changes."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='resources', type=d.T.array)]), + withResourcesMixin(resources): { spec+: { resources+: if std.isArray(v=resources) then resources else [resources] } }, + '#withSuspend':: d.fn(help='"This flag tells the controller to suspend subsequent events handling. Defaults to false."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withType':: d.fn(help='"Type of webhook sender, used to determine the validation procedure and payload deserialization."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { type: type } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/notification/v1beta2/alert.libsonnet b/2.2.1/_gen/notification/v1beta2/alert.libsonnet new file mode 100644 index 0000000..858391e --- /dev/null +++ b/2.2.1/_gen/notification/v1beta2/alert.libsonnet @@ -0,0 +1,97 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='alert', url='', help='"Alert is the Schema for the alerts API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Alert', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'notification.toolkit.fluxcd.io/v1beta2', + kind: 'Alert', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"AlertSpec defines an alerting rule for events involving a list of objects."'), + spec: { + '#eventSources':: d.obj(help='"EventSources specifies how to filter events based on the involved object kind, name and namespace."'), + eventSources: { + '#withApiVersion':: d.fn(help='"API version of the referent"', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { apiVersion: apiVersion }, + '#withKind':: d.fn(help='"Kind of the referent"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { kind: kind }, + '#withMatchLabels':: d.fn(help='"MatchLabels 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. MatchLabels requires the name to be set to `*`."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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. MatchLabels requires the name to be set to `*`."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + '#withName':: d.fn(help='"Name of the referent If multiple resources are targeted `*` may be set."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + }, + '#providerRef':: d.obj(help='"ProviderRef specifies which Provider this Alert should use."'), + providerRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { providerRef+: { name: name } } }, + }, + '#withEventMetadata':: d.fn(help="\"EventMetadata is an optional field for adding metadata to events dispatched by the controller. This can be used for enhancing the context of the event. If a field would override one already present on the original event as generated by the emitter, then the override doesn't happen, i.e. the original value is preserved, and an info log is printed.\"", args=[d.arg(name='eventMetadata', type=d.T.object)]), + withEventMetadata(eventMetadata): { spec+: { eventMetadata: eventMetadata } }, + '#withEventMetadataMixin':: d.fn(help="\"EventMetadata is an optional field for adding metadata to events dispatched by the controller. This can be used for enhancing the context of the event. If a field would override one already present on the original event as generated by the emitter, then the override doesn't happen, i.e. the original value is preserved, and an info log is printed.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='eventMetadata', type=d.T.object)]), + withEventMetadataMixin(eventMetadata): { spec+: { eventMetadata+: eventMetadata } }, + '#withEventSeverity':: d.fn(help="\"EventSeverity specifies how to filter events based on severity. If set to 'info' no events will be filtered.\"", args=[d.arg(name='eventSeverity', type=d.T.string)]), + withEventSeverity(eventSeverity): { spec+: { eventSeverity: eventSeverity } }, + '#withEventSources':: d.fn(help='"EventSources specifies how to filter events based on the involved object kind, name and namespace."', args=[d.arg(name='eventSources', type=d.T.array)]), + withEventSources(eventSources): { spec+: { eventSources: if std.isArray(v=eventSources) then eventSources else [eventSources] } }, + '#withEventSourcesMixin':: d.fn(help='"EventSources specifies how to filter events based on the involved object kind, name and namespace."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='eventSources', type=d.T.array)]), + withEventSourcesMixin(eventSources): { spec+: { eventSources+: if std.isArray(v=eventSources) then eventSources else [eventSources] } }, + '#withExclusionList':: d.fn(help='"ExclusionList specifies a list of Golang regular expressions to be used for excluding messages."', args=[d.arg(name='exclusionList', type=d.T.array)]), + withExclusionList(exclusionList): { spec+: { exclusionList: if std.isArray(v=exclusionList) then exclusionList else [exclusionList] } }, + '#withExclusionListMixin':: d.fn(help='"ExclusionList specifies a list of Golang regular expressions to be used for excluding messages."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='exclusionList', type=d.T.array)]), + withExclusionListMixin(exclusionList): { spec+: { exclusionList+: if std.isArray(v=exclusionList) then exclusionList else [exclusionList] } }, + '#withInclusionList':: d.fn(help='"InclusionList specifies a list of Golang regular expressions to be used for including messages."', args=[d.arg(name='inclusionList', type=d.T.array)]), + withInclusionList(inclusionList): { spec+: { inclusionList: if std.isArray(v=inclusionList) then inclusionList else [inclusionList] } }, + '#withInclusionListMixin':: d.fn(help='"InclusionList specifies a list of Golang regular expressions to be used for including messages."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='inclusionList', type=d.T.array)]), + withInclusionListMixin(inclusionList): { spec+: { inclusionList+: if std.isArray(v=inclusionList) then inclusionList else [inclusionList] } }, + '#withSummary':: d.fn(help='"Summary holds a short description of the impact and affected cluster."', args=[d.arg(name='summary', type=d.T.string)]), + withSummary(summary): { spec+: { summary: summary } }, + '#withSuspend':: d.fn(help='"Suspend tells the controller to suspend subsequent events handling for this Alert."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/notification/v1beta2/main.libsonnet b/2.2.1/_gen/notification/v1beta2/main.libsonnet new file mode 100644 index 0000000..1030381 --- /dev/null +++ b/2.2.1/_gen/notification/v1beta2/main.libsonnet @@ -0,0 +1,7 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1beta2', url='', help=''), + alert: (import 'alert.libsonnet'), + provider: (import 'provider.libsonnet'), + receiver: (import 'receiver.libsonnet'), +} diff --git a/2.2.1/_gen/notification/v1beta2/provider.libsonnet b/2.2.1/_gen/notification/v1beta2/provider.libsonnet new file mode 100644 index 0000000..b9cbb4f --- /dev/null +++ b/2.2.1/_gen/notification/v1beta2/provider.libsonnet @@ -0,0 +1,81 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='provider', url='', help='"Provider is the Schema for the providers API."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Provider', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'notification.toolkit.fluxcd.io/v1beta2', + kind: 'Provider', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ProviderSpec defines the desired state of the Provider."'), + spec: { + '#certSecretRef':: d.obj(help='"CertSecretRef specifies the Secret containing a PEM-encoded CA certificate (in the `ca.crt` key). \\n Note: Support for the `caFile` key has been deprecated."'), + certSecretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { certSecretRef+: { name: name } } }, + }, + '#secretRef':: d.obj(help='"SecretRef specifies the Secret containing the authentication credentials for this Provider."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#withAddress':: d.fn(help='"Address specifies the endpoint, in a generic sense, to where alerts are sent. What kind of endpoint depends on the specific Provider type being used. For the generic Provider, for example, this is an HTTP/S address. For other Provider types this could be a project ID or a namespace."', args=[d.arg(name='address', type=d.T.string)]), + withAddress(address): { spec+: { address: address } }, + '#withChannel':: d.fn(help='"Channel specifies the destination channel where events should be posted."', args=[d.arg(name='channel', type=d.T.string)]), + withChannel(channel): { spec+: { channel: channel } }, + '#withInterval':: d.fn(help='"Interval at which to reconcile the Provider with its Secret references."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withProxy':: d.fn(help='"Proxy the HTTP/S address of the proxy server."', args=[d.arg(name='proxy', type=d.T.string)]), + withProxy(proxy): { spec+: { proxy: proxy } }, + '#withSuspend':: d.fn(help='"Suspend tells the controller to suspend subsequent events handling for this Provider."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTimeout':: d.fn(help='"Timeout for sending alerts to the Provider."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + '#withType':: d.fn(help='"Type specifies which Provider implementation to use."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { type: type } }, + '#withUsername':: d.fn(help='"Username specifies the name under which events are posted."', args=[d.arg(name='username', type=d.T.string)]), + withUsername(username): { spec+: { username: username } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/notification/v1beta2/receiver.libsonnet b/2.2.1/_gen/notification/v1beta2/receiver.libsonnet new file mode 100644 index 0000000..0bc6bfb --- /dev/null +++ b/2.2.1/_gen/notification/v1beta2/receiver.libsonnet @@ -0,0 +1,89 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='receiver', url='', help='"Receiver is the Schema for the receivers API."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Receiver', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'notification.toolkit.fluxcd.io/v1beta2', + kind: 'Receiver', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ReceiverSpec defines the desired state of the Receiver."'), + spec: { + '#resources':: d.obj(help='"A list of resources to be notified about changes."'), + resources: { + '#withApiVersion':: d.fn(help='"API version of the referent"', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { apiVersion: apiVersion }, + '#withKind':: d.fn(help='"Kind of the referent"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { kind: kind }, + '#withMatchLabels':: d.fn(help='"MatchLabels 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. MatchLabels requires the name to be set to `*`."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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. MatchLabels requires the name to be set to `*`."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + '#withName':: d.fn(help='"Name of the referent If multiple resources are targeted `*` may be set."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + }, + '#secretRef':: d.obj(help='"SecretRef specifies the Secret containing the token used to validate the payload authenticity."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#withEvents':: d.fn(help="\"Events specifies the list of event types to handle, e.g. 'push' for GitHub or 'Push Hook' for GitLab.\"", args=[d.arg(name='events', type=d.T.array)]), + withEvents(events): { spec+: { events: if std.isArray(v=events) then events else [events] } }, + '#withEventsMixin':: d.fn(help="\"Events specifies the list of event types to handle, e.g. 'push' for GitHub or 'Push Hook' for GitLab.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='events', type=d.T.array)]), + withEventsMixin(events): { spec+: { events+: if std.isArray(v=events) then events else [events] } }, + '#withInterval':: d.fn(help='"Interval at which to reconcile the Receiver with its Secret references."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withResources':: d.fn(help='"A list of resources to be notified about changes."', args=[d.arg(name='resources', type=d.T.array)]), + withResources(resources): { spec+: { resources: if std.isArray(v=resources) then resources else [resources] } }, + '#withResourcesMixin':: d.fn(help='"A list of resources to be notified about changes."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='resources', type=d.T.array)]), + withResourcesMixin(resources): { spec+: { resources+: if std.isArray(v=resources) then resources else [resources] } }, + '#withSuspend':: d.fn(help='"Suspend tells the controller to suspend subsequent events handling for this receiver."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withType':: d.fn(help='"Type of webhook sender, used to determine the validation procedure and payload deserialization."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { type: type } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/notification/v1beta3/alert.libsonnet b/2.2.1/_gen/notification/v1beta3/alert.libsonnet new file mode 100644 index 0000000..2889916 --- /dev/null +++ b/2.2.1/_gen/notification/v1beta3/alert.libsonnet @@ -0,0 +1,97 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='alert', url='', help='"Alert is the Schema for the alerts API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Alert', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'notification.toolkit.fluxcd.io/v1beta3', + kind: 'Alert', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"AlertSpec defines an alerting rule for events involving a list of objects."'), + spec: { + '#eventSources':: d.obj(help='"EventSources specifies how to filter events based on the involved object kind, name and namespace."'), + eventSources: { + '#withApiVersion':: d.fn(help='"API version of the referent"', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { apiVersion: apiVersion }, + '#withKind':: d.fn(help='"Kind of the referent"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { kind: kind }, + '#withMatchLabels':: d.fn(help='"MatchLabels 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. MatchLabels requires the name to be set to `*`."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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. MatchLabels requires the name to be set to `*`."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + '#withName':: d.fn(help='"Name of the referent If multiple resources are targeted `*` may be set."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + }, + '#providerRef':: d.obj(help='"ProviderRef specifies which Provider this Alert should use."'), + providerRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { providerRef+: { name: name } } }, + }, + '#withEventMetadata':: d.fn(help="\"EventMetadata is an optional field for adding metadata to events dispatched by the controller. This can be used for enhancing the context of the event. If a field would override one already present on the original event as generated by the emitter, then the override doesn't happen, i.e. the original value is preserved, and an info log is printed.\"", args=[d.arg(name='eventMetadata', type=d.T.object)]), + withEventMetadata(eventMetadata): { spec+: { eventMetadata: eventMetadata } }, + '#withEventMetadataMixin':: d.fn(help="\"EventMetadata is an optional field for adding metadata to events dispatched by the controller. This can be used for enhancing the context of the event. If a field would override one already present on the original event as generated by the emitter, then the override doesn't happen, i.e. the original value is preserved, and an info log is printed.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='eventMetadata', type=d.T.object)]), + withEventMetadataMixin(eventMetadata): { spec+: { eventMetadata+: eventMetadata } }, + '#withEventSeverity':: d.fn(help="\"EventSeverity specifies how to filter events based on severity. If set to 'info' no events will be filtered.\"", args=[d.arg(name='eventSeverity', type=d.T.string)]), + withEventSeverity(eventSeverity): { spec+: { eventSeverity: eventSeverity } }, + '#withEventSources':: d.fn(help='"EventSources specifies how to filter events based on the involved object kind, name and namespace."', args=[d.arg(name='eventSources', type=d.T.array)]), + withEventSources(eventSources): { spec+: { eventSources: if std.isArray(v=eventSources) then eventSources else [eventSources] } }, + '#withEventSourcesMixin':: d.fn(help='"EventSources specifies how to filter events based on the involved object kind, name and namespace."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='eventSources', type=d.T.array)]), + withEventSourcesMixin(eventSources): { spec+: { eventSources+: if std.isArray(v=eventSources) then eventSources else [eventSources] } }, + '#withExclusionList':: d.fn(help='"ExclusionList specifies a list of Golang regular expressions to be used for excluding messages."', args=[d.arg(name='exclusionList', type=d.T.array)]), + withExclusionList(exclusionList): { spec+: { exclusionList: if std.isArray(v=exclusionList) then exclusionList else [exclusionList] } }, + '#withExclusionListMixin':: d.fn(help='"ExclusionList specifies a list of Golang regular expressions to be used for excluding messages."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='exclusionList', type=d.T.array)]), + withExclusionListMixin(exclusionList): { spec+: { exclusionList+: if std.isArray(v=exclusionList) then exclusionList else [exclusionList] } }, + '#withInclusionList':: d.fn(help='"InclusionList specifies a list of Golang regular expressions to be used for including messages."', args=[d.arg(name='inclusionList', type=d.T.array)]), + withInclusionList(inclusionList): { spec+: { inclusionList: if std.isArray(v=inclusionList) then inclusionList else [inclusionList] } }, + '#withInclusionListMixin':: d.fn(help='"InclusionList specifies a list of Golang regular expressions to be used for including messages."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='inclusionList', type=d.T.array)]), + withInclusionListMixin(inclusionList): { spec+: { inclusionList+: if std.isArray(v=inclusionList) then inclusionList else [inclusionList] } }, + '#withSummary':: d.fn(help='"Summary holds a short description of the impact and affected cluster."', args=[d.arg(name='summary', type=d.T.string)]), + withSummary(summary): { spec+: { summary: summary } }, + '#withSuspend':: d.fn(help='"Suspend tells the controller to suspend subsequent events handling for this Alert."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/notification/v1beta3/main.libsonnet b/2.2.1/_gen/notification/v1beta3/main.libsonnet new file mode 100644 index 0000000..6d78ab3 --- /dev/null +++ b/2.2.1/_gen/notification/v1beta3/main.libsonnet @@ -0,0 +1,6 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1beta3', url='', help=''), + alert: (import 'alert.libsonnet'), + provider: (import 'provider.libsonnet'), +} diff --git a/2.2.1/_gen/notification/v1beta3/provider.libsonnet b/2.2.1/_gen/notification/v1beta3/provider.libsonnet new file mode 100644 index 0000000..5cc0917 --- /dev/null +++ b/2.2.1/_gen/notification/v1beta3/provider.libsonnet @@ -0,0 +1,81 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='provider', url='', help='"Provider is the Schema for the providers API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Provider', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'notification.toolkit.fluxcd.io/v1beta3', + kind: 'Provider', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ProviderSpec defines the desired state of the Provider."'), + spec: { + '#certSecretRef':: d.obj(help='"CertSecretRef specifies the Secret containing a PEM-encoded CA certificate (in the `ca.crt` key). \\n Note: Support for the `caFile` key has been deprecated."'), + certSecretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { certSecretRef+: { name: name } } }, + }, + '#secretRef':: d.obj(help='"SecretRef specifies the Secret containing the authentication credentials for this Provider."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#withAddress':: d.fn(help='"Address specifies the endpoint, in a generic sense, to where alerts are sent. What kind of endpoint depends on the specific Provider type being used. For the generic Provider, for example, this is an HTTP/S address. For other Provider types this could be a project ID or a namespace."', args=[d.arg(name='address', type=d.T.string)]), + withAddress(address): { spec+: { address: address } }, + '#withChannel':: d.fn(help='"Channel specifies the destination channel where events should be posted."', args=[d.arg(name='channel', type=d.T.string)]), + withChannel(channel): { spec+: { channel: channel } }, + '#withInterval':: d.fn(help='"Interval at which to reconcile the Provider with its Secret references. Deprecated and not used in v1beta3."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withProxy':: d.fn(help='"Proxy the HTTP/S address of the proxy server."', args=[d.arg(name='proxy', type=d.T.string)]), + withProxy(proxy): { spec+: { proxy: proxy } }, + '#withSuspend':: d.fn(help='"Suspend tells the controller to suspend subsequent events handling for this Provider."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTimeout':: d.fn(help='"Timeout for sending alerts to the Provider."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + '#withType':: d.fn(help='"Type specifies which Provider implementation to use."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { type: type } }, + '#withUsername':: d.fn(help='"Username specifies the name under which events are posted."', args=[d.arg(name='username', type=d.T.string)]), + withUsername(username): { spec+: { username: username } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/source/main.libsonnet b/2.2.1/_gen/source/main.libsonnet new file mode 100644 index 0000000..7544093 --- /dev/null +++ b/2.2.1/_gen/source/main.libsonnet @@ -0,0 +1,7 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='source', url='', help=''), + v1: (import 'v1/main.libsonnet'), + v1beta1: (import 'v1beta1/main.libsonnet'), + v1beta2: (import 'v1beta2/main.libsonnet'), +} diff --git a/2.2.1/_gen/source/v1/gitRepository.libsonnet b/2.2.1/_gen/source/v1/gitRepository.libsonnet new file mode 100644 index 0000000..52db6a9 --- /dev/null +++ b/2.2.1/_gen/source/v1/gitRepository.libsonnet @@ -0,0 +1,116 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='gitRepository', url='', help='"GitRepository is the Schema for the gitrepositories API."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of GitRepository', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'source.toolkit.fluxcd.io/v1', + kind: 'GitRepository', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"GitRepositorySpec specifies the required configuration to produce an Artifact for a Git repository."'), + spec: { + '#include':: d.obj(help='"Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository."'), + include: { + '#repository':: d.obj(help='"GitRepositoryRef specifies the GitRepository which Artifact contents must be included."'), + repository: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { repository+: { name: name } }, + }, + '#withFromPath':: d.fn(help='"FromPath specifies the path to copy contents from, defaults to the root of the Artifact."', args=[d.arg(name='fromPath', type=d.T.string)]), + withFromPath(fromPath): { fromPath: fromPath }, + '#withToPath':: d.fn(help='"ToPath specifies the path to copy contents to, defaults to the name of the GitRepositoryRef."', args=[d.arg(name='toPath', type=d.T.string)]), + withToPath(toPath): { toPath: toPath }, + }, + '#proxySecretRef':: d.obj(help='"ProxySecretRef specifies the Secret containing the proxy configuration to use while communicating with the Git server."'), + proxySecretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { proxySecretRef+: { name: name } } }, + }, + '#ref':: d.obj(help="\"Reference specifies the Git reference to resolve and monitor for changes, defaults to the 'master' branch.\""), + ref: { + '#withBranch':: d.fn(help="\"Branch to check out, defaults to 'master' if no other field is defined.\"", args=[d.arg(name='branch', type=d.T.string)]), + withBranch(branch): { spec+: { ref+: { branch: branch } } }, + '#withCommit':: d.fn(help='"Commit SHA to check out, takes precedence over all reference fields. \\n This can be combined with Branch to shallow clone the branch, in which the commit is expected to exist."', args=[d.arg(name='commit', type=d.T.string)]), + withCommit(commit): { spec+: { ref+: { commit: commit } } }, + '#withName':: d.fn(help='"Name of the reference to check out; takes precedence over Branch, Tag and SemVer. \\n It must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description Examples: \\"refs/heads/main\\", \\"refs/tags/v0.1.0\\", \\"refs/pull/420/head\\", \\"refs/merge-requests/1/head\\', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { ref+: { name: name } } }, + '#withSemver':: d.fn(help='"SemVer tag expression to check out, takes precedence over Tag."', args=[d.arg(name='semver', type=d.T.string)]), + withSemver(semver): { spec+: { ref+: { semver: semver } } }, + '#withTag':: d.fn(help='"Tag to check out, takes precedence over Branch."', args=[d.arg(name='tag', type=d.T.string)]), + withTag(tag): { spec+: { ref+: { tag: tag } } }, + }, + '#secretRef':: d.obj(help="\"SecretRef specifies the Secret containing authentication credentials for the GitRepository. For HTTPS repositories the Secret must contain 'username' and 'password' fields for basic auth or 'bearerToken' field for token auth. For SSH repositories the Secret must contain 'identity' and 'known_hosts' fields.\""), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#verify':: d.obj(help='"Verification specifies the configuration to verify the Git commit signature(s)."'), + verify: { + '#secretRef':: d.obj(help='"SecretRef specifies the Secret containing the public keys of trusted Git authors."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { verify+: { secretRef+: { name: name } } } }, + }, + '#withMode':: d.fn(help='"Mode specifies which Git object(s) should be verified. \\n The variants \\"head\\" and \\"HEAD\\" both imply the same thing, i.e. verify the commit that the HEAD of the Git repository points to. The variant \\"head\\" solely exists to ensure backwards compatibility."', args=[d.arg(name='mode', type=d.T.string)]), + withMode(mode): { spec+: { verify+: { mode: mode } } }, + }, + '#withIgnore':: d.fn(help='"Ignore 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."', args=[d.arg(name='ignore', type=d.T.string)]), + withIgnore(ignore): { spec+: { ignore: ignore } }, + '#withInclude':: d.fn(help='"Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository."', args=[d.arg(name='include', type=d.T.array)]), + withInclude(include): { spec+: { include: if std.isArray(v=include) then include else [include] } }, + '#withIncludeMixin':: d.fn(help='"Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='include', type=d.T.array)]), + withIncludeMixin(include): { spec+: { include+: if std.isArray(v=include) then include else [include] } }, + '#withInterval':: d.fn(help='"Interval at which the GitRepository URL is checked for updates. This interval is approximate and may be subject to jitter to ensure efficient use of resources."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withRecurseSubmodules':: d.fn(help='"RecurseSubmodules enables the initialization of all submodules within the GitRepository as cloned from the URL, using their default settings."', args=[d.arg(name='recurseSubmodules', type=d.T.boolean)]), + withRecurseSubmodules(recurseSubmodules): { spec+: { recurseSubmodules: recurseSubmodules } }, + '#withSuspend':: d.fn(help='"Suspend tells the controller to suspend the reconciliation of this GitRepository."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTimeout':: d.fn(help='"Timeout for Git operations like cloning, defaults to 60s."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + '#withUrl':: d.fn(help='"URL specifies the Git repository URL, it can be an HTTP/S or SSH address."', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { spec+: { url: url } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/source/v1/main.libsonnet b/2.2.1/_gen/source/v1/main.libsonnet new file mode 100644 index 0000000..c71be83 --- /dev/null +++ b/2.2.1/_gen/source/v1/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1', url='', help=''), + gitRepository: (import 'gitRepository.libsonnet'), +} diff --git a/2.2.1/_gen/source/v1beta1/bucket.libsonnet b/2.2.1/_gen/source/v1beta1/bucket.libsonnet new file mode 100644 index 0000000..491c8e2 --- /dev/null +++ b/2.2.1/_gen/source/v1beta1/bucket.libsonnet @@ -0,0 +1,92 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='bucket', url='', help='"Bucket is the Schema for the buckets API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Bucket', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'source.toolkit.fluxcd.io/v1beta1', + kind: 'Bucket', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"BucketSpec defines the desired state of an S3 compatible bucket"'), + spec: { + '#accessFrom':: d.obj(help='"AccessFrom defines an Access Control List for allowing cross-namespace references to this object."'), + accessFrom: { + '#namespaceSelectors':: d.obj(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."'), + namespaceSelectors: { + '#withMatchLabels':: d.fn(help='"MatchLabels 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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + }, + '#withNamespaceSelectors':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectors(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + '#withNamespaceSelectorsMixin':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectorsMixin(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors+: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + }, + '#secretRef':: d.obj(help='"The name of the secret containing authentication credentials for the Bucket."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#withBucketName':: d.fn(help='"The bucket name."', args=[d.arg(name='bucketName', type=d.T.string)]), + withBucketName(bucketName): { spec+: { bucketName: bucketName } }, + '#withEndpoint':: d.fn(help='"The bucket endpoint address."', args=[d.arg(name='endpoint', type=d.T.string)]), + withEndpoint(endpoint): { spec+: { endpoint: endpoint } }, + '#withIgnore':: d.fn(help='"Ignore 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."', args=[d.arg(name='ignore', type=d.T.string)]), + withIgnore(ignore): { spec+: { ignore: ignore } }, + '#withInsecure':: d.fn(help='"Insecure allows connecting to a non-TLS S3 HTTP endpoint."', args=[d.arg(name='insecure', type=d.T.boolean)]), + withInsecure(insecure): { spec+: { insecure: insecure } }, + '#withInterval':: d.fn(help='"The interval at which to check for bucket updates."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withProvider':: d.fn(help="\"The S3 compatible storage provider name, default ('generic').\"", args=[d.arg(name='provider', type=d.T.string)]), + withProvider(provider): { spec+: { provider: provider } }, + '#withRegion':: d.fn(help='"The bucket region."', args=[d.arg(name='region', type=d.T.string)]), + withRegion(region): { spec+: { region: region } }, + '#withSuspend':: d.fn(help='"This flag tells the controller to suspend the reconciliation of this source."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTimeout':: d.fn(help='"The timeout for download operations, defaults to 60s."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/source/v1beta1/gitRepository.libsonnet b/2.2.1/_gen/source/v1beta1/gitRepository.libsonnet new file mode 100644 index 0000000..aa2a81c --- /dev/null +++ b/2.2.1/_gen/source/v1beta1/gitRepository.libsonnet @@ -0,0 +1,125 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='gitRepository', url='', help='"GitRepository is the Schema for the gitrepositories API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of GitRepository', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'source.toolkit.fluxcd.io/v1beta1', + kind: 'GitRepository', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"GitRepositorySpec defines the desired state of a Git repository."'), + spec: { + '#accessFrom':: d.obj(help='"AccessFrom defines an Access Control List for allowing cross-namespace references to this object."'), + accessFrom: { + '#namespaceSelectors':: d.obj(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."'), + namespaceSelectors: { + '#withMatchLabels':: d.fn(help='"MatchLabels 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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + }, + '#withNamespaceSelectors':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectors(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + '#withNamespaceSelectorsMixin':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectorsMixin(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors+: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + }, + '#include':: d.obj(help='"Extra git repositories to map into the repository"'), + include: { + '#repository':: d.obj(help='"Reference to a GitRepository to include."'), + repository: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { repository+: { name: name } }, + }, + '#withFromPath':: d.fn(help='"The path to copy contents from, defaults to the root directory."', args=[d.arg(name='fromPath', type=d.T.string)]), + withFromPath(fromPath): { fromPath: fromPath }, + '#withToPath':: d.fn(help='"The path to copy contents to, defaults to the name of the source ref."', args=[d.arg(name='toPath', type=d.T.string)]), + withToPath(toPath): { toPath: toPath }, + }, + '#ref':: d.obj(help='"The Git reference to checkout and monitor for changes, defaults to master branch."'), + ref: { + '#withBranch':: d.fn(help='"The Git branch to checkout, defaults to master."', args=[d.arg(name='branch', type=d.T.string)]), + withBranch(branch): { spec+: { ref+: { branch: branch } } }, + '#withCommit':: d.fn(help='"The Git commit SHA to checkout, if specified Tag filters will be ignored."', args=[d.arg(name='commit', type=d.T.string)]), + withCommit(commit): { spec+: { ref+: { commit: commit } } }, + '#withSemver':: d.fn(help='"The Git tag semver expression, takes precedence over Tag."', args=[d.arg(name='semver', type=d.T.string)]), + withSemver(semver): { spec+: { ref+: { semver: semver } } }, + '#withTag':: d.fn(help='"The Git tag to checkout, takes precedence over Branch."', args=[d.arg(name='tag', type=d.T.string)]), + withTag(tag): { spec+: { ref+: { tag: tag } } }, + }, + '#secretRef':: d.obj(help='"The secret name containing the Git credentials. For HTTPS repositories the secret must contain username and password fields. For SSH repositories the secret must contain identity and known_hosts fields."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#verify':: d.obj(help='"Verify OpenPGP signature for the Git commit HEAD points to."'), + verify: { + '#secretRef':: d.obj(help='"The secret name containing the public keys of all trusted Git authors."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { verify+: { secretRef+: { name: name } } } }, + }, + '#withMode':: d.fn(help="\"Mode describes what git object should be verified, currently ('head').\"", args=[d.arg(name='mode', type=d.T.string)]), + withMode(mode): { spec+: { verify+: { mode: mode } } }, + }, + '#withGitImplementation':: d.fn(help="\"Determines which git client library to use. Defaults to go-git, valid values are ('go-git', 'libgit2').\"", args=[d.arg(name='gitImplementation', type=d.T.string)]), + withGitImplementation(gitImplementation): { spec+: { gitImplementation: gitImplementation } }, + '#withIgnore':: d.fn(help='"Ignore 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."', args=[d.arg(name='ignore', type=d.T.string)]), + withIgnore(ignore): { spec+: { ignore: ignore } }, + '#withInclude':: d.fn(help='"Extra git repositories to map into the repository"', args=[d.arg(name='include', type=d.T.array)]), + withInclude(include): { spec+: { include: if std.isArray(v=include) then include else [include] } }, + '#withIncludeMixin':: d.fn(help='"Extra git repositories to map into the repository"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='include', type=d.T.array)]), + withIncludeMixin(include): { spec+: { include+: if std.isArray(v=include) then include else [include] } }, + '#withInterval':: d.fn(help='"The interval at which to check for repository updates."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withRecurseSubmodules':: d.fn(help="\"When enabled, after the clone is created, initializes all submodules within, using their default settings. This option is available only when using the 'go-git' GitImplementation.\"", args=[d.arg(name='recurseSubmodules', type=d.T.boolean)]), + withRecurseSubmodules(recurseSubmodules): { spec+: { recurseSubmodules: recurseSubmodules } }, + '#withSuspend':: d.fn(help='"This flag tells the controller to suspend the reconciliation of this source."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTimeout':: d.fn(help='"The timeout for remote Git operations like cloning, defaults to 60s."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + '#withUrl':: d.fn(help='"The repository URL, can be a HTTP/S or SSH address."', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { spec+: { url: url } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/source/v1beta1/helmChart.libsonnet b/2.2.1/_gen/source/v1beta1/helmChart.libsonnet new file mode 100644 index 0000000..f0c2b69 --- /dev/null +++ b/2.2.1/_gen/source/v1beta1/helmChart.libsonnet @@ -0,0 +1,94 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='helmChart', url='', help='"HelmChart is the Schema for the helmcharts API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of HelmChart', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'source.toolkit.fluxcd.io/v1beta1', + kind: 'HelmChart', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"HelmChartSpec defines the desired state of a Helm chart."'), + spec: { + '#accessFrom':: d.obj(help='"AccessFrom defines an Access Control List for allowing cross-namespace references to this object."'), + accessFrom: { + '#namespaceSelectors':: d.obj(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."'), + namespaceSelectors: { + '#withMatchLabels':: d.fn(help='"MatchLabels 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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + }, + '#withNamespaceSelectors':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectors(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + '#withNamespaceSelectorsMixin':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectorsMixin(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors+: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + }, + '#sourceRef':: d.obj(help='"The reference to the Source the chart is available at."'), + sourceRef: { + '#withApiVersion':: d.fn(help='"APIVersion of the referent."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { spec+: { sourceRef+: { apiVersion: apiVersion } } }, + '#withKind':: d.fn(help="\"Kind of the referent, valid values are ('HelmRepository', 'GitRepository', 'Bucket').\"", args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { sourceRef+: { kind: kind } } }, + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { sourceRef+: { name: name } } }, + }, + '#withChart':: d.fn(help='"The name or path the Helm chart is available at in the SourceRef."', args=[d.arg(name='chart', type=d.T.string)]), + withChart(chart): { spec+: { chart: chart } }, + '#withInterval':: d.fn(help='"The interval at which to check the Source for updates."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withReconcileStrategy':: d.fn(help="\"Determines what enables the creation of a new artifact. Valid values are ('ChartVersion', 'Revision'). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted.\"", args=[d.arg(name='reconcileStrategy', type=d.T.string)]), + withReconcileStrategy(reconcileStrategy): { spec+: { reconcileStrategy: reconcileStrategy } }, + '#withSuspend':: d.fn(help='"This flag tells the controller to suspend the reconciliation of this source."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withValuesFile':: d.fn(help='"Alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Deprecated in favor of ValuesFiles, for backwards compatibility the file defined here is merged before the ValuesFiles items. Ignored when omitted."', args=[d.arg(name='valuesFile', type=d.T.string)]), + withValuesFile(valuesFile): { spec+: { valuesFile: valuesFile } }, + '#withValuesFiles':: d.fn(help='"Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted."', args=[d.arg(name='valuesFiles', type=d.T.array)]), + withValuesFiles(valuesFiles): { spec+: { valuesFiles: if std.isArray(v=valuesFiles) then valuesFiles else [valuesFiles] } }, + '#withValuesFilesMixin':: d.fn(help='"Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='valuesFiles', type=d.T.array)]), + withValuesFilesMixin(valuesFiles): { spec+: { valuesFiles+: if std.isArray(v=valuesFiles) then valuesFiles else [valuesFiles] } }, + '#withVersion':: d.fn(help='"The chart version semver expression, ignored for charts from GitRepository and Bucket sources. Defaults to latest when omitted."', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { spec+: { version: version } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/source/v1beta1/helmRepository.libsonnet b/2.2.1/_gen/source/v1beta1/helmRepository.libsonnet new file mode 100644 index 0000000..be7e88c --- /dev/null +++ b/2.2.1/_gen/source/v1beta1/helmRepository.libsonnet @@ -0,0 +1,84 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='helmRepository', url='', help='"HelmRepository is the Schema for the helmrepositories API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of HelmRepository', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'source.toolkit.fluxcd.io/v1beta1', + kind: 'HelmRepository', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"HelmRepositorySpec defines the reference to a Helm repository."'), + spec: { + '#accessFrom':: d.obj(help='"AccessFrom defines an Access Control List for allowing cross-namespace references to this object."'), + accessFrom: { + '#namespaceSelectors':: d.obj(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."'), + namespaceSelectors: { + '#withMatchLabels':: d.fn(help='"MatchLabels 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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + }, + '#withNamespaceSelectors':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectors(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + '#withNamespaceSelectorsMixin':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectorsMixin(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors+: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + }, + '#secretRef':: d.obj(help='"The name of the secret containing authentication credentials for the Helm repository. For HTTP/S basic auth the secret must contain username and password fields. For TLS the secret must contain a certFile and keyFile, and/or caFile fields."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#withInterval':: d.fn(help='"The interval at which to check the upstream for updates."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withPassCredentials':: d.fn(help='"PassCredentials 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."', args=[d.arg(name='passCredentials', type=d.T.boolean)]), + withPassCredentials(passCredentials): { spec+: { passCredentials: passCredentials } }, + '#withSuspend':: d.fn(help='"This flag tells the controller to suspend the reconciliation of this source."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTimeout':: d.fn(help='"The timeout of index downloading, defaults to 60s."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + '#withUrl':: d.fn(help='"The Helm repository URL, a valid URL contains at least a protocol and host."', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { spec+: { url: url } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/source/v1beta1/main.libsonnet b/2.2.1/_gen/source/v1beta1/main.libsonnet new file mode 100644 index 0000000..e064f75 --- /dev/null +++ b/2.2.1/_gen/source/v1beta1/main.libsonnet @@ -0,0 +1,8 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1beta1', url='', help=''), + bucket: (import 'bucket.libsonnet'), + gitRepository: (import 'gitRepository.libsonnet'), + helmChart: (import 'helmChart.libsonnet'), + helmRepository: (import 'helmRepository.libsonnet'), +} diff --git a/2.2.1/_gen/source/v1beta2/bucket.libsonnet b/2.2.1/_gen/source/v1beta2/bucket.libsonnet new file mode 100644 index 0000000..2e9be4f --- /dev/null +++ b/2.2.1/_gen/source/v1beta2/bucket.libsonnet @@ -0,0 +1,94 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='bucket', url='', help='"Bucket is the Schema for the buckets API."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Bucket', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'source.toolkit.fluxcd.io/v1beta2', + kind: 'Bucket', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"BucketSpec specifies the required configuration to produce an Artifact for an object storage bucket."'), + spec: { + '#accessFrom':: d.obj(help='"AccessFrom 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"'), + accessFrom: { + '#namespaceSelectors':: d.obj(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."'), + namespaceSelectors: { + '#withMatchLabels':: d.fn(help='"MatchLabels 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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + }, + '#withNamespaceSelectors':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectors(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + '#withNamespaceSelectorsMixin':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectorsMixin(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors+: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + }, + '#secretRef':: d.obj(help='"SecretRef specifies the Secret containing authentication credentials for the Bucket."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#withBucketName':: d.fn(help='"BucketName is the name of the object storage bucket."', args=[d.arg(name='bucketName', type=d.T.string)]), + withBucketName(bucketName): { spec+: { bucketName: bucketName } }, + '#withEndpoint':: d.fn(help='"Endpoint is the object storage address the BucketName is located at."', args=[d.arg(name='endpoint', type=d.T.string)]), + withEndpoint(endpoint): { spec+: { endpoint: endpoint } }, + '#withIgnore':: d.fn(help='"Ignore 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."', args=[d.arg(name='ignore', type=d.T.string)]), + withIgnore(ignore): { spec+: { ignore: ignore } }, + '#withInsecure':: d.fn(help='"Insecure allows connecting to a non-TLS HTTP Endpoint."', args=[d.arg(name='insecure', type=d.T.boolean)]), + withInsecure(insecure): { spec+: { insecure: insecure } }, + '#withInterval':: d.fn(help='"Interval at which the Bucket Endpoint is checked for updates. This interval is approximate and may be subject to jitter to ensure efficient use of resources."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withPrefix':: d.fn(help='"Prefix to use for server-side filtering of files in the Bucket."', args=[d.arg(name='prefix', type=d.T.string)]), + withPrefix(prefix): { spec+: { prefix: prefix } }, + '#withProvider':: d.fn(help="\"Provider of the object storage bucket. Defaults to 'generic', which expects an S3 (API) compatible object storage.\"", args=[d.arg(name='provider', type=d.T.string)]), + withProvider(provider): { spec+: { provider: provider } }, + '#withRegion':: d.fn(help='"Region of the Endpoint where the BucketName is located in."', args=[d.arg(name='region', type=d.T.string)]), + withRegion(region): { spec+: { region: region } }, + '#withSuspend':: d.fn(help='"Suspend tells the controller to suspend the reconciliation of this Bucket."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTimeout':: d.fn(help='"Timeout for fetch operations, defaults to 60s."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/source/v1beta2/gitRepository.libsonnet b/2.2.1/_gen/source/v1beta2/gitRepository.libsonnet new file mode 100644 index 0000000..c93ffec --- /dev/null +++ b/2.2.1/_gen/source/v1beta2/gitRepository.libsonnet @@ -0,0 +1,127 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='gitRepository', url='', help='"GitRepository is the Schema for the gitrepositories API."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of GitRepository', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'source.toolkit.fluxcd.io/v1beta2', + kind: 'GitRepository', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"GitRepositorySpec specifies the required configuration to produce an Artifact for a Git repository."'), + spec: { + '#accessFrom':: d.obj(help='"AccessFrom 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"'), + accessFrom: { + '#namespaceSelectors':: d.obj(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."'), + namespaceSelectors: { + '#withMatchLabels':: d.fn(help='"MatchLabels 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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + }, + '#withNamespaceSelectors':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectors(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + '#withNamespaceSelectorsMixin':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectorsMixin(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors+: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + }, + '#include':: d.obj(help='"Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository."'), + include: { + '#repository':: d.obj(help='"GitRepositoryRef specifies the GitRepository which Artifact contents must be included."'), + repository: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { repository+: { name: name } }, + }, + '#withFromPath':: d.fn(help='"FromPath specifies the path to copy contents from, defaults to the root of the Artifact."', args=[d.arg(name='fromPath', type=d.T.string)]), + withFromPath(fromPath): { fromPath: fromPath }, + '#withToPath':: d.fn(help='"ToPath specifies the path to copy contents to, defaults to the name of the GitRepositoryRef."', args=[d.arg(name='toPath', type=d.T.string)]), + withToPath(toPath): { toPath: toPath }, + }, + '#ref':: d.obj(help="\"Reference specifies the Git reference to resolve and monitor for changes, defaults to the 'master' branch.\""), + ref: { + '#withBranch':: d.fn(help="\"Branch to check out, defaults to 'master' if no other field is defined.\"", args=[d.arg(name='branch', type=d.T.string)]), + withBranch(branch): { spec+: { ref+: { branch: branch } } }, + '#withCommit':: d.fn(help='"Commit SHA to check out, takes precedence over all reference fields. \\n This can be combined with Branch to shallow clone the branch, in which the commit is expected to exist."', args=[d.arg(name='commit', type=d.T.string)]), + withCommit(commit): { spec+: { ref+: { commit: commit } } }, + '#withName':: d.fn(help='"Name of the reference to check out; takes precedence over Branch, Tag and SemVer. \\n It must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description Examples: \\"refs/heads/main\\", \\"refs/tags/v0.1.0\\", \\"refs/pull/420/head\\", \\"refs/merge-requests/1/head\\', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { ref+: { name: name } } }, + '#withSemver':: d.fn(help='"SemVer tag expression to check out, takes precedence over Tag."', args=[d.arg(name='semver', type=d.T.string)]), + withSemver(semver): { spec+: { ref+: { semver: semver } } }, + '#withTag':: d.fn(help='"Tag to check out, takes precedence over Branch."', args=[d.arg(name='tag', type=d.T.string)]), + withTag(tag): { spec+: { ref+: { tag: tag } } }, + }, + '#secretRef':: d.obj(help="\"SecretRef specifies the Secret containing authentication credentials for the GitRepository. For HTTPS repositories the Secret must contain 'username' and 'password' fields for basic auth or 'bearerToken' field for token auth. For SSH repositories the Secret must contain 'identity' and 'known_hosts' fields.\""), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#verify':: d.obj(help='"Verification specifies the configuration to verify the Git commit signature(s)."'), + verify: { + '#secretRef':: d.obj(help='"SecretRef specifies the Secret containing the public keys of trusted Git authors."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { verify+: { secretRef+: { name: name } } } }, + }, + '#withMode':: d.fn(help="\"Mode specifies what Git object should be verified, currently ('head').\"", args=[d.arg(name='mode', type=d.T.string)]), + withMode(mode): { spec+: { verify+: { mode: mode } } }, + }, + '#withGitImplementation':: d.fn(help="\"GitImplementation specifies which Git client library implementation to use. Defaults to 'go-git', valid values are ('go-git', 'libgit2'). Deprecated: gitImplementation is deprecated now that 'go-git' is the only supported implementation.\"", args=[d.arg(name='gitImplementation', type=d.T.string)]), + withGitImplementation(gitImplementation): { spec+: { gitImplementation: gitImplementation } }, + '#withIgnore':: d.fn(help='"Ignore 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."', args=[d.arg(name='ignore', type=d.T.string)]), + withIgnore(ignore): { spec+: { ignore: ignore } }, + '#withInclude':: d.fn(help='"Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository."', args=[d.arg(name='include', type=d.T.array)]), + withInclude(include): { spec+: { include: if std.isArray(v=include) then include else [include] } }, + '#withIncludeMixin':: d.fn(help='"Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='include', type=d.T.array)]), + withIncludeMixin(include): { spec+: { include+: if std.isArray(v=include) then include else [include] } }, + '#withInterval':: d.fn(help='"Interval at which to check the GitRepository for updates."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withRecurseSubmodules':: d.fn(help='"RecurseSubmodules enables the initialization of all submodules within the GitRepository as cloned from the URL, using their default settings."', args=[d.arg(name='recurseSubmodules', type=d.T.boolean)]), + withRecurseSubmodules(recurseSubmodules): { spec+: { recurseSubmodules: recurseSubmodules } }, + '#withSuspend':: d.fn(help='"Suspend tells the controller to suspend the reconciliation of this GitRepository."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTimeout':: d.fn(help='"Timeout for Git operations like cloning, defaults to 60s."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + '#withUrl':: d.fn(help='"URL specifies the Git repository URL, it can be an HTTP/S or SSH address."', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { spec+: { url: url } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/source/v1beta2/helmChart.libsonnet b/2.2.1/_gen/source/v1beta2/helmChart.libsonnet new file mode 100644 index 0000000..19acf04 --- /dev/null +++ b/2.2.1/_gen/source/v1beta2/helmChart.libsonnet @@ -0,0 +1,115 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='helmChart', url='', help='"HelmChart is the Schema for the helmcharts API."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of HelmChart', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'source.toolkit.fluxcd.io/v1beta2', + kind: 'HelmChart', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"HelmChartSpec specifies the desired state of a Helm chart."'), + spec: { + '#accessFrom':: d.obj(help='"AccessFrom 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"'), + accessFrom: { + '#namespaceSelectors':: d.obj(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."'), + namespaceSelectors: { + '#withMatchLabels':: d.fn(help='"MatchLabels 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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + }, + '#withNamespaceSelectors':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectors(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + '#withNamespaceSelectorsMixin':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectorsMixin(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors+: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + }, + '#sourceRef':: d.obj(help='"SourceRef is the reference to the Source the chart is available at."'), + sourceRef: { + '#withApiVersion':: d.fn(help='"APIVersion of the referent."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { spec+: { sourceRef+: { apiVersion: apiVersion } } }, + '#withKind':: d.fn(help="\"Kind of the referent, valid values are ('HelmRepository', 'GitRepository', 'Bucket').\"", args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { sourceRef+: { kind: kind } } }, + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { sourceRef+: { name: name } } }, + }, + '#verify':: d.obj(help="\"Verify 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. This field is only supported when using HelmRepository source with spec.type 'oci'. Chart dependencies, which are not bundled in the umbrella chart artifact, are not verified.\""), + verify: { + '#matchOIDCIdentity':: d.obj(help="\"MatchOIDCIdentity 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.\""), + matchOIDCIdentity: { + '#withIssuer':: d.fn(help='"Issuer 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."', args=[d.arg(name='issuer', type=d.T.string)]), + withIssuer(issuer): { issuer: issuer }, + '#withSubject':: d.fn(help='"Subject 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."', args=[d.arg(name='subject', type=d.T.string)]), + withSubject(subject): { subject: subject }, + }, + '#secretRef':: d.obj(help='"SecretRef specifies the Kubernetes Secret containing the trusted public keys."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { verify+: { secretRef+: { name: name } } } }, + }, + '#withMatchOIDCIdentity':: d.fn(help="\"MatchOIDCIdentity 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.\"", args=[d.arg(name='matchOIDCIdentity', type=d.T.array)]), + withMatchOIDCIdentity(matchOIDCIdentity): { spec+: { verify+: { matchOIDCIdentity: if std.isArray(v=matchOIDCIdentity) then matchOIDCIdentity else [matchOIDCIdentity] } } }, + '#withMatchOIDCIdentityMixin':: d.fn(help="\"MatchOIDCIdentity 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.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchOIDCIdentity', type=d.T.array)]), + withMatchOIDCIdentityMixin(matchOIDCIdentity): { spec+: { verify+: { matchOIDCIdentity+: if std.isArray(v=matchOIDCIdentity) then matchOIDCIdentity else [matchOIDCIdentity] } } }, + '#withProvider':: d.fn(help='"Provider specifies the technology used to sign the OCI Artifact."', args=[d.arg(name='provider', type=d.T.string)]), + withProvider(provider): { spec+: { verify+: { provider: provider } } }, + }, + '#withChart':: d.fn(help='"Chart is the name or path the Helm chart is available at in the SourceRef."', args=[d.arg(name='chart', type=d.T.string)]), + withChart(chart): { spec+: { chart: chart } }, + '#withInterval':: d.fn(help='"Interval at which the HelmChart SourceRef is checked for updates. This interval is approximate and may be subject to jitter to ensure efficient use of resources."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withReconcileStrategy':: d.fn(help="\"ReconcileStrategy determines what enables the creation of a new artifact. Valid values are ('ChartVersion', 'Revision'). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted.\"", args=[d.arg(name='reconcileStrategy', type=d.T.string)]), + withReconcileStrategy(reconcileStrategy): { spec+: { reconcileStrategy: reconcileStrategy } }, + '#withSuspend':: d.fn(help='"Suspend tells the controller to suspend the reconciliation of this source."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withValuesFile':: d.fn(help='"ValuesFile is an alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Deprecated in favor of ValuesFiles, for backwards compatibility the file specified here is merged before the ValuesFiles items. Ignored when omitted."', args=[d.arg(name='valuesFile', type=d.T.string)]), + withValuesFile(valuesFile): { spec+: { valuesFile: valuesFile } }, + '#withValuesFiles':: d.fn(help='"ValuesFiles is an alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted."', args=[d.arg(name='valuesFiles', type=d.T.array)]), + withValuesFiles(valuesFiles): { spec+: { valuesFiles: if std.isArray(v=valuesFiles) then valuesFiles else [valuesFiles] } }, + '#withValuesFilesMixin':: d.fn(help='"ValuesFiles is an alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='valuesFiles', type=d.T.array)]), + withValuesFilesMixin(valuesFiles): { spec+: { valuesFiles+: if std.isArray(v=valuesFiles) then valuesFiles else [valuesFiles] } }, + '#withVersion':: d.fn(help='"Version is the chart version semver expression, ignored for charts from GitRepository and Bucket sources. Defaults to latest when omitted."', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { spec+: { version: version } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/source/v1beta2/helmRepository.libsonnet b/2.2.1/_gen/source/v1beta2/helmRepository.libsonnet new file mode 100644 index 0000000..7469eeb --- /dev/null +++ b/2.2.1/_gen/source/v1beta2/helmRepository.libsonnet @@ -0,0 +1,95 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='helmRepository', url='', help='"HelmRepository is the Schema for the helmrepositories API."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of HelmRepository', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'source.toolkit.fluxcd.io/v1beta2', + kind: 'HelmRepository', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"HelmRepositorySpec specifies the required configuration to produce an Artifact for a Helm repository index YAML."'), + spec: { + '#accessFrom':: d.obj(help='"AccessFrom 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"'), + accessFrom: { + '#namespaceSelectors':: d.obj(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."'), + namespaceSelectors: { + '#withMatchLabels':: d.fn(help='"MatchLabels 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."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { matchLabels: matchLabels }, + '#withMatchLabelsMixin':: d.fn(help='"MatchLabels 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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { matchLabels+: matchLabels }, + }, + '#withNamespaceSelectors':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectors(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + '#withNamespaceSelectorsMixin':: d.fn(help='"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='namespaceSelectors', type=d.T.array)]), + withNamespaceSelectorsMixin(namespaceSelectors): { spec+: { accessFrom+: { namespaceSelectors+: if std.isArray(v=namespaceSelectors) then namespaceSelectors else [namespaceSelectors] } } }, + }, + '#certSecretRef':: d.obj(help='"CertSecretRef can be given the name of a Secret containing either or both of \\n - a PEM-encoded client certificate (`tls.crt`) and private key (`tls.key`); - a PEM-encoded CA certificate (`ca.crt`) \\n 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`. \\n It takes precedence over the values specified in the Secret referred to by `.spec.secretRef`."'), + certSecretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { certSecretRef+: { name: name } } }, + }, + '#secretRef':: d.obj(help="\"SecretRef 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.\""), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#withInsecure':: d.fn(help="\"Insecure 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'.\"", args=[d.arg(name='insecure', type=d.T.boolean)]), + withInsecure(insecure): { spec+: { insecure: insecure } }, + '#withInterval':: d.fn(help='"Interval 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."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withPassCredentials':: d.fn(help='"PassCredentials 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."', args=[d.arg(name='passCredentials', type=d.T.boolean)]), + withPassCredentials(passCredentials): { spec+: { passCredentials: passCredentials } }, + '#withProvider':: d.fn(help="\"Provider 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'.\"", args=[d.arg(name='provider', type=d.T.string)]), + withProvider(provider): { spec+: { provider: provider } }, + '#withSuspend':: d.fn(help='"Suspend tells the controller to suspend the reconciliation of this HelmRepository."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTimeout':: d.fn(help='"Timeout 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."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + '#withType':: d.fn(help='"Type of the HelmRepository. When this field is set to \\"oci\\", the URL field value must be prefixed with \\"oci://\\"."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { type: type } }, + '#withUrl':: d.fn(help='"URL of the Helm repository, a valid URL contains at least a protocol and host."', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { spec+: { url: url } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/_gen/source/v1beta2/main.libsonnet b/2.2.1/_gen/source/v1beta2/main.libsonnet new file mode 100644 index 0000000..7309d3a --- /dev/null +++ b/2.2.1/_gen/source/v1beta2/main.libsonnet @@ -0,0 +1,9 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1beta2', url='', help=''), + bucket: (import 'bucket.libsonnet'), + gitRepository: (import 'gitRepository.libsonnet'), + helmChart: (import 'helmChart.libsonnet'), + helmRepository: (import 'helmRepository.libsonnet'), + ociRepository: (import 'ociRepository.libsonnet'), +} diff --git a/2.2.1/_gen/source/v1beta2/ociRepository.libsonnet b/2.2.1/_gen/source/v1beta2/ociRepository.libsonnet new file mode 100644 index 0000000..907084c --- /dev/null +++ b/2.2.1/_gen/source/v1beta2/ociRepository.libsonnet @@ -0,0 +1,118 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='ociRepository', url='', help='"OCIRepository is the Schema for the ocirepositories API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of OCIRepository', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'source.toolkit.fluxcd.io/v1beta2', + kind: 'OCIRepository', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"OCIRepositorySpec defines the desired state of OCIRepository"'), + spec: { + '#certSecretRef':: d.obj(help='"CertSecretRef can be given the name of a Secret containing either or both of \\n - a PEM-encoded client certificate (`tls.crt`) and private key (`tls.key`); - a PEM-encoded CA certificate (`ca.crt`) \\n 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`. \\n Note: Support for the `caFile`, `certFile` and `keyFile` keys have been deprecated."'), + certSecretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { certSecretRef+: { name: name } } }, + }, + '#layerSelector':: d.obj(help='"LayerSelector specifies which layer should be extracted from the OCI artifact. When not specified, the first layer found in the artifact is selected."'), + layerSelector: { + '#withMediaType':: d.fn(help='"MediaType specifies the OCI media type of the layer which should be extracted from the OCI Artifact. The first layer matching this type is selected."', args=[d.arg(name='mediaType', type=d.T.string)]), + withMediaType(mediaType): { spec+: { layerSelector+: { mediaType: mediaType } } }, + '#withOperation':: d.fn(help="\"Operation 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.\"", args=[d.arg(name='operation', type=d.T.string)]), + withOperation(operation): { spec+: { layerSelector+: { operation: operation } } }, + }, + '#ref':: d.obj(help='"The OCI reference to pull and monitor for changes, defaults to the latest tag."'), + ref: { + '#withDigest':: d.fn(help="\"Digest is the image digest to pull, takes precedence over SemVer. The value should be in the format 'sha256:\u003cHASH\u003e'.\"", args=[d.arg(name='digest', type=d.T.string)]), + withDigest(digest): { spec+: { ref+: { digest: digest } } }, + '#withSemver':: d.fn(help='"SemVer is the range of tags to pull selecting the latest within the range, takes precedence over Tag."', args=[d.arg(name='semver', type=d.T.string)]), + withSemver(semver): { spec+: { ref+: { semver: semver } } }, + '#withTag':: d.fn(help='"Tag is the image tag to pull, defaults to latest."', args=[d.arg(name='tag', type=d.T.string)]), + withTag(tag): { spec+: { ref+: { tag: tag } } }, + }, + '#secretRef':: d.obj(help='"SecretRef contains the secret name containing the registry login credentials to resolve image metadata. The secret must be of type kubernetes.io/dockerconfigjson."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { secretRef+: { name: name } } }, + }, + '#verify':: d.obj(help='"Verify 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."'), + verify: { + '#matchOIDCIdentity':: d.obj(help="\"MatchOIDCIdentity 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.\""), + matchOIDCIdentity: { + '#withIssuer':: d.fn(help='"Issuer 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."', args=[d.arg(name='issuer', type=d.T.string)]), + withIssuer(issuer): { issuer: issuer }, + '#withSubject':: d.fn(help='"Subject 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."', args=[d.arg(name='subject', type=d.T.string)]), + withSubject(subject): { subject: subject }, + }, + '#secretRef':: d.obj(help='"SecretRef specifies the Kubernetes Secret containing the trusted public keys."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { verify+: { secretRef+: { name: name } } } }, + }, + '#withMatchOIDCIdentity':: d.fn(help="\"MatchOIDCIdentity 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.\"", args=[d.arg(name='matchOIDCIdentity', type=d.T.array)]), + withMatchOIDCIdentity(matchOIDCIdentity): { spec+: { verify+: { matchOIDCIdentity: if std.isArray(v=matchOIDCIdentity) then matchOIDCIdentity else [matchOIDCIdentity] } } }, + '#withMatchOIDCIdentityMixin':: d.fn(help="\"MatchOIDCIdentity 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.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchOIDCIdentity', type=d.T.array)]), + withMatchOIDCIdentityMixin(matchOIDCIdentity): { spec+: { verify+: { matchOIDCIdentity+: if std.isArray(v=matchOIDCIdentity) then matchOIDCIdentity else [matchOIDCIdentity] } } }, + '#withProvider':: d.fn(help='"Provider specifies the technology used to sign the OCI Artifact."', args=[d.arg(name='provider', type=d.T.string)]), + withProvider(provider): { spec+: { verify+: { provider: provider } } }, + }, + '#withIgnore':: d.fn(help='"Ignore 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."', args=[d.arg(name='ignore', type=d.T.string)]), + withIgnore(ignore): { spec+: { ignore: ignore } }, + '#withInsecure':: d.fn(help='"Insecure allows connecting to a non-TLS HTTP container registry."', args=[d.arg(name='insecure', type=d.T.boolean)]), + withInsecure(insecure): { spec+: { insecure: insecure } }, + '#withInterval':: d.fn(help='"Interval 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."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withProvider':: d.fn(help="\"The provider used for authentication, can be 'aws', 'azure', 'gcp' or 'generic'. When not specified, defaults to 'generic'.\"", args=[d.arg(name='provider', type=d.T.string)]), + withProvider(provider): { spec+: { provider: provider } }, + '#withServiceAccountName':: d.fn(help='"ServiceAccountName 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"', args=[d.arg(name='serviceAccountName', type=d.T.string)]), + withServiceAccountName(serviceAccountName): { spec+: { serviceAccountName: serviceAccountName } }, + '#withSuspend':: d.fn(help='"This flag tells the controller to suspend the reconciliation of this source."', args=[d.arg(name='suspend', type=d.T.boolean)]), + withSuspend(suspend): { spec+: { suspend: suspend } }, + '#withTimeout':: d.fn(help='"The timeout for remote OCI Repository operations like pulling, defaults to 60s."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + '#withUrl':: d.fn(help='"URL is a reference to an OCI artifact repository hosted on a remote container registry."', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { spec+: { url: url } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/2.2.1/gen.libsonnet b/2.2.1/gen.libsonnet new file mode 100644 index 0000000..6aac12f --- /dev/null +++ b/2.2.1/gen.libsonnet @@ -0,0 +1,9 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='fluxcd', url='github.com/jsonnet-libs/fluxcd-libsonnet/2.2.1/main.libsonnet', help=''), + helm:: (import '_gen/helm/main.libsonnet'), + image:: (import '_gen/image/main.libsonnet'), + kustomize:: (import '_gen/kustomize/main.libsonnet'), + notification:: (import '_gen/notification/main.libsonnet'), + source:: (import '_gen/source/main.libsonnet'), +} diff --git a/2.2.1/main.libsonnet b/2.2.1/main.libsonnet new file mode 100644 index 0000000..f5597a5 --- /dev/null +++ b/2.2.1/main.libsonnet @@ -0,0 +1 @@ +(import 'gen.libsonnet') diff --git a/docs/2.2.1/README.md b/docs/2.2.1/README.md new file mode 100644 index 0000000..fa1d45a --- /dev/null +++ b/docs/2.2.1/README.md @@ -0,0 +1,17 @@ +--- +permalink: /2.2.1/ +--- + +# fluxcd + +```jsonnet +local fluxcd = import "github.com/jsonnet-libs/fluxcd-libsonnet/2.2.1/main.libsonnet" +``` + + + +* [helm](helm/index.md) +* [image](image/index.md) +* [kustomize](kustomize/index.md) +* [notification](notification/index.md) +* [source](source/index.md) \ No newline at end of file diff --git a/docs/2.2.1/helm/index.md b/docs/2.2.1/helm/index.md new file mode 100644 index 0000000..e5c8ecd --- /dev/null +++ b/docs/2.2.1/helm/index.md @@ -0,0 +1,10 @@ +--- +permalink: /2.2.1/helm/ +--- + +# helm + + + +* [v2beta1](v2beta1/index.md) +* [v2beta2](v2beta2/index.md) \ No newline at end of file diff --git a/docs/2.2.1/helm/v2beta1/helmRelease.md b/docs/2.2.1/helm/v2beta1/helmRelease.md new file mode 100644 index 0000000..4849ce2 --- /dev/null +++ b/docs/2.2.1/helm/v2beta1/helmRelease.md @@ -0,0 +1,1519 @@ +--- +permalink: /2.2.1/helm/v2beta1/helmRelease/ +--- + +# helm.v2beta1.helmRelease + +"HelmRelease is the Schema for the helmreleases API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withDependsOn(dependsOn)`](#fn-specwithdependson) + * [`fn withDependsOnMixin(dependsOn)`](#fn-specwithdependsonmixin) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withMaxHistory(maxHistory)`](#fn-specwithmaxhistory) + * [`fn withPersistentClient(persistentClient)`](#fn-specwithpersistentclient) + * [`fn withPostRenderers(postRenderers)`](#fn-specwithpostrenderers) + * [`fn withPostRenderersMixin(postRenderers)`](#fn-specwithpostrenderersmixin) + * [`fn withReleaseName(releaseName)`](#fn-specwithreleasename) + * [`fn withServiceAccountName(serviceAccountName)`](#fn-specwithserviceaccountname) + * [`fn withStorageNamespace(storageNamespace)`](#fn-specwithstoragenamespace) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTargetNamespace(targetNamespace)`](#fn-specwithtargetnamespace) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`fn withValues(values)`](#fn-specwithvalues) + * [`fn withValuesFrom(valuesFrom)`](#fn-specwithvaluesfrom) + * [`fn withValuesFromMixin(valuesFrom)`](#fn-specwithvaluesfrommixin) + * [`obj spec.chart`](#obj-specchart) + * [`obj spec.chart.metadata`](#obj-specchartmetadata) + * [`fn withAnnotations(annotations)`](#fn-specchartmetadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-specchartmetadatawithannotationsmixin) + * [`fn withLabels(labels)`](#fn-specchartmetadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-specchartmetadatawithlabelsmixin) + * [`obj spec.chart.spec`](#obj-specchartspec) + * [`fn withChart(chart)`](#fn-specchartspecwithchart) + * [`fn withInterval(interval)`](#fn-specchartspecwithinterval) + * [`fn withReconcileStrategy(reconcileStrategy)`](#fn-specchartspecwithreconcilestrategy) + * [`fn withValuesFile(valuesFile)`](#fn-specchartspecwithvaluesfile) + * [`fn withValuesFiles(valuesFiles)`](#fn-specchartspecwithvaluesfiles) + * [`fn withValuesFilesMixin(valuesFiles)`](#fn-specchartspecwithvaluesfilesmixin) + * [`fn withVersion(version)`](#fn-specchartspecwithversion) + * [`obj spec.chart.spec.sourceRef`](#obj-specchartspecsourceref) + * [`fn withApiVersion(apiVersion)`](#fn-specchartspecsourcerefwithapiversion) + * [`fn withKind(kind)`](#fn-specchartspecsourcerefwithkind) + * [`fn withName(name)`](#fn-specchartspecsourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specchartspecsourcerefwithnamespace) + * [`obj spec.chart.spec.verify`](#obj-specchartspecverify) + * [`fn withProvider(provider)`](#fn-specchartspecverifywithprovider) + * [`obj spec.chart.spec.verify.secretRef`](#obj-specchartspecverifysecretref) + * [`fn withName(name)`](#fn-specchartspecverifysecretrefwithname) + * [`obj spec.dependsOn`](#obj-specdependson) + * [`fn withName(name)`](#fn-specdependsonwithname) + * [`fn withNamespace(namespace)`](#fn-specdependsonwithnamespace) + * [`obj spec.driftDetection`](#obj-specdriftdetection) + * [`fn withIgnore(ignore)`](#fn-specdriftdetectionwithignore) + * [`fn withIgnoreMixin(ignore)`](#fn-specdriftdetectionwithignoremixin) + * [`fn withMode(mode)`](#fn-specdriftdetectionwithmode) + * [`obj spec.driftDetection.ignore`](#obj-specdriftdetectionignore) + * [`fn withPaths(paths)`](#fn-specdriftdetectionignorewithpaths) + * [`fn withPathsMixin(paths)`](#fn-specdriftdetectionignorewithpathsmixin) + * [`obj spec.driftDetection.ignore.target`](#obj-specdriftdetectionignoretarget) + * [`fn withAnnotationSelector(annotationSelector)`](#fn-specdriftdetectionignoretargetwithannotationselector) + * [`fn withGroup(group)`](#fn-specdriftdetectionignoretargetwithgroup) + * [`fn withKind(kind)`](#fn-specdriftdetectionignoretargetwithkind) + * [`fn withLabelSelector(labelSelector)`](#fn-specdriftdetectionignoretargetwithlabelselector) + * [`fn withName(name)`](#fn-specdriftdetectionignoretargetwithname) + * [`fn withNamespace(namespace)`](#fn-specdriftdetectionignoretargetwithnamespace) + * [`fn withVersion(version)`](#fn-specdriftdetectionignoretargetwithversion) + * [`obj spec.install`](#obj-specinstall) + * [`fn withCrds(crds)`](#fn-specinstallwithcrds) + * [`fn withCreateNamespace(createNamespace)`](#fn-specinstallwithcreatenamespace) + * [`fn withDisableHooks(disableHooks)`](#fn-specinstallwithdisablehooks) + * [`fn withDisableOpenAPIValidation(disableOpenAPIValidation)`](#fn-specinstallwithdisableopenapivalidation) + * [`fn withDisableWait(disableWait)`](#fn-specinstallwithdisablewait) + * [`fn withDisableWaitForJobs(disableWaitForJobs)`](#fn-specinstallwithdisablewaitforjobs) + * [`fn withReplace(replace)`](#fn-specinstallwithreplace) + * [`fn withSkipCRDs(skipCRDs)`](#fn-specinstallwithskipcrds) + * [`fn withTimeout(timeout)`](#fn-specinstallwithtimeout) + * [`obj spec.install.remediation`](#obj-specinstallremediation) + * [`fn withIgnoreTestFailures(ignoreTestFailures)`](#fn-specinstallremediationwithignoretestfailures) + * [`fn withRemediateLastFailure(remediateLastFailure)`](#fn-specinstallremediationwithremediatelastfailure) + * [`fn withRetries(retries)`](#fn-specinstallremediationwithretries) + * [`obj spec.kubeConfig`](#obj-speckubeconfig) + * [`obj spec.kubeConfig.secretRef`](#obj-speckubeconfigsecretref) + * [`fn withKey(key)`](#fn-speckubeconfigsecretrefwithkey) + * [`fn withName(name)`](#fn-speckubeconfigsecretrefwithname) + * [`obj spec.postRenderers`](#obj-specpostrenderers) + * [`obj spec.postRenderers.kustomize`](#obj-specpostrendererskustomize) + * [`fn withImages(images)`](#fn-specpostrendererskustomizewithimages) + * [`fn withImagesMixin(images)`](#fn-specpostrendererskustomizewithimagesmixin) + * [`fn withPatches(patches)`](#fn-specpostrendererskustomizewithpatches) + * [`fn withPatchesJson6902(patchesJson6902)`](#fn-specpostrendererskustomizewithpatchesjson6902) + * [`fn withPatchesJson6902Mixin(patchesJson6902)`](#fn-specpostrendererskustomizewithpatchesjson6902mixin) + * [`fn withPatchesMixin(patches)`](#fn-specpostrendererskustomizewithpatchesmixin) + * [`fn withPatchesStrategicMerge(patchesStrategicMerge)`](#fn-specpostrendererskustomizewithpatchesstrategicmerge) + * [`fn withPatchesStrategicMergeMixin(patchesStrategicMerge)`](#fn-specpostrendererskustomizewithpatchesstrategicmergemixin) + * [`obj spec.postRenderers.kustomize.images`](#obj-specpostrendererskustomizeimages) + * [`fn withDigest(digest)`](#fn-specpostrendererskustomizeimageswithdigest) + * [`fn withName(name)`](#fn-specpostrendererskustomizeimageswithname) + * [`fn withNewName(newName)`](#fn-specpostrendererskustomizeimageswithnewname) + * [`fn withNewTag(newTag)`](#fn-specpostrendererskustomizeimageswithnewtag) + * [`obj spec.postRenderers.kustomize.patches`](#obj-specpostrendererskustomizepatches) + * [`fn withPatch(patch)`](#fn-specpostrendererskustomizepatcheswithpatch) + * [`obj spec.postRenderers.kustomize.patches.target`](#obj-specpostrendererskustomizepatchestarget) + * [`fn withAnnotationSelector(annotationSelector)`](#fn-specpostrendererskustomizepatchestargetwithannotationselector) + * [`fn withGroup(group)`](#fn-specpostrendererskustomizepatchestargetwithgroup) + * [`fn withKind(kind)`](#fn-specpostrendererskustomizepatchestargetwithkind) + * [`fn withLabelSelector(labelSelector)`](#fn-specpostrendererskustomizepatchestargetwithlabelselector) + * [`fn withName(name)`](#fn-specpostrendererskustomizepatchestargetwithname) + * [`fn withNamespace(namespace)`](#fn-specpostrendererskustomizepatchestargetwithnamespace) + * [`fn withVersion(version)`](#fn-specpostrendererskustomizepatchestargetwithversion) + * [`obj spec.postRenderers.kustomize.patchesJson6902`](#obj-specpostrendererskustomizepatchesjson6902) + * [`fn withPatch(patch)`](#fn-specpostrendererskustomizepatchesjson6902withpatch) + * [`fn withPatchMixin(patch)`](#fn-specpostrendererskustomizepatchesjson6902withpatchmixin) + * [`obj spec.postRenderers.kustomize.patchesJson6902.patch`](#obj-specpostrendererskustomizepatchesjson6902patch) + * [`fn withFrom(from)`](#fn-specpostrendererskustomizepatchesjson6902patchwithfrom) + * [`fn withOp(op)`](#fn-specpostrendererskustomizepatchesjson6902patchwithop) + * [`fn withPath(path)`](#fn-specpostrendererskustomizepatchesjson6902patchwithpath) + * [`fn withValue(value)`](#fn-specpostrendererskustomizepatchesjson6902patchwithvalue) + * [`obj spec.postRenderers.kustomize.patchesJson6902.target`](#obj-specpostrendererskustomizepatchesjson6902target) + * [`fn withAnnotationSelector(annotationSelector)`](#fn-specpostrendererskustomizepatchesjson6902targetwithannotationselector) + * [`fn withGroup(group)`](#fn-specpostrendererskustomizepatchesjson6902targetwithgroup) + * [`fn withKind(kind)`](#fn-specpostrendererskustomizepatchesjson6902targetwithkind) + * [`fn withLabelSelector(labelSelector)`](#fn-specpostrendererskustomizepatchesjson6902targetwithlabelselector) + * [`fn withName(name)`](#fn-specpostrendererskustomizepatchesjson6902targetwithname) + * [`fn withNamespace(namespace)`](#fn-specpostrendererskustomizepatchesjson6902targetwithnamespace) + * [`fn withVersion(version)`](#fn-specpostrendererskustomizepatchesjson6902targetwithversion) + * [`obj spec.rollback`](#obj-specrollback) + * [`fn withCleanupOnFail(cleanupOnFail)`](#fn-specrollbackwithcleanuponfail) + * [`fn withDisableHooks(disableHooks)`](#fn-specrollbackwithdisablehooks) + * [`fn withDisableWait(disableWait)`](#fn-specrollbackwithdisablewait) + * [`fn withDisableWaitForJobs(disableWaitForJobs)`](#fn-specrollbackwithdisablewaitforjobs) + * [`fn withForce(force)`](#fn-specrollbackwithforce) + * [`fn withRecreate(recreate)`](#fn-specrollbackwithrecreate) + * [`fn withTimeout(timeout)`](#fn-specrollbackwithtimeout) + * [`obj spec.test`](#obj-spectest) + * [`fn withEnable(enable)`](#fn-spectestwithenable) + * [`fn withIgnoreFailures(ignoreFailures)`](#fn-spectestwithignorefailures) + * [`fn withTimeout(timeout)`](#fn-spectestwithtimeout) + * [`obj spec.uninstall`](#obj-specuninstall) + * [`fn withDeletionPropagation(deletionPropagation)`](#fn-specuninstallwithdeletionpropagation) + * [`fn withDisableHooks(disableHooks)`](#fn-specuninstallwithdisablehooks) + * [`fn withDisableWait(disableWait)`](#fn-specuninstallwithdisablewait) + * [`fn withKeepHistory(keepHistory)`](#fn-specuninstallwithkeephistory) + * [`fn withTimeout(timeout)`](#fn-specuninstallwithtimeout) + * [`obj spec.upgrade`](#obj-specupgrade) + * [`fn withCleanupOnFail(cleanupOnFail)`](#fn-specupgradewithcleanuponfail) + * [`fn withCrds(crds)`](#fn-specupgradewithcrds) + * [`fn withDisableHooks(disableHooks)`](#fn-specupgradewithdisablehooks) + * [`fn withDisableOpenAPIValidation(disableOpenAPIValidation)`](#fn-specupgradewithdisableopenapivalidation) + * [`fn withDisableWait(disableWait)`](#fn-specupgradewithdisablewait) + * [`fn withDisableWaitForJobs(disableWaitForJobs)`](#fn-specupgradewithdisablewaitforjobs) + * [`fn withForce(force)`](#fn-specupgradewithforce) + * [`fn withPreserveValues(preserveValues)`](#fn-specupgradewithpreservevalues) + * [`fn withTimeout(timeout)`](#fn-specupgradewithtimeout) + * [`obj spec.upgrade.remediation`](#obj-specupgraderemediation) + * [`fn withIgnoreTestFailures(ignoreTestFailures)`](#fn-specupgraderemediationwithignoretestfailures) + * [`fn withRemediateLastFailure(remediateLastFailure)`](#fn-specupgraderemediationwithremediatelastfailure) + * [`fn withRetries(retries)`](#fn-specupgraderemediationwithretries) + * [`fn withStrategy(strategy)`](#fn-specupgraderemediationwithstrategy) + * [`obj spec.valuesFrom`](#obj-specvaluesfrom) + * [`fn withKind(kind)`](#fn-specvaluesfromwithkind) + * [`fn withName(name)`](#fn-specvaluesfromwithname) + * [`fn withOptional(optional)`](#fn-specvaluesfromwithoptional) + * [`fn withTargetPath(targetPath)`](#fn-specvaluesfromwithtargetpath) + * [`fn withValuesKey(valuesKey)`](#fn-specvaluesfromwithvalueskey) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of HelmRelease + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"HelmReleaseSpec defines the desired state of a Helm release." + +### fn spec.withDependsOn + +```ts +withDependsOn(dependsOn) +``` + +"DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled." + +### fn spec.withDependsOnMixin + +```ts +withDependsOnMixin(dependsOn) +``` + +"DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled." + +**Note:** This function appends passed data to existing values + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval at which to reconcile the Helm release. This interval is approximate and may be subject to jitter to ensure efficient use of resources." + +### fn spec.withMaxHistory + +```ts +withMaxHistory(maxHistory) +``` + +"MaxHistory is the number of revisions saved by Helm for this HelmRelease. Use '0' for an unlimited number of revisions; defaults to '10'." + +### fn spec.withPersistentClient + +```ts +withPersistentClient(persistentClient) +``` + +"PersistentClient tells the controller to use a persistent Kubernetes client for this release. When enabled, the client will be reused for the duration of the reconciliation, instead of being created and destroyed for each (step of a) Helm action. \n This can improve performance, but may cause issues with some Helm charts that for example do create Custom Resource Definitions during installation outside Helm's CRD lifecycle hooks, which are then not observed to be available by e.g. post-install hooks. \n If not set, it defaults to true." + +### fn spec.withPostRenderers + +```ts +withPostRenderers(postRenderers) +``` + +"PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition." + +### fn spec.withPostRenderersMixin + +```ts +withPostRenderersMixin(postRenderers) +``` + +"PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition." + +**Note:** This function appends passed data to existing values + +### fn spec.withReleaseName + +```ts +withReleaseName(releaseName) +``` + +"ReleaseName used for the Helm release. Defaults to a composition of '[TargetNamespace-]Name'." + +### fn spec.withServiceAccountName + +```ts +withServiceAccountName(serviceAccountName) +``` + +"The name of the Kubernetes service account to impersonate when reconciling this HelmRelease." + +### fn spec.withStorageNamespace + +```ts +withStorageNamespace(storageNamespace) +``` + +"StorageNamespace used for the Helm storage. Defaults to the namespace of the HelmRelease." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"Suspend tells the controller to suspend reconciliation for this HelmRelease, it does not apply to already started reconciliations. Defaults to false." + +### fn spec.withTargetNamespace + +```ts +withTargetNamespace(targetNamespace) +``` + +"TargetNamespace to target when performing operations for the HelmRelease. Defaults to the namespace of the HelmRelease." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm action. Defaults to '5m0s'." + +### fn spec.withValues + +```ts +withValues(values) +``` + +"Values holds the values for this Helm release." + +### fn spec.withValuesFrom + +```ts +withValuesFrom(valuesFrom) +``` + +"ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged." + +### fn spec.withValuesFromMixin + +```ts +withValuesFromMixin(valuesFrom) +``` + +"ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged." + +**Note:** This function appends passed data to existing values + +## obj spec.chart + +"Chart defines the template of the v1beta2.HelmChart that should be created for this HelmRelease." + +## obj spec.chart.metadata + +"ObjectMeta holds the template for metadata like labels and annotations." + +### fn spec.chart.metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/" + +### fn spec.chart.metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/" + +**Note:** This function appends passed data to existing values + +### fn spec.chart.metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/" + +### fn spec.chart.metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/" + +**Note:** This function appends passed data to existing values + +## obj spec.chart.spec + +"Spec holds the template for the v1beta2.HelmChartSpec for this HelmRelease." + +### fn spec.chart.spec.withChart + +```ts +withChart(chart) +``` + +"The name or path the Helm chart is available at in the SourceRef." + +### fn spec.chart.spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval at which to check the v1beta2.Source for updates. Defaults to 'HelmReleaseSpec.Interval'." + +### fn spec.chart.spec.withReconcileStrategy + +```ts +withReconcileStrategy(reconcileStrategy) +``` + +"Determines what enables the creation of a new artifact. Valid values are ('ChartVersion', 'Revision'). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted." + +### fn spec.chart.spec.withValuesFile + +```ts +withValuesFile(valuesFile) +``` + +"Alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Deprecated in favor of ValuesFiles, for backwards compatibility the file defined here is merged before the ValuesFiles items. Ignored when omitted." + +### fn spec.chart.spec.withValuesFiles + +```ts +withValuesFiles(valuesFiles) +``` + +"Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted." + +### fn spec.chart.spec.withValuesFilesMixin + +```ts +withValuesFilesMixin(valuesFiles) +``` + +"Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted." + +**Note:** This function appends passed data to existing values + +### fn spec.chart.spec.withVersion + +```ts +withVersion(version) +``` + +"Version semver expression, ignored for charts from v1beta2.GitRepository and v1beta2.Bucket sources. Defaults to latest when omitted." + +## obj spec.chart.spec.sourceRef + +"The name and namespace of the v1beta2.Source the chart is available at." + +### fn spec.chart.spec.sourceRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"APIVersion of the referent." + +### fn spec.chart.spec.sourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent." + +### fn spec.chart.spec.sourceRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +### fn spec.chart.spec.sourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent." + +## obj spec.chart.spec.verify + +"Verify 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. This field is only supported for OCI sources. Chart dependencies, which are not bundled in the umbrella chart artifact, are not verified." + +### fn spec.chart.spec.verify.withProvider + +```ts +withProvider(provider) +``` + +"Provider specifies the technology used to sign the OCI Helm chart." + +## obj spec.chart.spec.verify.secretRef + +"SecretRef specifies the Kubernetes Secret containing the trusted public keys." + +### fn spec.chart.spec.verify.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.dependsOn + +"DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled." + +### fn spec.dependsOn.withName + +```ts +withName(name) +``` + +"Name of the referent." + +### fn spec.dependsOn.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent, when not specified it acts as LocalObjectReference." + +## obj spec.driftDetection + +"DriftDetection holds the configuration for detecting and handling differences between the manifest in the Helm storage and the resources currently existing in the cluster. \n Note: this field is provisional to the v2beta2 API, and not actively used by v2beta1 HelmReleases." + +### fn spec.driftDetection.withIgnore + +```ts +withIgnore(ignore) +``` + +"Ignore contains a list of rules for specifying which changes to ignore during diffing." + +### fn spec.driftDetection.withIgnoreMixin + +```ts +withIgnoreMixin(ignore) +``` + +"Ignore contains a list of rules for specifying which changes to ignore during diffing." + +**Note:** This function appends passed data to existing values + +### fn spec.driftDetection.withMode + +```ts +withMode(mode) +``` + +"Mode defines how differences should be handled between the Helm manifest and the manifest currently applied to the cluster. If not explicitly set, it defaults to DiffModeDisabled." + +## obj spec.driftDetection.ignore + +"Ignore contains a list of rules for specifying which changes to ignore during diffing." + +### fn spec.driftDetection.ignore.withPaths + +```ts +withPaths(paths) +``` + +"Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from consideration in a Kubernetes object." + +### fn spec.driftDetection.ignore.withPathsMixin + +```ts +withPathsMixin(paths) +``` + +"Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from consideration in a Kubernetes object." + +**Note:** This function appends passed data to existing values + +## obj spec.driftDetection.ignore.target + +"Target is a selector for specifying Kubernetes objects to which this rule applies. If Target is not set, the Paths will be ignored for all Kubernetes objects within the manifest of the Helm release." + +### fn spec.driftDetection.ignore.target.withAnnotationSelector + +```ts +withAnnotationSelector(annotationSelector) +``` + +"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations." + +### fn spec.driftDetection.ignore.target.withGroup + +```ts +withGroup(group) +``` + +"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.driftDetection.ignore.target.withKind + +```ts +withKind(kind) +``` + +"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.driftDetection.ignore.target.withLabelSelector + +```ts +withLabelSelector(labelSelector) +``` + +"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels." + +### fn spec.driftDetection.ignore.target.withName + +```ts +withName(name) +``` + +"Name to match resources with." + +### fn spec.driftDetection.ignore.target.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace to select resources from." + +### fn spec.driftDetection.ignore.target.withVersion + +```ts +withVersion(version) +``` + +"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +## obj spec.install + +"Install holds the configuration for Helm install actions for this HelmRelease." + +### fn spec.install.withCrds + +```ts +withCrds(crds) +``` + +"CRDs upgrade CRDs from the Helm Chart's crds directory according to the CRD upgrade policy provided here. Valid values are `Skip`, `Create` or `CreateReplace`. Default is `Create` and if omitted CRDs are installed but not updated. \n Skip: do neither install nor replace (update) any CRDs. \n Create: new CRDs are created, existing CRDs are neither updated nor deleted. \n CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted. \n By default, CRDs are applied (installed) during Helm install action. With this option users can opt-in to CRD replace existing CRDs on Helm install actions, which is not (yet) natively supported by Helm. https://helm.sh/docs/chart_best_practices/custom_resource_definitions." + +### fn spec.install.withCreateNamespace + +```ts +withCreateNamespace(createNamespace) +``` + +"CreateNamespace tells the Helm install action to create the HelmReleaseSpec.TargetNamespace if it does not exist yet. On uninstall, the namespace will not be garbage collected." + +### fn spec.install.withDisableHooks + +```ts +withDisableHooks(disableHooks) +``` + +"DisableHooks prevents hooks from running during the Helm install action." + +### fn spec.install.withDisableOpenAPIValidation + +```ts +withDisableOpenAPIValidation(disableOpenAPIValidation) +``` + +"DisableOpenAPIValidation prevents the Helm install action from validating rendered templates against the Kubernetes OpenAPI Schema." + +### fn spec.install.withDisableWait + +```ts +withDisableWait(disableWait) +``` + +"DisableWait disables the waiting for resources to be ready after a Helm install has been performed." + +### fn spec.install.withDisableWaitForJobs + +```ts +withDisableWaitForJobs(disableWaitForJobs) +``` + +"DisableWaitForJobs disables waiting for jobs to complete after a Helm install has been performed." + +### fn spec.install.withReplace + +```ts +withReplace(replace) +``` + +"Replace tells the Helm install action to re-use the 'ReleaseName', but only if that name is a deleted release which remains in the history." + +### fn spec.install.withSkipCRDs + +```ts +withSkipCRDs(skipCRDs) +``` + +"SkipCRDs tells the Helm install action to not install any CRDs. By default, CRDs are installed if not already present. \n Deprecated use CRD policy (`crds`) attribute with value `Skip` instead." + +### fn spec.install.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm install action. Defaults to 'HelmReleaseSpec.Timeout'." + +## obj spec.install.remediation + +"Remediation holds the remediation configuration for when the Helm install action for the HelmRelease fails. The default is to not perform any action." + +### fn spec.install.remediation.withIgnoreTestFailures + +```ts +withIgnoreTestFailures(ignoreTestFailures) +``` + +"IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an install action but fail. Defaults to 'Test.IgnoreFailures'." + +### fn spec.install.remediation.withRemediateLastFailure + +```ts +withRemediateLastFailure(remediateLastFailure) +``` + +"RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false'." + +### fn spec.install.remediation.withRetries + +```ts +withRetries(retries) +``` + +"Retries is the number of retries that should be attempted on failures before bailing. Remediation, using an uninstall, is performed between each attempt. Defaults to '0', a negative integer equals to unlimited retries." + +## obj spec.kubeConfig + +"KubeConfig for reconciling the HelmRelease on a remote cluster. When used in combination with HelmReleaseSpec.ServiceAccountName, forces the controller to act on behalf of that Service Account at the target cluster. If the --default-service-account flag is set, its value will be used as a controller level fallback for when HelmReleaseSpec.ServiceAccountName is empty." + +## obj spec.kubeConfig.secretRef + +"SecretRef holds the name of a secret that contains a key with the kubeconfig file as the value. If no key is set, the key will default to 'value'. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific `cmd-path` auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling Kubernetes resources." + +### fn spec.kubeConfig.secretRef.withKey + +```ts +withKey(key) +``` + +"Key in the Secret, when not specified an implementation-specific default key is used." + +### fn spec.kubeConfig.secretRef.withName + +```ts +withName(name) +``` + +"Name of the Secret." + +## obj spec.postRenderers + +"PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition." + +## obj spec.postRenderers.kustomize + +"Kustomization to apply as PostRenderer." + +### fn spec.postRenderers.kustomize.withImages + +```ts +withImages(images) +``` + +"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify." + +### fn spec.postRenderers.kustomize.withImagesMixin + +```ts +withImagesMixin(images) +``` + +"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify." + +**Note:** This function appends passed data to existing values + +### fn spec.postRenderers.kustomize.withPatches + +```ts +withPatches(patches) +``` + +"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors." + +### fn spec.postRenderers.kustomize.withPatchesJson6902 + +```ts +withPatchesJson6902(patchesJson6902) +``` + +"JSON 6902 patches, defined as inline YAML objects." + +### fn spec.postRenderers.kustomize.withPatchesJson6902Mixin + +```ts +withPatchesJson6902Mixin(patchesJson6902) +``` + +"JSON 6902 patches, defined as inline YAML objects." + +**Note:** This function appends passed data to existing values + +### fn spec.postRenderers.kustomize.withPatchesMixin + +```ts +withPatchesMixin(patches) +``` + +"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors." + +**Note:** This function appends passed data to existing values + +### fn spec.postRenderers.kustomize.withPatchesStrategicMerge + +```ts +withPatchesStrategicMerge(patchesStrategicMerge) +``` + +"Strategic merge patches, defined as inline YAML objects." + +### fn spec.postRenderers.kustomize.withPatchesStrategicMergeMixin + +```ts +withPatchesStrategicMergeMixin(patchesStrategicMerge) +``` + +"Strategic merge patches, defined as inline YAML objects." + +**Note:** This function appends passed data to existing values + +## obj spec.postRenderers.kustomize.images + +"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify." + +### fn spec.postRenderers.kustomize.images.withDigest + +```ts +withDigest(digest) +``` + +"Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored." + +### fn spec.postRenderers.kustomize.images.withName + +```ts +withName(name) +``` + +"Name is a tag-less image name." + +### fn spec.postRenderers.kustomize.images.withNewName + +```ts +withNewName(newName) +``` + +"NewName is the value used to replace the original name." + +### fn spec.postRenderers.kustomize.images.withNewTag + +```ts +withNewTag(newTag) +``` + +"NewTag is the value used to replace the original tag." + +## obj spec.postRenderers.kustomize.patches + +"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors." + +### fn spec.postRenderers.kustomize.patches.withPatch + +```ts +withPatch(patch) +``` + +"Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects." + +## obj spec.postRenderers.kustomize.patches.target + +"Target points to the resources that the patch document should be applied to." + +### fn spec.postRenderers.kustomize.patches.target.withAnnotationSelector + +```ts +withAnnotationSelector(annotationSelector) +``` + +"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations." + +### fn spec.postRenderers.kustomize.patches.target.withGroup + +```ts +withGroup(group) +``` + +"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.postRenderers.kustomize.patches.target.withKind + +```ts +withKind(kind) +``` + +"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.postRenderers.kustomize.patches.target.withLabelSelector + +```ts +withLabelSelector(labelSelector) +``` + +"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels." + +### fn spec.postRenderers.kustomize.patches.target.withName + +```ts +withName(name) +``` + +"Name to match resources with." + +### fn spec.postRenderers.kustomize.patches.target.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace to select resources from." + +### fn spec.postRenderers.kustomize.patches.target.withVersion + +```ts +withVersion(version) +``` + +"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +## obj spec.postRenderers.kustomize.patchesJson6902 + +"JSON 6902 patches, defined as inline YAML objects." + +### fn spec.postRenderers.kustomize.patchesJson6902.withPatch + +```ts +withPatch(patch) +``` + +"Patch contains the JSON6902 patch document with an array of operation objects." + +### fn spec.postRenderers.kustomize.patchesJson6902.withPatchMixin + +```ts +withPatchMixin(patch) +``` + +"Patch contains the JSON6902 patch document with an array of operation objects." + +**Note:** This function appends passed data to existing values + +## obj spec.postRenderers.kustomize.patchesJson6902.patch + +"Patch contains the JSON6902 patch document with an array of operation objects." + +### fn spec.postRenderers.kustomize.patchesJson6902.patch.withFrom + +```ts +withFrom(from) +``` + +"From contains a JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations." + +### fn spec.postRenderers.kustomize.patchesJson6902.patch.withOp + +```ts +withOp(op) +``` + +"Op indicates the operation to perform. Its value MUST be one of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or \"test\". https://datatracker.ietf.org/doc/html/rfc6902#section-4" + +### fn spec.postRenderers.kustomize.patchesJson6902.patch.withPath + +```ts +withPath(path) +``` + +"Path contains the JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op." + +### fn spec.postRenderers.kustomize.patchesJson6902.patch.withValue + +```ts +withValue(value) +``` + +"Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations." + +## obj spec.postRenderers.kustomize.patchesJson6902.target + +"Target points to the resources that the patch document should be applied to." + +### fn spec.postRenderers.kustomize.patchesJson6902.target.withAnnotationSelector + +```ts +withAnnotationSelector(annotationSelector) +``` + +"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations." + +### fn spec.postRenderers.kustomize.patchesJson6902.target.withGroup + +```ts +withGroup(group) +``` + +"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.postRenderers.kustomize.patchesJson6902.target.withKind + +```ts +withKind(kind) +``` + +"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.postRenderers.kustomize.patchesJson6902.target.withLabelSelector + +```ts +withLabelSelector(labelSelector) +``` + +"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels." + +### fn spec.postRenderers.kustomize.patchesJson6902.target.withName + +```ts +withName(name) +``` + +"Name to match resources with." + +### fn spec.postRenderers.kustomize.patchesJson6902.target.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace to select resources from." + +### fn spec.postRenderers.kustomize.patchesJson6902.target.withVersion + +```ts +withVersion(version) +``` + +"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +## obj spec.rollback + +"Rollback holds the configuration for Helm rollback actions for this HelmRelease." + +### fn spec.rollback.withCleanupOnFail + +```ts +withCleanupOnFail(cleanupOnFail) +``` + +"CleanupOnFail allows deletion of new resources created during the Helm rollback action when it fails." + +### fn spec.rollback.withDisableHooks + +```ts +withDisableHooks(disableHooks) +``` + +"DisableHooks prevents hooks from running during the Helm rollback action." + +### fn spec.rollback.withDisableWait + +```ts +withDisableWait(disableWait) +``` + +"DisableWait disables the waiting for resources to be ready after a Helm rollback has been performed." + +### fn spec.rollback.withDisableWaitForJobs + +```ts +withDisableWaitForJobs(disableWaitForJobs) +``` + +"DisableWaitForJobs disables waiting for jobs to complete after a Helm rollback has been performed." + +### fn spec.rollback.withForce + +```ts +withForce(force) +``` + +"Force forces resource updates through a replacement strategy." + +### fn spec.rollback.withRecreate + +```ts +withRecreate(recreate) +``` + +"Recreate performs pod restarts for the resource if applicable." + +### fn spec.rollback.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm rollback action. Defaults to 'HelmReleaseSpec.Timeout'." + +## obj spec.test + +"Test holds the configuration for Helm test actions for this HelmRelease." + +### fn spec.test.withEnable + +```ts +withEnable(enable) +``` + +"Enable enables Helm test actions for this HelmRelease after an Helm install or upgrade action has been performed." + +### fn spec.test.withIgnoreFailures + +```ts +withIgnoreFailures(ignoreFailures) +``` + +"IgnoreFailures tells the controller to skip remediation when the Helm tests are run but fail. Can be overwritten for tests run after install or upgrade actions in 'Install.IgnoreTestFailures' and 'Upgrade.IgnoreTestFailures'." + +### fn spec.test.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout is the time to wait for any individual Kubernetes operation during the performance of a Helm test action. Defaults to 'HelmReleaseSpec.Timeout'." + +## obj spec.uninstall + +"Uninstall holds the configuration for Helm uninstall actions for this HelmRelease." + +### fn spec.uninstall.withDeletionPropagation + +```ts +withDeletionPropagation(deletionPropagation) +``` + +"DeletionPropagation specifies the deletion propagation policy when a Helm uninstall is performed." + +### fn spec.uninstall.withDisableHooks + +```ts +withDisableHooks(disableHooks) +``` + +"DisableHooks prevents hooks from running during the Helm rollback action." + +### fn spec.uninstall.withDisableWait + +```ts +withDisableWait(disableWait) +``` + +"DisableWait disables waiting for all the resources to be deleted after a Helm uninstall is performed." + +### fn spec.uninstall.withKeepHistory + +```ts +withKeepHistory(keepHistory) +``` + +"KeepHistory tells Helm to remove all associated resources and mark the release as deleted, but retain the release history." + +### fn spec.uninstall.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm uninstall action. Defaults to 'HelmReleaseSpec.Timeout'." + +## obj spec.upgrade + +"Upgrade holds the configuration for Helm upgrade actions for this HelmRelease." + +### fn spec.upgrade.withCleanupOnFail + +```ts +withCleanupOnFail(cleanupOnFail) +``` + +"CleanupOnFail allows deletion of new resources created during the Helm upgrade action when it fails." + +### fn spec.upgrade.withCrds + +```ts +withCrds(crds) +``` + +"CRDs upgrade CRDs from the Helm Chart's crds directory according to the CRD upgrade policy provided here. Valid values are `Skip`, `Create` or `CreateReplace`. Default is `Skip` and if omitted CRDs are neither installed nor upgraded. \n Skip: do neither install nor replace (update) any CRDs. \n Create: new CRDs are created, existing CRDs are neither updated nor deleted. \n CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted. \n By default, CRDs are not applied during Helm upgrade action. With this option users can opt-in to CRD upgrade, which is not (yet) natively supported by Helm. https://helm.sh/docs/chart_best_practices/custom_resource_definitions." + +### fn spec.upgrade.withDisableHooks + +```ts +withDisableHooks(disableHooks) +``` + +"DisableHooks prevents hooks from running during the Helm upgrade action." + +### fn spec.upgrade.withDisableOpenAPIValidation + +```ts +withDisableOpenAPIValidation(disableOpenAPIValidation) +``` + +"DisableOpenAPIValidation prevents the Helm upgrade action from validating rendered templates against the Kubernetes OpenAPI Schema." + +### fn spec.upgrade.withDisableWait + +```ts +withDisableWait(disableWait) +``` + +"DisableWait disables the waiting for resources to be ready after a Helm upgrade has been performed." + +### fn spec.upgrade.withDisableWaitForJobs + +```ts +withDisableWaitForJobs(disableWaitForJobs) +``` + +"DisableWaitForJobs disables waiting for jobs to complete after a Helm upgrade has been performed." + +### fn spec.upgrade.withForce + +```ts +withForce(force) +``` + +"Force forces resource updates through a replacement strategy." + +### fn spec.upgrade.withPreserveValues + +```ts +withPreserveValues(preserveValues) +``` + +"PreserveValues will make Helm reuse the last release's values and merge in overrides from 'Values'. Setting this flag makes the HelmRelease non-declarative." + +### fn spec.upgrade.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm upgrade action. Defaults to 'HelmReleaseSpec.Timeout'." + +## obj spec.upgrade.remediation + +"Remediation holds the remediation configuration for when the Helm upgrade action for the HelmRelease fails. The default is to not perform any action." + +### fn spec.upgrade.remediation.withIgnoreTestFailures + +```ts +withIgnoreTestFailures(ignoreTestFailures) +``` + +"IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an upgrade action but fail. Defaults to 'Test.IgnoreFailures'." + +### fn spec.upgrade.remediation.withRemediateLastFailure + +```ts +withRemediateLastFailure(remediateLastFailure) +``` + +"RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false' unless 'Retries' is greater than 0." + +### fn spec.upgrade.remediation.withRetries + +```ts +withRetries(retries) +``` + +"Retries is the number of retries that should be attempted on failures before bailing. Remediation, using 'Strategy', is performed between each attempt. Defaults to '0', a negative integer equals to unlimited retries." + +### fn spec.upgrade.remediation.withStrategy + +```ts +withStrategy(strategy) +``` + +"Strategy to use for failure remediation. Defaults to 'rollback'." + +## obj spec.valuesFrom + +"ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged." + +### fn spec.valuesFrom.withKind + +```ts +withKind(kind) +``` + +"Kind of the values referent, valid values are ('Secret', 'ConfigMap')." + +### fn spec.valuesFrom.withName + +```ts +withName(name) +``` + +"Name of the values referent. Should reside in the same namespace as the referring resource." + +### fn spec.valuesFrom.withOptional + +```ts +withOptional(optional) +``` + +"Optional marks this ValuesReference as optional. When set, a not found error for the values reference is ignored, but any ValuesKey, TargetPath or transient error will still result in a reconciliation failure." + +### fn spec.valuesFrom.withTargetPath + +```ts +withTargetPath(targetPath) +``` + +"TargetPath is the YAML dot notation path the value should be merged at. When set, the ValuesKey is expected to be a single flat value. Defaults to 'None', which results in the values getting merged at the root." + +### fn spec.valuesFrom.withValuesKey + +```ts +withValuesKey(valuesKey) +``` + +"ValuesKey is the data key where the values.yaml or a specific value can be found at. Defaults to 'values.yaml'. When set, must be a valid Data Key, consisting of alphanumeric characters, '-', '_' or '.'." \ No newline at end of file diff --git a/docs/2.2.1/helm/v2beta1/index.md b/docs/2.2.1/helm/v2beta1/index.md new file mode 100644 index 0000000..2794b76 --- /dev/null +++ b/docs/2.2.1/helm/v2beta1/index.md @@ -0,0 +1,9 @@ +--- +permalink: /2.2.1/helm/v2beta1/ +--- + +# helm.v2beta1 + + + +* [helmRelease](helmRelease.md) \ No newline at end of file diff --git a/docs/2.2.1/helm/v2beta2/helmRelease.md b/docs/2.2.1/helm/v2beta2/helmRelease.md new file mode 100644 index 0000000..4b1efb2 --- /dev/null +++ b/docs/2.2.1/helm/v2beta2/helmRelease.md @@ -0,0 +1,1562 @@ +--- +permalink: /2.2.1/helm/v2beta2/helmRelease/ +--- + +# helm.v2beta2.helmRelease + +"HelmRelease is the Schema for the helmreleases API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withDependsOn(dependsOn)`](#fn-specwithdependson) + * [`fn withDependsOnMixin(dependsOn)`](#fn-specwithdependsonmixin) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withMaxHistory(maxHistory)`](#fn-specwithmaxhistory) + * [`fn withPersistentClient(persistentClient)`](#fn-specwithpersistentclient) + * [`fn withPostRenderers(postRenderers)`](#fn-specwithpostrenderers) + * [`fn withPostRenderersMixin(postRenderers)`](#fn-specwithpostrenderersmixin) + * [`fn withReleaseName(releaseName)`](#fn-specwithreleasename) + * [`fn withServiceAccountName(serviceAccountName)`](#fn-specwithserviceaccountname) + * [`fn withStorageNamespace(storageNamespace)`](#fn-specwithstoragenamespace) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTargetNamespace(targetNamespace)`](#fn-specwithtargetnamespace) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`fn withValues(values)`](#fn-specwithvalues) + * [`fn withValuesFrom(valuesFrom)`](#fn-specwithvaluesfrom) + * [`fn withValuesFromMixin(valuesFrom)`](#fn-specwithvaluesfrommixin) + * [`obj spec.chart`](#obj-specchart) + * [`obj spec.chart.metadata`](#obj-specchartmetadata) + * [`fn withAnnotations(annotations)`](#fn-specchartmetadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-specchartmetadatawithannotationsmixin) + * [`fn withLabels(labels)`](#fn-specchartmetadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-specchartmetadatawithlabelsmixin) + * [`obj spec.chart.spec`](#obj-specchartspec) + * [`fn withChart(chart)`](#fn-specchartspecwithchart) + * [`fn withInterval(interval)`](#fn-specchartspecwithinterval) + * [`fn withReconcileStrategy(reconcileStrategy)`](#fn-specchartspecwithreconcilestrategy) + * [`fn withValuesFile(valuesFile)`](#fn-specchartspecwithvaluesfile) + * [`fn withValuesFiles(valuesFiles)`](#fn-specchartspecwithvaluesfiles) + * [`fn withValuesFilesMixin(valuesFiles)`](#fn-specchartspecwithvaluesfilesmixin) + * [`fn withVersion(version)`](#fn-specchartspecwithversion) + * [`obj spec.chart.spec.sourceRef`](#obj-specchartspecsourceref) + * [`fn withApiVersion(apiVersion)`](#fn-specchartspecsourcerefwithapiversion) + * [`fn withKind(kind)`](#fn-specchartspecsourcerefwithkind) + * [`fn withName(name)`](#fn-specchartspecsourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specchartspecsourcerefwithnamespace) + * [`obj spec.chart.spec.verify`](#obj-specchartspecverify) + * [`fn withProvider(provider)`](#fn-specchartspecverifywithprovider) + * [`obj spec.chart.spec.verify.secretRef`](#obj-specchartspecverifysecretref) + * [`fn withName(name)`](#fn-specchartspecverifysecretrefwithname) + * [`obj spec.dependsOn`](#obj-specdependson) + * [`fn withName(name)`](#fn-specdependsonwithname) + * [`fn withNamespace(namespace)`](#fn-specdependsonwithnamespace) + * [`obj spec.driftDetection`](#obj-specdriftdetection) + * [`fn withIgnore(ignore)`](#fn-specdriftdetectionwithignore) + * [`fn withIgnoreMixin(ignore)`](#fn-specdriftdetectionwithignoremixin) + * [`fn withMode(mode)`](#fn-specdriftdetectionwithmode) + * [`obj spec.driftDetection.ignore`](#obj-specdriftdetectionignore) + * [`fn withPaths(paths)`](#fn-specdriftdetectionignorewithpaths) + * [`fn withPathsMixin(paths)`](#fn-specdriftdetectionignorewithpathsmixin) + * [`obj spec.driftDetection.ignore.target`](#obj-specdriftdetectionignoretarget) + * [`fn withAnnotationSelector(annotationSelector)`](#fn-specdriftdetectionignoretargetwithannotationselector) + * [`fn withGroup(group)`](#fn-specdriftdetectionignoretargetwithgroup) + * [`fn withKind(kind)`](#fn-specdriftdetectionignoretargetwithkind) + * [`fn withLabelSelector(labelSelector)`](#fn-specdriftdetectionignoretargetwithlabelselector) + * [`fn withName(name)`](#fn-specdriftdetectionignoretargetwithname) + * [`fn withNamespace(namespace)`](#fn-specdriftdetectionignoretargetwithnamespace) + * [`fn withVersion(version)`](#fn-specdriftdetectionignoretargetwithversion) + * [`obj spec.install`](#obj-specinstall) + * [`fn withCrds(crds)`](#fn-specinstallwithcrds) + * [`fn withCreateNamespace(createNamespace)`](#fn-specinstallwithcreatenamespace) + * [`fn withDisableHooks(disableHooks)`](#fn-specinstallwithdisablehooks) + * [`fn withDisableOpenAPIValidation(disableOpenAPIValidation)`](#fn-specinstallwithdisableopenapivalidation) + * [`fn withDisableWait(disableWait)`](#fn-specinstallwithdisablewait) + * [`fn withDisableWaitForJobs(disableWaitForJobs)`](#fn-specinstallwithdisablewaitforjobs) + * [`fn withReplace(replace)`](#fn-specinstallwithreplace) + * [`fn withSkipCRDs(skipCRDs)`](#fn-specinstallwithskipcrds) + * [`fn withTimeout(timeout)`](#fn-specinstallwithtimeout) + * [`obj spec.install.remediation`](#obj-specinstallremediation) + * [`fn withIgnoreTestFailures(ignoreTestFailures)`](#fn-specinstallremediationwithignoretestfailures) + * [`fn withRemediateLastFailure(remediateLastFailure)`](#fn-specinstallremediationwithremediatelastfailure) + * [`fn withRetries(retries)`](#fn-specinstallremediationwithretries) + * [`obj spec.kubeConfig`](#obj-speckubeconfig) + * [`obj spec.kubeConfig.secretRef`](#obj-speckubeconfigsecretref) + * [`fn withKey(key)`](#fn-speckubeconfigsecretrefwithkey) + * [`fn withName(name)`](#fn-speckubeconfigsecretrefwithname) + * [`obj spec.postRenderers`](#obj-specpostrenderers) + * [`obj spec.postRenderers.kustomize`](#obj-specpostrendererskustomize) + * [`fn withImages(images)`](#fn-specpostrendererskustomizewithimages) + * [`fn withImagesMixin(images)`](#fn-specpostrendererskustomizewithimagesmixin) + * [`fn withPatches(patches)`](#fn-specpostrendererskustomizewithpatches) + * [`fn withPatchesJson6902(patchesJson6902)`](#fn-specpostrendererskustomizewithpatchesjson6902) + * [`fn withPatchesJson6902Mixin(patchesJson6902)`](#fn-specpostrendererskustomizewithpatchesjson6902mixin) + * [`fn withPatchesMixin(patches)`](#fn-specpostrendererskustomizewithpatchesmixin) + * [`fn withPatchesStrategicMerge(patchesStrategicMerge)`](#fn-specpostrendererskustomizewithpatchesstrategicmerge) + * [`fn withPatchesStrategicMergeMixin(patchesStrategicMerge)`](#fn-specpostrendererskustomizewithpatchesstrategicmergemixin) + * [`obj spec.postRenderers.kustomize.images`](#obj-specpostrendererskustomizeimages) + * [`fn withDigest(digest)`](#fn-specpostrendererskustomizeimageswithdigest) + * [`fn withName(name)`](#fn-specpostrendererskustomizeimageswithname) + * [`fn withNewName(newName)`](#fn-specpostrendererskustomizeimageswithnewname) + * [`fn withNewTag(newTag)`](#fn-specpostrendererskustomizeimageswithnewtag) + * [`obj spec.postRenderers.kustomize.patches`](#obj-specpostrendererskustomizepatches) + * [`fn withPatch(patch)`](#fn-specpostrendererskustomizepatcheswithpatch) + * [`obj spec.postRenderers.kustomize.patches.target`](#obj-specpostrendererskustomizepatchestarget) + * [`fn withAnnotationSelector(annotationSelector)`](#fn-specpostrendererskustomizepatchestargetwithannotationselector) + * [`fn withGroup(group)`](#fn-specpostrendererskustomizepatchestargetwithgroup) + * [`fn withKind(kind)`](#fn-specpostrendererskustomizepatchestargetwithkind) + * [`fn withLabelSelector(labelSelector)`](#fn-specpostrendererskustomizepatchestargetwithlabelselector) + * [`fn withName(name)`](#fn-specpostrendererskustomizepatchestargetwithname) + * [`fn withNamespace(namespace)`](#fn-specpostrendererskustomizepatchestargetwithnamespace) + * [`fn withVersion(version)`](#fn-specpostrendererskustomizepatchestargetwithversion) + * [`obj spec.postRenderers.kustomize.patchesJson6902`](#obj-specpostrendererskustomizepatchesjson6902) + * [`fn withPatch(patch)`](#fn-specpostrendererskustomizepatchesjson6902withpatch) + * [`fn withPatchMixin(patch)`](#fn-specpostrendererskustomizepatchesjson6902withpatchmixin) + * [`obj spec.postRenderers.kustomize.patchesJson6902.patch`](#obj-specpostrendererskustomizepatchesjson6902patch) + * [`fn withFrom(from)`](#fn-specpostrendererskustomizepatchesjson6902patchwithfrom) + * [`fn withOp(op)`](#fn-specpostrendererskustomizepatchesjson6902patchwithop) + * [`fn withPath(path)`](#fn-specpostrendererskustomizepatchesjson6902patchwithpath) + * [`fn withValue(value)`](#fn-specpostrendererskustomizepatchesjson6902patchwithvalue) + * [`obj spec.postRenderers.kustomize.patchesJson6902.target`](#obj-specpostrendererskustomizepatchesjson6902target) + * [`fn withAnnotationSelector(annotationSelector)`](#fn-specpostrendererskustomizepatchesjson6902targetwithannotationselector) + * [`fn withGroup(group)`](#fn-specpostrendererskustomizepatchesjson6902targetwithgroup) + * [`fn withKind(kind)`](#fn-specpostrendererskustomizepatchesjson6902targetwithkind) + * [`fn withLabelSelector(labelSelector)`](#fn-specpostrendererskustomizepatchesjson6902targetwithlabelselector) + * [`fn withName(name)`](#fn-specpostrendererskustomizepatchesjson6902targetwithname) + * [`fn withNamespace(namespace)`](#fn-specpostrendererskustomizepatchesjson6902targetwithnamespace) + * [`fn withVersion(version)`](#fn-specpostrendererskustomizepatchesjson6902targetwithversion) + * [`obj spec.rollback`](#obj-specrollback) + * [`fn withCleanupOnFail(cleanupOnFail)`](#fn-specrollbackwithcleanuponfail) + * [`fn withDisableHooks(disableHooks)`](#fn-specrollbackwithdisablehooks) + * [`fn withDisableWait(disableWait)`](#fn-specrollbackwithdisablewait) + * [`fn withDisableWaitForJobs(disableWaitForJobs)`](#fn-specrollbackwithdisablewaitforjobs) + * [`fn withForce(force)`](#fn-specrollbackwithforce) + * [`fn withRecreate(recreate)`](#fn-specrollbackwithrecreate) + * [`fn withTimeout(timeout)`](#fn-specrollbackwithtimeout) + * [`obj spec.test`](#obj-spectest) + * [`fn withEnable(enable)`](#fn-spectestwithenable) + * [`fn withFilters(filters)`](#fn-spectestwithfilters) + * [`fn withFiltersMixin(filters)`](#fn-spectestwithfiltersmixin) + * [`fn withIgnoreFailures(ignoreFailures)`](#fn-spectestwithignorefailures) + * [`fn withTimeout(timeout)`](#fn-spectestwithtimeout) + * [`obj spec.test.filters`](#obj-spectestfilters) + * [`fn withExclude(exclude)`](#fn-spectestfilterswithexclude) + * [`fn withName(name)`](#fn-spectestfilterswithname) + * [`obj spec.uninstall`](#obj-specuninstall) + * [`fn withDeletionPropagation(deletionPropagation)`](#fn-specuninstallwithdeletionpropagation) + * [`fn withDisableHooks(disableHooks)`](#fn-specuninstallwithdisablehooks) + * [`fn withDisableWait(disableWait)`](#fn-specuninstallwithdisablewait) + * [`fn withKeepHistory(keepHistory)`](#fn-specuninstallwithkeephistory) + * [`fn withTimeout(timeout)`](#fn-specuninstallwithtimeout) + * [`obj spec.upgrade`](#obj-specupgrade) + * [`fn withCleanupOnFail(cleanupOnFail)`](#fn-specupgradewithcleanuponfail) + * [`fn withCrds(crds)`](#fn-specupgradewithcrds) + * [`fn withDisableHooks(disableHooks)`](#fn-specupgradewithdisablehooks) + * [`fn withDisableOpenAPIValidation(disableOpenAPIValidation)`](#fn-specupgradewithdisableopenapivalidation) + * [`fn withDisableWait(disableWait)`](#fn-specupgradewithdisablewait) + * [`fn withDisableWaitForJobs(disableWaitForJobs)`](#fn-specupgradewithdisablewaitforjobs) + * [`fn withForce(force)`](#fn-specupgradewithforce) + * [`fn withPreserveValues(preserveValues)`](#fn-specupgradewithpreservevalues) + * [`fn withTimeout(timeout)`](#fn-specupgradewithtimeout) + * [`obj spec.upgrade.remediation`](#obj-specupgraderemediation) + * [`fn withIgnoreTestFailures(ignoreTestFailures)`](#fn-specupgraderemediationwithignoretestfailures) + * [`fn withRemediateLastFailure(remediateLastFailure)`](#fn-specupgraderemediationwithremediatelastfailure) + * [`fn withRetries(retries)`](#fn-specupgraderemediationwithretries) + * [`fn withStrategy(strategy)`](#fn-specupgraderemediationwithstrategy) + * [`obj spec.valuesFrom`](#obj-specvaluesfrom) + * [`fn withKind(kind)`](#fn-specvaluesfromwithkind) + * [`fn withName(name)`](#fn-specvaluesfromwithname) + * [`fn withOptional(optional)`](#fn-specvaluesfromwithoptional) + * [`fn withTargetPath(targetPath)`](#fn-specvaluesfromwithtargetpath) + * [`fn withValuesKey(valuesKey)`](#fn-specvaluesfromwithvalueskey) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of HelmRelease + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"HelmReleaseSpec defines the desired state of a Helm release." + +### fn spec.withDependsOn + +```ts +withDependsOn(dependsOn) +``` + +"DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled." + +### fn spec.withDependsOnMixin + +```ts +withDependsOnMixin(dependsOn) +``` + +"DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled." + +**Note:** This function appends passed data to existing values + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval at which to reconcile the Helm release." + +### fn spec.withMaxHistory + +```ts +withMaxHistory(maxHistory) +``` + +"MaxHistory is the number of revisions saved by Helm for this HelmRelease. Use '0' for an unlimited number of revisions; defaults to '5'." + +### fn spec.withPersistentClient + +```ts +withPersistentClient(persistentClient) +``` + +"PersistentClient tells the controller to use a persistent Kubernetes client for this release. When enabled, the client will be reused for the duration of the reconciliation, instead of being created and destroyed for each (step of a) Helm action. \n This can improve performance, but may cause issues with some Helm charts that for example do create Custom Resource Definitions during installation outside Helm's CRD lifecycle hooks, which are then not observed to be available by e.g. post-install hooks. \n If not set, it defaults to true." + +### fn spec.withPostRenderers + +```ts +withPostRenderers(postRenderers) +``` + +"PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition." + +### fn spec.withPostRenderersMixin + +```ts +withPostRenderersMixin(postRenderers) +``` + +"PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition." + +**Note:** This function appends passed data to existing values + +### fn spec.withReleaseName + +```ts +withReleaseName(releaseName) +``` + +"ReleaseName used for the Helm release. Defaults to a composition of '[TargetNamespace-]Name'." + +### fn spec.withServiceAccountName + +```ts +withServiceAccountName(serviceAccountName) +``` + +"The name of the Kubernetes service account to impersonate when reconciling this HelmRelease." + +### fn spec.withStorageNamespace + +```ts +withStorageNamespace(storageNamespace) +``` + +"StorageNamespace used for the Helm storage. Defaults to the namespace of the HelmRelease." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"Suspend tells the controller to suspend reconciliation for this HelmRelease, it does not apply to already started reconciliations. Defaults to false." + +### fn spec.withTargetNamespace + +```ts +withTargetNamespace(targetNamespace) +``` + +"TargetNamespace to target when performing operations for the HelmRelease. Defaults to the namespace of the HelmRelease." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm action. Defaults to '5m0s'." + +### fn spec.withValues + +```ts +withValues(values) +``` + +"Values holds the values for this Helm release." + +### fn spec.withValuesFrom + +```ts +withValuesFrom(valuesFrom) +``` + +"ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged." + +### fn spec.withValuesFromMixin + +```ts +withValuesFromMixin(valuesFrom) +``` + +"ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged." + +**Note:** This function appends passed data to existing values + +## obj spec.chart + +"Chart defines the template of the v1beta2.HelmChart that should be created for this HelmRelease." + +## obj spec.chart.metadata + +"ObjectMeta holds the template for metadata like labels and annotations." + +### fn spec.chart.metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/" + +### fn spec.chart.metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/" + +**Note:** This function appends passed data to existing values + +### fn spec.chart.metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/" + +### fn spec.chart.metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/" + +**Note:** This function appends passed data to existing values + +## obj spec.chart.spec + +"Spec holds the template for the v1beta2.HelmChartSpec for this HelmRelease." + +### fn spec.chart.spec.withChart + +```ts +withChart(chart) +``` + +"The name or path the Helm chart is available at in the SourceRef." + +### fn spec.chart.spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval at which to check the v1.Source for updates. Defaults to 'HelmReleaseSpec.Interval'." + +### fn spec.chart.spec.withReconcileStrategy + +```ts +withReconcileStrategy(reconcileStrategy) +``` + +"Determines what enables the creation of a new artifact. Valid values are ('ChartVersion', 'Revision'). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted." + +### fn spec.chart.spec.withValuesFile + +```ts +withValuesFile(valuesFile) +``` + +"Alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Deprecated in favor of ValuesFiles, for backwards compatibility the file defined here is merged before the ValuesFiles items. Ignored when omitted." + +### fn spec.chart.spec.withValuesFiles + +```ts +withValuesFiles(valuesFiles) +``` + +"Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted." + +### fn spec.chart.spec.withValuesFilesMixin + +```ts +withValuesFilesMixin(valuesFiles) +``` + +"Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted." + +**Note:** This function appends passed data to existing values + +### fn spec.chart.spec.withVersion + +```ts +withVersion(version) +``` + +"Version semver expression, ignored for charts from v1beta2.GitRepository and v1beta2.Bucket sources. Defaults to latest when omitted." + +## obj spec.chart.spec.sourceRef + +"The name and namespace of the v1.Source the chart is available at." + +### fn spec.chart.spec.sourceRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"APIVersion of the referent." + +### fn spec.chart.spec.sourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent." + +### fn spec.chart.spec.sourceRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +### fn spec.chart.spec.sourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent." + +## obj spec.chart.spec.verify + +"Verify 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. This field is only supported for OCI sources. Chart dependencies, which are not bundled in the umbrella chart artifact, are not verified." + +### fn spec.chart.spec.verify.withProvider + +```ts +withProvider(provider) +``` + +"Provider specifies the technology used to sign the OCI Helm chart." + +## obj spec.chart.spec.verify.secretRef + +"SecretRef specifies the Kubernetes Secret containing the trusted public keys." + +### fn spec.chart.spec.verify.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.dependsOn + +"DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled." + +### fn spec.dependsOn.withName + +```ts +withName(name) +``` + +"Name of the referent." + +### fn spec.dependsOn.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent, when not specified it acts as LocalObjectReference." + +## obj spec.driftDetection + +"DriftDetection holds the configuration for detecting and handling differences between the manifest in the Helm storage and the resources currently existing in the cluster." + +### fn spec.driftDetection.withIgnore + +```ts +withIgnore(ignore) +``` + +"Ignore contains a list of rules for specifying which changes to ignore during diffing." + +### fn spec.driftDetection.withIgnoreMixin + +```ts +withIgnoreMixin(ignore) +``` + +"Ignore contains a list of rules for specifying which changes to ignore during diffing." + +**Note:** This function appends passed data to existing values + +### fn spec.driftDetection.withMode + +```ts +withMode(mode) +``` + +"Mode defines how differences should be handled between the Helm manifest and the manifest currently applied to the cluster. If not explicitly set, it defaults to DiffModeDisabled." + +## obj spec.driftDetection.ignore + +"Ignore contains a list of rules for specifying which changes to ignore during diffing." + +### fn spec.driftDetection.ignore.withPaths + +```ts +withPaths(paths) +``` + +"Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from consideration in a Kubernetes object." + +### fn spec.driftDetection.ignore.withPathsMixin + +```ts +withPathsMixin(paths) +``` + +"Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from consideration in a Kubernetes object." + +**Note:** This function appends passed data to existing values + +## obj spec.driftDetection.ignore.target + +"Target is a selector for specifying Kubernetes objects to which this rule applies. If Target is not set, the Paths will be ignored for all Kubernetes objects within the manifest of the Helm release." + +### fn spec.driftDetection.ignore.target.withAnnotationSelector + +```ts +withAnnotationSelector(annotationSelector) +``` + +"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations." + +### fn spec.driftDetection.ignore.target.withGroup + +```ts +withGroup(group) +``` + +"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.driftDetection.ignore.target.withKind + +```ts +withKind(kind) +``` + +"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.driftDetection.ignore.target.withLabelSelector + +```ts +withLabelSelector(labelSelector) +``` + +"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels." + +### fn spec.driftDetection.ignore.target.withName + +```ts +withName(name) +``` + +"Name to match resources with." + +### fn spec.driftDetection.ignore.target.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace to select resources from." + +### fn spec.driftDetection.ignore.target.withVersion + +```ts +withVersion(version) +``` + +"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +## obj spec.install + +"Install holds the configuration for Helm install actions for this HelmRelease." + +### fn spec.install.withCrds + +```ts +withCrds(crds) +``` + +"CRDs upgrade CRDs from the Helm Chart's crds directory according to the CRD upgrade policy provided here. Valid values are `Skip`, `Create` or `CreateReplace`. Default is `Create` and if omitted CRDs are installed but not updated. \n Skip: do neither install nor replace (update) any CRDs. \n Create: new CRDs are created, existing CRDs are neither updated nor deleted. \n CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted. \n By default, CRDs are applied (installed) during Helm install action. With this option users can opt in to CRD replace existing CRDs on Helm install actions, which is not (yet) natively supported by Helm. https://helm.sh/docs/chart_best_practices/custom_resource_definitions." + +### fn spec.install.withCreateNamespace + +```ts +withCreateNamespace(createNamespace) +``` + +"CreateNamespace tells the Helm install action to create the HelmReleaseSpec.TargetNamespace if it does not exist yet. On uninstall, the namespace will not be garbage collected." + +### fn spec.install.withDisableHooks + +```ts +withDisableHooks(disableHooks) +``` + +"DisableHooks prevents hooks from running during the Helm install action." + +### fn spec.install.withDisableOpenAPIValidation + +```ts +withDisableOpenAPIValidation(disableOpenAPIValidation) +``` + +"DisableOpenAPIValidation prevents the Helm install action from validating rendered templates against the Kubernetes OpenAPI Schema." + +### fn spec.install.withDisableWait + +```ts +withDisableWait(disableWait) +``` + +"DisableWait disables the waiting for resources to be ready after a Helm install has been performed." + +### fn spec.install.withDisableWaitForJobs + +```ts +withDisableWaitForJobs(disableWaitForJobs) +``` + +"DisableWaitForJobs disables waiting for jobs to complete after a Helm install has been performed." + +### fn spec.install.withReplace + +```ts +withReplace(replace) +``` + +"Replace tells the Helm install action to re-use the 'ReleaseName', but only if that name is a deleted release which remains in the history." + +### fn spec.install.withSkipCRDs + +```ts +withSkipCRDs(skipCRDs) +``` + +"SkipCRDs tells the Helm install action to not install any CRDs. By default, CRDs are installed if not already present. \n Deprecated use CRD policy (`crds`) attribute with value `Skip` instead." + +### fn spec.install.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm install action. Defaults to 'HelmReleaseSpec.Timeout'." + +## obj spec.install.remediation + +"Remediation holds the remediation configuration for when the Helm install action for the HelmRelease fails. The default is to not perform any action." + +### fn spec.install.remediation.withIgnoreTestFailures + +```ts +withIgnoreTestFailures(ignoreTestFailures) +``` + +"IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an install action but fail. Defaults to 'Test.IgnoreFailures'." + +### fn spec.install.remediation.withRemediateLastFailure + +```ts +withRemediateLastFailure(remediateLastFailure) +``` + +"RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false'." + +### fn spec.install.remediation.withRetries + +```ts +withRetries(retries) +``` + +"Retries is the number of retries that should be attempted on failures before bailing. Remediation, using an uninstall, is performed between each attempt. Defaults to '0', a negative integer equals to unlimited retries." + +## obj spec.kubeConfig + +"KubeConfig for reconciling the HelmRelease on a remote cluster. When used in combination with HelmReleaseSpec.ServiceAccountName, forces the controller to act on behalf of that Service Account at the target cluster. If the --default-service-account flag is set, its value will be used as a controller level fallback for when HelmReleaseSpec.ServiceAccountName is empty." + +## obj spec.kubeConfig.secretRef + +"SecretRef holds the name of a secret that contains a key with the kubeconfig file as the value. If no key is set, the key will default to 'value'. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific `cmd-path` auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling Kubernetes resources." + +### fn spec.kubeConfig.secretRef.withKey + +```ts +withKey(key) +``` + +"Key in the Secret, when not specified an implementation-specific default key is used." + +### fn spec.kubeConfig.secretRef.withName + +```ts +withName(name) +``` + +"Name of the Secret." + +## obj spec.postRenderers + +"PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition." + +## obj spec.postRenderers.kustomize + +"Kustomization to apply as PostRenderer." + +### fn spec.postRenderers.kustomize.withImages + +```ts +withImages(images) +``` + +"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify." + +### fn spec.postRenderers.kustomize.withImagesMixin + +```ts +withImagesMixin(images) +``` + +"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify." + +**Note:** This function appends passed data to existing values + +### fn spec.postRenderers.kustomize.withPatches + +```ts +withPatches(patches) +``` + +"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors." + +### fn spec.postRenderers.kustomize.withPatchesJson6902 + +```ts +withPatchesJson6902(patchesJson6902) +``` + +"JSON 6902 patches, defined as inline YAML objects. Deprecated: use Patches instead." + +### fn spec.postRenderers.kustomize.withPatchesJson6902Mixin + +```ts +withPatchesJson6902Mixin(patchesJson6902) +``` + +"JSON 6902 patches, defined as inline YAML objects. Deprecated: use Patches instead." + +**Note:** This function appends passed data to existing values + +### fn spec.postRenderers.kustomize.withPatchesMixin + +```ts +withPatchesMixin(patches) +``` + +"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors." + +**Note:** This function appends passed data to existing values + +### fn spec.postRenderers.kustomize.withPatchesStrategicMerge + +```ts +withPatchesStrategicMerge(patchesStrategicMerge) +``` + +"Strategic merge patches, defined as inline YAML objects. Deprecated: use Patches instead." + +### fn spec.postRenderers.kustomize.withPatchesStrategicMergeMixin + +```ts +withPatchesStrategicMergeMixin(patchesStrategicMerge) +``` + +"Strategic merge patches, defined as inline YAML objects. Deprecated: use Patches instead." + +**Note:** This function appends passed data to existing values + +## obj spec.postRenderers.kustomize.images + +"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify." + +### fn spec.postRenderers.kustomize.images.withDigest + +```ts +withDigest(digest) +``` + +"Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored." + +### fn spec.postRenderers.kustomize.images.withName + +```ts +withName(name) +``` + +"Name is a tag-less image name." + +### fn spec.postRenderers.kustomize.images.withNewName + +```ts +withNewName(newName) +``` + +"NewName is the value used to replace the original name." + +### fn spec.postRenderers.kustomize.images.withNewTag + +```ts +withNewTag(newTag) +``` + +"NewTag is the value used to replace the original tag." + +## obj spec.postRenderers.kustomize.patches + +"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors." + +### fn spec.postRenderers.kustomize.patches.withPatch + +```ts +withPatch(patch) +``` + +"Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects." + +## obj spec.postRenderers.kustomize.patches.target + +"Target points to the resources that the patch document should be applied to." + +### fn spec.postRenderers.kustomize.patches.target.withAnnotationSelector + +```ts +withAnnotationSelector(annotationSelector) +``` + +"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations." + +### fn spec.postRenderers.kustomize.patches.target.withGroup + +```ts +withGroup(group) +``` + +"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.postRenderers.kustomize.patches.target.withKind + +```ts +withKind(kind) +``` + +"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.postRenderers.kustomize.patches.target.withLabelSelector + +```ts +withLabelSelector(labelSelector) +``` + +"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels." + +### fn spec.postRenderers.kustomize.patches.target.withName + +```ts +withName(name) +``` + +"Name to match resources with." + +### fn spec.postRenderers.kustomize.patches.target.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace to select resources from." + +### fn spec.postRenderers.kustomize.patches.target.withVersion + +```ts +withVersion(version) +``` + +"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +## obj spec.postRenderers.kustomize.patchesJson6902 + +"JSON 6902 patches, defined as inline YAML objects. Deprecated: use Patches instead." + +### fn spec.postRenderers.kustomize.patchesJson6902.withPatch + +```ts +withPatch(patch) +``` + +"Patch contains the JSON6902 patch document with an array of operation objects." + +### fn spec.postRenderers.kustomize.patchesJson6902.withPatchMixin + +```ts +withPatchMixin(patch) +``` + +"Patch contains the JSON6902 patch document with an array of operation objects." + +**Note:** This function appends passed data to existing values + +## obj spec.postRenderers.kustomize.patchesJson6902.patch + +"Patch contains the JSON6902 patch document with an array of operation objects." + +### fn spec.postRenderers.kustomize.patchesJson6902.patch.withFrom + +```ts +withFrom(from) +``` + +"From contains a JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations." + +### fn spec.postRenderers.kustomize.patchesJson6902.patch.withOp + +```ts +withOp(op) +``` + +"Op indicates the operation to perform. Its value MUST be one of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or \"test\". https://datatracker.ietf.org/doc/html/rfc6902#section-4" + +### fn spec.postRenderers.kustomize.patchesJson6902.patch.withPath + +```ts +withPath(path) +``` + +"Path contains the JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op." + +### fn spec.postRenderers.kustomize.patchesJson6902.patch.withValue + +```ts +withValue(value) +``` + +"Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations." + +## obj spec.postRenderers.kustomize.patchesJson6902.target + +"Target points to the resources that the patch document should be applied to." + +### fn spec.postRenderers.kustomize.patchesJson6902.target.withAnnotationSelector + +```ts +withAnnotationSelector(annotationSelector) +``` + +"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations." + +### fn spec.postRenderers.kustomize.patchesJson6902.target.withGroup + +```ts +withGroup(group) +``` + +"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.postRenderers.kustomize.patchesJson6902.target.withKind + +```ts +withKind(kind) +``` + +"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.postRenderers.kustomize.patchesJson6902.target.withLabelSelector + +```ts +withLabelSelector(labelSelector) +``` + +"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels." + +### fn spec.postRenderers.kustomize.patchesJson6902.target.withName + +```ts +withName(name) +``` + +"Name to match resources with." + +### fn spec.postRenderers.kustomize.patchesJson6902.target.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace to select resources from." + +### fn spec.postRenderers.kustomize.patchesJson6902.target.withVersion + +```ts +withVersion(version) +``` + +"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +## obj spec.rollback + +"Rollback holds the configuration for Helm rollback actions for this HelmRelease." + +### fn spec.rollback.withCleanupOnFail + +```ts +withCleanupOnFail(cleanupOnFail) +``` + +"CleanupOnFail allows deletion of new resources created during the Helm rollback action when it fails." + +### fn spec.rollback.withDisableHooks + +```ts +withDisableHooks(disableHooks) +``` + +"DisableHooks prevents hooks from running during the Helm rollback action." + +### fn spec.rollback.withDisableWait + +```ts +withDisableWait(disableWait) +``` + +"DisableWait disables the waiting for resources to be ready after a Helm rollback has been performed." + +### fn spec.rollback.withDisableWaitForJobs + +```ts +withDisableWaitForJobs(disableWaitForJobs) +``` + +"DisableWaitForJobs disables waiting for jobs to complete after a Helm rollback has been performed." + +### fn spec.rollback.withForce + +```ts +withForce(force) +``` + +"Force forces resource updates through a replacement strategy." + +### fn spec.rollback.withRecreate + +```ts +withRecreate(recreate) +``` + +"Recreate performs pod restarts for the resource if applicable." + +### fn spec.rollback.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm rollback action. Defaults to 'HelmReleaseSpec.Timeout'." + +## obj spec.test + +"Test holds the configuration for Helm test actions for this HelmRelease." + +### fn spec.test.withEnable + +```ts +withEnable(enable) +``` + +"Enable enables Helm test actions for this HelmRelease after an Helm install or upgrade action has been performed." + +### fn spec.test.withFilters + +```ts +withFilters(filters) +``` + +"Filters is a list of tests to run or exclude from running." + +### fn spec.test.withFiltersMixin + +```ts +withFiltersMixin(filters) +``` + +"Filters is a list of tests to run or exclude from running." + +**Note:** This function appends passed data to existing values + +### fn spec.test.withIgnoreFailures + +```ts +withIgnoreFailures(ignoreFailures) +``` + +"IgnoreFailures tells the controller to skip remediation when the Helm tests are run but fail. Can be overwritten for tests run after install or upgrade actions in 'Install.IgnoreTestFailures' and 'Upgrade.IgnoreTestFailures'." + +### fn spec.test.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout is the time to wait for any individual Kubernetes operation during the performance of a Helm test action. Defaults to 'HelmReleaseSpec.Timeout'." + +## obj spec.test.filters + +"Filters is a list of tests to run or exclude from running." + +### fn spec.test.filters.withExclude + +```ts +withExclude(exclude) +``` + +"Exclude specifies whether the named test should be excluded." + +### fn spec.test.filters.withName + +```ts +withName(name) +``` + +"Name is the name of the test." + +## obj spec.uninstall + +"Uninstall holds the configuration for Helm uninstall actions for this HelmRelease." + +### fn spec.uninstall.withDeletionPropagation + +```ts +withDeletionPropagation(deletionPropagation) +``` + +"DeletionPropagation specifies the deletion propagation policy when a Helm uninstall is performed." + +### fn spec.uninstall.withDisableHooks + +```ts +withDisableHooks(disableHooks) +``` + +"DisableHooks prevents hooks from running during the Helm rollback action." + +### fn spec.uninstall.withDisableWait + +```ts +withDisableWait(disableWait) +``` + +"DisableWait disables waiting for all the resources to be deleted after a Helm uninstall is performed." + +### fn spec.uninstall.withKeepHistory + +```ts +withKeepHistory(keepHistory) +``` + +"KeepHistory tells Helm to remove all associated resources and mark the release as deleted, but retain the release history." + +### fn spec.uninstall.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm uninstall action. Defaults to 'HelmReleaseSpec.Timeout'." + +## obj spec.upgrade + +"Upgrade holds the configuration for Helm upgrade actions for this HelmRelease." + +### fn spec.upgrade.withCleanupOnFail + +```ts +withCleanupOnFail(cleanupOnFail) +``` + +"CleanupOnFail allows deletion of new resources created during the Helm upgrade action when it fails." + +### fn spec.upgrade.withCrds + +```ts +withCrds(crds) +``` + +"CRDs upgrade CRDs from the Helm Chart's crds directory according to the CRD upgrade policy provided here. Valid values are `Skip`, `Create` or `CreateReplace`. Default is `Skip` and if omitted CRDs are neither installed nor upgraded. \n Skip: do neither install nor replace (update) any CRDs. \n Create: new CRDs are created, existing CRDs are neither updated nor deleted. \n CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted. \n By default, CRDs are not applied during Helm upgrade action. With this option users can opt-in to CRD upgrade, which is not (yet) natively supported by Helm. https://helm.sh/docs/chart_best_practices/custom_resource_definitions." + +### fn spec.upgrade.withDisableHooks + +```ts +withDisableHooks(disableHooks) +``` + +"DisableHooks prevents hooks from running during the Helm upgrade action." + +### fn spec.upgrade.withDisableOpenAPIValidation + +```ts +withDisableOpenAPIValidation(disableOpenAPIValidation) +``` + +"DisableOpenAPIValidation prevents the Helm upgrade action from validating rendered templates against the Kubernetes OpenAPI Schema." + +### fn spec.upgrade.withDisableWait + +```ts +withDisableWait(disableWait) +``` + +"DisableWait disables the waiting for resources to be ready after a Helm upgrade has been performed." + +### fn spec.upgrade.withDisableWaitForJobs + +```ts +withDisableWaitForJobs(disableWaitForJobs) +``` + +"DisableWaitForJobs disables waiting for jobs to complete after a Helm upgrade has been performed." + +### fn spec.upgrade.withForce + +```ts +withForce(force) +``` + +"Force forces resource updates through a replacement strategy." + +### fn spec.upgrade.withPreserveValues + +```ts +withPreserveValues(preserveValues) +``` + +"PreserveValues will make Helm reuse the last release's values and merge in overrides from 'Values'. Setting this flag makes the HelmRelease non-declarative." + +### fn spec.upgrade.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm upgrade action. Defaults to 'HelmReleaseSpec.Timeout'." + +## obj spec.upgrade.remediation + +"Remediation holds the remediation configuration for when the Helm upgrade action for the HelmRelease fails. The default is to not perform any action." + +### fn spec.upgrade.remediation.withIgnoreTestFailures + +```ts +withIgnoreTestFailures(ignoreTestFailures) +``` + +"IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an upgrade action but fail. Defaults to 'Test.IgnoreFailures'." + +### fn spec.upgrade.remediation.withRemediateLastFailure + +```ts +withRemediateLastFailure(remediateLastFailure) +``` + +"RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false' unless 'Retries' is greater than 0." + +### fn spec.upgrade.remediation.withRetries + +```ts +withRetries(retries) +``` + +"Retries is the number of retries that should be attempted on failures before bailing. Remediation, using 'Strategy', is performed between each attempt. Defaults to '0', a negative integer equals to unlimited retries." + +### fn spec.upgrade.remediation.withStrategy + +```ts +withStrategy(strategy) +``` + +"Strategy to use for failure remediation. Defaults to 'rollback'." + +## obj spec.valuesFrom + +"ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged." + +### fn spec.valuesFrom.withKind + +```ts +withKind(kind) +``` + +"Kind of the values referent, valid values are ('Secret', 'ConfigMap')." + +### fn spec.valuesFrom.withName + +```ts +withName(name) +``` + +"Name of the values referent. Should reside in the same namespace as the referring resource." + +### fn spec.valuesFrom.withOptional + +```ts +withOptional(optional) +``` + +"Optional marks this ValuesReference as optional. When set, a not found error for the values reference is ignored, but any ValuesKey, TargetPath or transient error will still result in a reconciliation failure." + +### fn spec.valuesFrom.withTargetPath + +```ts +withTargetPath(targetPath) +``` + +"TargetPath is the YAML dot notation path the value should be merged at. When set, the ValuesKey is expected to be a single flat value. Defaults to 'None', which results in the values getting merged at the root." + +### fn spec.valuesFrom.withValuesKey + +```ts +withValuesKey(valuesKey) +``` + +"ValuesKey is the data key where the values.yaml or a specific value can be found at. Defaults to 'values.yaml'." \ No newline at end of file diff --git a/docs/2.2.1/helm/v2beta2/index.md b/docs/2.2.1/helm/v2beta2/index.md new file mode 100644 index 0000000..c0ecf18 --- /dev/null +++ b/docs/2.2.1/helm/v2beta2/index.md @@ -0,0 +1,9 @@ +--- +permalink: /2.2.1/helm/v2beta2/ +--- + +# helm.v2beta2 + + + +* [helmRelease](helmRelease.md) \ No newline at end of file diff --git a/docs/2.2.1/image/index.md b/docs/2.2.1/image/index.md new file mode 100644 index 0000000..e7134ca --- /dev/null +++ b/docs/2.2.1/image/index.md @@ -0,0 +1,10 @@ +--- +permalink: /2.2.1/image/ +--- + +# image + + + +* [v1beta1](v1beta1/index.md) +* [v1beta2](v1beta2/index.md) \ No newline at end of file diff --git a/docs/2.2.1/image/v1beta1/imagePolicy.md b/docs/2.2.1/image/v1beta1/imagePolicy.md new file mode 100644 index 0000000..dc0a5d2 --- /dev/null +++ b/docs/2.2.1/image/v1beta1/imagePolicy.md @@ -0,0 +1,303 @@ +--- +permalink: /2.2.1/image/v1beta1/imagePolicy/ +--- + +# image.v1beta1.imagePolicy + +"ImagePolicy is the Schema for the imagepolicies API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`obj spec.filterTags`](#obj-specfiltertags) + * [`fn withExtract(extract)`](#fn-specfiltertagswithextract) + * [`fn withPattern(pattern)`](#fn-specfiltertagswithpattern) + * [`obj spec.imageRepositoryRef`](#obj-specimagerepositoryref) + * [`fn withName(name)`](#fn-specimagerepositoryrefwithname) + * [`fn withNamespace(namespace)`](#fn-specimagerepositoryrefwithnamespace) + * [`obj spec.policy`](#obj-specpolicy) + * [`obj spec.policy.alphabetical`](#obj-specpolicyalphabetical) + * [`fn withOrder(order)`](#fn-specpolicyalphabeticalwithorder) + * [`obj spec.policy.numerical`](#obj-specpolicynumerical) + * [`fn withOrder(order)`](#fn-specpolicynumericalwithorder) + * [`obj spec.policy.semver`](#obj-specpolicysemver) + * [`fn withRange(range)`](#fn-specpolicysemverwithrange) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ImagePolicy + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ImagePolicySpec defines the parameters for calculating the ImagePolicy" + +## obj spec.filterTags + +"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." + +### fn spec.filterTags.withExtract + +```ts +withExtract(extract) +``` + +"Extract allows a capture group to be extracted from the specified regular expression pattern, useful before tag evaluation." + +### fn spec.filterTags.withPattern + +```ts +withPattern(pattern) +``` + +"Pattern specifies a regular expression pattern used to filter for image tags." + +## obj spec.imageRepositoryRef + +"ImageRepositoryRef points at the object specifying the image being scanned" + +### fn spec.imageRepositoryRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +### fn spec.imageRepositoryRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent, when not specified it acts as LocalObjectReference." + +## obj spec.policy + +"Policy gives the particulars of the policy to be followed in selecting the most recent image" + +## obj spec.policy.alphabetical + +"Alphabetical set of rules to use for alphabetical ordering of the tags." + +### fn spec.policy.alphabetical.withOrder + +```ts +withOrder(order) +``` + +"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." + +## obj spec.policy.numerical + +"Numerical set of rules to use for numerical ordering of the tags." + +### fn spec.policy.numerical.withOrder + +```ts +withOrder(order) +``` + +"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." + +## obj spec.policy.semver + +"SemVer gives a semantic version range to check against the tags available." + +### fn spec.policy.semver.withRange + +```ts +withRange(range) +``` + +"Range gives a semver range for the image tag; the highest version within the range that's a tag yields the latest image." \ No newline at end of file diff --git a/docs/2.2.1/image/v1beta1/imageRepository.md b/docs/2.2.1/image/v1beta1/imageRepository.md new file mode 100644 index 0000000..a1c9f6b --- /dev/null +++ b/docs/2.2.1/image/v1beta1/imageRepository.md @@ -0,0 +1,353 @@ +--- +permalink: /2.2.1/image/v1beta1/imageRepository/ +--- + +# image.v1beta1.imageRepository + +"ImageRepository is the Schema for the imagerepositories API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withExclusionList(exclusionList)`](#fn-specwithexclusionlist) + * [`fn withExclusionListMixin(exclusionList)`](#fn-specwithexclusionlistmixin) + * [`fn withImage(image)`](#fn-specwithimage) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withServiceAccountName(serviceAccountName)`](#fn-specwithserviceaccountname) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`obj spec.accessFrom`](#obj-specaccessfrom) + * [`fn withNamespaceSelectors(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectors) + * [`fn withNamespaceSelectorsMixin(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectorsmixin) + * [`obj spec.accessFrom.namespaceSelectors`](#obj-specaccessfromnamespaceselectors) + * [`fn withMatchLabels(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabelsmixin) + * [`obj spec.certSecretRef`](#obj-speccertsecretref) + * [`fn withName(name)`](#fn-speccertsecretrefwithname) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ImageRepository + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ImageRepositorySpec defines the parameters for scanning an image repository, e.g., `fluxcd/flux`." + +### fn spec.withExclusionList + +```ts +withExclusionList(exclusionList) +``` + +"ExclusionList is a list of regex strings used to exclude certain tags from being stored in the database." + +### fn spec.withExclusionListMixin + +```ts +withExclusionListMixin(exclusionList) +``` + +"ExclusionList is a list of regex strings used to exclude certain tags from being stored in the database." + +**Note:** This function appends passed data to existing values + +### fn spec.withImage + +```ts +withImage(image) +``` + +"Image is the name of the image repository" + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval is the length of time to wait between scans of the image repository." + +### fn spec.withServiceAccountName + +```ts +withServiceAccountName(serviceAccountName) +``` + +"ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate the image pull if the service account has attached pull secrets." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"This flag tells the controller to suspend subsequent image scans. It does not apply to already started scans. Defaults to false." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout for image scanning. Defaults to 'Interval' duration." + +## obj spec.accessFrom + +"AccessFrom defines an ACL for allowing cross-namespace references to the ImageRepository object based on the caller's namespace labels." + +### fn spec.accessFrom.withNamespaceSelectors + +```ts +withNamespaceSelectors(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.withNamespaceSelectorsMixin + +```ts +withNamespaceSelectorsMixin(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +**Note:** This function appends passed data to existing values + +## obj spec.accessFrom.namespaceSelectors + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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." + +**Note:** This function appends passed data to existing values + +## obj spec.certSecretRef + +"CertSecretRef can be given the name of a secret containing either or both of \n - a PEM-encoded client certificate (`certFile`) and private key (`keyFile`); - a PEM-encoded CA certificate (`caFile`) \n 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." + +### fn spec.certSecretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.secretRef + +"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." + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/image/v1beta1/imageUpdateAutomation.md b/docs/2.2.1/image/v1beta1/imageUpdateAutomation.md new file mode 100644 index 0000000..d0da5b1 --- /dev/null +++ b/docs/2.2.1/image/v1beta1/imageUpdateAutomation.md @@ -0,0 +1,451 @@ +--- +permalink: /2.2.1/image/v1beta1/imageUpdateAutomation/ +--- + +# image.v1beta1.imageUpdateAutomation + +"ImageUpdateAutomation is the Schema for the imageupdateautomations API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`obj spec.git`](#obj-specgit) + * [`obj spec.git.checkout`](#obj-specgitcheckout) + * [`obj spec.git.checkout.ref`](#obj-specgitcheckoutref) + * [`fn withBranch(branch)`](#fn-specgitcheckoutrefwithbranch) + * [`fn withCommit(commit)`](#fn-specgitcheckoutrefwithcommit) + * [`fn withName(name)`](#fn-specgitcheckoutrefwithname) + * [`fn withSemver(semver)`](#fn-specgitcheckoutrefwithsemver) + * [`fn withTag(tag)`](#fn-specgitcheckoutrefwithtag) + * [`obj spec.git.commit`](#obj-specgitcommit) + * [`fn withMessageTemplate(messageTemplate)`](#fn-specgitcommitwithmessagetemplate) + * [`obj spec.git.commit.author`](#obj-specgitcommitauthor) + * [`fn withEmail(email)`](#fn-specgitcommitauthorwithemail) + * [`fn withName(name)`](#fn-specgitcommitauthorwithname) + * [`obj spec.git.commit.signingKey`](#obj-specgitcommitsigningkey) + * [`obj spec.git.commit.signingKey.secretRef`](#obj-specgitcommitsigningkeysecretref) + * [`fn withName(name)`](#fn-specgitcommitsigningkeysecretrefwithname) + * [`obj spec.git.push`](#obj-specgitpush) + * [`fn withBranch(branch)`](#fn-specgitpushwithbranch) + * [`fn withOptions(options)`](#fn-specgitpushwithoptions) + * [`fn withOptionsMixin(options)`](#fn-specgitpushwithoptionsmixin) + * [`fn withRefspec(refspec)`](#fn-specgitpushwithrefspec) + * [`obj spec.sourceRef`](#obj-specsourceref) + * [`fn withApiVersion(apiVersion)`](#fn-specsourcerefwithapiversion) + * [`fn withKind(kind)`](#fn-specsourcerefwithkind) + * [`fn withName(name)`](#fn-specsourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specsourcerefwithnamespace) + * [`obj spec.update`](#obj-specupdate) + * [`fn withPath(path)`](#fn-specupdatewithpath) + * [`fn withStrategy(strategy)`](#fn-specupdatewithstrategy) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ImageUpdateAutomation + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ImageUpdateAutomationSpec defines the desired state of ImageUpdateAutomation" + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval gives an lower bound for how often the automation run should be attempted." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"Suspend tells the controller to not run this automation, until it is unset (or set to false). Defaults to false." + +## obj spec.git + +"GitSpec contains all the git-specific definitions. This is technically optional, but in practice mandatory until there are other kinds of source allowed." + +## obj spec.git.checkout + +"Checkout gives the parameters for cloning the git repository, ready to make changes. If not present, the `spec.ref` field from the referenced `GitRepository` or its default will be used." + +## obj spec.git.checkout.ref + +"Reference gives a branch, tag or commit to clone from the Git repository." + +### fn spec.git.checkout.ref.withBranch + +```ts +withBranch(branch) +``` + +"Branch to check out, defaults to 'master' if no other field is defined." + +### fn spec.git.checkout.ref.withCommit + +```ts +withCommit(commit) +``` + +"Commit SHA to check out, takes precedence over all reference fields. \n This can be combined with Branch to shallow clone the branch, in which the commit is expected to exist." + +### fn spec.git.checkout.ref.withName + +```ts +withName(name) +``` + +"Name of the reference to check out; takes precedence over Branch, Tag and SemVer. \n It must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description Examples: \"refs/heads/main\", \"refs/tags/v0.1.0\", \"refs/pull/420/head\", \"refs/merge-requests/1/head\ + +### fn spec.git.checkout.ref.withSemver + +```ts +withSemver(semver) +``` + +"SemVer tag expression to check out, takes precedence over Tag." + +### fn spec.git.checkout.ref.withTag + +```ts +withTag(tag) +``` + +"Tag to check out, takes precedence over Branch." + +## obj spec.git.commit + +"Commit specifies how to commit to the git repository." + +### fn spec.git.commit.withMessageTemplate + +```ts +withMessageTemplate(messageTemplate) +``` + +"MessageTemplate provides a template for the commit message, into which will be interpolated the details of the change made." + +## obj spec.git.commit.author + +"Author gives the email and optionally the name to use as the author of commits." + +### fn spec.git.commit.author.withEmail + +```ts +withEmail(email) +``` + +"Email gives the email to provide when making a commit." + +### fn spec.git.commit.author.withName + +```ts +withName(name) +``` + +"Name gives the name to provide when making a commit." + +## obj spec.git.commit.signingKey + +"SigningKey provides the option to sign commits with a GPG key" + +## obj spec.git.commit.signingKey.secretRef + +"SecretRef holds the name to a secret that contains a 'git.asc' key corresponding to the ASCII Armored file containing the GPG signing keypair as the value. It must be in the same namespace as the ImageUpdateAutomation." + +### fn spec.git.commit.signingKey.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.git.push + +"Push specifies how and where to push commits made by the automation. If missing, commits are pushed (back) to `.spec.checkout.branch` or its default." + +### fn spec.git.push.withBranch + +```ts +withBranch(branch) +``` + +"Branch specifies that commits should be pushed to the branch named. The branch is created using `.spec.checkout.branch` as the starting point, if it doesn't already exist." + +### fn spec.git.push.withOptions + +```ts +withOptions(options) +``` + +"Options specifies the push options that are sent to the Git server when performing a push operation. For details, see: https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt" + +### fn spec.git.push.withOptionsMixin + +```ts +withOptionsMixin(options) +``` + +"Options specifies the push options that are sent to the Git server when performing a push operation. For details, see: https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt" + +**Note:** This function appends passed data to existing values + +### fn spec.git.push.withRefspec + +```ts +withRefspec(refspec) +``` + +"Refspec specifies the Git Refspec to use for a push operation. If both Branch and Refspec are provided, then the commit is pushed to the branch and also using the specified refspec. For more details about Git Refspecs, see: https://git-scm.com/book/en/v2/Git-Internals-The-Refspec" + +## obj spec.sourceRef + +"SourceRef refers to the resource giving access details to a git repository." + +### fn spec.sourceRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"API version of the referent." + +### fn spec.sourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent." + +### fn spec.sourceRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +### fn spec.sourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent, defaults to the namespace of the Kubernetes resource object that contains the reference." + +## obj spec.update + +"Update gives the specification for how to update the files in the repository. This can be left empty, to use the default value." + +### fn spec.update.withPath + +```ts +withPath(path) +``` + +"Path to the directory containing the manifests to be updated. Defaults to 'None', which translates to the root path of the GitRepositoryRef." + +### fn spec.update.withStrategy + +```ts +withStrategy(strategy) +``` + +"Strategy names the strategy to be used." \ No newline at end of file diff --git a/docs/2.2.1/image/v1beta1/index.md b/docs/2.2.1/image/v1beta1/index.md new file mode 100644 index 0000000..d001b09 --- /dev/null +++ b/docs/2.2.1/image/v1beta1/index.md @@ -0,0 +1,11 @@ +--- +permalink: /2.2.1/image/v1beta1/ +--- + +# image.v1beta1 + + + +* [imagePolicy](imagePolicy.md) +* [imageRepository](imageRepository.md) +* [imageUpdateAutomation](imageUpdateAutomation.md) \ No newline at end of file diff --git a/docs/2.2.1/image/v1beta2/imagePolicy.md b/docs/2.2.1/image/v1beta2/imagePolicy.md new file mode 100644 index 0000000..4ca07d0 --- /dev/null +++ b/docs/2.2.1/image/v1beta2/imagePolicy.md @@ -0,0 +1,303 @@ +--- +permalink: /2.2.1/image/v1beta2/imagePolicy/ +--- + +# image.v1beta2.imagePolicy + +"ImagePolicy is the Schema for the imagepolicies API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`obj spec.filterTags`](#obj-specfiltertags) + * [`fn withExtract(extract)`](#fn-specfiltertagswithextract) + * [`fn withPattern(pattern)`](#fn-specfiltertagswithpattern) + * [`obj spec.imageRepositoryRef`](#obj-specimagerepositoryref) + * [`fn withName(name)`](#fn-specimagerepositoryrefwithname) + * [`fn withNamespace(namespace)`](#fn-specimagerepositoryrefwithnamespace) + * [`obj spec.policy`](#obj-specpolicy) + * [`obj spec.policy.alphabetical`](#obj-specpolicyalphabetical) + * [`fn withOrder(order)`](#fn-specpolicyalphabeticalwithorder) + * [`obj spec.policy.numerical`](#obj-specpolicynumerical) + * [`fn withOrder(order)`](#fn-specpolicynumericalwithorder) + * [`obj spec.policy.semver`](#obj-specpolicysemver) + * [`fn withRange(range)`](#fn-specpolicysemverwithrange) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ImagePolicy + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ImagePolicySpec defines the parameters for calculating the ImagePolicy." + +## obj spec.filterTags + +"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." + +### fn spec.filterTags.withExtract + +```ts +withExtract(extract) +``` + +"Extract allows a capture group to be extracted from the specified regular expression pattern, useful before tag evaluation." + +### fn spec.filterTags.withPattern + +```ts +withPattern(pattern) +``` + +"Pattern specifies a regular expression pattern used to filter for image tags." + +## obj spec.imageRepositoryRef + +"ImageRepositoryRef points at the object specifying the image being scanned" + +### fn spec.imageRepositoryRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +### fn spec.imageRepositoryRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent, when not specified it acts as LocalObjectReference." + +## obj spec.policy + +"Policy gives the particulars of the policy to be followed in selecting the most recent image" + +## obj spec.policy.alphabetical + +"Alphabetical set of rules to use for alphabetical ordering of the tags." + +### fn spec.policy.alphabetical.withOrder + +```ts +withOrder(order) +``` + +"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." + +## obj spec.policy.numerical + +"Numerical set of rules to use for numerical ordering of the tags." + +### fn spec.policy.numerical.withOrder + +```ts +withOrder(order) +``` + +"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." + +## obj spec.policy.semver + +"SemVer gives a semantic version range to check against the tags available." + +### fn spec.policy.semver.withRange + +```ts +withRange(range) +``` + +"Range gives a semver range for the image tag; the highest version within the range that's a tag yields the latest image." \ No newline at end of file diff --git a/docs/2.2.1/image/v1beta2/imageRepository.md b/docs/2.2.1/image/v1beta2/imageRepository.md new file mode 100644 index 0000000..8ee32c7 --- /dev/null +++ b/docs/2.2.1/image/v1beta2/imageRepository.md @@ -0,0 +1,371 @@ +--- +permalink: /2.2.1/image/v1beta2/imageRepository/ +--- + +# image.v1beta2.imageRepository + +"ImageRepository is the Schema for the imagerepositories API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withExclusionList(exclusionList)`](#fn-specwithexclusionlist) + * [`fn withExclusionListMixin(exclusionList)`](#fn-specwithexclusionlistmixin) + * [`fn withImage(image)`](#fn-specwithimage) + * [`fn withInsecure(insecure)`](#fn-specwithinsecure) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withProvider(provider)`](#fn-specwithprovider) + * [`fn withServiceAccountName(serviceAccountName)`](#fn-specwithserviceaccountname) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`obj spec.accessFrom`](#obj-specaccessfrom) + * [`fn withNamespaceSelectors(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectors) + * [`fn withNamespaceSelectorsMixin(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectorsmixin) + * [`obj spec.accessFrom.namespaceSelectors`](#obj-specaccessfromnamespaceselectors) + * [`fn withMatchLabels(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabelsmixin) + * [`obj spec.certSecretRef`](#obj-speccertsecretref) + * [`fn withName(name)`](#fn-speccertsecretrefwithname) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ImageRepository + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ImageRepositorySpec defines the parameters for scanning an image repository, e.g., `fluxcd/flux`." + +### fn spec.withExclusionList + +```ts +withExclusionList(exclusionList) +``` + +"ExclusionList is a list of regex strings used to exclude certain tags from being stored in the database." + +### fn spec.withExclusionListMixin + +```ts +withExclusionListMixin(exclusionList) +``` + +"ExclusionList is a list of regex strings used to exclude certain tags from being stored in the database." + +**Note:** This function appends passed data to existing values + +### fn spec.withImage + +```ts +withImage(image) +``` + +"Image is the name of the image repository" + +### fn spec.withInsecure + +```ts +withInsecure(insecure) +``` + +"Insecure allows connecting to a non-TLS HTTP container registry." + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval is the length of time to wait between scans of the image repository." + +### fn spec.withProvider + +```ts +withProvider(provider) +``` + +"The provider used for authentication, can be 'aws', 'azure', 'gcp' or 'generic'. When not specified, defaults to 'generic'." + +### fn spec.withServiceAccountName + +```ts +withServiceAccountName(serviceAccountName) +``` + +"ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate the image pull if the service account has attached pull secrets." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"This flag tells the controller to suspend subsequent image scans. It does not apply to already started scans. Defaults to false." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout for image scanning. Defaults to 'Interval' duration." + +## obj spec.accessFrom + +"AccessFrom defines an ACL for allowing cross-namespace references to the ImageRepository object based on the caller's namespace labels." + +### fn spec.accessFrom.withNamespaceSelectors + +```ts +withNamespaceSelectors(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.withNamespaceSelectorsMixin + +```ts +withNamespaceSelectorsMixin(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +**Note:** This function appends passed data to existing values + +## obj spec.accessFrom.namespaceSelectors + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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." + +**Note:** This function appends passed data to existing values + +## obj spec.certSecretRef + +"CertSecretRef can be given the name of a Secret containing either or both of \n - a PEM-encoded client certificate (`tls.crt`) and private key (`tls.key`); - a PEM-encoded CA certificate (`ca.crt`) \n 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`. \n Note: Support for the `caFile`, `certFile` and `keyFile` keys has been deprecated." + +### fn spec.certSecretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.secretRef + +"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." + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/image/v1beta2/index.md b/docs/2.2.1/image/v1beta2/index.md new file mode 100644 index 0000000..28e0bce --- /dev/null +++ b/docs/2.2.1/image/v1beta2/index.md @@ -0,0 +1,10 @@ +--- +permalink: /2.2.1/image/v1beta2/ +--- + +# image.v1beta2 + + + +* [imagePolicy](imagePolicy.md) +* [imageRepository](imageRepository.md) \ No newline at end of file diff --git a/docs/2.2.1/kustomize/index.md b/docs/2.2.1/kustomize/index.md new file mode 100644 index 0000000..bb7bb5a --- /dev/null +++ b/docs/2.2.1/kustomize/index.md @@ -0,0 +1,11 @@ +--- +permalink: /2.2.1/kustomize/ +--- + +# kustomize + + + +* [v1](v1/index.md) +* [v1beta1](v1beta1/index.md) +* [v1beta2](v1beta2/index.md) \ No newline at end of file diff --git a/docs/2.2.1/kustomize/v1/index.md b/docs/2.2.1/kustomize/v1/index.md new file mode 100644 index 0000000..d33e283 --- /dev/null +++ b/docs/2.2.1/kustomize/v1/index.md @@ -0,0 +1,9 @@ +--- +permalink: /2.2.1/kustomize/v1/ +--- + +# kustomize.v1 + + + +* [kustomization](kustomization.md) \ No newline at end of file diff --git a/docs/2.2.1/kustomize/v1/kustomization.md b/docs/2.2.1/kustomize/v1/kustomization.md new file mode 100644 index 0000000..da5d31b --- /dev/null +++ b/docs/2.2.1/kustomize/v1/kustomization.md @@ -0,0 +1,806 @@ +--- +permalink: /2.2.1/kustomize/v1/kustomization/ +--- + +# kustomize.v1.kustomization + +"Kustomization is the Schema for the kustomizations API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withComponents(components)`](#fn-specwithcomponents) + * [`fn withComponentsMixin(components)`](#fn-specwithcomponentsmixin) + * [`fn withDependsOn(dependsOn)`](#fn-specwithdependson) + * [`fn withDependsOnMixin(dependsOn)`](#fn-specwithdependsonmixin) + * [`fn withForce(force)`](#fn-specwithforce) + * [`fn withHealthChecks(healthChecks)`](#fn-specwithhealthchecks) + * [`fn withHealthChecksMixin(healthChecks)`](#fn-specwithhealthchecksmixin) + * [`fn withImages(images)`](#fn-specwithimages) + * [`fn withImagesMixin(images)`](#fn-specwithimagesmixin) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withPatches(patches)`](#fn-specwithpatches) + * [`fn withPatchesMixin(patches)`](#fn-specwithpatchesmixin) + * [`fn withPath(path)`](#fn-specwithpath) + * [`fn withPrune(prune)`](#fn-specwithprune) + * [`fn withRetryInterval(retryInterval)`](#fn-specwithretryinterval) + * [`fn withServiceAccountName(serviceAccountName)`](#fn-specwithserviceaccountname) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTargetNamespace(targetNamespace)`](#fn-specwithtargetnamespace) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`fn withWait(wait)`](#fn-specwithwait) + * [`obj spec.commonMetadata`](#obj-speccommonmetadata) + * [`fn withAnnotations(annotations)`](#fn-speccommonmetadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-speccommonmetadatawithannotationsmixin) + * [`fn withLabels(labels)`](#fn-speccommonmetadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-speccommonmetadatawithlabelsmixin) + * [`obj spec.decryption`](#obj-specdecryption) + * [`fn withProvider(provider)`](#fn-specdecryptionwithprovider) + * [`obj spec.decryption.secretRef`](#obj-specdecryptionsecretref) + * [`fn withName(name)`](#fn-specdecryptionsecretrefwithname) + * [`obj spec.dependsOn`](#obj-specdependson) + * [`fn withName(name)`](#fn-specdependsonwithname) + * [`fn withNamespace(namespace)`](#fn-specdependsonwithnamespace) + * [`obj spec.healthChecks`](#obj-spechealthchecks) + * [`fn withApiVersion(apiVersion)`](#fn-spechealthcheckswithapiversion) + * [`fn withKind(kind)`](#fn-spechealthcheckswithkind) + * [`fn withName(name)`](#fn-spechealthcheckswithname) + * [`fn withNamespace(namespace)`](#fn-spechealthcheckswithnamespace) + * [`obj spec.images`](#obj-specimages) + * [`fn withDigest(digest)`](#fn-specimageswithdigest) + * [`fn withName(name)`](#fn-specimageswithname) + * [`fn withNewName(newName)`](#fn-specimageswithnewname) + * [`fn withNewTag(newTag)`](#fn-specimageswithnewtag) + * [`obj spec.kubeConfig`](#obj-speckubeconfig) + * [`obj spec.kubeConfig.secretRef`](#obj-speckubeconfigsecretref) + * [`fn withKey(key)`](#fn-speckubeconfigsecretrefwithkey) + * [`fn withName(name)`](#fn-speckubeconfigsecretrefwithname) + * [`obj spec.patches`](#obj-specpatches) + * [`fn withPatch(patch)`](#fn-specpatcheswithpatch) + * [`obj spec.patches.target`](#obj-specpatchestarget) + * [`fn withAnnotationSelector(annotationSelector)`](#fn-specpatchestargetwithannotationselector) + * [`fn withGroup(group)`](#fn-specpatchestargetwithgroup) + * [`fn withKind(kind)`](#fn-specpatchestargetwithkind) + * [`fn withLabelSelector(labelSelector)`](#fn-specpatchestargetwithlabelselector) + * [`fn withName(name)`](#fn-specpatchestargetwithname) + * [`fn withNamespace(namespace)`](#fn-specpatchestargetwithnamespace) + * [`fn withVersion(version)`](#fn-specpatchestargetwithversion) + * [`obj spec.postBuild`](#obj-specpostbuild) + * [`fn withSubstitute(substitute)`](#fn-specpostbuildwithsubstitute) + * [`fn withSubstituteFrom(substituteFrom)`](#fn-specpostbuildwithsubstitutefrom) + * [`fn withSubstituteFromMixin(substituteFrom)`](#fn-specpostbuildwithsubstitutefrommixin) + * [`fn withSubstituteMixin(substitute)`](#fn-specpostbuildwithsubstitutemixin) + * [`obj spec.postBuild.substituteFrom`](#obj-specpostbuildsubstitutefrom) + * [`fn withKind(kind)`](#fn-specpostbuildsubstitutefromwithkind) + * [`fn withName(name)`](#fn-specpostbuildsubstitutefromwithname) + * [`fn withOptional(optional)`](#fn-specpostbuildsubstitutefromwithoptional) + * [`obj spec.sourceRef`](#obj-specsourceref) + * [`fn withApiVersion(apiVersion)`](#fn-specsourcerefwithapiversion) + * [`fn withKind(kind)`](#fn-specsourcerefwithkind) + * [`fn withName(name)`](#fn-specsourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specsourcerefwithnamespace) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Kustomization + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"KustomizationSpec defines the configuration to calculate the desired state from a Source using Kustomize." + +### fn spec.withComponents + +```ts +withComponents(components) +``` + +"Components specifies relative paths to specifications of other Components." + +### fn spec.withComponentsMixin + +```ts +withComponentsMixin(components) +``` + +"Components specifies relative paths to specifications of other Components." + +**Note:** This function appends passed data to existing values + +### fn spec.withDependsOn + +```ts +withDependsOn(dependsOn) +``` + +"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled." + +### fn spec.withDependsOnMixin + +```ts +withDependsOnMixin(dependsOn) +``` + +"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled." + +**Note:** This function appends passed data to existing values + +### fn spec.withForce + +```ts +withForce(force) +``` + +"Force instructs the controller to recreate resources when patching fails due to an immutable field change." + +### fn spec.withHealthChecks + +```ts +withHealthChecks(healthChecks) +``` + +"A list of resources to be included in the health assessment." + +### fn spec.withHealthChecksMixin + +```ts +withHealthChecksMixin(healthChecks) +``` + +"A list of resources to be included in the health assessment." + +**Note:** This function appends passed data to existing values + +### fn spec.withImages + +```ts +withImages(images) +``` + +"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify." + +### fn spec.withImagesMixin + +```ts +withImagesMixin(images) +``` + +"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify." + +**Note:** This function appends passed data to existing values + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"The interval at which to reconcile the Kustomization. This interval is approximate and may be subject to jitter to ensure efficient use of resources." + +### fn spec.withPatches + +```ts +withPatches(patches) +``` + +"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors." + +### fn spec.withPatchesMixin + +```ts +withPatchesMixin(patches) +``` + +"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors." + +**Note:** This function appends passed data to existing values + +### fn spec.withPath + +```ts +withPath(path) +``` + +"Path to the directory containing the kustomization.yaml file, or the set of plain YAMLs a kustomization.yaml should be generated for. Defaults to 'None', which translates to the root path of the SourceRef." + +### fn spec.withPrune + +```ts +withPrune(prune) +``` + +"Prune enables garbage collection." + +### fn spec.withRetryInterval + +```ts +withRetryInterval(retryInterval) +``` + +"The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the KustomizationSpec.Interval value to retry failures." + +### fn spec.withServiceAccountName + +```ts +withServiceAccountName(serviceAccountName) +``` + +"The name of the Kubernetes service account to impersonate when reconciling this Kustomization." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"This flag tells the controller to suspend subsequent kustomize executions, it does not apply to already started executions. Defaults to false." + +### fn spec.withTargetNamespace + +```ts +withTargetNamespace(targetNamespace) +``` + +"TargetNamespace sets or overrides the namespace in the kustomization.yaml file." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout for validation, apply and health checking operations. Defaults to 'Interval' duration." + +### fn spec.withWait + +```ts +withWait(wait) +``` + +"Wait instructs the controller to check the health of all the reconciled resources. When enabled, the HealthChecks are ignored. Defaults to false." + +## obj spec.commonMetadata + +"CommonMetadata specifies the common labels and annotations that are applied to all resources. Any existing label or annotation will be overridden if its key matches a common one." + +### fn spec.commonMetadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations to be added to the object's metadata." + +### fn spec.commonMetadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations to be added to the object's metadata." + +**Note:** This function appends passed data to existing values + +### fn spec.commonMetadata.withLabels + +```ts +withLabels(labels) +``` + +"Labels to be added to the object's metadata." + +### fn spec.commonMetadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Labels to be added to the object's metadata." + +**Note:** This function appends passed data to existing values + +## obj spec.decryption + +"Decrypt Kubernetes secrets before applying them on the cluster." + +### fn spec.decryption.withProvider + +```ts +withProvider(provider) +``` + +"Provider is the name of the decryption engine." + +## obj spec.decryption.secretRef + +"The secret name containing the private OpenPGP keys used for decryption." + +### fn spec.decryption.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.dependsOn + +"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled." + +### fn spec.dependsOn.withName + +```ts +withName(name) +``` + +"Name of the referent." + +### fn spec.dependsOn.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent, when not specified it acts as LocalObjectReference." + +## obj spec.healthChecks + +"A list of resources to be included in the health assessment." + +### fn spec.healthChecks.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"API version of the referent, if not specified the Kubernetes preferred version will be used." + +### fn spec.healthChecks.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent." + +### fn spec.healthChecks.withName + +```ts +withName(name) +``` + +"Name of the referent." + +### fn spec.healthChecks.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent, when not specified it acts as LocalObjectReference." + +## obj spec.images + +"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify." + +### fn spec.images.withDigest + +```ts +withDigest(digest) +``` + +"Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored." + +### fn spec.images.withName + +```ts +withName(name) +``` + +"Name is a tag-less image name." + +### fn spec.images.withNewName + +```ts +withNewName(newName) +``` + +"NewName is the value used to replace the original name." + +### fn spec.images.withNewTag + +```ts +withNewTag(newTag) +``` + +"NewTag is the value used to replace the original tag." + +## obj spec.kubeConfig + +"The KubeConfig for reconciling the Kustomization on a remote cluster. When used in combination with KustomizationSpec.ServiceAccountName, forces the controller to act on behalf of that Service Account at the target cluster. If the --default-service-account flag is set, its value will be used as a controller level fallback for when KustomizationSpec.ServiceAccountName is empty." + +## obj spec.kubeConfig.secretRef + +"SecretRef holds the name of a secret that contains a key with the kubeconfig file as the value. If no key is set, the key will default to 'value'. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific `cmd-path` auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling Kubernetes resources." + +### fn spec.kubeConfig.secretRef.withKey + +```ts +withKey(key) +``` + +"Key in the Secret, when not specified an implementation-specific default key is used." + +### fn spec.kubeConfig.secretRef.withName + +```ts +withName(name) +``` + +"Name of the Secret." + +## obj spec.patches + +"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors." + +### fn spec.patches.withPatch + +```ts +withPatch(patch) +``` + +"Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects." + +## obj spec.patches.target + +"Target points to the resources that the patch document should be applied to." + +### fn spec.patches.target.withAnnotationSelector + +```ts +withAnnotationSelector(annotationSelector) +``` + +"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations." + +### fn spec.patches.target.withGroup + +```ts +withGroup(group) +``` + +"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.patches.target.withKind + +```ts +withKind(kind) +``` + +"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.patches.target.withLabelSelector + +```ts +withLabelSelector(labelSelector) +``` + +"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels." + +### fn spec.patches.target.withName + +```ts +withName(name) +``` + +"Name to match resources with." + +### fn spec.patches.target.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace to select resources from." + +### fn spec.patches.target.withVersion + +```ts +withVersion(version) +``` + +"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +## obj spec.postBuild + +"PostBuild describes which actions to perform on the YAML manifest generated by building the kustomize overlay." + +### fn spec.postBuild.withSubstitute + +```ts +withSubstitute(substitute) +``` + +"Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}." + +### fn spec.postBuild.withSubstituteFrom + +```ts +withSubstituteFrom(substituteFrom) +``` + +"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names, and they must match the vars declared in the manifests for the substitution to happen." + +### fn spec.postBuild.withSubstituteFromMixin + +```ts +withSubstituteFromMixin(substituteFrom) +``` + +"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names, and they must match the vars declared in the manifests for the substitution to happen." + +**Note:** This function appends passed data to existing values + +### fn spec.postBuild.withSubstituteMixin + +```ts +withSubstituteMixin(substitute) +``` + +"Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}." + +**Note:** This function appends passed data to existing values + +## obj spec.postBuild.substituteFrom + +"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names, and they must match the vars declared in the manifests for the substitution to happen." + +### fn spec.postBuild.substituteFrom.withKind + +```ts +withKind(kind) +``` + +"Kind of the values referent, valid values are ('Secret', 'ConfigMap')." + +### fn spec.postBuild.substituteFrom.withName + +```ts +withName(name) +``` + +"Name of the values referent. Should reside in the same namespace as the referring resource." + +### fn spec.postBuild.substituteFrom.withOptional + +```ts +withOptional(optional) +``` + +"Optional indicates whether the referenced resource must exist, or whether to tolerate its absence. If true and the referenced resource is absent, proceed as if the resource was present but empty, without any variables defined." + +## obj spec.sourceRef + +"Reference of the source where the kustomization file is." + +### fn spec.sourceRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"API version of the referent." + +### fn spec.sourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent." + +### fn spec.sourceRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +### fn spec.sourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent, defaults to the namespace of the Kubernetes resource object that contains the reference." \ No newline at end of file diff --git a/docs/2.2.1/kustomize/v1beta1/index.md b/docs/2.2.1/kustomize/v1beta1/index.md new file mode 100644 index 0000000..4c73da6 --- /dev/null +++ b/docs/2.2.1/kustomize/v1beta1/index.md @@ -0,0 +1,9 @@ +--- +permalink: /2.2.1/kustomize/v1beta1/ +--- + +# kustomize.v1beta1 + + + +* [kustomization](kustomization.md) \ No newline at end of file diff --git a/docs/2.2.1/kustomize/v1beta1/kustomization.md b/docs/2.2.1/kustomize/v1beta1/kustomization.md new file mode 100644 index 0000000..1281ad0 --- /dev/null +++ b/docs/2.2.1/kustomize/v1beta1/kustomization.md @@ -0,0 +1,897 @@ +--- +permalink: /2.2.1/kustomize/v1beta1/kustomization/ +--- + +# kustomize.v1beta1.kustomization + +"Kustomization is the Schema for the kustomizations API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withDependsOn(dependsOn)`](#fn-specwithdependson) + * [`fn withDependsOnMixin(dependsOn)`](#fn-specwithdependsonmixin) + * [`fn withForce(force)`](#fn-specwithforce) + * [`fn withHealthChecks(healthChecks)`](#fn-specwithhealthchecks) + * [`fn withHealthChecksMixin(healthChecks)`](#fn-specwithhealthchecksmixin) + * [`fn withImages(images)`](#fn-specwithimages) + * [`fn withImagesMixin(images)`](#fn-specwithimagesmixin) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withPatches(patches)`](#fn-specwithpatches) + * [`fn withPatchesJson6902(patchesJson6902)`](#fn-specwithpatchesjson6902) + * [`fn withPatchesJson6902Mixin(patchesJson6902)`](#fn-specwithpatchesjson6902mixin) + * [`fn withPatchesMixin(patches)`](#fn-specwithpatchesmixin) + * [`fn withPatchesStrategicMerge(patchesStrategicMerge)`](#fn-specwithpatchesstrategicmerge) + * [`fn withPatchesStrategicMergeMixin(patchesStrategicMerge)`](#fn-specwithpatchesstrategicmergemixin) + * [`fn withPath(path)`](#fn-specwithpath) + * [`fn withPrune(prune)`](#fn-specwithprune) + * [`fn withRetryInterval(retryInterval)`](#fn-specwithretryinterval) + * [`fn withServiceAccountName(serviceAccountName)`](#fn-specwithserviceaccountname) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTargetNamespace(targetNamespace)`](#fn-specwithtargetnamespace) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`fn withValidation(validation)`](#fn-specwithvalidation) + * [`obj spec.decryption`](#obj-specdecryption) + * [`fn withProvider(provider)`](#fn-specdecryptionwithprovider) + * [`obj spec.decryption.secretRef`](#obj-specdecryptionsecretref) + * [`fn withName(name)`](#fn-specdecryptionsecretrefwithname) + * [`obj spec.dependsOn`](#obj-specdependson) + * [`fn withName(name)`](#fn-specdependsonwithname) + * [`fn withNamespace(namespace)`](#fn-specdependsonwithnamespace) + * [`obj spec.healthChecks`](#obj-spechealthchecks) + * [`fn withApiVersion(apiVersion)`](#fn-spechealthcheckswithapiversion) + * [`fn withKind(kind)`](#fn-spechealthcheckswithkind) + * [`fn withName(name)`](#fn-spechealthcheckswithname) + * [`fn withNamespace(namespace)`](#fn-spechealthcheckswithnamespace) + * [`obj spec.images`](#obj-specimages) + * [`fn withDigest(digest)`](#fn-specimageswithdigest) + * [`fn withName(name)`](#fn-specimageswithname) + * [`fn withNewName(newName)`](#fn-specimageswithnewname) + * [`fn withNewTag(newTag)`](#fn-specimageswithnewtag) + * [`obj spec.kubeConfig`](#obj-speckubeconfig) + * [`obj spec.kubeConfig.secretRef`](#obj-speckubeconfigsecretref) + * [`fn withName(name)`](#fn-speckubeconfigsecretrefwithname) + * [`obj spec.patches`](#obj-specpatches) + * [`fn withPatch(patch)`](#fn-specpatcheswithpatch) + * [`obj spec.patches.target`](#obj-specpatchestarget) + * [`fn withAnnotationSelector(annotationSelector)`](#fn-specpatchestargetwithannotationselector) + * [`fn withGroup(group)`](#fn-specpatchestargetwithgroup) + * [`fn withKind(kind)`](#fn-specpatchestargetwithkind) + * [`fn withLabelSelector(labelSelector)`](#fn-specpatchestargetwithlabelselector) + * [`fn withName(name)`](#fn-specpatchestargetwithname) + * [`fn withNamespace(namespace)`](#fn-specpatchestargetwithnamespace) + * [`fn withVersion(version)`](#fn-specpatchestargetwithversion) + * [`obj spec.patchesJson6902`](#obj-specpatchesjson6902) + * [`fn withPatch(patch)`](#fn-specpatchesjson6902withpatch) + * [`fn withPatchMixin(patch)`](#fn-specpatchesjson6902withpatchmixin) + * [`obj spec.patchesJson6902.patch`](#obj-specpatchesjson6902patch) + * [`fn withFrom(from)`](#fn-specpatchesjson6902patchwithfrom) + * [`fn withOp(op)`](#fn-specpatchesjson6902patchwithop) + * [`fn withPath(path)`](#fn-specpatchesjson6902patchwithpath) + * [`fn withValue(value)`](#fn-specpatchesjson6902patchwithvalue) + * [`obj spec.patchesJson6902.target`](#obj-specpatchesjson6902target) + * [`fn withAnnotationSelector(annotationSelector)`](#fn-specpatchesjson6902targetwithannotationselector) + * [`fn withGroup(group)`](#fn-specpatchesjson6902targetwithgroup) + * [`fn withKind(kind)`](#fn-specpatchesjson6902targetwithkind) + * [`fn withLabelSelector(labelSelector)`](#fn-specpatchesjson6902targetwithlabelselector) + * [`fn withName(name)`](#fn-specpatchesjson6902targetwithname) + * [`fn withNamespace(namespace)`](#fn-specpatchesjson6902targetwithnamespace) + * [`fn withVersion(version)`](#fn-specpatchesjson6902targetwithversion) + * [`obj spec.postBuild`](#obj-specpostbuild) + * [`fn withSubstitute(substitute)`](#fn-specpostbuildwithsubstitute) + * [`fn withSubstituteFrom(substituteFrom)`](#fn-specpostbuildwithsubstitutefrom) + * [`fn withSubstituteFromMixin(substituteFrom)`](#fn-specpostbuildwithsubstitutefrommixin) + * [`fn withSubstituteMixin(substitute)`](#fn-specpostbuildwithsubstitutemixin) + * [`obj spec.postBuild.substituteFrom`](#obj-specpostbuildsubstitutefrom) + * [`fn withKind(kind)`](#fn-specpostbuildsubstitutefromwithkind) + * [`fn withName(name)`](#fn-specpostbuildsubstitutefromwithname) + * [`obj spec.sourceRef`](#obj-specsourceref) + * [`fn withApiVersion(apiVersion)`](#fn-specsourcerefwithapiversion) + * [`fn withKind(kind)`](#fn-specsourcerefwithkind) + * [`fn withName(name)`](#fn-specsourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specsourcerefwithnamespace) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Kustomization + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"KustomizationSpec defines the desired state of a kustomization." + +### fn spec.withDependsOn + +```ts +withDependsOn(dependsOn) +``` + +"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled." + +### fn spec.withDependsOnMixin + +```ts +withDependsOnMixin(dependsOn) +``` + +"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled." + +**Note:** This function appends passed data to existing values + +### fn spec.withForce + +```ts +withForce(force) +``` + +"Force instructs the controller to recreate resources when patching fails due to an immutable field change." + +### fn spec.withHealthChecks + +```ts +withHealthChecks(healthChecks) +``` + +"A list of resources to be included in the health assessment." + +### fn spec.withHealthChecksMixin + +```ts +withHealthChecksMixin(healthChecks) +``` + +"A list of resources to be included in the health assessment." + +**Note:** This function appends passed data to existing values + +### fn spec.withImages + +```ts +withImages(images) +``` + +"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify." + +### fn spec.withImagesMixin + +```ts +withImagesMixin(images) +``` + +"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify." + +**Note:** This function appends passed data to existing values + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"The interval at which to reconcile the Kustomization." + +### fn spec.withPatches + +```ts +withPatches(patches) +``` + +"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors." + +### fn spec.withPatchesJson6902 + +```ts +withPatchesJson6902(patchesJson6902) +``` + +"JSON 6902 patches, defined as inline YAML objects." + +### fn spec.withPatchesJson6902Mixin + +```ts +withPatchesJson6902Mixin(patchesJson6902) +``` + +"JSON 6902 patches, defined as inline YAML objects." + +**Note:** This function appends passed data to existing values + +### fn spec.withPatchesMixin + +```ts +withPatchesMixin(patches) +``` + +"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors." + +**Note:** This function appends passed data to existing values + +### fn spec.withPatchesStrategicMerge + +```ts +withPatchesStrategicMerge(patchesStrategicMerge) +``` + +"Strategic merge patches, defined as inline YAML objects." + +### fn spec.withPatchesStrategicMergeMixin + +```ts +withPatchesStrategicMergeMixin(patchesStrategicMerge) +``` + +"Strategic merge patches, defined as inline YAML objects." + +**Note:** This function appends passed data to existing values + +### fn spec.withPath + +```ts +withPath(path) +``` + +"Path to the directory containing the kustomization.yaml file, or the set of plain YAMLs a kustomization.yaml should be generated for. Defaults to 'None', which translates to the root path of the SourceRef." + +### fn spec.withPrune + +```ts +withPrune(prune) +``` + +"Prune enables garbage collection." + +### fn spec.withRetryInterval + +```ts +withRetryInterval(retryInterval) +``` + +"The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the KustomizationSpec.Interval value to retry failures." + +### fn spec.withServiceAccountName + +```ts +withServiceAccountName(serviceAccountName) +``` + +"The name of the Kubernetes service account to impersonate when reconciling this Kustomization." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"This flag tells the controller to suspend subsequent kustomize executions, it does not apply to already started executions. Defaults to false." + +### fn spec.withTargetNamespace + +```ts +withTargetNamespace(targetNamespace) +``` + +"TargetNamespace sets or overrides the namespace in the kustomization.yaml file." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout for validation, apply and health checking operations. Defaults to 'Interval' duration." + +### fn spec.withValidation + +```ts +withValidation(validation) +``` + +"Validate the Kubernetes objects before applying them on the cluster. The validation strategy can be 'client' (local dry-run), 'server' (APIServer dry-run) or 'none'. When 'Force' is 'true', validation will fallback to 'client' if set to 'server' because server-side validation is not supported in this scenario." + +## obj spec.decryption + +"Decrypt Kubernetes secrets before applying them on the cluster." + +### fn spec.decryption.withProvider + +```ts +withProvider(provider) +``` + +"Provider is the name of the decryption engine." + +## obj spec.decryption.secretRef + +"The secret name containing the private OpenPGP keys used for decryption." + +### fn spec.decryption.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.dependsOn + +"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled." + +### fn spec.dependsOn.withName + +```ts +withName(name) +``` + +"Name of the referent." + +### fn spec.dependsOn.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent, when not specified it acts as LocalObjectReference." + +## obj spec.healthChecks + +"A list of resources to be included in the health assessment." + +### fn spec.healthChecks.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"API version of the referent, if not specified the Kubernetes preferred version will be used." + +### fn spec.healthChecks.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent." + +### fn spec.healthChecks.withName + +```ts +withName(name) +``` + +"Name of the referent." + +### fn spec.healthChecks.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent, when not specified it acts as LocalObjectReference." + +## obj spec.images + +"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify." + +### fn spec.images.withDigest + +```ts +withDigest(digest) +``` + +"Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored." + +### fn spec.images.withName + +```ts +withName(name) +``` + +"Name is a tag-less image name." + +### fn spec.images.withNewName + +```ts +withNewName(newName) +``` + +"NewName is the value used to replace the original name." + +### fn spec.images.withNewTag + +```ts +withNewTag(newTag) +``` + +"NewTag is the value used to replace the original tag." + +## obj spec.kubeConfig + +"The KubeConfig for reconciling the Kustomization on a remote cluster. When specified, KubeConfig takes precedence over ServiceAccountName." + +## obj spec.kubeConfig.secretRef + +"SecretRef holds the name to a secret that contains a 'value' key with the kubeconfig file as the value. It must be in the same namespace as the Kustomization. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific `cmd-path` auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling the Kustomization." + +### fn spec.kubeConfig.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.patches + +"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors." + +### fn spec.patches.withPatch + +```ts +withPatch(patch) +``` + +"Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects." + +## obj spec.patches.target + +"Target points to the resources that the patch document should be applied to." + +### fn spec.patches.target.withAnnotationSelector + +```ts +withAnnotationSelector(annotationSelector) +``` + +"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations." + +### fn spec.patches.target.withGroup + +```ts +withGroup(group) +``` + +"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.patches.target.withKind + +```ts +withKind(kind) +``` + +"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.patches.target.withLabelSelector + +```ts +withLabelSelector(labelSelector) +``` + +"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels." + +### fn spec.patches.target.withName + +```ts +withName(name) +``` + +"Name to match resources with." + +### fn spec.patches.target.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace to select resources from." + +### fn spec.patches.target.withVersion + +```ts +withVersion(version) +``` + +"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +## obj spec.patchesJson6902 + +"JSON 6902 patches, defined as inline YAML objects." + +### fn spec.patchesJson6902.withPatch + +```ts +withPatch(patch) +``` + +"Patch contains the JSON6902 patch document with an array of operation objects." + +### fn spec.patchesJson6902.withPatchMixin + +```ts +withPatchMixin(patch) +``` + +"Patch contains the JSON6902 patch document with an array of operation objects." + +**Note:** This function appends passed data to existing values + +## obj spec.patchesJson6902.patch + +"Patch contains the JSON6902 patch document with an array of operation objects." + +### fn spec.patchesJson6902.patch.withFrom + +```ts +withFrom(from) +``` + +"From contains a JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations." + +### fn spec.patchesJson6902.patch.withOp + +```ts +withOp(op) +``` + +"Op indicates the operation to perform. Its value MUST be one of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or \"test\". https://datatracker.ietf.org/doc/html/rfc6902#section-4" + +### fn spec.patchesJson6902.patch.withPath + +```ts +withPath(path) +``` + +"Path contains the JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op." + +### fn spec.patchesJson6902.patch.withValue + +```ts +withValue(value) +``` + +"Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations." + +## obj spec.patchesJson6902.target + +"Target points to the resources that the patch document should be applied to." + +### fn spec.patchesJson6902.target.withAnnotationSelector + +```ts +withAnnotationSelector(annotationSelector) +``` + +"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations." + +### fn spec.patchesJson6902.target.withGroup + +```ts +withGroup(group) +``` + +"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.patchesJson6902.target.withKind + +```ts +withKind(kind) +``` + +"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.patchesJson6902.target.withLabelSelector + +```ts +withLabelSelector(labelSelector) +``` + +"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels." + +### fn spec.patchesJson6902.target.withName + +```ts +withName(name) +``` + +"Name to match resources with." + +### fn spec.patchesJson6902.target.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace to select resources from." + +### fn spec.patchesJson6902.target.withVersion + +```ts +withVersion(version) +``` + +"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +## obj spec.postBuild + +"PostBuild describes which actions to perform on the YAML manifest generated by building the kustomize overlay." + +### fn spec.postBuild.withSubstitute + +```ts +withSubstitute(substitute) +``` + +"Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}." + +### fn spec.postBuild.withSubstituteFrom + +```ts +withSubstituteFrom(substituteFrom) +``` + +"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names and they must match the vars declared in the manifests for the substitution to happen." + +### fn spec.postBuild.withSubstituteFromMixin + +```ts +withSubstituteFromMixin(substituteFrom) +``` + +"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names and they must match the vars declared in the manifests for the substitution to happen." + +**Note:** This function appends passed data to existing values + +### fn spec.postBuild.withSubstituteMixin + +```ts +withSubstituteMixin(substitute) +``` + +"Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}." + +**Note:** This function appends passed data to existing values + +## obj spec.postBuild.substituteFrom + +"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names and they must match the vars declared in the manifests for the substitution to happen." + +### fn spec.postBuild.substituteFrom.withKind + +```ts +withKind(kind) +``` + +"Kind of the values referent, valid values are ('Secret', 'ConfigMap')." + +### fn spec.postBuild.substituteFrom.withName + +```ts +withName(name) +``` + +"Name of the values referent. Should reside in the same namespace as the referring resource." + +## obj spec.sourceRef + +"Reference of the source where the kustomization file is." + +### fn spec.sourceRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"API version of the referent" + +### fn spec.sourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent" + +### fn spec.sourceRef.withName + +```ts +withName(name) +``` + +"Name of the referent" + +### fn spec.sourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent, defaults to the Kustomization namespace" \ No newline at end of file diff --git a/docs/2.2.1/kustomize/v1beta2/index.md b/docs/2.2.1/kustomize/v1beta2/index.md new file mode 100644 index 0000000..3ff59f8 --- /dev/null +++ b/docs/2.2.1/kustomize/v1beta2/index.md @@ -0,0 +1,9 @@ +--- +permalink: /2.2.1/kustomize/v1beta2/ +--- + +# kustomize.v1beta2 + + + +* [kustomization](kustomization.md) \ No newline at end of file diff --git a/docs/2.2.1/kustomize/v1beta2/kustomization.md b/docs/2.2.1/kustomize/v1beta2/kustomization.md new file mode 100644 index 0000000..4de8a3d --- /dev/null +++ b/docs/2.2.1/kustomize/v1beta2/kustomization.md @@ -0,0 +1,989 @@ +--- +permalink: /2.2.1/kustomize/v1beta2/kustomization/ +--- + +# kustomize.v1beta2.kustomization + +"Kustomization is the Schema for the kustomizations API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withComponents(components)`](#fn-specwithcomponents) + * [`fn withComponentsMixin(components)`](#fn-specwithcomponentsmixin) + * [`fn withDependsOn(dependsOn)`](#fn-specwithdependson) + * [`fn withDependsOnMixin(dependsOn)`](#fn-specwithdependsonmixin) + * [`fn withForce(force)`](#fn-specwithforce) + * [`fn withHealthChecks(healthChecks)`](#fn-specwithhealthchecks) + * [`fn withHealthChecksMixin(healthChecks)`](#fn-specwithhealthchecksmixin) + * [`fn withImages(images)`](#fn-specwithimages) + * [`fn withImagesMixin(images)`](#fn-specwithimagesmixin) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withPatches(patches)`](#fn-specwithpatches) + * [`fn withPatchesJson6902(patchesJson6902)`](#fn-specwithpatchesjson6902) + * [`fn withPatchesJson6902Mixin(patchesJson6902)`](#fn-specwithpatchesjson6902mixin) + * [`fn withPatchesMixin(patches)`](#fn-specwithpatchesmixin) + * [`fn withPatchesStrategicMerge(patchesStrategicMerge)`](#fn-specwithpatchesstrategicmerge) + * [`fn withPatchesStrategicMergeMixin(patchesStrategicMerge)`](#fn-specwithpatchesstrategicmergemixin) + * [`fn withPath(path)`](#fn-specwithpath) + * [`fn withPrune(prune)`](#fn-specwithprune) + * [`fn withRetryInterval(retryInterval)`](#fn-specwithretryinterval) + * [`fn withServiceAccountName(serviceAccountName)`](#fn-specwithserviceaccountname) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTargetNamespace(targetNamespace)`](#fn-specwithtargetnamespace) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`fn withValidation(validation)`](#fn-specwithvalidation) + * [`fn withWait(wait)`](#fn-specwithwait) + * [`obj spec.commonMetadata`](#obj-speccommonmetadata) + * [`fn withAnnotations(annotations)`](#fn-speccommonmetadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-speccommonmetadatawithannotationsmixin) + * [`fn withLabels(labels)`](#fn-speccommonmetadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-speccommonmetadatawithlabelsmixin) + * [`obj spec.decryption`](#obj-specdecryption) + * [`fn withProvider(provider)`](#fn-specdecryptionwithprovider) + * [`obj spec.decryption.secretRef`](#obj-specdecryptionsecretref) + * [`fn withName(name)`](#fn-specdecryptionsecretrefwithname) + * [`obj spec.dependsOn`](#obj-specdependson) + * [`fn withName(name)`](#fn-specdependsonwithname) + * [`fn withNamespace(namespace)`](#fn-specdependsonwithnamespace) + * [`obj spec.healthChecks`](#obj-spechealthchecks) + * [`fn withApiVersion(apiVersion)`](#fn-spechealthcheckswithapiversion) + * [`fn withKind(kind)`](#fn-spechealthcheckswithkind) + * [`fn withName(name)`](#fn-spechealthcheckswithname) + * [`fn withNamespace(namespace)`](#fn-spechealthcheckswithnamespace) + * [`obj spec.images`](#obj-specimages) + * [`fn withDigest(digest)`](#fn-specimageswithdigest) + * [`fn withName(name)`](#fn-specimageswithname) + * [`fn withNewName(newName)`](#fn-specimageswithnewname) + * [`fn withNewTag(newTag)`](#fn-specimageswithnewtag) + * [`obj spec.kubeConfig`](#obj-speckubeconfig) + * [`obj spec.kubeConfig.secretRef`](#obj-speckubeconfigsecretref) + * [`fn withKey(key)`](#fn-speckubeconfigsecretrefwithkey) + * [`fn withName(name)`](#fn-speckubeconfigsecretrefwithname) + * [`obj spec.patches`](#obj-specpatches) + * [`fn withPatch(patch)`](#fn-specpatcheswithpatch) + * [`obj spec.patches.target`](#obj-specpatchestarget) + * [`fn withAnnotationSelector(annotationSelector)`](#fn-specpatchestargetwithannotationselector) + * [`fn withGroup(group)`](#fn-specpatchestargetwithgroup) + * [`fn withKind(kind)`](#fn-specpatchestargetwithkind) + * [`fn withLabelSelector(labelSelector)`](#fn-specpatchestargetwithlabelselector) + * [`fn withName(name)`](#fn-specpatchestargetwithname) + * [`fn withNamespace(namespace)`](#fn-specpatchestargetwithnamespace) + * [`fn withVersion(version)`](#fn-specpatchestargetwithversion) + * [`obj spec.patchesJson6902`](#obj-specpatchesjson6902) + * [`fn withPatch(patch)`](#fn-specpatchesjson6902withpatch) + * [`fn withPatchMixin(patch)`](#fn-specpatchesjson6902withpatchmixin) + * [`obj spec.patchesJson6902.patch`](#obj-specpatchesjson6902patch) + * [`fn withFrom(from)`](#fn-specpatchesjson6902patchwithfrom) + * [`fn withOp(op)`](#fn-specpatchesjson6902patchwithop) + * [`fn withPath(path)`](#fn-specpatchesjson6902patchwithpath) + * [`fn withValue(value)`](#fn-specpatchesjson6902patchwithvalue) + * [`obj spec.patchesJson6902.target`](#obj-specpatchesjson6902target) + * [`fn withAnnotationSelector(annotationSelector)`](#fn-specpatchesjson6902targetwithannotationselector) + * [`fn withGroup(group)`](#fn-specpatchesjson6902targetwithgroup) + * [`fn withKind(kind)`](#fn-specpatchesjson6902targetwithkind) + * [`fn withLabelSelector(labelSelector)`](#fn-specpatchesjson6902targetwithlabelselector) + * [`fn withName(name)`](#fn-specpatchesjson6902targetwithname) + * [`fn withNamespace(namespace)`](#fn-specpatchesjson6902targetwithnamespace) + * [`fn withVersion(version)`](#fn-specpatchesjson6902targetwithversion) + * [`obj spec.postBuild`](#obj-specpostbuild) + * [`fn withSubstitute(substitute)`](#fn-specpostbuildwithsubstitute) + * [`fn withSubstituteFrom(substituteFrom)`](#fn-specpostbuildwithsubstitutefrom) + * [`fn withSubstituteFromMixin(substituteFrom)`](#fn-specpostbuildwithsubstitutefrommixin) + * [`fn withSubstituteMixin(substitute)`](#fn-specpostbuildwithsubstitutemixin) + * [`obj spec.postBuild.substituteFrom`](#obj-specpostbuildsubstitutefrom) + * [`fn withKind(kind)`](#fn-specpostbuildsubstitutefromwithkind) + * [`fn withName(name)`](#fn-specpostbuildsubstitutefromwithname) + * [`fn withOptional(optional)`](#fn-specpostbuildsubstitutefromwithoptional) + * [`obj spec.sourceRef`](#obj-specsourceref) + * [`fn withApiVersion(apiVersion)`](#fn-specsourcerefwithapiversion) + * [`fn withKind(kind)`](#fn-specsourcerefwithkind) + * [`fn withName(name)`](#fn-specsourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specsourcerefwithnamespace) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Kustomization + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"KustomizationSpec defines the configuration to calculate the desired state from a Source using Kustomize." + +### fn spec.withComponents + +```ts +withComponents(components) +``` + +"Components specifies relative paths to specifications of other Components." + +### fn spec.withComponentsMixin + +```ts +withComponentsMixin(components) +``` + +"Components specifies relative paths to specifications of other Components." + +**Note:** This function appends passed data to existing values + +### fn spec.withDependsOn + +```ts +withDependsOn(dependsOn) +``` + +"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled." + +### fn spec.withDependsOnMixin + +```ts +withDependsOnMixin(dependsOn) +``` + +"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled." + +**Note:** This function appends passed data to existing values + +### fn spec.withForce + +```ts +withForce(force) +``` + +"Force instructs the controller to recreate resources when patching fails due to an immutable field change." + +### fn spec.withHealthChecks + +```ts +withHealthChecks(healthChecks) +``` + +"A list of resources to be included in the health assessment." + +### fn spec.withHealthChecksMixin + +```ts +withHealthChecksMixin(healthChecks) +``` + +"A list of resources to be included in the health assessment." + +**Note:** This function appends passed data to existing values + +### fn spec.withImages + +```ts +withImages(images) +``` + +"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify." + +### fn spec.withImagesMixin + +```ts +withImagesMixin(images) +``` + +"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify." + +**Note:** This function appends passed data to existing values + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"The interval at which to reconcile the Kustomization." + +### fn spec.withPatches + +```ts +withPatches(patches) +``` + +"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors." + +### fn spec.withPatchesJson6902 + +```ts +withPatchesJson6902(patchesJson6902) +``` + +"JSON 6902 patches, defined as inline YAML objects. Deprecated: Use Patches instead." + +### fn spec.withPatchesJson6902Mixin + +```ts +withPatchesJson6902Mixin(patchesJson6902) +``` + +"JSON 6902 patches, defined as inline YAML objects. Deprecated: Use Patches instead." + +**Note:** This function appends passed data to existing values + +### fn spec.withPatchesMixin + +```ts +withPatchesMixin(patches) +``` + +"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors." + +**Note:** This function appends passed data to existing values + +### fn spec.withPatchesStrategicMerge + +```ts +withPatchesStrategicMerge(patchesStrategicMerge) +``` + +"Strategic merge patches, defined as inline YAML objects. Deprecated: Use Patches instead." + +### fn spec.withPatchesStrategicMergeMixin + +```ts +withPatchesStrategicMergeMixin(patchesStrategicMerge) +``` + +"Strategic merge patches, defined as inline YAML objects. Deprecated: Use Patches instead." + +**Note:** This function appends passed data to existing values + +### fn spec.withPath + +```ts +withPath(path) +``` + +"Path to the directory containing the kustomization.yaml file, or the set of plain YAMLs a kustomization.yaml should be generated for. Defaults to 'None', which translates to the root path of the SourceRef." + +### fn spec.withPrune + +```ts +withPrune(prune) +``` + +"Prune enables garbage collection." + +### fn spec.withRetryInterval + +```ts +withRetryInterval(retryInterval) +``` + +"The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the KustomizationSpec.Interval value to retry failures." + +### fn spec.withServiceAccountName + +```ts +withServiceAccountName(serviceAccountName) +``` + +"The name of the Kubernetes service account to impersonate when reconciling this Kustomization." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"This flag tells the controller to suspend subsequent kustomize executions, it does not apply to already started executions. Defaults to false." + +### fn spec.withTargetNamespace + +```ts +withTargetNamespace(targetNamespace) +``` + +"TargetNamespace sets or overrides the namespace in the kustomization.yaml file." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout for validation, apply and health checking operations. Defaults to 'Interval' duration." + +### fn spec.withValidation + +```ts +withValidation(validation) +``` + +"Deprecated: Not used in v1beta2." + +### fn spec.withWait + +```ts +withWait(wait) +``` + +"Wait instructs the controller to check the health of all the reconciled resources. When enabled, the HealthChecks are ignored. Defaults to false." + +## obj spec.commonMetadata + +"CommonMetadata specifies the common labels and annotations that are applied to all resources. Any existing label or annotation will be overridden if its key matches a common one." + +### fn spec.commonMetadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations to be added to the object's metadata." + +### fn spec.commonMetadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations to be added to the object's metadata." + +**Note:** This function appends passed data to existing values + +### fn spec.commonMetadata.withLabels + +```ts +withLabels(labels) +``` + +"Labels to be added to the object's metadata." + +### fn spec.commonMetadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Labels to be added to the object's metadata." + +**Note:** This function appends passed data to existing values + +## obj spec.decryption + +"Decrypt Kubernetes secrets before applying them on the cluster." + +### fn spec.decryption.withProvider + +```ts +withProvider(provider) +``` + +"Provider is the name of the decryption engine." + +## obj spec.decryption.secretRef + +"The secret name containing the private OpenPGP keys used for decryption." + +### fn spec.decryption.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.dependsOn + +"DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled." + +### fn spec.dependsOn.withName + +```ts +withName(name) +``` + +"Name of the referent." + +### fn spec.dependsOn.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent, when not specified it acts as LocalObjectReference." + +## obj spec.healthChecks + +"A list of resources to be included in the health assessment." + +### fn spec.healthChecks.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"API version of the referent, if not specified the Kubernetes preferred version will be used." + +### fn spec.healthChecks.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent." + +### fn spec.healthChecks.withName + +```ts +withName(name) +``` + +"Name of the referent." + +### fn spec.healthChecks.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent, when not specified it acts as LocalObjectReference." + +## obj spec.images + +"Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify." + +### fn spec.images.withDigest + +```ts +withDigest(digest) +``` + +"Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored." + +### fn spec.images.withName + +```ts +withName(name) +``` + +"Name is a tag-less image name." + +### fn spec.images.withNewName + +```ts +withNewName(newName) +``` + +"NewName is the value used to replace the original name." + +### fn spec.images.withNewTag + +```ts +withNewTag(newTag) +``` + +"NewTag is the value used to replace the original tag." + +## obj spec.kubeConfig + +"The KubeConfig for reconciling the Kustomization on a remote cluster. When used in combination with KustomizationSpec.ServiceAccountName, forces the controller to act on behalf of that Service Account at the target cluster. If the --default-service-account flag is set, its value will be used as a controller level fallback for when KustomizationSpec.ServiceAccountName is empty." + +## obj spec.kubeConfig.secretRef + +"SecretRef holds the name of a secret that contains a key with the kubeconfig file as the value. If no key is set, the key will default to 'value'. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific `cmd-path` auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling Kubernetes resources." + +### fn spec.kubeConfig.secretRef.withKey + +```ts +withKey(key) +``` + +"Key in the Secret, when not specified an implementation-specific default key is used." + +### fn spec.kubeConfig.secretRef.withName + +```ts +withName(name) +``` + +"Name of the Secret." + +## obj spec.patches + +"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors." + +### fn spec.patches.withPatch + +```ts +withPatch(patch) +``` + +"Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects." + +## obj spec.patches.target + +"Target points to the resources that the patch document should be applied to." + +### fn spec.patches.target.withAnnotationSelector + +```ts +withAnnotationSelector(annotationSelector) +``` + +"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations." + +### fn spec.patches.target.withGroup + +```ts +withGroup(group) +``` + +"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.patches.target.withKind + +```ts +withKind(kind) +``` + +"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.patches.target.withLabelSelector + +```ts +withLabelSelector(labelSelector) +``` + +"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels." + +### fn spec.patches.target.withName + +```ts +withName(name) +``` + +"Name to match resources with." + +### fn spec.patches.target.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace to select resources from." + +### fn spec.patches.target.withVersion + +```ts +withVersion(version) +``` + +"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +## obj spec.patchesJson6902 + +"JSON 6902 patches, defined as inline YAML objects. Deprecated: Use Patches instead." + +### fn spec.patchesJson6902.withPatch + +```ts +withPatch(patch) +``` + +"Patch contains the JSON6902 patch document with an array of operation objects." + +### fn spec.patchesJson6902.withPatchMixin + +```ts +withPatchMixin(patch) +``` + +"Patch contains the JSON6902 patch document with an array of operation objects." + +**Note:** This function appends passed data to existing values + +## obj spec.patchesJson6902.patch + +"Patch contains the JSON6902 patch document with an array of operation objects." + +### fn spec.patchesJson6902.patch.withFrom + +```ts +withFrom(from) +``` + +"From contains a JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations." + +### fn spec.patchesJson6902.patch.withOp + +```ts +withOp(op) +``` + +"Op indicates the operation to perform. Its value MUST be one of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or \"test\". https://datatracker.ietf.org/doc/html/rfc6902#section-4" + +### fn spec.patchesJson6902.patch.withPath + +```ts +withPath(path) +``` + +"Path contains the JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op." + +### fn spec.patchesJson6902.patch.withValue + +```ts +withValue(value) +``` + +"Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations." + +## obj spec.patchesJson6902.target + +"Target points to the resources that the patch document should be applied to." + +### fn spec.patchesJson6902.target.withAnnotationSelector + +```ts +withAnnotationSelector(annotationSelector) +``` + +"AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations." + +### fn spec.patchesJson6902.target.withGroup + +```ts +withGroup(group) +``` + +"Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.patchesJson6902.target.withKind + +```ts +withKind(kind) +``` + +"Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +### fn spec.patchesJson6902.target.withLabelSelector + +```ts +withLabelSelector(labelSelector) +``` + +"LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels." + +### fn spec.patchesJson6902.target.withName + +```ts +withName(name) +``` + +"Name to match resources with." + +### fn spec.patchesJson6902.target.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace to select resources from." + +### fn spec.patchesJson6902.target.withVersion + +```ts +withVersion(version) +``` + +"Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md" + +## obj spec.postBuild + +"PostBuild describes which actions to perform on the YAML manifest generated by building the kustomize overlay." + +### fn spec.postBuild.withSubstitute + +```ts +withSubstitute(substitute) +``` + +"Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}." + +### fn spec.postBuild.withSubstituteFrom + +```ts +withSubstituteFrom(substituteFrom) +``` + +"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names and they must match the vars declared in the manifests for the substitution to happen." + +### fn spec.postBuild.withSubstituteFromMixin + +```ts +withSubstituteFromMixin(substituteFrom) +``` + +"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names and they must match the vars declared in the manifests for the substitution to happen." + +**Note:** This function appends passed data to existing values + +### fn spec.postBuild.withSubstituteMixin + +```ts +withSubstituteMixin(substitute) +``` + +"Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}." + +**Note:** This function appends passed data to existing values + +## obj spec.postBuild.substituteFrom + +"SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names and they must match the vars declared in the manifests for the substitution to happen." + +### fn spec.postBuild.substituteFrom.withKind + +```ts +withKind(kind) +``` + +"Kind of the values referent, valid values are ('Secret', 'ConfigMap')." + +### fn spec.postBuild.substituteFrom.withName + +```ts +withName(name) +``` + +"Name of the values referent. Should reside in the same namespace as the referring resource." + +### fn spec.postBuild.substituteFrom.withOptional + +```ts +withOptional(optional) +``` + +"Optional indicates whether the referenced resource must exist, or whether to tolerate its absence. If true and the referenced resource is absent, proceed as if the resource was present but empty, without any variables defined." + +## obj spec.sourceRef + +"Reference of the source where the kustomization file is." + +### fn spec.sourceRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"API version of the referent." + +### fn spec.sourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent." + +### fn spec.sourceRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +### fn spec.sourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent, defaults to the namespace of the Kubernetes resource object that contains the reference." \ No newline at end of file diff --git a/docs/2.2.1/notification/index.md b/docs/2.2.1/notification/index.md new file mode 100644 index 0000000..eea64d6 --- /dev/null +++ b/docs/2.2.1/notification/index.md @@ -0,0 +1,12 @@ +--- +permalink: /2.2.1/notification/ +--- + +# notification + + + +* [v1](v1/index.md) +* [v1beta1](v1beta1/index.md) +* [v1beta2](v1beta2/index.md) +* [v1beta3](v1beta3/index.md) \ No newline at end of file diff --git a/docs/2.2.1/notification/v1/index.md b/docs/2.2.1/notification/v1/index.md new file mode 100644 index 0000000..f1174cc --- /dev/null +++ b/docs/2.2.1/notification/v1/index.md @@ -0,0 +1,9 @@ +--- +permalink: /2.2.1/notification/v1/ +--- + +# notification.v1 + + + +* [receiver](receiver.md) \ No newline at end of file diff --git a/docs/2.2.1/notification/v1/receiver.md b/docs/2.2.1/notification/v1/receiver.md new file mode 100644 index 0000000..6cf4101 --- /dev/null +++ b/docs/2.2.1/notification/v1/receiver.md @@ -0,0 +1,352 @@ +--- +permalink: /2.2.1/notification/v1/receiver/ +--- + +# notification.v1.receiver + +"Receiver is the Schema for the receivers API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withEvents(events)`](#fn-specwithevents) + * [`fn withEventsMixin(events)`](#fn-specwitheventsmixin) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withResources(resources)`](#fn-specwithresources) + * [`fn withResourcesMixin(resources)`](#fn-specwithresourcesmixin) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withType(type)`](#fn-specwithtype) + * [`obj spec.resources`](#obj-specresources) + * [`fn withApiVersion(apiVersion)`](#fn-specresourceswithapiversion) + * [`fn withKind(kind)`](#fn-specresourceswithkind) + * [`fn withMatchLabels(matchLabels)`](#fn-specresourceswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specresourceswithmatchlabelsmixin) + * [`fn withName(name)`](#fn-specresourceswithname) + * [`fn withNamespace(namespace)`](#fn-specresourceswithnamespace) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Receiver + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ReceiverSpec defines the desired state of the Receiver." + +### fn spec.withEvents + +```ts +withEvents(events) +``` + +"Events specifies the list of event types to handle, e.g. 'push' for GitHub or 'Push Hook' for GitLab." + +### fn spec.withEventsMixin + +```ts +withEventsMixin(events) +``` + +"Events specifies the list of event types to handle, e.g. 'push' for GitHub or 'Push Hook' for GitLab." + +**Note:** This function appends passed data to existing values + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval at which to reconcile the Receiver with its Secret references." + +### fn spec.withResources + +```ts +withResources(resources) +``` + +"A list of resources to be notified about changes." + +### fn spec.withResourcesMixin + +```ts +withResourcesMixin(resources) +``` + +"A list of resources to be notified about changes." + +**Note:** This function appends passed data to existing values + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"Suspend tells the controller to suspend subsequent events handling for this receiver." + +### fn spec.withType + +```ts +withType(type) +``` + +"Type of webhook sender, used to determine the validation procedure and payload deserialization." + +## obj spec.resources + +"A list of resources to be notified about changes." + +### fn spec.resources.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"API version of the referent" + +### fn spec.resources.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent" + +### fn spec.resources.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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. MatchLabels requires the name to be set to `*`." + +### fn spec.resources.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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. MatchLabels requires the name to be set to `*`." + +**Note:** This function appends passed data to existing values + +### fn spec.resources.withName + +```ts +withName(name) +``` + +"Name of the referent If multiple resources are targeted `*` may be set." + +### fn spec.resources.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent" + +## obj spec.secretRef + +"SecretRef specifies the Secret containing the token used to validate the payload authenticity." + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/notification/v1beta1/alert.md b/docs/2.2.1/notification/v1beta1/alert.md new file mode 100644 index 0000000..49d188d --- /dev/null +++ b/docs/2.2.1/notification/v1beta1/alert.md @@ -0,0 +1,352 @@ +--- +permalink: /2.2.1/notification/v1beta1/alert/ +--- + +# notification.v1beta1.alert + +"Alert is the Schema for the alerts API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withEventSeverity(eventSeverity)`](#fn-specwitheventseverity) + * [`fn withEventSources(eventSources)`](#fn-specwitheventsources) + * [`fn withEventSourcesMixin(eventSources)`](#fn-specwitheventsourcesmixin) + * [`fn withExclusionList(exclusionList)`](#fn-specwithexclusionlist) + * [`fn withExclusionListMixin(exclusionList)`](#fn-specwithexclusionlistmixin) + * [`fn withSummary(summary)`](#fn-specwithsummary) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`obj spec.eventSources`](#obj-speceventsources) + * [`fn withApiVersion(apiVersion)`](#fn-speceventsourceswithapiversion) + * [`fn withKind(kind)`](#fn-speceventsourceswithkind) + * [`fn withMatchLabels(matchLabels)`](#fn-speceventsourceswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-speceventsourceswithmatchlabelsmixin) + * [`fn withName(name)`](#fn-speceventsourceswithname) + * [`fn withNamespace(namespace)`](#fn-speceventsourceswithnamespace) + * [`obj spec.providerRef`](#obj-specproviderref) + * [`fn withName(name)`](#fn-specproviderrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Alert + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"AlertSpec defines an alerting rule for events involving a list of objects" + +### fn spec.withEventSeverity + +```ts +withEventSeverity(eventSeverity) +``` + +"Filter events based on severity, defaults to ('info'). If set to 'info' no events will be filtered." + +### fn spec.withEventSources + +```ts +withEventSources(eventSources) +``` + +"Filter events based on the involved objects." + +### fn spec.withEventSourcesMixin + +```ts +withEventSourcesMixin(eventSources) +``` + +"Filter events based on the involved objects." + +**Note:** This function appends passed data to existing values + +### fn spec.withExclusionList + +```ts +withExclusionList(exclusionList) +``` + +"A list of Golang regular expressions to be used for excluding messages." + +### fn spec.withExclusionListMixin + +```ts +withExclusionListMixin(exclusionList) +``` + +"A list of Golang regular expressions to be used for excluding messages." + +**Note:** This function appends passed data to existing values + +### fn spec.withSummary + +```ts +withSummary(summary) +``` + +"Short description of the impact and affected cluster." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"This flag tells the controller to suspend subsequent events dispatching. Defaults to false." + +## obj spec.eventSources + +"Filter events based on the involved objects." + +### fn spec.eventSources.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"API version of the referent" + +### fn spec.eventSources.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent" + +### fn spec.eventSources.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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." + +### fn spec.eventSources.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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." + +**Note:** This function appends passed data to existing values + +### fn spec.eventSources.withName + +```ts +withName(name) +``` + +"Name of the referent" + +### fn spec.eventSources.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent" + +## obj spec.providerRef + +"Send events using this provider." + +### fn spec.providerRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/notification/v1beta1/index.md b/docs/2.2.1/notification/v1beta1/index.md new file mode 100644 index 0000000..2b48294 --- /dev/null +++ b/docs/2.2.1/notification/v1beta1/index.md @@ -0,0 +1,11 @@ +--- +permalink: /2.2.1/notification/v1beta1/ +--- + +# notification.v1beta1 + + + +* [alert](alert.md) +* [provider](provider.md) +* [receiver](receiver.md) \ No newline at end of file diff --git a/docs/2.2.1/notification/v1beta1/provider.md b/docs/2.2.1/notification/v1beta1/provider.md new file mode 100644 index 0000000..d042eb2 --- /dev/null +++ b/docs/2.2.1/notification/v1beta1/provider.md @@ -0,0 +1,301 @@ +--- +permalink: /2.2.1/notification/v1beta1/provider/ +--- + +# notification.v1beta1.provider + +"Provider is the Schema for the providers API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withAddress(address)`](#fn-specwithaddress) + * [`fn withChannel(channel)`](#fn-specwithchannel) + * [`fn withProxy(proxy)`](#fn-specwithproxy) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`fn withType(type)`](#fn-specwithtype) + * [`fn withUsername(username)`](#fn-specwithusername) + * [`obj spec.certSecretRef`](#obj-speccertsecretref) + * [`fn withName(name)`](#fn-speccertsecretrefwithname) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Provider + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ProviderSpec defines the desired state of Provider" + +### fn spec.withAddress + +```ts +withAddress(address) +``` + +"HTTP/S webhook address of this provider" + +### fn spec.withChannel + +```ts +withChannel(channel) +``` + +"Alert channel for this provider" + +### fn spec.withProxy + +```ts +withProxy(proxy) +``` + +"HTTP/S address of the proxy" + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"This flag tells the controller to suspend subsequent events handling. Defaults to false." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout for sending alerts to the provider." + +### fn spec.withType + +```ts +withType(type) +``` + +"Type of provider" + +### fn spec.withUsername + +```ts +withUsername(username) +``` + +"Bot username for this provider" + +## obj spec.certSecretRef + +"CertSecretRef can be given the name of a secret containing a PEM-encoded CA certificate (`caFile`)" + +### fn spec.certSecretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.secretRef + +"Secret reference containing the provider webhook URL using \"address\" as data key" + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/notification/v1beta1/receiver.md b/docs/2.2.1/notification/v1beta1/receiver.md new file mode 100644 index 0000000..fd76693 --- /dev/null +++ b/docs/2.2.1/notification/v1beta1/receiver.md @@ -0,0 +1,343 @@ +--- +permalink: /2.2.1/notification/v1beta1/receiver/ +--- + +# notification.v1beta1.receiver + +"Receiver is the Schema for the receivers API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withEvents(events)`](#fn-specwithevents) + * [`fn withEventsMixin(events)`](#fn-specwitheventsmixin) + * [`fn withResources(resources)`](#fn-specwithresources) + * [`fn withResourcesMixin(resources)`](#fn-specwithresourcesmixin) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withType(type)`](#fn-specwithtype) + * [`obj spec.resources`](#obj-specresources) + * [`fn withApiVersion(apiVersion)`](#fn-specresourceswithapiversion) + * [`fn withKind(kind)`](#fn-specresourceswithkind) + * [`fn withMatchLabels(matchLabels)`](#fn-specresourceswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specresourceswithmatchlabelsmixin) + * [`fn withName(name)`](#fn-specresourceswithname) + * [`fn withNamespace(namespace)`](#fn-specresourceswithnamespace) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Receiver + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ReceiverSpec defines the desired state of Receiver" + +### fn spec.withEvents + +```ts +withEvents(events) +``` + +"A list of events to handle, e.g. 'push' for GitHub or 'Push Hook' for GitLab." + +### fn spec.withEventsMixin + +```ts +withEventsMixin(events) +``` + +"A list of events to handle, e.g. 'push' for GitHub or 'Push Hook' for GitLab." + +**Note:** This function appends passed data to existing values + +### fn spec.withResources + +```ts +withResources(resources) +``` + +"A list of resources to be notified about changes." + +### fn spec.withResourcesMixin + +```ts +withResourcesMixin(resources) +``` + +"A list of resources to be notified about changes." + +**Note:** This function appends passed data to existing values + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"This flag tells the controller to suspend subsequent events handling. Defaults to false." + +### fn spec.withType + +```ts +withType(type) +``` + +"Type of webhook sender, used to determine the validation procedure and payload deserialization." + +## obj spec.resources + +"A list of resources to be notified about changes." + +### fn spec.resources.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"API version of the referent" + +### fn spec.resources.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent" + +### fn spec.resources.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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." + +### fn spec.resources.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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." + +**Note:** This function appends passed data to existing values + +### fn spec.resources.withName + +```ts +withName(name) +``` + +"Name of the referent" + +### fn spec.resources.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent" + +## obj spec.secretRef + +"Secret reference containing the token used to validate the payload authenticity" + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/notification/v1beta2/alert.md b/docs/2.2.1/notification/v1beta2/alert.md new file mode 100644 index 0000000..e1cd99d --- /dev/null +++ b/docs/2.2.1/notification/v1beta2/alert.md @@ -0,0 +1,392 @@ +--- +permalink: /2.2.1/notification/v1beta2/alert/ +--- + +# notification.v1beta2.alert + +"Alert is the Schema for the alerts API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withEventMetadata(eventMetadata)`](#fn-specwitheventmetadata) + * [`fn withEventMetadataMixin(eventMetadata)`](#fn-specwitheventmetadatamixin) + * [`fn withEventSeverity(eventSeverity)`](#fn-specwitheventseverity) + * [`fn withEventSources(eventSources)`](#fn-specwitheventsources) + * [`fn withEventSourcesMixin(eventSources)`](#fn-specwitheventsourcesmixin) + * [`fn withExclusionList(exclusionList)`](#fn-specwithexclusionlist) + * [`fn withExclusionListMixin(exclusionList)`](#fn-specwithexclusionlistmixin) + * [`fn withInclusionList(inclusionList)`](#fn-specwithinclusionlist) + * [`fn withInclusionListMixin(inclusionList)`](#fn-specwithinclusionlistmixin) + * [`fn withSummary(summary)`](#fn-specwithsummary) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`obj spec.eventSources`](#obj-speceventsources) + * [`fn withApiVersion(apiVersion)`](#fn-speceventsourceswithapiversion) + * [`fn withKind(kind)`](#fn-speceventsourceswithkind) + * [`fn withMatchLabels(matchLabels)`](#fn-speceventsourceswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-speceventsourceswithmatchlabelsmixin) + * [`fn withName(name)`](#fn-speceventsourceswithname) + * [`fn withNamespace(namespace)`](#fn-speceventsourceswithnamespace) + * [`obj spec.providerRef`](#obj-specproviderref) + * [`fn withName(name)`](#fn-specproviderrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Alert + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"AlertSpec defines an alerting rule for events involving a list of objects." + +### fn spec.withEventMetadata + +```ts +withEventMetadata(eventMetadata) +``` + +"EventMetadata is an optional field for adding metadata to events dispatched by the controller. This can be used for enhancing the context of the event. If a field would override one already present on the original event as generated by the emitter, then the override doesn't happen, i.e. the original value is preserved, and an info log is printed." + +### fn spec.withEventMetadataMixin + +```ts +withEventMetadataMixin(eventMetadata) +``` + +"EventMetadata is an optional field for adding metadata to events dispatched by the controller. This can be used for enhancing the context of the event. If a field would override one already present on the original event as generated by the emitter, then the override doesn't happen, i.e. the original value is preserved, and an info log is printed." + +**Note:** This function appends passed data to existing values + +### fn spec.withEventSeverity + +```ts +withEventSeverity(eventSeverity) +``` + +"EventSeverity specifies how to filter events based on severity. If set to 'info' no events will be filtered." + +### fn spec.withEventSources + +```ts +withEventSources(eventSources) +``` + +"EventSources specifies how to filter events based on the involved object kind, name and namespace." + +### fn spec.withEventSourcesMixin + +```ts +withEventSourcesMixin(eventSources) +``` + +"EventSources specifies how to filter events based on the involved object kind, name and namespace." + +**Note:** This function appends passed data to existing values + +### fn spec.withExclusionList + +```ts +withExclusionList(exclusionList) +``` + +"ExclusionList specifies a list of Golang regular expressions to be used for excluding messages." + +### fn spec.withExclusionListMixin + +```ts +withExclusionListMixin(exclusionList) +``` + +"ExclusionList specifies a list of Golang regular expressions to be used for excluding messages." + +**Note:** This function appends passed data to existing values + +### fn spec.withInclusionList + +```ts +withInclusionList(inclusionList) +``` + +"InclusionList specifies a list of Golang regular expressions to be used for including messages." + +### fn spec.withInclusionListMixin + +```ts +withInclusionListMixin(inclusionList) +``` + +"InclusionList specifies a list of Golang regular expressions to be used for including messages." + +**Note:** This function appends passed data to existing values + +### fn spec.withSummary + +```ts +withSummary(summary) +``` + +"Summary holds a short description of the impact and affected cluster." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"Suspend tells the controller to suspend subsequent events handling for this Alert." + +## obj spec.eventSources + +"EventSources specifies how to filter events based on the involved object kind, name and namespace." + +### fn spec.eventSources.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"API version of the referent" + +### fn spec.eventSources.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent" + +### fn spec.eventSources.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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. MatchLabels requires the name to be set to `*`." + +### fn spec.eventSources.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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. MatchLabels requires the name to be set to `*`." + +**Note:** This function appends passed data to existing values + +### fn spec.eventSources.withName + +```ts +withName(name) +``` + +"Name of the referent If multiple resources are targeted `*` may be set." + +### fn spec.eventSources.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent" + +## obj spec.providerRef + +"ProviderRef specifies which Provider this Alert should use." + +### fn spec.providerRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/notification/v1beta2/index.md b/docs/2.2.1/notification/v1beta2/index.md new file mode 100644 index 0000000..0ec8c0f --- /dev/null +++ b/docs/2.2.1/notification/v1beta2/index.md @@ -0,0 +1,11 @@ +--- +permalink: /2.2.1/notification/v1beta2/ +--- + +# notification.v1beta2 + + + +* [alert](alert.md) +* [provider](provider.md) +* [receiver](receiver.md) \ No newline at end of file diff --git a/docs/2.2.1/notification/v1beta2/provider.md b/docs/2.2.1/notification/v1beta2/provider.md new file mode 100644 index 0000000..e9b2994 --- /dev/null +++ b/docs/2.2.1/notification/v1beta2/provider.md @@ -0,0 +1,310 @@ +--- +permalink: /2.2.1/notification/v1beta2/provider/ +--- + +# notification.v1beta2.provider + +"Provider is the Schema for the providers API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withAddress(address)`](#fn-specwithaddress) + * [`fn withChannel(channel)`](#fn-specwithchannel) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withProxy(proxy)`](#fn-specwithproxy) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`fn withType(type)`](#fn-specwithtype) + * [`fn withUsername(username)`](#fn-specwithusername) + * [`obj spec.certSecretRef`](#obj-speccertsecretref) + * [`fn withName(name)`](#fn-speccertsecretrefwithname) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Provider + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ProviderSpec defines the desired state of the Provider." + +### fn spec.withAddress + +```ts +withAddress(address) +``` + +"Address specifies the endpoint, in a generic sense, to where alerts are sent. What kind of endpoint depends on the specific Provider type being used. For the generic Provider, for example, this is an HTTP/S address. For other Provider types this could be a project ID or a namespace." + +### fn spec.withChannel + +```ts +withChannel(channel) +``` + +"Channel specifies the destination channel where events should be posted." + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval at which to reconcile the Provider with its Secret references." + +### fn spec.withProxy + +```ts +withProxy(proxy) +``` + +"Proxy the HTTP/S address of the proxy server." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"Suspend tells the controller to suspend subsequent events handling for this Provider." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout for sending alerts to the Provider." + +### fn spec.withType + +```ts +withType(type) +``` + +"Type specifies which Provider implementation to use." + +### fn spec.withUsername + +```ts +withUsername(username) +``` + +"Username specifies the name under which events are posted." + +## obj spec.certSecretRef + +"CertSecretRef specifies the Secret containing a PEM-encoded CA certificate (in the `ca.crt` key). \n Note: Support for the `caFile` key has been deprecated." + +### fn spec.certSecretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.secretRef + +"SecretRef specifies the Secret containing the authentication credentials for this Provider." + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/notification/v1beta2/receiver.md b/docs/2.2.1/notification/v1beta2/receiver.md new file mode 100644 index 0000000..50560ac --- /dev/null +++ b/docs/2.2.1/notification/v1beta2/receiver.md @@ -0,0 +1,352 @@ +--- +permalink: /2.2.1/notification/v1beta2/receiver/ +--- + +# notification.v1beta2.receiver + +"Receiver is the Schema for the receivers API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withEvents(events)`](#fn-specwithevents) + * [`fn withEventsMixin(events)`](#fn-specwitheventsmixin) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withResources(resources)`](#fn-specwithresources) + * [`fn withResourcesMixin(resources)`](#fn-specwithresourcesmixin) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withType(type)`](#fn-specwithtype) + * [`obj spec.resources`](#obj-specresources) + * [`fn withApiVersion(apiVersion)`](#fn-specresourceswithapiversion) + * [`fn withKind(kind)`](#fn-specresourceswithkind) + * [`fn withMatchLabels(matchLabels)`](#fn-specresourceswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specresourceswithmatchlabelsmixin) + * [`fn withName(name)`](#fn-specresourceswithname) + * [`fn withNamespace(namespace)`](#fn-specresourceswithnamespace) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Receiver + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ReceiverSpec defines the desired state of the Receiver." + +### fn spec.withEvents + +```ts +withEvents(events) +``` + +"Events specifies the list of event types to handle, e.g. 'push' for GitHub or 'Push Hook' for GitLab." + +### fn spec.withEventsMixin + +```ts +withEventsMixin(events) +``` + +"Events specifies the list of event types to handle, e.g. 'push' for GitHub or 'Push Hook' for GitLab." + +**Note:** This function appends passed data to existing values + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval at which to reconcile the Receiver with its Secret references." + +### fn spec.withResources + +```ts +withResources(resources) +``` + +"A list of resources to be notified about changes." + +### fn spec.withResourcesMixin + +```ts +withResourcesMixin(resources) +``` + +"A list of resources to be notified about changes." + +**Note:** This function appends passed data to existing values + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"Suspend tells the controller to suspend subsequent events handling for this receiver." + +### fn spec.withType + +```ts +withType(type) +``` + +"Type of webhook sender, used to determine the validation procedure and payload deserialization." + +## obj spec.resources + +"A list of resources to be notified about changes." + +### fn spec.resources.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"API version of the referent" + +### fn spec.resources.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent" + +### fn spec.resources.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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. MatchLabels requires the name to be set to `*`." + +### fn spec.resources.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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. MatchLabels requires the name to be set to `*`." + +**Note:** This function appends passed data to existing values + +### fn spec.resources.withName + +```ts +withName(name) +``` + +"Name of the referent If multiple resources are targeted `*` may be set." + +### fn spec.resources.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent" + +## obj spec.secretRef + +"SecretRef specifies the Secret containing the token used to validate the payload authenticity." + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/notification/v1beta3/alert.md b/docs/2.2.1/notification/v1beta3/alert.md new file mode 100644 index 0000000..f55fb90 --- /dev/null +++ b/docs/2.2.1/notification/v1beta3/alert.md @@ -0,0 +1,392 @@ +--- +permalink: /2.2.1/notification/v1beta3/alert/ +--- + +# notification.v1beta3.alert + +"Alert is the Schema for the alerts API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withEventMetadata(eventMetadata)`](#fn-specwitheventmetadata) + * [`fn withEventMetadataMixin(eventMetadata)`](#fn-specwitheventmetadatamixin) + * [`fn withEventSeverity(eventSeverity)`](#fn-specwitheventseverity) + * [`fn withEventSources(eventSources)`](#fn-specwitheventsources) + * [`fn withEventSourcesMixin(eventSources)`](#fn-specwitheventsourcesmixin) + * [`fn withExclusionList(exclusionList)`](#fn-specwithexclusionlist) + * [`fn withExclusionListMixin(exclusionList)`](#fn-specwithexclusionlistmixin) + * [`fn withInclusionList(inclusionList)`](#fn-specwithinclusionlist) + * [`fn withInclusionListMixin(inclusionList)`](#fn-specwithinclusionlistmixin) + * [`fn withSummary(summary)`](#fn-specwithsummary) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`obj spec.eventSources`](#obj-speceventsources) + * [`fn withApiVersion(apiVersion)`](#fn-speceventsourceswithapiversion) + * [`fn withKind(kind)`](#fn-speceventsourceswithkind) + * [`fn withMatchLabels(matchLabels)`](#fn-speceventsourceswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-speceventsourceswithmatchlabelsmixin) + * [`fn withName(name)`](#fn-speceventsourceswithname) + * [`fn withNamespace(namespace)`](#fn-speceventsourceswithnamespace) + * [`obj spec.providerRef`](#obj-specproviderref) + * [`fn withName(name)`](#fn-specproviderrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Alert + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"AlertSpec defines an alerting rule for events involving a list of objects." + +### fn spec.withEventMetadata + +```ts +withEventMetadata(eventMetadata) +``` + +"EventMetadata is an optional field for adding metadata to events dispatched by the controller. This can be used for enhancing the context of the event. If a field would override one already present on the original event as generated by the emitter, then the override doesn't happen, i.e. the original value is preserved, and an info log is printed." + +### fn spec.withEventMetadataMixin + +```ts +withEventMetadataMixin(eventMetadata) +``` + +"EventMetadata is an optional field for adding metadata to events dispatched by the controller. This can be used for enhancing the context of the event. If a field would override one already present on the original event as generated by the emitter, then the override doesn't happen, i.e. the original value is preserved, and an info log is printed." + +**Note:** This function appends passed data to existing values + +### fn spec.withEventSeverity + +```ts +withEventSeverity(eventSeverity) +``` + +"EventSeverity specifies how to filter events based on severity. If set to 'info' no events will be filtered." + +### fn spec.withEventSources + +```ts +withEventSources(eventSources) +``` + +"EventSources specifies how to filter events based on the involved object kind, name and namespace." + +### fn spec.withEventSourcesMixin + +```ts +withEventSourcesMixin(eventSources) +``` + +"EventSources specifies how to filter events based on the involved object kind, name and namespace." + +**Note:** This function appends passed data to existing values + +### fn spec.withExclusionList + +```ts +withExclusionList(exclusionList) +``` + +"ExclusionList specifies a list of Golang regular expressions to be used for excluding messages." + +### fn spec.withExclusionListMixin + +```ts +withExclusionListMixin(exclusionList) +``` + +"ExclusionList specifies a list of Golang regular expressions to be used for excluding messages." + +**Note:** This function appends passed data to existing values + +### fn spec.withInclusionList + +```ts +withInclusionList(inclusionList) +``` + +"InclusionList specifies a list of Golang regular expressions to be used for including messages." + +### fn spec.withInclusionListMixin + +```ts +withInclusionListMixin(inclusionList) +``` + +"InclusionList specifies a list of Golang regular expressions to be used for including messages." + +**Note:** This function appends passed data to existing values + +### fn spec.withSummary + +```ts +withSummary(summary) +``` + +"Summary holds a short description of the impact and affected cluster." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"Suspend tells the controller to suspend subsequent events handling for this Alert." + +## obj spec.eventSources + +"EventSources specifies how to filter events based on the involved object kind, name and namespace." + +### fn spec.eventSources.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"API version of the referent" + +### fn spec.eventSources.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent" + +### fn spec.eventSources.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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. MatchLabels requires the name to be set to `*`." + +### fn spec.eventSources.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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. MatchLabels requires the name to be set to `*`." + +**Note:** This function appends passed data to existing values + +### fn spec.eventSources.withName + +```ts +withName(name) +``` + +"Name of the referent If multiple resources are targeted `*` may be set." + +### fn spec.eventSources.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent" + +## obj spec.providerRef + +"ProviderRef specifies which Provider this Alert should use." + +### fn spec.providerRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/notification/v1beta3/index.md b/docs/2.2.1/notification/v1beta3/index.md new file mode 100644 index 0000000..d78aa43 --- /dev/null +++ b/docs/2.2.1/notification/v1beta3/index.md @@ -0,0 +1,10 @@ +--- +permalink: /2.2.1/notification/v1beta3/ +--- + +# notification.v1beta3 + + + +* [alert](alert.md) +* [provider](provider.md) \ No newline at end of file diff --git a/docs/2.2.1/notification/v1beta3/provider.md b/docs/2.2.1/notification/v1beta3/provider.md new file mode 100644 index 0000000..377d59b --- /dev/null +++ b/docs/2.2.1/notification/v1beta3/provider.md @@ -0,0 +1,310 @@ +--- +permalink: /2.2.1/notification/v1beta3/provider/ +--- + +# notification.v1beta3.provider + +"Provider is the Schema for the providers API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withAddress(address)`](#fn-specwithaddress) + * [`fn withChannel(channel)`](#fn-specwithchannel) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withProxy(proxy)`](#fn-specwithproxy) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`fn withType(type)`](#fn-specwithtype) + * [`fn withUsername(username)`](#fn-specwithusername) + * [`obj spec.certSecretRef`](#obj-speccertsecretref) + * [`fn withName(name)`](#fn-speccertsecretrefwithname) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Provider + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ProviderSpec defines the desired state of the Provider." + +### fn spec.withAddress + +```ts +withAddress(address) +``` + +"Address specifies the endpoint, in a generic sense, to where alerts are sent. What kind of endpoint depends on the specific Provider type being used. For the generic Provider, for example, this is an HTTP/S address. For other Provider types this could be a project ID or a namespace." + +### fn spec.withChannel + +```ts +withChannel(channel) +``` + +"Channel specifies the destination channel where events should be posted." + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval at which to reconcile the Provider with its Secret references. Deprecated and not used in v1beta3." + +### fn spec.withProxy + +```ts +withProxy(proxy) +``` + +"Proxy the HTTP/S address of the proxy server." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"Suspend tells the controller to suspend subsequent events handling for this Provider." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout for sending alerts to the Provider." + +### fn spec.withType + +```ts +withType(type) +``` + +"Type specifies which Provider implementation to use." + +### fn spec.withUsername + +```ts +withUsername(username) +``` + +"Username specifies the name under which events are posted." + +## obj spec.certSecretRef + +"CertSecretRef specifies the Secret containing a PEM-encoded CA certificate (in the `ca.crt` key). \n Note: Support for the `caFile` key has been deprecated." + +### fn spec.certSecretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.secretRef + +"SecretRef specifies the Secret containing the authentication credentials for this Provider." + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/source/index.md b/docs/2.2.1/source/index.md new file mode 100644 index 0000000..811f279 --- /dev/null +++ b/docs/2.2.1/source/index.md @@ -0,0 +1,11 @@ +--- +permalink: /2.2.1/source/ +--- + +# source + + + +* [v1](v1/index.md) +* [v1beta1](v1beta1/index.md) +* [v1beta2](v1beta2/index.md) \ No newline at end of file diff --git a/docs/2.2.1/source/v1/gitRepository.md b/docs/2.2.1/source/v1/gitRepository.md new file mode 100644 index 0000000..0dae4de --- /dev/null +++ b/docs/2.2.1/source/v1/gitRepository.md @@ -0,0 +1,427 @@ +--- +permalink: /2.2.1/source/v1/gitRepository/ +--- + +# source.v1.gitRepository + +"GitRepository is the Schema for the gitrepositories API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withIgnore(ignore)`](#fn-specwithignore) + * [`fn withInclude(include)`](#fn-specwithinclude) + * [`fn withIncludeMixin(include)`](#fn-specwithincludemixin) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withRecurseSubmodules(recurseSubmodules)`](#fn-specwithrecursesubmodules) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`fn withUrl(url)`](#fn-specwithurl) + * [`obj spec.include`](#obj-specinclude) + * [`fn withFromPath(fromPath)`](#fn-specincludewithfrompath) + * [`fn withToPath(toPath)`](#fn-specincludewithtopath) + * [`obj spec.include.repository`](#obj-specincluderepository) + * [`fn withName(name)`](#fn-specincluderepositorywithname) + * [`obj spec.proxySecretRef`](#obj-specproxysecretref) + * [`fn withName(name)`](#fn-specproxysecretrefwithname) + * [`obj spec.ref`](#obj-specref) + * [`fn withBranch(branch)`](#fn-specrefwithbranch) + * [`fn withCommit(commit)`](#fn-specrefwithcommit) + * [`fn withName(name)`](#fn-specrefwithname) + * [`fn withSemver(semver)`](#fn-specrefwithsemver) + * [`fn withTag(tag)`](#fn-specrefwithtag) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + * [`obj spec.verify`](#obj-specverify) + * [`fn withMode(mode)`](#fn-specverifywithmode) + * [`obj spec.verify.secretRef`](#obj-specverifysecretref) + * [`fn withName(name)`](#fn-specverifysecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of GitRepository + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"GitRepositorySpec specifies the required configuration to produce an Artifact for a Git repository." + +### fn spec.withIgnore + +```ts +withIgnore(ignore) +``` + +"Ignore 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." + +### fn spec.withInclude + +```ts +withInclude(include) +``` + +"Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository." + +### fn spec.withIncludeMixin + +```ts +withIncludeMixin(include) +``` + +"Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository." + +**Note:** This function appends passed data to existing values + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval at which the GitRepository URL is checked for updates. This interval is approximate and may be subject to jitter to ensure efficient use of resources." + +### fn spec.withRecurseSubmodules + +```ts +withRecurseSubmodules(recurseSubmodules) +``` + +"RecurseSubmodules enables the initialization of all submodules within the GitRepository as cloned from the URL, using their default settings." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"Suspend tells the controller to suspend the reconciliation of this GitRepository." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout for Git operations like cloning, defaults to 60s." + +### fn spec.withUrl + +```ts +withUrl(url) +``` + +"URL specifies the Git repository URL, it can be an HTTP/S or SSH address." + +## obj spec.include + +"Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository." + +### fn spec.include.withFromPath + +```ts +withFromPath(fromPath) +``` + +"FromPath specifies the path to copy contents from, defaults to the root of the Artifact." + +### fn spec.include.withToPath + +```ts +withToPath(toPath) +``` + +"ToPath specifies the path to copy contents to, defaults to the name of the GitRepositoryRef." + +## obj spec.include.repository + +"GitRepositoryRef specifies the GitRepository which Artifact contents must be included." + +### fn spec.include.repository.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.proxySecretRef + +"ProxySecretRef specifies the Secret containing the proxy configuration to use while communicating with the Git server." + +### fn spec.proxySecretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.ref + +"Reference specifies the Git reference to resolve and monitor for changes, defaults to the 'master' branch." + +### fn spec.ref.withBranch + +```ts +withBranch(branch) +``` + +"Branch to check out, defaults to 'master' if no other field is defined." + +### fn spec.ref.withCommit + +```ts +withCommit(commit) +``` + +"Commit SHA to check out, takes precedence over all reference fields. \n This can be combined with Branch to shallow clone the branch, in which the commit is expected to exist." + +### fn spec.ref.withName + +```ts +withName(name) +``` + +"Name of the reference to check out; takes precedence over Branch, Tag and SemVer. \n It must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description Examples: \"refs/heads/main\", \"refs/tags/v0.1.0\", \"refs/pull/420/head\", \"refs/merge-requests/1/head\ + +### fn spec.ref.withSemver + +```ts +withSemver(semver) +``` + +"SemVer tag expression to check out, takes precedence over Tag." + +### fn spec.ref.withTag + +```ts +withTag(tag) +``` + +"Tag to check out, takes precedence over Branch." + +## obj spec.secretRef + +"SecretRef specifies the Secret containing authentication credentials for the GitRepository. For HTTPS repositories the Secret must contain 'username' and 'password' fields for basic auth or 'bearerToken' field for token auth. For SSH repositories the Secret must contain 'identity' and 'known_hosts' fields." + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.verify + +"Verification specifies the configuration to verify the Git commit signature(s)." + +### fn spec.verify.withMode + +```ts +withMode(mode) +``` + +"Mode specifies which Git object(s) should be verified. \n The variants \"head\" and \"HEAD\" both imply the same thing, i.e. verify the commit that the HEAD of the Git repository points to. The variant \"head\" solely exists to ensure backwards compatibility." + +## obj spec.verify.secretRef + +"SecretRef specifies the Secret containing the public keys of trusted Git authors." + +### fn spec.verify.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/source/v1/index.md b/docs/2.2.1/source/v1/index.md new file mode 100644 index 0000000..5d72c08 --- /dev/null +++ b/docs/2.2.1/source/v1/index.md @@ -0,0 +1,9 @@ +--- +permalink: /2.2.1/source/v1/ +--- + +# source.v1 + + + +* [gitRepository](gitRepository.md) \ No newline at end of file diff --git a/docs/2.2.1/source/v1beta1/bucket.md b/docs/2.2.1/source/v1beta1/bucket.md new file mode 100644 index 0000000..194b651 --- /dev/null +++ b/docs/2.2.1/source/v1beta1/bucket.md @@ -0,0 +1,355 @@ +--- +permalink: /2.2.1/source/v1beta1/bucket/ +--- + +# source.v1beta1.bucket + +"Bucket is the Schema for the buckets API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withBucketName(bucketName)`](#fn-specwithbucketname) + * [`fn withEndpoint(endpoint)`](#fn-specwithendpoint) + * [`fn withIgnore(ignore)`](#fn-specwithignore) + * [`fn withInsecure(insecure)`](#fn-specwithinsecure) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withProvider(provider)`](#fn-specwithprovider) + * [`fn withRegion(region)`](#fn-specwithregion) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`obj spec.accessFrom`](#obj-specaccessfrom) + * [`fn withNamespaceSelectors(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectors) + * [`fn withNamespaceSelectorsMixin(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectorsmixin) + * [`obj spec.accessFrom.namespaceSelectors`](#obj-specaccessfromnamespaceselectors) + * [`fn withMatchLabels(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabelsmixin) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Bucket + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"BucketSpec defines the desired state of an S3 compatible bucket" + +### fn spec.withBucketName + +```ts +withBucketName(bucketName) +``` + +"The bucket name." + +### fn spec.withEndpoint + +```ts +withEndpoint(endpoint) +``` + +"The bucket endpoint address." + +### fn spec.withIgnore + +```ts +withIgnore(ignore) +``` + +"Ignore 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." + +### fn spec.withInsecure + +```ts +withInsecure(insecure) +``` + +"Insecure allows connecting to a non-TLS S3 HTTP endpoint." + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"The interval at which to check for bucket updates." + +### fn spec.withProvider + +```ts +withProvider(provider) +``` + +"The S3 compatible storage provider name, default ('generic')." + +### fn spec.withRegion + +```ts +withRegion(region) +``` + +"The bucket region." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"This flag tells the controller to suspend the reconciliation of this source." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"The timeout for download operations, defaults to 60s." + +## obj spec.accessFrom + +"AccessFrom defines an Access Control List for allowing cross-namespace references to this object." + +### fn spec.accessFrom.withNamespaceSelectors + +```ts +withNamespaceSelectors(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.withNamespaceSelectorsMixin + +```ts +withNamespaceSelectorsMixin(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +**Note:** This function appends passed data to existing values + +## obj spec.accessFrom.namespaceSelectors + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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." + +**Note:** This function appends passed data to existing values + +## obj spec.secretRef + +"The name of the secret containing authentication credentials for the Bucket." + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/source/v1beta1/gitRepository.md b/docs/2.2.1/source/v1beta1/gitRepository.md new file mode 100644 index 0000000..f41d307 --- /dev/null +++ b/docs/2.2.1/source/v1beta1/gitRepository.md @@ -0,0 +1,463 @@ +--- +permalink: /2.2.1/source/v1beta1/gitRepository/ +--- + +# source.v1beta1.gitRepository + +"GitRepository is the Schema for the gitrepositories API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withGitImplementation(gitImplementation)`](#fn-specwithgitimplementation) + * [`fn withIgnore(ignore)`](#fn-specwithignore) + * [`fn withInclude(include)`](#fn-specwithinclude) + * [`fn withIncludeMixin(include)`](#fn-specwithincludemixin) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withRecurseSubmodules(recurseSubmodules)`](#fn-specwithrecursesubmodules) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`fn withUrl(url)`](#fn-specwithurl) + * [`obj spec.accessFrom`](#obj-specaccessfrom) + * [`fn withNamespaceSelectors(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectors) + * [`fn withNamespaceSelectorsMixin(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectorsmixin) + * [`obj spec.accessFrom.namespaceSelectors`](#obj-specaccessfromnamespaceselectors) + * [`fn withMatchLabels(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabelsmixin) + * [`obj spec.include`](#obj-specinclude) + * [`fn withFromPath(fromPath)`](#fn-specincludewithfrompath) + * [`fn withToPath(toPath)`](#fn-specincludewithtopath) + * [`obj spec.include.repository`](#obj-specincluderepository) + * [`fn withName(name)`](#fn-specincluderepositorywithname) + * [`obj spec.ref`](#obj-specref) + * [`fn withBranch(branch)`](#fn-specrefwithbranch) + * [`fn withCommit(commit)`](#fn-specrefwithcommit) + * [`fn withSemver(semver)`](#fn-specrefwithsemver) + * [`fn withTag(tag)`](#fn-specrefwithtag) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + * [`obj spec.verify`](#obj-specverify) + * [`fn withMode(mode)`](#fn-specverifywithmode) + * [`obj spec.verify.secretRef`](#obj-specverifysecretref) + * [`fn withName(name)`](#fn-specverifysecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of GitRepository + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"GitRepositorySpec defines the desired state of a Git repository." + +### fn spec.withGitImplementation + +```ts +withGitImplementation(gitImplementation) +``` + +"Determines which git client library to use. Defaults to go-git, valid values are ('go-git', 'libgit2')." + +### fn spec.withIgnore + +```ts +withIgnore(ignore) +``` + +"Ignore 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." + +### fn spec.withInclude + +```ts +withInclude(include) +``` + +"Extra git repositories to map into the repository" + +### fn spec.withIncludeMixin + +```ts +withIncludeMixin(include) +``` + +"Extra git repositories to map into the repository" + +**Note:** This function appends passed data to existing values + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"The interval at which to check for repository updates." + +### fn spec.withRecurseSubmodules + +```ts +withRecurseSubmodules(recurseSubmodules) +``` + +"When enabled, after the clone is created, initializes all submodules within, using their default settings. This option is available only when using the 'go-git' GitImplementation." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"This flag tells the controller to suspend the reconciliation of this source." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"The timeout for remote Git operations like cloning, defaults to 60s." + +### fn spec.withUrl + +```ts +withUrl(url) +``` + +"The repository URL, can be a HTTP/S or SSH address." + +## obj spec.accessFrom + +"AccessFrom defines an Access Control List for allowing cross-namespace references to this object." + +### fn spec.accessFrom.withNamespaceSelectors + +```ts +withNamespaceSelectors(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.withNamespaceSelectorsMixin + +```ts +withNamespaceSelectorsMixin(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +**Note:** This function appends passed data to existing values + +## obj spec.accessFrom.namespaceSelectors + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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." + +**Note:** This function appends passed data to existing values + +## obj spec.include + +"Extra git repositories to map into the repository" + +### fn spec.include.withFromPath + +```ts +withFromPath(fromPath) +``` + +"The path to copy contents from, defaults to the root directory." + +### fn spec.include.withToPath + +```ts +withToPath(toPath) +``` + +"The path to copy contents to, defaults to the name of the source ref." + +## obj spec.include.repository + +"Reference to a GitRepository to include." + +### fn spec.include.repository.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.ref + +"The Git reference to checkout and monitor for changes, defaults to master branch." + +### fn spec.ref.withBranch + +```ts +withBranch(branch) +``` + +"The Git branch to checkout, defaults to master." + +### fn spec.ref.withCommit + +```ts +withCommit(commit) +``` + +"The Git commit SHA to checkout, if specified Tag filters will be ignored." + +### fn spec.ref.withSemver + +```ts +withSemver(semver) +``` + +"The Git tag semver expression, takes precedence over Tag." + +### fn spec.ref.withTag + +```ts +withTag(tag) +``` + +"The Git tag to checkout, takes precedence over Branch." + +## obj spec.secretRef + +"The secret name containing the Git credentials. For HTTPS repositories the secret must contain username and password fields. For SSH repositories the secret must contain identity and known_hosts fields." + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.verify + +"Verify OpenPGP signature for the Git commit HEAD points to." + +### fn spec.verify.withMode + +```ts +withMode(mode) +``` + +"Mode describes what git object should be verified, currently ('head')." + +## obj spec.verify.secretRef + +"The secret name containing the public keys of all trusted Git authors." + +### fn spec.verify.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/source/v1beta1/helmChart.md b/docs/2.2.1/source/v1beta1/helmChart.md new file mode 100644 index 0000000..2546818 --- /dev/null +++ b/docs/2.2.1/source/v1beta1/helmChart.md @@ -0,0 +1,366 @@ +--- +permalink: /2.2.1/source/v1beta1/helmChart/ +--- + +# source.v1beta1.helmChart + +"HelmChart is the Schema for the helmcharts API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withChart(chart)`](#fn-specwithchart) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withReconcileStrategy(reconcileStrategy)`](#fn-specwithreconcilestrategy) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withValuesFile(valuesFile)`](#fn-specwithvaluesfile) + * [`fn withValuesFiles(valuesFiles)`](#fn-specwithvaluesfiles) + * [`fn withValuesFilesMixin(valuesFiles)`](#fn-specwithvaluesfilesmixin) + * [`fn withVersion(version)`](#fn-specwithversion) + * [`obj spec.accessFrom`](#obj-specaccessfrom) + * [`fn withNamespaceSelectors(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectors) + * [`fn withNamespaceSelectorsMixin(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectorsmixin) + * [`obj spec.accessFrom.namespaceSelectors`](#obj-specaccessfromnamespaceselectors) + * [`fn withMatchLabels(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabelsmixin) + * [`obj spec.sourceRef`](#obj-specsourceref) + * [`fn withApiVersion(apiVersion)`](#fn-specsourcerefwithapiversion) + * [`fn withKind(kind)`](#fn-specsourcerefwithkind) + * [`fn withName(name)`](#fn-specsourcerefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of HelmChart + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"HelmChartSpec defines the desired state of a Helm chart." + +### fn spec.withChart + +```ts +withChart(chart) +``` + +"The name or path the Helm chart is available at in the SourceRef." + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"The interval at which to check the Source for updates." + +### fn spec.withReconcileStrategy + +```ts +withReconcileStrategy(reconcileStrategy) +``` + +"Determines what enables the creation of a new artifact. Valid values are ('ChartVersion', 'Revision'). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"This flag tells the controller to suspend the reconciliation of this source." + +### fn spec.withValuesFile + +```ts +withValuesFile(valuesFile) +``` + +"Alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Deprecated in favor of ValuesFiles, for backwards compatibility the file defined here is merged before the ValuesFiles items. Ignored when omitted." + +### fn spec.withValuesFiles + +```ts +withValuesFiles(valuesFiles) +``` + +"Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted." + +### fn spec.withValuesFilesMixin + +```ts +withValuesFilesMixin(valuesFiles) +``` + +"Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted." + +**Note:** This function appends passed data to existing values + +### fn spec.withVersion + +```ts +withVersion(version) +``` + +"The chart version semver expression, ignored for charts from GitRepository and Bucket sources. Defaults to latest when omitted." + +## obj spec.accessFrom + +"AccessFrom defines an Access Control List for allowing cross-namespace references to this object." + +### fn spec.accessFrom.withNamespaceSelectors + +```ts +withNamespaceSelectors(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.withNamespaceSelectorsMixin + +```ts +withNamespaceSelectorsMixin(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +**Note:** This function appends passed data to existing values + +## obj spec.accessFrom.namespaceSelectors + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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." + +**Note:** This function appends passed data to existing values + +## obj spec.sourceRef + +"The reference to the Source the chart is available at." + +### fn spec.sourceRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"APIVersion of the referent." + +### fn spec.sourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent, valid values are ('HelmRepository', 'GitRepository', 'Bucket')." + +### fn spec.sourceRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/source/v1beta1/helmRepository.md b/docs/2.2.1/source/v1beta1/helmRepository.md new file mode 100644 index 0000000..f305539 --- /dev/null +++ b/docs/2.2.1/source/v1beta1/helmRepository.md @@ -0,0 +1,319 @@ +--- +permalink: /2.2.1/source/v1beta1/helmRepository/ +--- + +# source.v1beta1.helmRepository + +"HelmRepository is the Schema for the helmrepositories API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withPassCredentials(passCredentials)`](#fn-specwithpasscredentials) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`fn withUrl(url)`](#fn-specwithurl) + * [`obj spec.accessFrom`](#obj-specaccessfrom) + * [`fn withNamespaceSelectors(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectors) + * [`fn withNamespaceSelectorsMixin(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectorsmixin) + * [`obj spec.accessFrom.namespaceSelectors`](#obj-specaccessfromnamespaceselectors) + * [`fn withMatchLabels(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabelsmixin) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of HelmRepository + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"HelmRepositorySpec defines the reference to a Helm repository." + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"The interval at which to check the upstream for updates." + +### fn spec.withPassCredentials + +```ts +withPassCredentials(passCredentials) +``` + +"PassCredentials 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." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"This flag tells the controller to suspend the reconciliation of this source." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"The timeout of index downloading, defaults to 60s." + +### fn spec.withUrl + +```ts +withUrl(url) +``` + +"The Helm repository URL, a valid URL contains at least a protocol and host." + +## obj spec.accessFrom + +"AccessFrom defines an Access Control List for allowing cross-namespace references to this object." + +### fn spec.accessFrom.withNamespaceSelectors + +```ts +withNamespaceSelectors(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.withNamespaceSelectorsMixin + +```ts +withNamespaceSelectorsMixin(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +**Note:** This function appends passed data to existing values + +## obj spec.accessFrom.namespaceSelectors + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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." + +**Note:** This function appends passed data to existing values + +## obj spec.secretRef + +"The name of the secret containing authentication credentials for the Helm repository. For HTTP/S basic auth the secret must contain username and password fields. For TLS the secret must contain a certFile and keyFile, and/or caFile fields." + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/source/v1beta1/index.md b/docs/2.2.1/source/v1beta1/index.md new file mode 100644 index 0000000..d2108fb --- /dev/null +++ b/docs/2.2.1/source/v1beta1/index.md @@ -0,0 +1,12 @@ +--- +permalink: /2.2.1/source/v1beta1/ +--- + +# source.v1beta1 + + + +* [bucket](bucket.md) +* [gitRepository](gitRepository.md) +* [helmChart](helmChart.md) +* [helmRepository](helmRepository.md) \ No newline at end of file diff --git a/docs/2.2.1/source/v1beta2/bucket.md b/docs/2.2.1/source/v1beta2/bucket.md new file mode 100644 index 0000000..27c5f33 --- /dev/null +++ b/docs/2.2.1/source/v1beta2/bucket.md @@ -0,0 +1,364 @@ +--- +permalink: /2.2.1/source/v1beta2/bucket/ +--- + +# source.v1beta2.bucket + +"Bucket is the Schema for the buckets API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withBucketName(bucketName)`](#fn-specwithbucketname) + * [`fn withEndpoint(endpoint)`](#fn-specwithendpoint) + * [`fn withIgnore(ignore)`](#fn-specwithignore) + * [`fn withInsecure(insecure)`](#fn-specwithinsecure) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withPrefix(prefix)`](#fn-specwithprefix) + * [`fn withProvider(provider)`](#fn-specwithprovider) + * [`fn withRegion(region)`](#fn-specwithregion) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`obj spec.accessFrom`](#obj-specaccessfrom) + * [`fn withNamespaceSelectors(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectors) + * [`fn withNamespaceSelectorsMixin(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectorsmixin) + * [`obj spec.accessFrom.namespaceSelectors`](#obj-specaccessfromnamespaceselectors) + * [`fn withMatchLabels(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabelsmixin) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Bucket + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"BucketSpec specifies the required configuration to produce an Artifact for an object storage bucket." + +### fn spec.withBucketName + +```ts +withBucketName(bucketName) +``` + +"BucketName is the name of the object storage bucket." + +### fn spec.withEndpoint + +```ts +withEndpoint(endpoint) +``` + +"Endpoint is the object storage address the BucketName is located at." + +### fn spec.withIgnore + +```ts +withIgnore(ignore) +``` + +"Ignore 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." + +### fn spec.withInsecure + +```ts +withInsecure(insecure) +``` + +"Insecure allows connecting to a non-TLS HTTP Endpoint." + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval at which the Bucket Endpoint is checked for updates. This interval is approximate and may be subject to jitter to ensure efficient use of resources." + +### fn spec.withPrefix + +```ts +withPrefix(prefix) +``` + +"Prefix to use for server-side filtering of files in the Bucket." + +### fn spec.withProvider + +```ts +withProvider(provider) +``` + +"Provider of the object storage bucket. Defaults to 'generic', which expects an S3 (API) compatible object storage." + +### fn spec.withRegion + +```ts +withRegion(region) +``` + +"Region of the Endpoint where the BucketName is located in." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"Suspend tells the controller to suspend the reconciliation of this Bucket." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout for fetch operations, defaults to 60s." + +## obj spec.accessFrom + +"AccessFrom 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" + +### fn spec.accessFrom.withNamespaceSelectors + +```ts +withNamespaceSelectors(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.withNamespaceSelectorsMixin + +```ts +withNamespaceSelectorsMixin(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +**Note:** This function appends passed data to existing values + +## obj spec.accessFrom.namespaceSelectors + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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." + +**Note:** This function appends passed data to existing values + +## obj spec.secretRef + +"SecretRef specifies the Secret containing authentication credentials for the Bucket." + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/source/v1beta2/gitRepository.md b/docs/2.2.1/source/v1beta2/gitRepository.md new file mode 100644 index 0000000..13bf448 --- /dev/null +++ b/docs/2.2.1/source/v1beta2/gitRepository.md @@ -0,0 +1,472 @@ +--- +permalink: /2.2.1/source/v1beta2/gitRepository/ +--- + +# source.v1beta2.gitRepository + +"GitRepository is the Schema for the gitrepositories API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withGitImplementation(gitImplementation)`](#fn-specwithgitimplementation) + * [`fn withIgnore(ignore)`](#fn-specwithignore) + * [`fn withInclude(include)`](#fn-specwithinclude) + * [`fn withIncludeMixin(include)`](#fn-specwithincludemixin) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withRecurseSubmodules(recurseSubmodules)`](#fn-specwithrecursesubmodules) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`fn withUrl(url)`](#fn-specwithurl) + * [`obj spec.accessFrom`](#obj-specaccessfrom) + * [`fn withNamespaceSelectors(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectors) + * [`fn withNamespaceSelectorsMixin(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectorsmixin) + * [`obj spec.accessFrom.namespaceSelectors`](#obj-specaccessfromnamespaceselectors) + * [`fn withMatchLabels(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabelsmixin) + * [`obj spec.include`](#obj-specinclude) + * [`fn withFromPath(fromPath)`](#fn-specincludewithfrompath) + * [`fn withToPath(toPath)`](#fn-specincludewithtopath) + * [`obj spec.include.repository`](#obj-specincluderepository) + * [`fn withName(name)`](#fn-specincluderepositorywithname) + * [`obj spec.ref`](#obj-specref) + * [`fn withBranch(branch)`](#fn-specrefwithbranch) + * [`fn withCommit(commit)`](#fn-specrefwithcommit) + * [`fn withName(name)`](#fn-specrefwithname) + * [`fn withSemver(semver)`](#fn-specrefwithsemver) + * [`fn withTag(tag)`](#fn-specrefwithtag) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + * [`obj spec.verify`](#obj-specverify) + * [`fn withMode(mode)`](#fn-specverifywithmode) + * [`obj spec.verify.secretRef`](#obj-specverifysecretref) + * [`fn withName(name)`](#fn-specverifysecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of GitRepository + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"GitRepositorySpec specifies the required configuration to produce an Artifact for a Git repository." + +### fn spec.withGitImplementation + +```ts +withGitImplementation(gitImplementation) +``` + +"GitImplementation specifies which Git client library implementation to use. Defaults to 'go-git', valid values are ('go-git', 'libgit2'). Deprecated: gitImplementation is deprecated now that 'go-git' is the only supported implementation." + +### fn spec.withIgnore + +```ts +withIgnore(ignore) +``` + +"Ignore 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." + +### fn spec.withInclude + +```ts +withInclude(include) +``` + +"Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository." + +### fn spec.withIncludeMixin + +```ts +withIncludeMixin(include) +``` + +"Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository." + +**Note:** This function appends passed data to existing values + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval at which to check the GitRepository for updates." + +### fn spec.withRecurseSubmodules + +```ts +withRecurseSubmodules(recurseSubmodules) +``` + +"RecurseSubmodules enables the initialization of all submodules within the GitRepository as cloned from the URL, using their default settings." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"Suspend tells the controller to suspend the reconciliation of this GitRepository." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout for Git operations like cloning, defaults to 60s." + +### fn spec.withUrl + +```ts +withUrl(url) +``` + +"URL specifies the Git repository URL, it can be an HTTP/S or SSH address." + +## obj spec.accessFrom + +"AccessFrom 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" + +### fn spec.accessFrom.withNamespaceSelectors + +```ts +withNamespaceSelectors(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.withNamespaceSelectorsMixin + +```ts +withNamespaceSelectorsMixin(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +**Note:** This function appends passed data to existing values + +## obj spec.accessFrom.namespaceSelectors + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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." + +**Note:** This function appends passed data to existing values + +## obj spec.include + +"Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository." + +### fn spec.include.withFromPath + +```ts +withFromPath(fromPath) +``` + +"FromPath specifies the path to copy contents from, defaults to the root of the Artifact." + +### fn spec.include.withToPath + +```ts +withToPath(toPath) +``` + +"ToPath specifies the path to copy contents to, defaults to the name of the GitRepositoryRef." + +## obj spec.include.repository + +"GitRepositoryRef specifies the GitRepository which Artifact contents must be included." + +### fn spec.include.repository.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.ref + +"Reference specifies the Git reference to resolve and monitor for changes, defaults to the 'master' branch." + +### fn spec.ref.withBranch + +```ts +withBranch(branch) +``` + +"Branch to check out, defaults to 'master' if no other field is defined." + +### fn spec.ref.withCommit + +```ts +withCommit(commit) +``` + +"Commit SHA to check out, takes precedence over all reference fields. \n This can be combined with Branch to shallow clone the branch, in which the commit is expected to exist." + +### fn spec.ref.withName + +```ts +withName(name) +``` + +"Name of the reference to check out; takes precedence over Branch, Tag and SemVer. \n It must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description Examples: \"refs/heads/main\", \"refs/tags/v0.1.0\", \"refs/pull/420/head\", \"refs/merge-requests/1/head\ + +### fn spec.ref.withSemver + +```ts +withSemver(semver) +``` + +"SemVer tag expression to check out, takes precedence over Tag." + +### fn spec.ref.withTag + +```ts +withTag(tag) +``` + +"Tag to check out, takes precedence over Branch." + +## obj spec.secretRef + +"SecretRef specifies the Secret containing authentication credentials for the GitRepository. For HTTPS repositories the Secret must contain 'username' and 'password' fields for basic auth or 'bearerToken' field for token auth. For SSH repositories the Secret must contain 'identity' and 'known_hosts' fields." + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.verify + +"Verification specifies the configuration to verify the Git commit signature(s)." + +### fn spec.verify.withMode + +```ts +withMode(mode) +``` + +"Mode specifies what Git object should be verified, currently ('head')." + +## obj spec.verify.secretRef + +"SecretRef specifies the Secret containing the public keys of trusted Git authors." + +### fn spec.verify.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/source/v1beta2/helmChart.md b/docs/2.2.1/source/v1beta2/helmChart.md new file mode 100644 index 0000000..922ceeb --- /dev/null +++ b/docs/2.2.1/source/v1beta2/helmChart.md @@ -0,0 +1,437 @@ +--- +permalink: /2.2.1/source/v1beta2/helmChart/ +--- + +# source.v1beta2.helmChart + +"HelmChart is the Schema for the helmcharts API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withChart(chart)`](#fn-specwithchart) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withReconcileStrategy(reconcileStrategy)`](#fn-specwithreconcilestrategy) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withValuesFile(valuesFile)`](#fn-specwithvaluesfile) + * [`fn withValuesFiles(valuesFiles)`](#fn-specwithvaluesfiles) + * [`fn withValuesFilesMixin(valuesFiles)`](#fn-specwithvaluesfilesmixin) + * [`fn withVersion(version)`](#fn-specwithversion) + * [`obj spec.accessFrom`](#obj-specaccessfrom) + * [`fn withNamespaceSelectors(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectors) + * [`fn withNamespaceSelectorsMixin(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectorsmixin) + * [`obj spec.accessFrom.namespaceSelectors`](#obj-specaccessfromnamespaceselectors) + * [`fn withMatchLabels(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabelsmixin) + * [`obj spec.sourceRef`](#obj-specsourceref) + * [`fn withApiVersion(apiVersion)`](#fn-specsourcerefwithapiversion) + * [`fn withKind(kind)`](#fn-specsourcerefwithkind) + * [`fn withName(name)`](#fn-specsourcerefwithname) + * [`obj spec.verify`](#obj-specverify) + * [`fn withMatchOIDCIdentity(matchOIDCIdentity)`](#fn-specverifywithmatchoidcidentity) + * [`fn withMatchOIDCIdentityMixin(matchOIDCIdentity)`](#fn-specverifywithmatchoidcidentitymixin) + * [`fn withProvider(provider)`](#fn-specverifywithprovider) + * [`obj spec.verify.matchOIDCIdentity`](#obj-specverifymatchoidcidentity) + * [`fn withIssuer(issuer)`](#fn-specverifymatchoidcidentitywithissuer) + * [`fn withSubject(subject)`](#fn-specverifymatchoidcidentitywithsubject) + * [`obj spec.verify.secretRef`](#obj-specverifysecretref) + * [`fn withName(name)`](#fn-specverifysecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of HelmChart + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"HelmChartSpec specifies the desired state of a Helm chart." + +### fn spec.withChart + +```ts +withChart(chart) +``` + +"Chart is the name or path the Helm chart is available at in the SourceRef." + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval at which the HelmChart SourceRef is checked for updates. This interval is approximate and may be subject to jitter to ensure efficient use of resources." + +### fn spec.withReconcileStrategy + +```ts +withReconcileStrategy(reconcileStrategy) +``` + +"ReconcileStrategy determines what enables the creation of a new artifact. Valid values are ('ChartVersion', 'Revision'). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"Suspend tells the controller to suspend the reconciliation of this source." + +### fn spec.withValuesFile + +```ts +withValuesFile(valuesFile) +``` + +"ValuesFile is an alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Deprecated in favor of ValuesFiles, for backwards compatibility the file specified here is merged before the ValuesFiles items. Ignored when omitted." + +### fn spec.withValuesFiles + +```ts +withValuesFiles(valuesFiles) +``` + +"ValuesFiles is an alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted." + +### fn spec.withValuesFilesMixin + +```ts +withValuesFilesMixin(valuesFiles) +``` + +"ValuesFiles is an alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted." + +**Note:** This function appends passed data to existing values + +### fn spec.withVersion + +```ts +withVersion(version) +``` + +"Version is the chart version semver expression, ignored for charts from GitRepository and Bucket sources. Defaults to latest when omitted." + +## obj spec.accessFrom + +"AccessFrom 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" + +### fn spec.accessFrom.withNamespaceSelectors + +```ts +withNamespaceSelectors(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.withNamespaceSelectorsMixin + +```ts +withNamespaceSelectorsMixin(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +**Note:** This function appends passed data to existing values + +## obj spec.accessFrom.namespaceSelectors + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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." + +**Note:** This function appends passed data to existing values + +## obj spec.sourceRef + +"SourceRef is the reference to the Source the chart is available at." + +### fn spec.sourceRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"APIVersion of the referent." + +### fn spec.sourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind of the referent, valid values are ('HelmRepository', 'GitRepository', 'Bucket')." + +### fn spec.sourceRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.verify + +"Verify 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. This field is only supported when using HelmRepository source with spec.type 'oci'. Chart dependencies, which are not bundled in the umbrella chart artifact, are not verified." + +### fn spec.verify.withMatchOIDCIdentity + +```ts +withMatchOIDCIdentity(matchOIDCIdentity) +``` + +"MatchOIDCIdentity 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." + +### fn spec.verify.withMatchOIDCIdentityMixin + +```ts +withMatchOIDCIdentityMixin(matchOIDCIdentity) +``` + +"MatchOIDCIdentity 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." + +**Note:** This function appends passed data to existing values + +### fn spec.verify.withProvider + +```ts +withProvider(provider) +``` + +"Provider specifies the technology used to sign the OCI Artifact." + +## obj spec.verify.matchOIDCIdentity + +"MatchOIDCIdentity 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." + +### fn spec.verify.matchOIDCIdentity.withIssuer + +```ts +withIssuer(issuer) +``` + +"Issuer 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." + +### fn spec.verify.matchOIDCIdentity.withSubject + +```ts +withSubject(subject) +``` + +"Subject 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." + +## obj spec.verify.secretRef + +"SecretRef specifies the Kubernetes Secret containing the trusted public keys." + +### fn spec.verify.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/source/v1beta2/helmRepository.md b/docs/2.2.1/source/v1beta2/helmRepository.md new file mode 100644 index 0000000..f7e7f2d --- /dev/null +++ b/docs/2.2.1/source/v1beta2/helmRepository.md @@ -0,0 +1,360 @@ +--- +permalink: /2.2.1/source/v1beta2/helmRepository/ +--- + +# source.v1beta2.helmRepository + +"HelmRepository is the Schema for the helmrepositories API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withInsecure(insecure)`](#fn-specwithinsecure) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withPassCredentials(passCredentials)`](#fn-specwithpasscredentials) + * [`fn withProvider(provider)`](#fn-specwithprovider) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`fn withType(type)`](#fn-specwithtype) + * [`fn withUrl(url)`](#fn-specwithurl) + * [`obj spec.accessFrom`](#obj-specaccessfrom) + * [`fn withNamespaceSelectors(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectors) + * [`fn withNamespaceSelectorsMixin(namespaceSelectors)`](#fn-specaccessfromwithnamespaceselectorsmixin) + * [`obj spec.accessFrom.namespaceSelectors`](#obj-specaccessfromnamespaceselectors) + * [`fn withMatchLabels(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaccessfromnamespaceselectorswithmatchlabelsmixin) + * [`obj spec.certSecretRef`](#obj-speccertsecretref) + * [`fn withName(name)`](#fn-speccertsecretrefwithname) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of HelmRepository + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"HelmRepositorySpec specifies the required configuration to produce an Artifact for a Helm repository index YAML." + +### fn spec.withInsecure + +```ts +withInsecure(insecure) +``` + +"Insecure 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'." + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval 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." + +### fn spec.withPassCredentials + +```ts +withPassCredentials(passCredentials) +``` + +"PassCredentials 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." + +### fn spec.withProvider + +```ts +withProvider(provider) +``` + +"Provider 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'." + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"Suspend tells the controller to suspend the reconciliation of this HelmRepository." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout 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." + +### fn spec.withType + +```ts +withType(type) +``` + +"Type of the HelmRepository. When this field is set to \"oci\", the URL field value must be prefixed with \"oci://\"." + +### fn spec.withUrl + +```ts +withUrl(url) +``` + +"URL of the Helm repository, a valid URL contains at least a protocol and host." + +## obj spec.accessFrom + +"AccessFrom 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" + +### fn spec.accessFrom.withNamespaceSelectors + +```ts +withNamespaceSelectors(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.withNamespaceSelectorsMixin + +```ts +withNamespaceSelectorsMixin(namespaceSelectors) +``` + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +**Note:** This function appends passed data to existing values + +## obj spec.accessFrom.namespaceSelectors + +"NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"MatchLabels 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." + +### fn spec.accessFrom.namespaceSelectors.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"MatchLabels 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." + +**Note:** This function appends passed data to existing values + +## obj spec.certSecretRef + +"CertSecretRef can be given the name of a Secret containing either or both of \n - a PEM-encoded client certificate (`tls.crt`) and private key (`tls.key`); - a PEM-encoded CA certificate (`ca.crt`) \n 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`. \n It takes precedence over the values specified in the Secret referred to by `.spec.secretRef`." + +### fn spec.certSecretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.secretRef + +"SecretRef 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." + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/2.2.1/source/v1beta2/index.md b/docs/2.2.1/source/v1beta2/index.md new file mode 100644 index 0000000..7272472 --- /dev/null +++ b/docs/2.2.1/source/v1beta2/index.md @@ -0,0 +1,13 @@ +--- +permalink: /2.2.1/source/v1beta2/ +--- + +# source.v1beta2 + + + +* [bucket](bucket.md) +* [gitRepository](gitRepository.md) +* [helmChart](helmChart.md) +* [helmRepository](helmRepository.md) +* [ociRepository](ociRepository.md) \ No newline at end of file diff --git a/docs/2.2.1/source/v1beta2/ociRepository.md b/docs/2.2.1/source/v1beta2/ociRepository.md new file mode 100644 index 0000000..8794641 --- /dev/null +++ b/docs/2.2.1/source/v1beta2/ociRepository.md @@ -0,0 +1,436 @@ +--- +permalink: /2.2.1/source/v1beta2/ociRepository/ +--- + +# source.v1beta2.ociRepository + +"OCIRepository is the Schema for the ocirepositories API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withIgnore(ignore)`](#fn-specwithignore) + * [`fn withInsecure(insecure)`](#fn-specwithinsecure) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withProvider(provider)`](#fn-specwithprovider) + * [`fn withServiceAccountName(serviceAccountName)`](#fn-specwithserviceaccountname) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`fn withUrl(url)`](#fn-specwithurl) + * [`obj spec.certSecretRef`](#obj-speccertsecretref) + * [`fn withName(name)`](#fn-speccertsecretrefwithname) + * [`obj spec.layerSelector`](#obj-speclayerselector) + * [`fn withMediaType(mediaType)`](#fn-speclayerselectorwithmediatype) + * [`fn withOperation(operation)`](#fn-speclayerselectorwithoperation) + * [`obj spec.ref`](#obj-specref) + * [`fn withDigest(digest)`](#fn-specrefwithdigest) + * [`fn withSemver(semver)`](#fn-specrefwithsemver) + * [`fn withTag(tag)`](#fn-specrefwithtag) + * [`obj spec.secretRef`](#obj-specsecretref) + * [`fn withName(name)`](#fn-specsecretrefwithname) + * [`obj spec.verify`](#obj-specverify) + * [`fn withMatchOIDCIdentity(matchOIDCIdentity)`](#fn-specverifywithmatchoidcidentity) + * [`fn withMatchOIDCIdentityMixin(matchOIDCIdentity)`](#fn-specverifywithmatchoidcidentitymixin) + * [`fn withProvider(provider)`](#fn-specverifywithprovider) + * [`obj spec.verify.matchOIDCIdentity`](#obj-specverifymatchoidcidentity) + * [`fn withIssuer(issuer)`](#fn-specverifymatchoidcidentitywithissuer) + * [`fn withSubject(subject)`](#fn-specverifymatchoidcidentitywithsubject) + * [`obj spec.verify.secretRef`](#obj-specverifysecretref) + * [`fn withName(name)`](#fn-specverifysecretrefwithname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of OCIRepository + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"OCIRepositorySpec defines the desired state of OCIRepository" + +### fn spec.withIgnore + +```ts +withIgnore(ignore) +``` + +"Ignore 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." + +### fn spec.withInsecure + +```ts +withInsecure(insecure) +``` + +"Insecure allows connecting to a non-TLS HTTP container registry." + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval 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." + +### fn spec.withProvider + +```ts +withProvider(provider) +``` + +"The provider used for authentication, can be 'aws', 'azure', 'gcp' or 'generic'. When not specified, defaults to 'generic'." + +### fn spec.withServiceAccountName + +```ts +withServiceAccountName(serviceAccountName) +``` + +"ServiceAccountName 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" + +### fn spec.withSuspend + +```ts +withSuspend(suspend) +``` + +"This flag tells the controller to suspend the reconciliation of this source." + +### fn spec.withTimeout + +```ts +withTimeout(timeout) +``` + +"The timeout for remote OCI Repository operations like pulling, defaults to 60s." + +### fn spec.withUrl + +```ts +withUrl(url) +``` + +"URL is a reference to an OCI artifact repository hosted on a remote container registry." + +## obj spec.certSecretRef + +"CertSecretRef can be given the name of a Secret containing either or both of \n - a PEM-encoded client certificate (`tls.crt`) and private key (`tls.key`); - a PEM-encoded CA certificate (`ca.crt`) \n 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`. \n Note: Support for the `caFile`, `certFile` and `keyFile` keys have been deprecated." + +### fn spec.certSecretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.layerSelector + +"LayerSelector specifies which layer should be extracted from the OCI artifact. When not specified, the first layer found in the artifact is selected." + +### fn spec.layerSelector.withMediaType + +```ts +withMediaType(mediaType) +``` + +"MediaType specifies the OCI media type of the layer which should be extracted from the OCI Artifact. The first layer matching this type is selected." + +### fn spec.layerSelector.withOperation + +```ts +withOperation(operation) +``` + +"Operation 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." + +## obj spec.ref + +"The OCI reference to pull and monitor for changes, defaults to the latest tag." + +### fn spec.ref.withDigest + +```ts +withDigest(digest) +``` + +"Digest is the image digest to pull, takes precedence over SemVer. The value should be in the format 'sha256:'." + +### fn spec.ref.withSemver + +```ts +withSemver(semver) +``` + +"SemVer is the range of tags to pull selecting the latest within the range, takes precedence over Tag." + +### fn spec.ref.withTag + +```ts +withTag(tag) +``` + +"Tag is the image tag to pull, defaults to latest." + +## obj spec.secretRef + +"SecretRef contains the secret name containing the registry login credentials to resolve image metadata. The secret must be of type kubernetes.io/dockerconfigjson." + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." + +## obj spec.verify + +"Verify 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." + +### fn spec.verify.withMatchOIDCIdentity + +```ts +withMatchOIDCIdentity(matchOIDCIdentity) +``` + +"MatchOIDCIdentity 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." + +### fn spec.verify.withMatchOIDCIdentityMixin + +```ts +withMatchOIDCIdentityMixin(matchOIDCIdentity) +``` + +"MatchOIDCIdentity 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." + +**Note:** This function appends passed data to existing values + +### fn spec.verify.withProvider + +```ts +withProvider(provider) +``` + +"Provider specifies the technology used to sign the OCI Artifact." + +## obj spec.verify.matchOIDCIdentity + +"MatchOIDCIdentity 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." + +### fn spec.verify.matchOIDCIdentity.withIssuer + +```ts +withIssuer(issuer) +``` + +"Issuer 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." + +### fn spec.verify.matchOIDCIdentity.withSubject + +```ts +withSubject(subject) +``` + +"Subject 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." + +## obj spec.verify.secretRef + +"SecretRef specifies the Kubernetes Secret containing the trusted public keys." + +### fn spec.verify.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent." \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index de6302b..c38a6ca 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,6 +2,7 @@ This library is generated with [`k8s`](https://github.com/jsonnet-libs/k8s). +- [2.2.1](2.2.1/README.md) - [2.0.1](2.0.1/README.md) - [0.30.2](0.30.2/README.md) - [0.31.1](0.31.1/README.md)