diff --git a/0.24.1/_gen/helm/main.libsonnet b/0.24.1/_gen/helm/main.libsonnet new file mode 100644 index 00000000..6724aab4 --- /dev/null +++ b/0.24.1/_gen/helm/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='helm', url='', help=''), + v2beta1: (import 'v2beta1/main.libsonnet'), +} diff --git a/0.24.1/_gen/helm/v2beta1/helmRelease.libsonnet b/0.24.1/_gen/helm/v2beta1/helmRelease.libsonnet new file mode 100644 index 00000000..4f336b25 --- /dev/null +++ b/0.24.1/_gen/helm/v2beta1/helmRelease.libsonnet @@ -0,0 +1,225 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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 v1beta1.HelmChart that should be created for this HelmRelease."'), + chart: { + '#spec':: d.obj(help='"Spec holds the template for the v1beta1.HelmChartSpec for this HelmRelease."'), + spec: { + '#sourceRef':: d.obj(help='"The name and namespace of the v1beta1.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 } } } } }, + }, + '#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 v1beta1.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 v1beta1.GitRepository and v1beta1.Bucket sources. Defaults to latest when omitted."', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { spec+: { chart+: { spec+: { version: version } } } }, + }, + }, + '#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 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 HelmRelease. 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 HelmRelease.\""), + 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 } } } }, + }, + }, + '#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: { + '#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 } } }, + '#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 } } }, + }, + '#withDependsOn':: d.fn(help='"DependsOn may contain a dependency.CrossNamespaceDependencyReference 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 dependency.CrossNamespaceDependencyReference 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 '10'.\"", args=[d.arg(name='maxHistory', type=d.T.integer)]), + withMaxHistory(maxHistory): { spec+: { maxHistory: maxHistory } }, + '#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/0.24.1/_gen/helm/v2beta1/main.libsonnet b/0.24.1/_gen/helm/v2beta1/main.libsonnet new file mode 100644 index 00000000..9782e049 --- /dev/null +++ b/0.24.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/0.24.1/_gen/image/main.libsonnet b/0.24.1/_gen/image/main.libsonnet new file mode 100644 index 00000000..8e970f59 --- /dev/null +++ b/0.24.1/_gen/image/main.libsonnet @@ -0,0 +1,7 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='image', url='', help=''), + v1alpha1: (import 'v1alpha1/main.libsonnet'), + v1alpha2: (import 'v1alpha2/main.libsonnet'), + v1beta1: (import 'v1beta1/main.libsonnet'), +} diff --git a/0.24.1/_gen/image/v1alpha1/imagePolicy.libsonnet b/0.24.1/_gen/image/v1alpha1/imagePolicy.libsonnet new file mode 100644 index 00000000..898afba3 --- /dev/null +++ b/0.24.1/_gen/image/v1alpha1/imagePolicy.libsonnet @@ -0,0 +1,89 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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/v1alpha1', + 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 } } }, + }, + '#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/0.24.1/_gen/image/v1alpha1/imageRepository.libsonnet b/0.24.1/_gen/image/v1alpha1/imageRepository.libsonnet new file mode 100644 index 00000000..e95d6d0e --- /dev/null +++ b/0.24.1/_gen/image/v1alpha1/imageRepository.libsonnet @@ -0,0 +1,77 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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/v1alpha1', + 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: { + '#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 } } }, + }, + '#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 } }, + '#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/0.24.1/_gen/image/v1alpha1/imageUpdateAutomation.libsonnet b/0.24.1/_gen/image/v1alpha1/imageUpdateAutomation.libsonnet new file mode 100644 index 00000000..e9ee7f79 --- /dev/null +++ b/0.24.1/_gen/image/v1alpha1/imageUpdateAutomation.libsonnet @@ -0,0 +1,102 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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/v1alpha1', + kind: 'ImageUpdateAutomation', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ImageUpdateAutomationSpec defines the desired state of ImageUpdateAutomation"'), + spec: { + '#checkout':: d.obj(help='"Checkout gives the parameters for cloning the git repository, ready to make changes."'), + checkout: { + '#gitRepositoryRef':: d.obj(help='"GitRepositoryRef refers to the resource giving access details to a git repository to update files in."'), + gitRepositoryRef: { + '#withName':: d.fn(help='"Name of the referent"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { checkout+: { gitRepositoryRef+: { name: name } } } }, + }, + '#withBranch':: d.fn(help='"Branch gives the branch to clone from the git repository. If `.spec.push` is not supplied, commits will also be pushed to this branch."', args=[d.arg(name='branch', type=d.T.string)]), + withBranch(branch): { spec+: { checkout+: { branch: branch } } }, + }, + '#commit':: d.obj(help='"Commit specifies how to commit to the git repository."'), + commit: { + '#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+: { commit+: { signingKey+: { secretRef+: { name: name } } } } }, + }, + }, + '#withAuthorEmail':: d.fn(help='"AuthorEmail gives the email to provide when making a commit"', args=[d.arg(name='authorEmail', type=d.T.string)]), + withAuthorEmail(authorEmail): { spec+: { commit+: { authorEmail: authorEmail } } }, + '#withAuthorName':: d.fn(help='"AuthorName gives the name to provide when making a commit"', args=[d.arg(name='authorName', type=d.T.string)]), + withAuthorName(authorName): { spec+: { commit+: { authorName: authorName } } }, + '#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+: { 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`."'), + 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+: { push+: { branch: branch } } }, + }, + '#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/0.24.1/_gen/image/v1alpha1/main.libsonnet b/0.24.1/_gen/image/v1alpha1/main.libsonnet new file mode 100644 index 00000000..4f741721 --- /dev/null +++ b/0.24.1/_gen/image/v1alpha1/main.libsonnet @@ -0,0 +1,7 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1alpha1', url='', help=''), + imagePolicy: (import 'imagePolicy.libsonnet'), + imageRepository: (import 'imageRepository.libsonnet'), + imageUpdateAutomation: (import 'imageUpdateAutomation.libsonnet'), +} diff --git a/0.24.1/_gen/image/v1alpha2/imagePolicy.libsonnet b/0.24.1/_gen/image/v1alpha2/imagePolicy.libsonnet new file mode 100644 index 00000000..b5254fe5 --- /dev/null +++ b/0.24.1/_gen/image/v1alpha2/imagePolicy.libsonnet @@ -0,0 +1,89 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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/v1alpha2', + 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 } } }, + }, + '#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/0.24.1/_gen/image/v1alpha2/imageRepository.libsonnet b/0.24.1/_gen/image/v1alpha2/imageRepository.libsonnet new file mode 100644 index 00000000..6f9841f3 --- /dev/null +++ b/0.24.1/_gen/image/v1alpha2/imageRepository.libsonnet @@ -0,0 +1,77 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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/v1alpha2', + 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: { + '#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 } } }, + }, + '#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 } }, + '#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/0.24.1/_gen/image/v1alpha2/imageUpdateAutomation.libsonnet b/0.24.1/_gen/image/v1alpha2/imageUpdateAutomation.libsonnet new file mode 100644 index 00000000..317c82a5 --- /dev/null +++ b/0.24.1/_gen/image/v1alpha2/imageUpdateAutomation.libsonnet @@ -0,0 +1,121 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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/v1alpha2', + 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='"The Git branch to checkout, defaults to master."', args=[d.arg(name='branch', type=d.T.string)]), + withBranch(branch): { spec+: { git+: { checkout+: { 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+: { git+: { checkout+: { 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+: { git+: { checkout+: { 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+: { 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 } } } }, + }, + }, + '#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 } } }, + }, + '#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/0.24.1/_gen/image/v1alpha2/main.libsonnet b/0.24.1/_gen/image/v1alpha2/main.libsonnet new file mode 100644 index 00000000..d3472eeb --- /dev/null +++ b/0.24.1/_gen/image/v1alpha2/main.libsonnet @@ -0,0 +1,7 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1alpha2', url='', help=''), + imagePolicy: (import 'imagePolicy.libsonnet'), + imageRepository: (import 'imageRepository.libsonnet'), + imageUpdateAutomation: (import 'imageUpdateAutomation.libsonnet'), +} diff --git a/0.24.1/_gen/image/v1beta1/imagePolicy.libsonnet b/0.24.1/_gen/image/v1beta1/imagePolicy.libsonnet new file mode 100644 index 00000000..f004e606 --- /dev/null +++ b/0.24.1/_gen/image/v1beta1/imagePolicy.libsonnet @@ -0,0 +1,91 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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/0.24.1/_gen/image/v1beta1/imageRepository.libsonnet b/0.24.1/_gen/image/v1beta1/imageRepository.libsonnet new file mode 100644 index 00000000..0e244257 --- /dev/null +++ b/0.24.1/_gen/image/v1beta1/imageRepository.libsonnet @@ -0,0 +1,84 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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: { + '#withNamespaceSelectors':: d.fn(help='', 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='\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 } } }, + }, + '#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 } }, + '#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/0.24.1/_gen/image/v1beta1/imageUpdateAutomation.libsonnet b/0.24.1/_gen/image/v1beta1/imageUpdateAutomation.libsonnet new file mode 100644 index 00000000..253a54e1 --- /dev/null +++ b/0.24.1/_gen/image/v1beta1/imageUpdateAutomation.libsonnet @@ -0,0 +1,121 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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='"The Git branch to checkout, defaults to master."', args=[d.arg(name='branch', type=d.T.string)]), + withBranch(branch): { spec+: { git+: { checkout+: { 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+: { git+: { checkout+: { 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+: { git+: { checkout+: { 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+: { 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 } } } }, + }, + }, + '#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 } } }, + }, + '#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/0.24.1/_gen/image/v1beta1/main.libsonnet b/0.24.1/_gen/image/v1beta1/main.libsonnet new file mode 100644 index 00000000..7caa9896 --- /dev/null +++ b/0.24.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/0.24.1/_gen/kustomize/main.libsonnet b/0.24.1/_gen/kustomize/main.libsonnet new file mode 100644 index 00000000..3787309f --- /dev/null +++ b/0.24.1/_gen/kustomize/main.libsonnet @@ -0,0 +1,6 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='kustomize', url='', help=''), + v1beta1: (import 'v1beta1/main.libsonnet'), + v1beta2: (import 'v1beta2/main.libsonnet'), +} diff --git a/0.24.1/_gen/kustomize/v1beta1/kustomization.libsonnet b/0.24.1/_gen/kustomize/v1beta1/kustomization.libsonnet new file mode 100644 index 00000000..fb409566 --- /dev/null +++ b/0.24.1/_gen/kustomize/v1beta1/kustomization.libsonnet @@ -0,0 +1,143 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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 } } }, + }, + '#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 } } } }, + }, + }, + '#postBuild':: d.obj(help='"PostBuild describes which actions to perform on the YAML manifest generated by building the kustomize overlay."'), + postBuild: { + '#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 dependency.CrossNamespaceDependencyReference 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 dependency.CrossNamespaceDependencyReference 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/0.24.1/_gen/kustomize/v1beta1/main.libsonnet b/0.24.1/_gen/kustomize/v1beta1/main.libsonnet new file mode 100644 index 00000000..2ac5dc5e --- /dev/null +++ b/0.24.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/0.24.1/_gen/kustomize/v1beta2/kustomization.libsonnet b/0.24.1/_gen/kustomize/v1beta2/kustomization.libsonnet new file mode 100644 index 00000000..7c83740a --- /dev/null +++ b/0.24.1/_gen/kustomize/v1beta2/kustomization.libsonnet @@ -0,0 +1,145 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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: { + '#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 } } }, + }, + '#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 } } } }, + }, + }, + '#postBuild':: d.obj(help='"PostBuild describes which actions to perform on the YAML manifest generated by building the kustomize overlay."'), + postBuild: { + '#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 } } }, + }, + '#withDependsOn':: d.fn(help='"DependsOn may contain a dependency.CrossNamespaceDependencyReference 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 dependency.CrossNamespaceDependencyReference 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/0.24.1/_gen/kustomize/v1beta2/main.libsonnet b/0.24.1/_gen/kustomize/v1beta2/main.libsonnet new file mode 100644 index 00000000..1c3848b2 --- /dev/null +++ b/0.24.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/0.24.1/_gen/notification/main.libsonnet b/0.24.1/_gen/notification/main.libsonnet new file mode 100644 index 00000000..6579e1b7 --- /dev/null +++ b/0.24.1/_gen/notification/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='notification', url='', help=''), + v1beta1: (import 'v1beta1/main.libsonnet'), +} diff --git a/0.24.1/_gen/notification/v1beta1/alert.libsonnet b/0.24.1/_gen/notification/v1beta1/alert.libsonnet new file mode 100644 index 00000000..e7aea47e --- /dev/null +++ b/0.24.1/_gen/notification/v1beta1/alert.libsonnet @@ -0,0 +1,78 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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: { + '#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/0.24.1/_gen/notification/v1beta1/main.libsonnet b/0.24.1/_gen/notification/v1beta1/main.libsonnet new file mode 100644 index 00000000..8dcb983a --- /dev/null +++ b/0.24.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/0.24.1/_gen/notification/v1beta1/provider.libsonnet b/0.24.1/_gen/notification/v1beta1/provider.libsonnet new file mode 100644 index 00000000..36a75f2d --- /dev/null +++ b/0.24.1/_gen/notification/v1beta1/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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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 } }, + '#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/0.24.1/_gen/notification/v1beta1/receiver.libsonnet b/0.24.1/_gen/notification/v1beta1/receiver.libsonnet new file mode 100644 index 00000000..0ac5153f --- /dev/null +++ b/0.24.1/_gen/notification/v1beta1/receiver.libsonnet @@ -0,0 +1,76 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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: { + '#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/0.24.1/_gen/source/main.libsonnet b/0.24.1/_gen/source/main.libsonnet new file mode 100644 index 00000000..f2b31b47 --- /dev/null +++ b/0.24.1/_gen/source/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='source', url='', help=''), + v1beta1: (import 'v1beta1/main.libsonnet'), +} diff --git a/0.24.1/_gen/source/v1beta1/bucket.libsonnet b/0.24.1/_gen/source/v1beta1/bucket.libsonnet new file mode 100644 index 00000000..2526f19d --- /dev/null +++ b/0.24.1/_gen/source/v1beta1/bucket.libsonnet @@ -0,0 +1,89 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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: { + '#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 20s."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { timeout: timeout } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.24.1/_gen/source/v1beta1/gitRepository.libsonnet b/0.24.1/_gen/source/v1beta1/gitRepository.libsonnet new file mode 100644 index 00000000..69d1f47b --- /dev/null +++ b/0.24.1/_gen/source/v1beta1/gitRepository.libsonnet @@ -0,0 +1,110 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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: { + '#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] } } }, + }, + '#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, identity.pub 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 20s."', 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/0.24.1/_gen/source/v1beta1/helmChart.libsonnet b/0.24.1/_gen/source/v1beta1/helmChart.libsonnet new file mode 100644 index 00000000..ac61c2ec --- /dev/null +++ b/0.24.1/_gen/source/v1beta1/helmChart.libsonnet @@ -0,0 +1,91 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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: { + '#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/0.24.1/_gen/source/v1beta1/helmRepository.libsonnet b/0.24.1/_gen/source/v1beta1/helmRepository.libsonnet new file mode 100644 index 00000000..49bb54fa --- /dev/null +++ b/0.24.1/_gen/source/v1beta1/helmRepository.libsonnet @@ -0,0 +1,81 @@ +{ + 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 } }, + '#withManagedFields':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFields(managedFields): { metadata+: { managedFields: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#withManagedFieldsMixin':: d.fn(help="\"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \\\"ci-cd\\\". The set of fields is always in the version that the workflow used when modifying the object.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='managedFields', type=d.T.array)]), + withManagedFieldsMixin(managedFields): { metadata+: { managedFields+: if std.isArray(v=managedFields) then managedFields else [managedFields] } }, + '#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: { + '#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 caCert 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/0.24.1/_gen/source/v1beta1/main.libsonnet b/0.24.1/_gen/source/v1beta1/main.libsonnet new file mode 100644 index 00000000..e064f75a --- /dev/null +++ b/0.24.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/0.24.1/gen.libsonnet b/0.24.1/gen.libsonnet new file mode 100644 index 00000000..2a5c489e --- /dev/null +++ b/0.24.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/0.24.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/0.24.1/main.libsonnet b/0.24.1/main.libsonnet new file mode 100644 index 00000000..f5597a50 --- /dev/null +++ b/0.24.1/main.libsonnet @@ -0,0 +1 @@ +(import 'gen.libsonnet') diff --git a/docs/0.24.1/README.md b/docs/0.24.1/README.md new file mode 100644 index 00000000..b2ae03d4 --- /dev/null +++ b/docs/0.24.1/README.md @@ -0,0 +1,17 @@ +--- +permalink: /0.24.1/ +--- + +# fluxcd + +```jsonnet +local fluxcd = import "github.com/jsonnet-libs/fluxcd-libsonnet/0.24.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/0.24.1/helm/index.md b/docs/0.24.1/helm/index.md new file mode 100644 index 00000000..1dbc4379 --- /dev/null +++ b/docs/0.24.1/helm/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.24.1/helm/ +--- + +# helm + + + +* [v2beta1](v2beta1/index.md) \ No newline at end of file diff --git a/docs/0.24.1/helm/v2beta1/helmRelease.md b/docs/0.24.1/helm/v2beta1/helmRelease.md new file mode 100644 index 00000000..a8abe8e1 --- /dev/null +++ b/docs/0.24.1/helm/v2beta1/helmRelease.md @@ -0,0 +1,883 @@ +--- +permalink: /0.24.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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 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.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.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 withName(name)`](#fn-speckubeconfigsecretrefwithname) + * [`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 withDisableHooks(disableHooks)`](#fn-specuninstallwithdisablehooks) + * [`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) + +## 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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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 dependency.CrossNamespaceDependencyReference 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 dependency.CrossNamespaceDependencyReference 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 '10'." + +### 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 v1beta1.HelmChart that should be created for this HelmRelease." + +## obj spec.chart.spec + +"Spec holds the template for the v1beta1.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 v1beta1.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 v1beta1.GitRepository and v1beta1.Bucket sources. Defaults to latest when omitted." + +## obj spec.chart.spec.sourceRef + +"The name and namespace of the v1beta1.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.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 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 HelmRelease. 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 HelmRelease." + +### fn spec.kubeConfig.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent" + +## 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.withDisableHooks + +```ts +withDisableHooks(disableHooks) +``` + +"DisableHooks prevents hooks from running during the Helm rollback action." + +### 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'." \ No newline at end of file diff --git a/docs/0.24.1/helm/v2beta1/index.md b/docs/0.24.1/helm/v2beta1/index.md new file mode 100644 index 00000000..5b795e63 --- /dev/null +++ b/docs/0.24.1/helm/v2beta1/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.24.1/helm/v2beta1/ +--- + +# helm.v2beta1 + + + +* [helmRelease](helmRelease.md) \ No newline at end of file diff --git a/docs/0.24.1/image/index.md b/docs/0.24.1/image/index.md new file mode 100644 index 00000000..3ffcd809 --- /dev/null +++ b/docs/0.24.1/image/index.md @@ -0,0 +1,11 @@ +--- +permalink: /0.24.1/image/ +--- + +# image + + + +* [v1alpha1](v1alpha1/index.md) +* [v1alpha2](v1alpha2/index.md) +* [v1beta1](v1beta1/index.md) \ No newline at end of file diff --git a/docs/0.24.1/image/v1alpha1/imagePolicy.md b/docs/0.24.1/image/v1alpha1/imagePolicy.md new file mode 100644 index 00000000..900c2d18 --- /dev/null +++ b/docs/0.24.1/image/v1alpha1/imagePolicy.md @@ -0,0 +1,314 @@ +--- +permalink: /0.24.1/image/v1alpha1/imagePolicy/ +--- + +# image.v1alpha1.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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) + * [`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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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" + +## 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/0.24.1/image/v1alpha1/imageRepository.md b/docs/0.24.1/image/v1alpha1/imageRepository.md new file mode 100644 index 00000000..ea15ae83 --- /dev/null +++ b/docs/0.24.1/image/v1alpha1/imageRepository.md @@ -0,0 +1,294 @@ +--- +permalink: /0.24.1/image/v1alpha1/imageRepository/ +--- + +# image.v1alpha1.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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 withImage(image)`](#fn-specwithimage) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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.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.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.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/0.24.1/image/v1alpha1/imageUpdateAutomation.md b/docs/0.24.1/image/v1alpha1/imageUpdateAutomation.md new file mode 100644 index 00000000..2b4bf463 --- /dev/null +++ b/docs/0.24.1/image/v1alpha1/imageUpdateAutomation.md @@ -0,0 +1,364 @@ +--- +permalink: /0.24.1/image/v1alpha1/imageUpdateAutomation/ +--- + +# image.v1alpha1.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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.checkout`](#obj-speccheckout) + * [`fn withBranch(branch)`](#fn-speccheckoutwithbranch) + * [`obj spec.checkout.gitRepositoryRef`](#obj-speccheckoutgitrepositoryref) + * [`fn withName(name)`](#fn-speccheckoutgitrepositoryrefwithname) + * [`obj spec.commit`](#obj-speccommit) + * [`fn withAuthorEmail(authorEmail)`](#fn-speccommitwithauthoremail) + * [`fn withAuthorName(authorName)`](#fn-speccommitwithauthorname) + * [`fn withMessageTemplate(messageTemplate)`](#fn-speccommitwithmessagetemplate) + * [`obj spec.commit.signingKey`](#obj-speccommitsigningkey) + * [`obj spec.commit.signingKey.secretRef`](#obj-speccommitsigningkeysecretref) + * [`fn withName(name)`](#fn-speccommitsigningkeysecretrefwithname) + * [`obj spec.push`](#obj-specpush) + * [`fn withBranch(branch)`](#fn-specpushwithbranch) + * [`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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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.checkout + +"Checkout gives the parameters for cloning the git repository, ready to make changes." + +### fn spec.checkout.withBranch + +```ts +withBranch(branch) +``` + +"Branch gives the branch to clone from the git repository. If `.spec.push` is not supplied, commits will also be pushed to this branch." + +## obj spec.checkout.gitRepositoryRef + +"GitRepositoryRef refers to the resource giving access details to a git repository to update files in." + +### fn spec.checkout.gitRepositoryRef.withName + +```ts +withName(name) +``` + +"Name of the referent" + +## obj spec.commit + +"Commit specifies how to commit to the git repository." + +### fn spec.commit.withAuthorEmail + +```ts +withAuthorEmail(authorEmail) +``` + +"AuthorEmail gives the email to provide when making a commit" + +### fn spec.commit.withAuthorName + +```ts +withAuthorName(authorName) +``` + +"AuthorName gives the name to provide when making a commit" + +### fn spec.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.commit.signingKey + +"SigningKey provides the option to sign commits with a GPG key" + +## obj spec.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.commit.signingKey.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent" + +## obj spec.push + +"Push specifies how and where to push commits made by the automation. If missing, commits are pushed (back) to `.spec.checkout.branch`." + +### fn spec.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." + +## 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/0.24.1/image/v1alpha1/index.md b/docs/0.24.1/image/v1alpha1/index.md new file mode 100644 index 00000000..09a3d5f4 --- /dev/null +++ b/docs/0.24.1/image/v1alpha1/index.md @@ -0,0 +1,11 @@ +--- +permalink: /0.24.1/image/v1alpha1/ +--- + +# image.v1alpha1 + + + +* [imagePolicy](imagePolicy.md) +* [imageRepository](imageRepository.md) +* [imageUpdateAutomation](imageUpdateAutomation.md) \ No newline at end of file diff --git a/docs/0.24.1/image/v1alpha2/imagePolicy.md b/docs/0.24.1/image/v1alpha2/imagePolicy.md new file mode 100644 index 00000000..c1c36dd2 --- /dev/null +++ b/docs/0.24.1/image/v1alpha2/imagePolicy.md @@ -0,0 +1,314 @@ +--- +permalink: /0.24.1/image/v1alpha2/imagePolicy/ +--- + +# image.v1alpha2.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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) + * [`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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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" + +## 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/0.24.1/image/v1alpha2/imageRepository.md b/docs/0.24.1/image/v1alpha2/imageRepository.md new file mode 100644 index 00000000..e012f85b --- /dev/null +++ b/docs/0.24.1/image/v1alpha2/imageRepository.md @@ -0,0 +1,294 @@ +--- +permalink: /0.24.1/image/v1alpha2/imageRepository/ +--- + +# image.v1alpha2.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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 withImage(image)`](#fn-specwithimage) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withSuspend(suspend)`](#fn-specwithsuspend) + * [`fn withTimeout(timeout)`](#fn-specwithtimeout) + * [`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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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.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.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.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/0.24.1/image/v1alpha2/imageUpdateAutomation.md b/docs/0.24.1/image/v1alpha2/imageUpdateAutomation.md new file mode 100644 index 00000000..b7b3a7e5 --- /dev/null +++ b/docs/0.24.1/image/v1alpha2/imageUpdateAutomation.md @@ -0,0 +1,424 @@ +--- +permalink: /0.24.1/image/v1alpha2/imageUpdateAutomation/ +--- + +# image.v1alpha2.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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 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) + * [`obj spec.sourceRef`](#obj-specsourceref) + * [`fn withApiVersion(apiVersion)`](#fn-specsourcerefwithapiversion) + * [`fn withKind(kind)`](#fn-specsourcerefwithkind) + * [`fn withName(name)`](#fn-specsourcerefwithname) + * [`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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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) +``` + +"The Git branch to checkout, defaults to master." + +### fn spec.git.checkout.ref.withCommit + +```ts +withCommit(commit) +``` + +"The Git commit SHA to checkout, if specified Tag filters will be ignored." + +### fn spec.git.checkout.ref.withSemver + +```ts +withSemver(semver) +``` + +"The Git tag semver expression, takes precedence over Tag." + +### fn spec.git.checkout.ref.withTag + +```ts +withTag(tag) +``` + +"The Git tag to checkout, 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." + +## 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" + +## 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/0.24.1/image/v1alpha2/index.md b/docs/0.24.1/image/v1alpha2/index.md new file mode 100644 index 00000000..9c4546e2 --- /dev/null +++ b/docs/0.24.1/image/v1alpha2/index.md @@ -0,0 +1,11 @@ +--- +permalink: /0.24.1/image/v1alpha2/ +--- + +# image.v1alpha2 + + + +* [imagePolicy](imagePolicy.md) +* [imageRepository](imageRepository.md) +* [imageUpdateAutomation](imageUpdateAutomation.md) \ No newline at end of file diff --git a/docs/0.24.1/image/v1beta1/imagePolicy.md b/docs/0.24.1/image/v1beta1/imagePolicy.md new file mode 100644 index 00000000..02484a43 --- /dev/null +++ b/docs/0.24.1/image/v1beta1/imagePolicy.md @@ -0,0 +1,323 @@ +--- +permalink: /0.24.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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/0.24.1/image/v1beta1/imageRepository.md b/docs/0.24.1/image/v1beta1/imageRepository.md new file mode 100644 index 00000000..5291c05f --- /dev/null +++ b/docs/0.24.1/image/v1beta1/imageRepository.md @@ -0,0 +1,319 @@ +--- +permalink: /0.24.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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 withImage(image)`](#fn-specwithimage) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`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.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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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.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.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) +``` + + + +### fn spec.accessFrom.withNamespaceSelectorsMixin + +```ts +withNamespaceSelectorsMixin(namespaceSelectors) +``` + + + +**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/0.24.1/image/v1beta1/imageUpdateAutomation.md b/docs/0.24.1/image/v1beta1/imageUpdateAutomation.md new file mode 100644 index 00000000..8d4ebcd1 --- /dev/null +++ b/docs/0.24.1/image/v1beta1/imageUpdateAutomation.md @@ -0,0 +1,424 @@ +--- +permalink: /0.24.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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 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) + * [`obj spec.sourceRef`](#obj-specsourceref) + * [`fn withApiVersion(apiVersion)`](#fn-specsourcerefwithapiversion) + * [`fn withKind(kind)`](#fn-specsourcerefwithkind) + * [`fn withName(name)`](#fn-specsourcerefwithname) + * [`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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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) +``` + +"The Git branch to checkout, defaults to master." + +### fn spec.git.checkout.ref.withCommit + +```ts +withCommit(commit) +``` + +"The Git commit SHA to checkout, if specified Tag filters will be ignored." + +### fn spec.git.checkout.ref.withSemver + +```ts +withSemver(semver) +``` + +"The Git tag semver expression, takes precedence over Tag." + +### fn spec.git.checkout.ref.withTag + +```ts +withTag(tag) +``` + +"The Git tag to checkout, 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." + +## 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" + +## 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/0.24.1/image/v1beta1/index.md b/docs/0.24.1/image/v1beta1/index.md new file mode 100644 index 00000000..e69def6b --- /dev/null +++ b/docs/0.24.1/image/v1beta1/index.md @@ -0,0 +1,11 @@ +--- +permalink: /0.24.1/image/v1beta1/ +--- + +# image.v1beta1 + + + +* [imagePolicy](imagePolicy.md) +* [imageRepository](imageRepository.md) +* [imageUpdateAutomation](imageUpdateAutomation.md) \ No newline at end of file diff --git a/docs/0.24.1/kustomize/index.md b/docs/0.24.1/kustomize/index.md new file mode 100644 index 00000000..1818a5f9 --- /dev/null +++ b/docs/0.24.1/kustomize/index.md @@ -0,0 +1,10 @@ +--- +permalink: /0.24.1/kustomize/ +--- + +# kustomize + + + +* [v1beta1](v1beta1/index.md) +* [v1beta2](v1beta2/index.md) \ No newline at end of file diff --git a/docs/0.24.1/kustomize/v1beta1/index.md b/docs/0.24.1/kustomize/v1beta1/index.md new file mode 100644 index 00000000..20f04b10 --- /dev/null +++ b/docs/0.24.1/kustomize/v1beta1/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.24.1/kustomize/v1beta1/ +--- + +# kustomize.v1beta1 + + + +* [kustomization](kustomization.md) \ No newline at end of file diff --git a/docs/0.24.1/kustomize/v1beta1/kustomization.md b/docs/0.24.1/kustomize/v1beta1/kustomization.md new file mode 100644 index 00000000..6af37422 --- /dev/null +++ b/docs/0.24.1/kustomize/v1beta1/kustomization.md @@ -0,0 +1,573 @@ +--- +permalink: /0.24.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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.kubeConfig`](#obj-speckubeconfig) + * [`obj spec.kubeConfig.secretRef`](#obj-speckubeconfigsecretref) + * [`fn withName(name)`](#fn-speckubeconfigsecretrefwithname) + * [`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.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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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 dependency.CrossNamespaceDependencyReference 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 dependency.CrossNamespaceDependencyReference 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.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.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.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/0.24.1/kustomize/v1beta2/index.md b/docs/0.24.1/kustomize/v1beta2/index.md new file mode 100644 index 00000000..e8cad387 --- /dev/null +++ b/docs/0.24.1/kustomize/v1beta2/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.24.1/kustomize/v1beta2/ +--- + +# kustomize.v1beta2 + + + +* [kustomization](kustomization.md) \ No newline at end of file diff --git a/docs/0.24.1/kustomize/v1beta2/kustomization.md b/docs/0.24.1/kustomize/v1beta2/kustomization.md new file mode 100644 index 00000000..6e3c37ac --- /dev/null +++ b/docs/0.24.1/kustomize/v1beta2/kustomization.md @@ -0,0 +1,582 @@ +--- +permalink: /0.24.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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) + * [`fn withWait(wait)`](#fn-specwithwait) + * [`obj spec.decryption`](#obj-specdecryption) + * [`fn withProvider(provider)`](#fn-specdecryptionwithprovider) + * [`obj spec.decryption.secretRef`](#obj-specdecryptionsecretref) + * [`fn withName(name)`](#fn-specdecryptionsecretrefwithname) + * [`obj spec.kubeConfig`](#obj-speckubeconfig) + * [`obj spec.kubeConfig.secretRef`](#obj-speckubeconfigsecretref) + * [`fn withName(name)`](#fn-speckubeconfigsecretrefwithname) + * [`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.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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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.withDependsOn + +```ts +withDependsOn(dependsOn) +``` + +"DependsOn may contain a dependency.CrossNamespaceDependencyReference 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 dependency.CrossNamespaceDependencyReference 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.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.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.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.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/0.24.1/notification/index.md b/docs/0.24.1/notification/index.md new file mode 100644 index 00000000..efc66a61 --- /dev/null +++ b/docs/0.24.1/notification/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.24.1/notification/ +--- + +# notification + + + +* [v1beta1](v1beta1/index.md) \ No newline at end of file diff --git a/docs/0.24.1/notification/v1beta1/alert.md b/docs/0.24.1/notification/v1beta1/alert.md new file mode 100644 index 00000000..4df97e56 --- /dev/null +++ b/docs/0.24.1/notification/v1beta1/alert.md @@ -0,0 +1,311 @@ +--- +permalink: /0.24.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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.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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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.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/0.24.1/notification/v1beta1/index.md b/docs/0.24.1/notification/v1beta1/index.md new file mode 100644 index 00000000..5d96310e --- /dev/null +++ b/docs/0.24.1/notification/v1beta1/index.md @@ -0,0 +1,11 @@ +--- +permalink: /0.24.1/notification/v1beta1/ +--- + +# notification.v1beta1 + + + +* [alert](alert.md) +* [provider](provider.md) +* [receiver](receiver.md) \ No newline at end of file diff --git a/docs/0.24.1/notification/v1beta1/provider.md b/docs/0.24.1/notification/v1beta1/provider.md new file mode 100644 index 00000000..b1bb0070 --- /dev/null +++ b/docs/0.24.1/notification/v1beta1/provider.md @@ -0,0 +1,312 @@ +--- +permalink: /0.24.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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 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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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.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/0.24.1/notification/v1beta1/receiver.md b/docs/0.24.1/notification/v1beta1/receiver.md new file mode 100644 index 00000000..81b82291 --- /dev/null +++ b/docs/0.24.1/notification/v1beta1/receiver.md @@ -0,0 +1,302 @@ +--- +permalink: /0.24.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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.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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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.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/0.24.1/source/index.md b/docs/0.24.1/source/index.md new file mode 100644 index 00000000..063cfbd4 --- /dev/null +++ b/docs/0.24.1/source/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.24.1/source/ +--- + +# source + + + +* [v1beta1](v1beta1/index.md) \ No newline at end of file diff --git a/docs/0.24.1/source/v1beta1/bucket.md b/docs/0.24.1/source/v1beta1/bucket.md new file mode 100644 index 00000000..76cbc42a --- /dev/null +++ b/docs/0.24.1/source/v1beta1/bucket.md @@ -0,0 +1,350 @@ +--- +permalink: /0.24.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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.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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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 20s." + +## 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.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/0.24.1/source/v1beta1/gitRepository.md b/docs/0.24.1/source/v1beta1/gitRepository.md new file mode 100644 index 00000000..dbf929d0 --- /dev/null +++ b/docs/0.24.1/source/v1beta1/gitRepository.md @@ -0,0 +1,421 @@ +--- +permalink: /0.24.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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.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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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 20s." + +### 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.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, identity.pub 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/0.24.1/source/v1beta1/helmChart.md b/docs/0.24.1/source/v1beta1/helmChart.md new file mode 100644 index 00000000..606da166 --- /dev/null +++ b/docs/0.24.1/source/v1beta1/helmChart.md @@ -0,0 +1,361 @@ +--- +permalink: /0.24.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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.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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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.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/0.24.1/source/v1beta1/helmRepository.md b/docs/0.24.1/source/v1beta1/helmRepository.md new file mode 100644 index 00000000..411d72bf --- /dev/null +++ b/docs/0.24.1/source/v1beta1/helmRepository.md @@ -0,0 +1,314 @@ +--- +permalink: /0.24.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 withManagedFields(managedFields)`](#fn-metadatawithmanagedfields) + * [`fn withManagedFieldsMixin(managedFields)`](#fn-metadatawithmanagedfieldsmixin) + * [`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.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.withManagedFields + +```ts +withManagedFields(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +### fn metadata.withManagedFieldsMixin + +```ts +withManagedFieldsMixin(managedFields) +``` + +"ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object." + +**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.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 caCert fields." + +### fn spec.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent" \ No newline at end of file diff --git a/docs/0.24.1/source/v1beta1/index.md b/docs/0.24.1/source/v1beta1/index.md new file mode 100644 index 00000000..ac6e0b47 --- /dev/null +++ b/docs/0.24.1/source/v1beta1/index.md @@ -0,0 +1,12 @@ +--- +permalink: /0.24.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/README.md b/docs/README.md index 3354dd77..423b2921 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,3 +4,4 @@ This library is generated with [`k8s`](https://github.com/jsonnet-libs/k8s). - [0.17.2](0.17.2/README.md) - [0.21.1](0.21.1/README.md) +- [0.24.1](0.24.1/README.md)