-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update: source github.com/jsonnet-libs/k8s@94cbf160
- Loading branch information
1 parent
50c0544
commit 3d03070
Showing
20 changed files
with
25,253 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| local d = (import 'doc-util/main.libsonnet'), | ||
| '#':: d.pkg(name='postgresql', url='', help=''), | ||
| v1: (import 'v1/main.libsonnet'), | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| { | ||
| local d = (import 'doc-util/main.libsonnet'), | ||
| '#':: d.pkg(name='backup', url='', help='"Backup is the Schema for the backups API"'), | ||
| '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), | ||
| metadata: { | ||
| '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), | ||
| withAnnotations(annotations): { metadata+: { annotations: annotations } }, | ||
| '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), | ||
| withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, | ||
| '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), | ||
| withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, | ||
| '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), | ||
| withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, | ||
| '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), | ||
| withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, | ||
| '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), | ||
| withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, | ||
| '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), | ||
| withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, | ||
| '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), | ||
| withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, | ||
| '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), | ||
| withGenerateName(generateName): { metadata+: { generateName: generateName } }, | ||
| '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), | ||
| withGeneration(generation): { metadata+: { generation: generation } }, | ||
| '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), | ||
| withLabels(labels): { metadata+: { labels: labels } }, | ||
| '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), | ||
| withLabelsMixin(labels): { metadata+: { labels+: labels } }, | ||
| '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), | ||
| withName(name): { metadata+: { name: name } }, | ||
| '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), | ||
| withNamespace(namespace): { metadata+: { namespace: namespace } }, | ||
| '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), | ||
| withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, | ||
| '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), | ||
| withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, | ||
| '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), | ||
| withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, | ||
| '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), | ||
| withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, | ||
| '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), | ||
| withUid(uid): { metadata+: { uid: uid } }, | ||
| }, | ||
| '#new':: d.fn(help='new returns an instance of Backup', args=[d.arg(name='name', type=d.T.string)]), | ||
| new(name): { | ||
| apiVersion: 'postgresql.cnpg.io/v1', | ||
| kind: 'Backup', | ||
| } + self.metadata.withName(name=name), | ||
| '#spec':: d.obj(help='"Specification of the desired behavior of the backup.\\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"'), | ||
| spec: { | ||
| '#cluster':: d.obj(help='"The cluster to backup"'), | ||
| cluster: { | ||
| '#withName':: d.fn(help='"Name of the referent."', args=[d.arg(name='name', type=d.T.string)]), | ||
| withName(name): { spec+: { cluster+: { name: name } } }, | ||
| }, | ||
| '#onlineConfiguration':: d.obj(help="\"Configuration parameters to control the online/hot backup with volume snapshots\\nOverrides the default settings specified in the cluster '.backup.volumeSnapshot.onlineConfiguration' stanza\""), | ||
| onlineConfiguration: { | ||
| '#withImmediateCheckpoint':: d.fn(help='"Control whether the I/O workload for the backup initial checkpoint will\\nbe limited, according to the `checkpoint_completion_target` setting on\\nthe PostgreSQL server. If set to true, an immediate checkpoint will be\\nused, meaning PostgreSQL will complete the checkpoint as soon as\\npossible. `false` by default."', args=[d.arg(name='immediateCheckpoint', type=d.T.boolean)]), | ||
| withImmediateCheckpoint(immediateCheckpoint): { spec+: { onlineConfiguration+: { immediateCheckpoint: immediateCheckpoint } } }, | ||
| '#withWaitForArchive':: d.fn(help='"If false, the function will return immediately after the backup is completed,\\nwithout waiting for WAL to be archived.\\nThis behavior is only useful with backup software that independently monitors WAL archiving.\\nOtherwise, WAL required to make the backup consistent might be missing and make the backup useless.\\nBy default, or when this parameter is true, pg_backup_stop will wait for WAL to be archived when archiving is\\nenabled.\\nOn a standby, this means that it will wait only when archive_mode = always.\\nIf write activity on the primary is low, it may be useful to run pg_switch_wal on the primary in order to trigger\\nan immediate segment switch."', args=[d.arg(name='waitForArchive', type=d.T.boolean)]), | ||
| withWaitForArchive(waitForArchive): { spec+: { onlineConfiguration+: { waitForArchive: waitForArchive } } }, | ||
| }, | ||
| '#pluginConfiguration':: d.obj(help='"Configuration parameters passed to the plugin managing this backup"'), | ||
| pluginConfiguration: { | ||
| '#withName':: d.fn(help='"Name is the name of the plugin managing this backup"', args=[d.arg(name='name', type=d.T.string)]), | ||
| withName(name): { spec+: { pluginConfiguration+: { name: name } } }, | ||
| '#withParameters':: d.fn(help='"Parameters are the configuration parameters passed to the backup\\nplugin for this backup"', args=[d.arg(name='parameters', type=d.T.object)]), | ||
| withParameters(parameters): { spec+: { pluginConfiguration+: { parameters: parameters } } }, | ||
| '#withParametersMixin':: d.fn(help='"Parameters are the configuration parameters passed to the backup\\nplugin for this backup"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='parameters', type=d.T.object)]), | ||
| withParametersMixin(parameters): { spec+: { pluginConfiguration+: { parameters+: parameters } } }, | ||
| }, | ||
| '#withMethod':: d.fn(help='"The backup method to be used, possible options are `barmanObjectStore`,\\n`volumeSnapshot` or `plugin`. Defaults to: `barmanObjectStore`."', args=[d.arg(name='method', type=d.T.string)]), | ||
| withMethod(method): { spec+: { method: method } }, | ||
| '#withOnline':: d.fn(help="\"Whether the default type of backup with volume snapshots is\\nonline/hot (`true`, default) or offline/cold (`false`)\\nOverrides the default setting specified in the cluster field '.spec.backup.volumeSnapshot.online'\"", args=[d.arg(name='online', type=d.T.boolean)]), | ||
| withOnline(online): { spec+: { online: online } }, | ||
| '#withTarget':: d.fn(help='"The policy to decide which instance should perform this backup. If empty,\\nit defaults to `cluster.spec.backup.target`.\\nAvailable options are empty string, `primary` and `prefer-standby`.\\n`primary` to have backups run always on primary instances,\\n`prefer-standby` to have backups run preferably on the most updated\\nstandby, if available."', args=[d.arg(name='target', type=d.T.string)]), | ||
| withTarget(target): { spec+: { target: target } }, | ||
| }, | ||
| '#mixin': 'ignore', | ||
| mixin: self, | ||
| } |
Oops, something went wrong.