diff --git a/docs/README.md b/docs/README.md index e94ce909a..3f4fc5014 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,6 +15,7 @@ This library is generated with [`k8s`](https://github.com/jsonnet-libs/k8s). - [provider-helm/0.13](provider-helm/0.13/README.md) - [provider-jet-mongodbatlas/0.3](provider-jet-mongodbatlas/0.3/README.md) - [provider-nop/0.1.1](provider-nop/0.1.1/README.md) +- [provider-nop/0.2.0](provider-nop/0.2.0/README.md) - [provider-grafana/0.5](provider-grafana/0.5/README.md) - [upbound-provider-aws/0.31](upbound-provider-aws/0.31/README.md) - [upbound-provider-azure/0.29](upbound-provider-azure/0.29/README.md) diff --git a/docs/provider-nop/0.2.0/README.md b/docs/provider-nop/0.2.0/README.md new file mode 100644 index 000000000..cf4d6a86e --- /dev/null +++ b/docs/provider-nop/0.2.0/README.md @@ -0,0 +1,13 @@ +--- +permalink: /provider-nop/0.2.0/ +--- + +# crossplane_nop + +```jsonnet +local crossplane_nop = import "github.com/jsonnet-libs/crossplane-libsonnet/provider-nop/0.2.0/main.libsonnet" +``` + + + +* [nop](nop/index.md) \ No newline at end of file diff --git a/docs/provider-nop/0.2.0/nop/index.md b/docs/provider-nop/0.2.0/nop/index.md new file mode 100644 index 000000000..73c80e837 --- /dev/null +++ b/docs/provider-nop/0.2.0/nop/index.md @@ -0,0 +1,9 @@ +--- +permalink: /provider-nop/0.2.0/nop/ +--- + +# nop + + + +* [v1alpha1](v1alpha1/index.md) \ No newline at end of file diff --git a/docs/provider-nop/0.2.0/nop/v1alpha1/index.md b/docs/provider-nop/0.2.0/nop/v1alpha1/index.md new file mode 100644 index 000000000..83a2964eb --- /dev/null +++ b/docs/provider-nop/0.2.0/nop/v1alpha1/index.md @@ -0,0 +1,9 @@ +--- +permalink: /provider-nop/0.2.0/nop/v1alpha1/ +--- + +# nop.v1alpha1 + + + +* [nopResource](nopResource.md) \ No newline at end of file diff --git a/docs/provider-nop/0.2.0/nop/v1alpha1/nopResource.md b/docs/provider-nop/0.2.0/nop/v1alpha1/nopResource.md new file mode 100644 index 000000000..5ad11d807 --- /dev/null +++ b/docs/provider-nop/0.2.0/nop/v1alpha1/nopResource.md @@ -0,0 +1,550 @@ +--- +permalink: /provider-nop/0.2.0/nop/v1alpha1/nopResource/ +--- + +# nop.v1alpha1.nopResource + +"A NopResource is an example API type." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withDeletionPolicy(deletionPolicy)`](#fn-specwithdeletionpolicy) + * [`obj spec.forProvider`](#obj-specforprovider) + * [`fn withConditionAfter(conditionAfter)`](#fn-specforproviderwithconditionafter) + * [`fn withConditionAfterMixin(conditionAfter)`](#fn-specforproviderwithconditionaftermixin) + * [`fn withConnectionDetails(connectionDetails)`](#fn-specforproviderwithconnectiondetails) + * [`fn withConnectionDetailsMixin(connectionDetails)`](#fn-specforproviderwithconnectiondetailsmixin) + * [`fn withFields(fields)`](#fn-specforproviderwithfields) + * [`fn withFieldsMixin(fields)`](#fn-specforproviderwithfieldsmixin) + * [`obj spec.forProvider.conditionAfter`](#obj-specforproviderconditionafter) + * [`fn withConditionReason(conditionReason)`](#fn-specforproviderconditionafterwithconditionreason) + * [`fn withConditionStatus(conditionStatus)`](#fn-specforproviderconditionafterwithconditionstatus) + * [`fn withConditionType(conditionType)`](#fn-specforproviderconditionafterwithconditiontype) + * [`fn withTime(time)`](#fn-specforproviderconditionafterwithtime) + * [`obj spec.forProvider.connectionDetails`](#obj-specforproviderconnectiondetails) + * [`fn withName(name)`](#fn-specforproviderconnectiondetailswithname) + * [`fn withValue(value)`](#fn-specforproviderconnectiondetailswithvalue) + * [`obj spec.providerConfigRef`](#obj-specproviderconfigref) + * [`fn withName(name)`](#fn-specproviderconfigrefwithname) + * [`obj spec.providerConfigRef.policy`](#obj-specproviderconfigrefpolicy) + * [`fn withResolution(resolution)`](#fn-specproviderconfigrefpolicywithresolution) + * [`fn withResolve(resolve)`](#fn-specproviderconfigrefpolicywithresolve) + * [`obj spec.providerRef`](#obj-specproviderref) + * [`fn withName(name)`](#fn-specproviderrefwithname) + * [`obj spec.providerRef.policy`](#obj-specproviderrefpolicy) + * [`fn withResolution(resolution)`](#fn-specproviderrefpolicywithresolution) + * [`fn withResolve(resolve)`](#fn-specproviderrefpolicywithresolve) + * [`obj spec.publishConnectionDetailsTo`](#obj-specpublishconnectiondetailsto) + * [`fn withName(name)`](#fn-specpublishconnectiondetailstowithname) + * [`obj spec.publishConnectionDetailsTo.configRef`](#obj-specpublishconnectiondetailstoconfigref) + * [`fn withName(name)`](#fn-specpublishconnectiondetailstoconfigrefwithname) + * [`obj spec.publishConnectionDetailsTo.configRef.policy`](#obj-specpublishconnectiondetailstoconfigrefpolicy) + * [`fn withResolution(resolution)`](#fn-specpublishconnectiondetailstoconfigrefpolicywithresolution) + * [`fn withResolve(resolve)`](#fn-specpublishconnectiondetailstoconfigrefpolicywithresolve) + * [`obj spec.publishConnectionDetailsTo.metadata`](#obj-specpublishconnectiondetailstometadata) + * [`fn withAnnotations(annotations)`](#fn-specpublishconnectiondetailstometadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-specpublishconnectiondetailstometadatawithannotationsmixin) + * [`fn withLabels(labels)`](#fn-specpublishconnectiondetailstometadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-specpublishconnectiondetailstometadatawithlabelsmixin) + * [`fn withType(type)`](#fn-specpublishconnectiondetailstometadatawithtype) + * [`obj spec.writeConnectionSecretToRef`](#obj-specwriteconnectionsecrettoref) + * [`fn withName(name)`](#fn-specwriteconnectionsecrettorefwithname) + * [`fn withNamespace(namespace)`](#fn-specwriteconnectionsecrettorefwithnamespace) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of NopResource + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"A NopResourceSpec defines the desired state of a NopResource." + +### fn spec.withDeletionPolicy + +```ts +withDeletionPolicy(deletionPolicy) +``` + +"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource." + +## obj spec.forProvider + +"NopResourceParameters are the configurable fields of a NopResource." + +### fn spec.forProvider.withConditionAfter + +```ts +withConditionAfter(conditionAfter) +``` + +"ConditionAfter can be used to set status conditions after a specified time. By default a NopResource will only have a status condition of Type: Synced. It will never have a status condition of Type: Ready unless one is configured here." + +### fn spec.forProvider.withConditionAfterMixin + +```ts +withConditionAfterMixin(conditionAfter) +``` + +"ConditionAfter can be used to set status conditions after a specified time. By default a NopResource will only have a status condition of Type: Synced. It will never have a status condition of Type: Ready unless one is configured here." + +**Note:** This function appends passed data to existing values + +### fn spec.forProvider.withConnectionDetails + +```ts +withConnectionDetails(connectionDetails) +``` + +"ConnectionDetails that this NopResource should emit on each reconcile." + +### fn spec.forProvider.withConnectionDetailsMixin + +```ts +withConnectionDetailsMixin(connectionDetails) +``` + +"ConnectionDetails that this NopResource should emit on each reconcile." + +**Note:** This function appends passed data to existing values + +### fn spec.forProvider.withFields + +```ts +withFields(fields) +``` + +"Fields is an arbitrary object you can patch to and from. It has no schema, is not validated, and is not used by the NopResource controller." + +### fn spec.forProvider.withFieldsMixin + +```ts +withFieldsMixin(fields) +``` + +"Fields is an arbitrary object you can patch to and from. It has no schema, is not validated, and is not used by the NopResource controller." + +**Note:** This function appends passed data to existing values + +## obj spec.forProvider.conditionAfter + +"ConditionAfter can be used to set status conditions after a specified time. By default a NopResource will only have a status condition of Type: Synced. It will never have a status condition of Type: Ready unless one is configured here." + +### fn spec.forProvider.conditionAfter.withConditionReason + +```ts +withConditionReason(conditionReason) +``` + +"ConditionReason to set - e.g. Available." + +### fn spec.forProvider.conditionAfter.withConditionStatus + +```ts +withConditionStatus(conditionStatus) +``` + +"ConditionStatus to set - e.g. True." + +### fn spec.forProvider.conditionAfter.withConditionType + +```ts +withConditionType(conditionType) +``` + +"ConditionType to set - e.g. Ready." + +### fn spec.forProvider.conditionAfter.withTime + +```ts +withTime(time) +``` + +"Time is the duration after which the condition should be set." + +## obj spec.forProvider.connectionDetails + +"ConnectionDetails that this NopResource should emit on each reconcile." + +### fn spec.forProvider.connectionDetails.withName + +```ts +withName(name) +``` + +"Name of the connection detail." + +### fn spec.forProvider.connectionDetails.withValue + +```ts +withValue(value) +``` + +"Value of the connection detail." + +## obj spec.providerConfigRef + +"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured." + +### fn spec.providerConfigRef.withName + +```ts +withName(name) +``` + +"Name of the referenced object." + +## obj spec.providerConfigRef.policy + +"Policies for referencing." + +### fn spec.providerConfigRef.policy.withResolution + +```ts +withResolution(resolution) +``` + +"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved." + +### fn spec.providerConfigRef.policy.withResolve + +```ts +withResolve(resolve) +``` + +"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile." + +## obj spec.providerRef + +"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. `providerConfigRef`" + +### fn spec.providerRef.withName + +```ts +withName(name) +``` + +"Name of the referenced object." + +## obj spec.providerRef.policy + +"Policies for referencing." + +### fn spec.providerRef.policy.withResolution + +```ts +withResolution(resolution) +``` + +"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved." + +### fn spec.providerRef.policy.withResolve + +```ts +withResolve(resolve) +``` + +"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile." + +## obj spec.publishConnectionDetailsTo + +"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource." + +### fn spec.publishConnectionDetailsTo.withName + +```ts +withName(name) +``` + +"Name is the name of the connection secret." + +## obj spec.publishConnectionDetailsTo.configRef + +"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret." + +### fn spec.publishConnectionDetailsTo.configRef.withName + +```ts +withName(name) +``` + +"Name of the referenced object." + +## obj spec.publishConnectionDetailsTo.configRef.policy + +"Policies for referencing." + +### fn spec.publishConnectionDetailsTo.configRef.policy.withResolution + +```ts +withResolution(resolution) +``` + +"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved." + +### fn spec.publishConnectionDetailsTo.configRef.policy.withResolve + +```ts +withResolve(resolve) +``` + +"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile." + +## obj spec.publishConnectionDetailsTo.metadata + +"Metadata is the metadata for connection secret." + +### fn spec.publishConnectionDetailsTo.metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types." + +### fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types." + +**Note:** This function appends passed data to existing values + +### fn spec.publishConnectionDetailsTo.metadata.withLabels + +```ts +withLabels(labels) +``` + +"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types." + +### fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types." + +**Note:** This function appends passed data to existing values + +### fn spec.publishConnectionDetailsTo.metadata.withType + +```ts +withType(type) +``` + +"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores." + +## obj spec.writeConnectionSecretToRef + +"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other." + +### fn spec.writeConnectionSecretToRef.withName + +```ts +withName(name) +``` + +"Name of the secret." + +### fn spec.writeConnectionSecretToRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the secret." \ No newline at end of file diff --git a/provider-nop/0.2.0/_gen/nop/main.libsonnet b/provider-nop/0.2.0/_gen/nop/main.libsonnet new file mode 100644 index 000000000..1a6f6877a --- /dev/null +++ b/provider-nop/0.2.0/_gen/nop/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='nop', url='', help=''), + v1alpha1: (import 'v1alpha1/main.libsonnet'), +} diff --git a/provider-nop/0.2.0/_gen/nop/v1alpha1/main.libsonnet b/provider-nop/0.2.0/_gen/nop/v1alpha1/main.libsonnet new file mode 100644 index 000000000..536978f85 --- /dev/null +++ b/provider-nop/0.2.0/_gen/nop/v1alpha1/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1alpha1', url='', help=''), + nopResource: (import 'nopResource.libsonnet'), +} diff --git a/provider-nop/0.2.0/_gen/nop/v1alpha1/nopResource.libsonnet b/provider-nop/0.2.0/_gen/nop/v1alpha1/nopResource.libsonnet new file mode 100644 index 000000000..865988160 --- /dev/null +++ b/provider-nop/0.2.0/_gen/nop/v1alpha1/nopResource.libsonnet @@ -0,0 +1,153 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='nopResource', url='', help='"A NopResource is an example API type."'), + '#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 NopResource', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'nop.crossplane.io/v1alpha1', + kind: 'NopResource', + } + self.metadata.withName(name=name) + self.metadata.withAnnotations(annotations={ + 'tanka.dev/namespaced': 'false', + }), + '#spec':: d.obj(help='"A NopResourceSpec defines the desired state of a NopResource."'), + spec: { + '#forProvider':: d.obj(help='"NopResourceParameters are the configurable fields of a NopResource."'), + forProvider: { + '#conditionAfter':: d.obj(help='"ConditionAfter can be used to set status conditions after a specified time. By default a NopResource will only have a status condition of Type: Synced. It will never have a status condition of Type: Ready unless one is configured here."'), + conditionAfter: { + '#withConditionReason':: d.fn(help='"ConditionReason to set - e.g. Available."', args=[d.arg(name='conditionReason', type=d.T.string)]), + withConditionReason(conditionReason): { conditionReason: conditionReason }, + '#withConditionStatus':: d.fn(help='"ConditionStatus to set - e.g. True."', args=[d.arg(name='conditionStatus', type=d.T.string)]), + withConditionStatus(conditionStatus): { conditionStatus: conditionStatus }, + '#withConditionType':: d.fn(help='"ConditionType to set - e.g. Ready."', args=[d.arg(name='conditionType', type=d.T.string)]), + withConditionType(conditionType): { conditionType: conditionType }, + '#withTime':: d.fn(help='"Time is the duration after which the condition should be set."', args=[d.arg(name='time', type=d.T.string)]), + withTime(time): { time: time }, + }, + '#connectionDetails':: d.obj(help='"ConnectionDetails that this NopResource should emit on each reconcile."'), + connectionDetails: { + '#withName':: d.fn(help='"Name of the connection detail."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Value of the connection detail."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withConditionAfter':: d.fn(help='"ConditionAfter can be used to set status conditions after a specified time. By default a NopResource will only have a status condition of Type: Synced. It will never have a status condition of Type: Ready unless one is configured here."', args=[d.arg(name='conditionAfter', type=d.T.array)]), + withConditionAfter(conditionAfter): { spec+: { forProvider+: { conditionAfter: if std.isArray(v=conditionAfter) then conditionAfter else [conditionAfter] } } }, + '#withConditionAfterMixin':: d.fn(help='"ConditionAfter can be used to set status conditions after a specified time. By default a NopResource will only have a status condition of Type: Synced. It will never have a status condition of Type: Ready unless one is configured here."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='conditionAfter', type=d.T.array)]), + withConditionAfterMixin(conditionAfter): { spec+: { forProvider+: { conditionAfter+: if std.isArray(v=conditionAfter) then conditionAfter else [conditionAfter] } } }, + '#withConnectionDetails':: d.fn(help='"ConnectionDetails that this NopResource should emit on each reconcile."', args=[d.arg(name='connectionDetails', type=d.T.array)]), + withConnectionDetails(connectionDetails): { spec+: { forProvider+: { connectionDetails: if std.isArray(v=connectionDetails) then connectionDetails else [connectionDetails] } } }, + '#withConnectionDetailsMixin':: d.fn(help='"ConnectionDetails that this NopResource should emit on each reconcile."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='connectionDetails', type=d.T.array)]), + withConnectionDetailsMixin(connectionDetails): { spec+: { forProvider+: { connectionDetails+: if std.isArray(v=connectionDetails) then connectionDetails else [connectionDetails] } } }, + '#withFields':: d.fn(help='"Fields is an arbitrary object you can patch to and from. It has no schema, is not validated, and is not used by the NopResource controller."', args=[d.arg(name='fields', type=d.T.object)]), + withFields(fields): { spec+: { forProvider+: { fields: fields } } }, + '#withFieldsMixin':: d.fn(help='"Fields is an arbitrary object you can patch to and from. It has no schema, is not validated, and is not used by the NopResource controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='fields', type=d.T.object)]), + withFieldsMixin(fields): { spec+: { forProvider+: { fields+: fields } } }, + }, + '#providerConfigRef':: d.obj(help='"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."'), + providerConfigRef: { + '#policy':: d.obj(help='"Policies for referencing."'), + policy: { + '#withResolution':: d.fn(help="\"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved.\"", args=[d.arg(name='resolution', type=d.T.string)]), + withResolution(resolution): { spec+: { providerConfigRef+: { policy+: { resolution: resolution } } } }, + '#withResolve':: d.fn(help="\"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile.\"", args=[d.arg(name='resolve', type=d.T.string)]), + withResolve(resolve): { spec+: { providerConfigRef+: { policy+: { resolve: resolve } } } }, + }, + '#withName':: d.fn(help='"Name of the referenced object."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { providerConfigRef+: { name: name } } }, + }, + '#providerRef':: d.obj(help='"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. `providerConfigRef`"'), + providerRef: { + '#policy':: d.obj(help='"Policies for referencing."'), + policy: { + '#withResolution':: d.fn(help="\"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved.\"", args=[d.arg(name='resolution', type=d.T.string)]), + withResolution(resolution): { spec+: { providerRef+: { policy+: { resolution: resolution } } } }, + '#withResolve':: d.fn(help="\"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile.\"", args=[d.arg(name='resolve', type=d.T.string)]), + withResolve(resolve): { spec+: { providerRef+: { policy+: { resolve: resolve } } } }, + }, + '#withName':: d.fn(help='"Name of the referenced object."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { providerRef+: { name: name } } }, + }, + '#publishConnectionDetailsTo':: d.obj(help='"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."'), + publishConnectionDetailsTo: { + '#configRef':: d.obj(help='"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."'), + configRef: { + '#policy':: d.obj(help='"Policies for referencing."'), + policy: { + '#withResolution':: d.fn(help="\"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved.\"", args=[d.arg(name='resolution', type=d.T.string)]), + withResolution(resolution): { spec+: { publishConnectionDetailsTo+: { configRef+: { policy+: { resolution: resolution } } } } }, + '#withResolve':: d.fn(help="\"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile.\"", args=[d.arg(name='resolve', type=d.T.string)]), + withResolve(resolve): { spec+: { publishConnectionDetailsTo+: { configRef+: { policy+: { resolve: resolve } } } } }, + }, + '#withName':: d.fn(help='"Name of the referenced object."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { publishConnectionDetailsTo+: { configRef+: { name: name } } } }, + }, + '#metadata':: d.obj(help='"Metadata is the metadata for connection secret."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \\"metadata.annotations\\". - It is up to Secret Store implementation for others store types."', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { spec+: { publishConnectionDetailsTo+: { metadata+: { annotations: annotations } } } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \\"metadata.annotations\\". - It is up to Secret Store implementation for others store types."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { spec+: { publishConnectionDetailsTo+: { metadata+: { annotations+: annotations } } } }, + '#withLabels':: d.fn(help='"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \\"metadata.labels\\". - It is up to Secret Store implementation for others store types."', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { publishConnectionDetailsTo+: { metadata+: { labels: labels } } } }, + '#withLabelsMixin':: d.fn(help='"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \\"metadata.labels\\". - It is up to Secret Store implementation for others store types."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { publishConnectionDetailsTo+: { metadata+: { labels+: labels } } } }, + '#withType':: d.fn(help='"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { publishConnectionDetailsTo+: { metadata+: { type: type } } } }, + }, + '#withName':: d.fn(help='"Name is the name of the connection secret."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { publishConnectionDetailsTo+: { name: name } } }, + }, + '#withDeletionPolicy':: d.fn(help='"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \\"Delete\\" or \\"Orphan\\" the external resource."', args=[d.arg(name='deletionPolicy', type=d.T.string)]), + withDeletionPolicy(deletionPolicy): { spec+: { deletionPolicy: deletionPolicy } }, + '#writeConnectionSecretToRef':: d.obj(help='"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."'), + writeConnectionSecretToRef: { + '#withName':: d.fn(help='"Name of the secret."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { writeConnectionSecretToRef+: { name: name } } }, + '#withNamespace':: d.fn(help='"Namespace of the secret."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { writeConnectionSecretToRef+: { namespace: namespace } } }, + }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/provider-nop/0.2.0/gen.libsonnet b/provider-nop/0.2.0/gen.libsonnet new file mode 100644 index 000000000..3bf5501b8 --- /dev/null +++ b/provider-nop/0.2.0/gen.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='crossplane_nop', url='github.com/jsonnet-libs/crossplane-libsonnet/provider-nop/0.2.0/main.libsonnet', help=''), + nop:: (import '_gen/nop/main.libsonnet'), +} diff --git a/provider-nop/0.2.0/main.libsonnet b/provider-nop/0.2.0/main.libsonnet new file mode 100644 index 000000000..f5597a504 --- /dev/null +++ b/provider-nop/0.2.0/main.libsonnet @@ -0,0 +1 @@ +(import 'gen.libsonnet')