diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..65ff66e --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,19 @@ +"jobs": + "build": + "name": "Deploy docs" + "runs-on": "ubuntu-latest" + "steps": + - "name": "Checkout main" + "uses": "actions/checkout@v3" + "with": + "fetch-depth": 0 + - "uses": "actions/setup-python@v2" + - "run": "pip install -r requirements.txt" + - "run": "git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com'" + - "name": "Publish docs" + "run": "mkdocs gh-deploy --force" +"name": "Publish docs via GitHub Pages" +"on": + "push": + "branches": + - "main" \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..985645d --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018-2021 Grafana Labs, sh0rez, Duologic + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 64e5fcb..b31d1fb 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,5 @@ -# envoy-gateway-libsonnet -envoy-gateway jsonnet library +# envoy-gateway Jsonnet library + +This library is generated with [`k8s`](https://github.com/jsonnet-libs/k8s). + +[Docs](https://jsonnet-libs.github.io/envoy-gateway-libsonnet) diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..e259940 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,5 @@ +# envoy-gateway Jsonnet library + +This library is generated with [`k8s`](https://github.com/jsonnet-libs/k8s). + +- [v0.6.0](v0.6.0/README.md) diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..562ac66 --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1 @@ +.md-nav__link:first-letter { text-transform: lowercase; } diff --git a/docs/v0.6.0/README.md b/docs/v0.6.0/README.md new file mode 100644 index 0000000..cc2c0f5 --- /dev/null +++ b/docs/v0.6.0/README.md @@ -0,0 +1,13 @@ +--- +permalink: /v0.6.0/ +--- + +# envoy-gateway + +```jsonnet +local envoy-gateway = import "github.com/jsonnet-libs/envoy-gateway-libsonnet/v0.6.0/main.libsonnet" +``` + + + +* [gateway](gateway/index.md) \ No newline at end of file diff --git a/docs/v0.6.0/gateway/index.md b/docs/v0.6.0/gateway/index.md new file mode 100644 index 0000000..3f1ce13 --- /dev/null +++ b/docs/v0.6.0/gateway/index.md @@ -0,0 +1,9 @@ +--- +permalink: /v0.6.0/gateway/ +--- + +# gateway + + + +* [v1alpha1](v1alpha1/index.md) \ No newline at end of file diff --git a/docs/v0.6.0/gateway/v1alpha1/backendTrafficPolicy.md b/docs/v0.6.0/gateway/v1alpha1/backendTrafficPolicy.md new file mode 100644 index 0000000..c12dc42 --- /dev/null +++ b/docs/v0.6.0/gateway/v1alpha1/backendTrafficPolicy.md @@ -0,0 +1,455 @@ +--- +permalink: /v0.6.0/gateway/v1alpha1/backendTrafficPolicy/ +--- + +# gateway.v1alpha1.backendTrafficPolicy + +"BackendTrafficPolicy allows the user to configure the behavior of the connection between the downstream client and Envoy Proxy listener." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`obj spec.loadBalancer`](#obj-specloadbalancer) + * [`fn withType(type)`](#fn-specloadbalancerwithtype) + * [`obj spec.loadBalancer.consistentHash`](#obj-specloadbalancerconsistenthash) + * [`fn withType(type)`](#fn-specloadbalancerconsistenthashwithtype) + * [`obj spec.rateLimit`](#obj-specratelimit) + * [`fn withType(type)`](#fn-specratelimitwithtype) + * [`obj spec.rateLimit.global`](#obj-specratelimitglobal) + * [`fn withRules(rules)`](#fn-specratelimitglobalwithrules) + * [`fn withRulesMixin(rules)`](#fn-specratelimitglobalwithrulesmixin) + * [`obj spec.rateLimit.global.rules`](#obj-specratelimitglobalrules) + * [`fn withClientSelectors(clientSelectors)`](#fn-specratelimitglobalruleswithclientselectors) + * [`fn withClientSelectorsMixin(clientSelectors)`](#fn-specratelimitglobalruleswithclientselectorsmixin) + * [`obj spec.rateLimit.global.rules.clientSelectors`](#obj-specratelimitglobalrulesclientselectors) + * [`fn withHeaders(headers)`](#fn-specratelimitglobalrulesclientselectorswithheaders) + * [`fn withHeadersMixin(headers)`](#fn-specratelimitglobalrulesclientselectorswithheadersmixin) + * [`obj spec.rateLimit.global.rules.clientSelectors.headers`](#obj-specratelimitglobalrulesclientselectorsheaders) + * [`fn withName(name)`](#fn-specratelimitglobalrulesclientselectorsheaderswithname) + * [`fn withType(type)`](#fn-specratelimitglobalrulesclientselectorsheaderswithtype) + * [`fn withValue(value)`](#fn-specratelimitglobalrulesclientselectorsheaderswithvalue) + * [`obj spec.rateLimit.global.rules.clientSelectors.sourceCIDR`](#obj-specratelimitglobalrulesclientselectorssourcecidr) + * [`fn withType(type)`](#fn-specratelimitglobalrulesclientselectorssourcecidrwithtype) + * [`fn withValue(value)`](#fn-specratelimitglobalrulesclientselectorssourcecidrwithvalue) + * [`obj spec.rateLimit.global.rules.limit`](#obj-specratelimitglobalruleslimit) + * [`fn withRequests(requests)`](#fn-specratelimitglobalruleslimitwithrequests) + * [`fn withUnit(unit)`](#fn-specratelimitglobalruleslimitwithunit) + * [`obj spec.targetRef`](#obj-spectargetref) + * [`fn withGroup(group)`](#fn-spectargetrefwithgroup) + * [`fn withKind(kind)`](#fn-spectargetrefwithkind) + * [`fn withName(name)`](#fn-spectargetrefwithname) + * [`fn withNamespace(namespace)`](#fn-spectargetrefwithnamespace) + * [`fn withSectionName(sectionName)`](#fn-spectargetrefwithsectionname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of BackendTrafficPolicy + +## 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 + +"spec defines the desired state of BackendTrafficPolicy." + +## obj spec.loadBalancer + +"LoadBalancer policy to apply when routing traffic from the gateway to the backend endpoints" + +### fn spec.loadBalancer.withType + +```ts +withType(type) +``` + +"Type decides the type of Load Balancer policy. Valid LoadBalancerType values are \"ConsistentHash\", \"LeastRequest\", \"Random\", \"RoundRobin\"," + +## obj spec.loadBalancer.consistentHash + +"ConsistentHash defines the configuration when the load balancer type is set to ConsistentHash" + +### fn spec.loadBalancer.consistentHash.withType + +```ts +withType(type) +``` + +"ConsistentHashType defines the type of input to hash on." + +## obj spec.rateLimit + +"RateLimit allows the user to limit the number of incoming requests to a predefined value based on attributes within the traffic flow." + +### fn spec.rateLimit.withType + +```ts +withType(type) +``` + +"Type decides the scope for the RateLimits. Valid RateLimitType values are \"Global\"." + +## obj spec.rateLimit.global + +"Global defines global rate limit configuration." + +### fn spec.rateLimit.global.withRules + +```ts +withRules(rules) +``` + +"Rules are a list of RateLimit selectors and limits. Each rule and its associated limit is applied in a mutually exclusive way i.e. if multiple rules get selected, each of their associated limits get applied, so a single traffic request might increase the rate limit counters for multiple rules if selected." + +### fn spec.rateLimit.global.withRulesMixin + +```ts +withRulesMixin(rules) +``` + +"Rules are a list of RateLimit selectors and limits. Each rule and its associated limit is applied in a mutually exclusive way i.e. if multiple rules get selected, each of their associated limits get applied, so a single traffic request might increase the rate limit counters for multiple rules if selected." + +**Note:** This function appends passed data to existing values + +## obj spec.rateLimit.global.rules + +"Rules are a list of RateLimit selectors and limits. Each rule and its associated limit is applied in a mutually exclusive way i.e. if multiple rules get selected, each of their associated limits get applied, so a single traffic request might increase the rate limit counters for multiple rules if selected." + +### fn spec.rateLimit.global.rules.withClientSelectors + +```ts +withClientSelectors(clientSelectors) +``` + +"ClientSelectors holds the list of select conditions to select specific clients using attributes from the traffic flow. All individual select conditions must hold True for this rule and its limit to be applied. If this field is empty, it is equivalent to True, and the limit is applied." + +### fn spec.rateLimit.global.rules.withClientSelectorsMixin + +```ts +withClientSelectorsMixin(clientSelectors) +``` + +"ClientSelectors holds the list of select conditions to select specific clients using attributes from the traffic flow. All individual select conditions must hold True for this rule and its limit to be applied. If this field is empty, it is equivalent to True, and the limit is applied." + +**Note:** This function appends passed data to existing values + +## obj spec.rateLimit.global.rules.clientSelectors + +"ClientSelectors holds the list of select conditions to select specific clients using attributes from the traffic flow. All individual select conditions must hold True for this rule and its limit to be applied. If this field is empty, it is equivalent to True, and the limit is applied." + +### fn spec.rateLimit.global.rules.clientSelectors.withHeaders + +```ts +withHeaders(headers) +``` + +"Headers is a list of request headers to match. Multiple header values are ANDed together, meaning, a request MUST match all the specified headers." + +### fn spec.rateLimit.global.rules.clientSelectors.withHeadersMixin + +```ts +withHeadersMixin(headers) +``` + +"Headers is a list of request headers to match. Multiple header values are ANDed together, meaning, a request MUST match all the specified headers." + +**Note:** This function appends passed data to existing values + +## obj spec.rateLimit.global.rules.clientSelectors.headers + +"Headers is a list of request headers to match. Multiple header values are ANDed together, meaning, a request MUST match all the specified headers." + +### fn spec.rateLimit.global.rules.clientSelectors.headers.withName + +```ts +withName(name) +``` + +"Name of the HTTP header." + +### fn spec.rateLimit.global.rules.clientSelectors.headers.withType + +```ts +withType(type) +``` + +"Type specifies how to match against the value of the header." + +### fn spec.rateLimit.global.rules.clientSelectors.headers.withValue + +```ts +withValue(value) +``` + +"Value within the HTTP header. Due to the case-insensitivity of header names, \"foo\" and \"Foo\" are considered equivalent. Do not set this field when Type=\"Distinct\", implying matching on any/all unique values within the header." + +## obj spec.rateLimit.global.rules.clientSelectors.sourceCIDR + +"SourceCIDR is the client IP Address range to match on." + +### fn spec.rateLimit.global.rules.clientSelectors.sourceCIDR.withType + +```ts +withType(type) +``` + + + +### fn spec.rateLimit.global.rules.clientSelectors.sourceCIDR.withValue + +```ts +withValue(value) +``` + +"Value is the IP CIDR that represents the range of Source IP Addresses of the client. These could also be the intermediate addresses through which the request has flown through and is part of the `X-Forwarded-For` header. For example, `192.168.0.1/32`, `192.168.0.0/24`, `001:db8::/64`." + +## obj spec.rateLimit.global.rules.limit + +"Limit holds the rate limit values. This limit is applied for traffic flows when the selectors compute to True, causing the request to be counted towards the limit. The limit is enforced and the request is ratelimited, i.e. a response with 429 HTTP status code is sent back to the client when the selected requests have reached the limit." + +### fn spec.rateLimit.global.rules.limit.withRequests + +```ts +withRequests(requests) +``` + + + +### fn spec.rateLimit.global.rules.limit.withUnit + +```ts +withUnit(unit) +``` + +"RateLimitUnit specifies the intervals for setting rate limits. Valid RateLimitUnit values are \"Second\", \"Minute\", \"Hour\", and \"Day\"." + +## obj spec.targetRef + +"targetRef is the name of the resource this policy is being attached to. This Policy and the TargetRef MUST be in the same namespace for this Policy to have effect and be applied to the Gateway." + +### fn spec.targetRef.withGroup + +```ts +withGroup(group) +``` + +"Group is the group of the target resource." + +### fn spec.targetRef.withKind + +```ts +withKind(kind) +``` + +"Kind is kind of the target resource." + +### fn spec.targetRef.withName + +```ts +withName(name) +``` + +"Name is the name of the target resource." + +### fn spec.targetRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of the referent. When unspecified, the local namespace is inferred. Even when policy targets a resource in a different namespace, it MUST only apply to traffic originating from the same namespace as the policy." + +### fn spec.targetRef.withSectionName + +```ts +withSectionName(sectionName) +``` + +"SectionName is the name of a section within the target resource. When unspecified, this targetRef targets the entire resource. In the following resources, SectionName is interpreted as the following: \n * Gateway: Listener Name * Service: Port Name \n If a SectionName is specified, but does not exist on the targeted object, the Policy must fail to attach, and the policy implementation should record a `ResolvedRefs` or similar Condition in the Policy's status." \ No newline at end of file diff --git a/docs/v0.6.0/gateway/v1alpha1/clientTrafficPolicy.md b/docs/v0.6.0/gateway/v1alpha1/clientTrafficPolicy.md new file mode 100644 index 0000000..1874f20 --- /dev/null +++ b/docs/v0.6.0/gateway/v1alpha1/clientTrafficPolicy.md @@ -0,0 +1,292 @@ +--- +permalink: /v0.6.0/gateway/v1alpha1/clientTrafficPolicy/ +--- + +# gateway.v1alpha1.clientTrafficPolicy + +"ClientTrafficPolicy allows the user to configure the behavior of the connection between the downstream client and Envoy Proxy listener." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`obj spec.targetRef`](#obj-spectargetref) + * [`fn withGroup(group)`](#fn-spectargetrefwithgroup) + * [`fn withKind(kind)`](#fn-spectargetrefwithkind) + * [`fn withName(name)`](#fn-spectargetrefwithname) + * [`fn withNamespace(namespace)`](#fn-spectargetrefwithnamespace) + * [`fn withSectionName(sectionName)`](#fn-spectargetrefwithsectionname) + * [`obj spec.tcpKeepalive`](#obj-spectcpkeepalive) + * [`fn withIdleTime(idleTime)`](#fn-spectcpkeepalivewithidletime) + * [`fn withInterval(interval)`](#fn-spectcpkeepalivewithinterval) + * [`fn withProbes(probes)`](#fn-spectcpkeepalivewithprobes) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ClientTrafficPolicy + +## 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 + +"Spec defines the desired state of ClientTrafficPolicy." + +## obj spec.targetRef + +"TargetRef is the name of the Gateway resource this policy is being attached to. This Policy and the TargetRef MUST be in the same namespace for this Policy to have effect and be applied to the Gateway. TargetRef" + +### fn spec.targetRef.withGroup + +```ts +withGroup(group) +``` + +"Group is the group of the target resource." + +### fn spec.targetRef.withKind + +```ts +withKind(kind) +``` + +"Kind is kind of the target resource." + +### fn spec.targetRef.withName + +```ts +withName(name) +``` + +"Name is the name of the target resource." + +### fn spec.targetRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of the referent. When unspecified, the local namespace is inferred. Even when policy targets a resource in a different namespace, it MUST only apply to traffic originating from the same namespace as the policy." + +### fn spec.targetRef.withSectionName + +```ts +withSectionName(sectionName) +``` + +"SectionName is the name of a section within the target resource. When unspecified, this targetRef targets the entire resource. In the following resources, SectionName is interpreted as the following: \n * Gateway: Listener Name * Service: Port Name \n If a SectionName is specified, but does not exist on the targeted object, the Policy must fail to attach, and the policy implementation should record a `ResolvedRefs` or similar Condition in the Policy's status." + +## obj spec.tcpKeepalive + +"TcpKeepalive settings associated with the downstream client connection. If defined, sets SO_KEEPALIVE on the listener socket to enable TCP Keepalives. Disabled by default." + +### fn spec.tcpKeepalive.withIdleTime + +```ts +withIdleTime(idleTime) +``` + +"The duration a connection needs to be idle before keep-alive probes start being sent. The duration format is Defaults to `7200s`." + +### fn spec.tcpKeepalive.withInterval + +```ts +withInterval(interval) +``` + +"The duration between keep-alive probes. Defaults to `75s`." + +### fn spec.tcpKeepalive.withProbes + +```ts +withProbes(probes) +``` + +"The total number of unacknowledged probes to send before deciding the connection is dead. Defaults to 9." \ No newline at end of file diff --git a/docs/v0.6.0/gateway/v1alpha1/envoyPatchPolicy.md b/docs/v0.6.0/gateway/v1alpha1/envoyPatchPolicy.md new file mode 100644 index 0000000..55522f0 --- /dev/null +++ b/docs/v0.6.0/gateway/v1alpha1/envoyPatchPolicy.md @@ -0,0 +1,344 @@ +--- +permalink: /v0.6.0/gateway/v1alpha1/envoyPatchPolicy/ +--- + +# gateway.v1alpha1.envoyPatchPolicy + +"EnvoyPatchPolicy allows the user to modify the generated Envoy xDS resources by Envoy Gateway using this patch API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withJsonPatches(jsonPatches)`](#fn-specwithjsonpatches) + * [`fn withJsonPatchesMixin(jsonPatches)`](#fn-specwithjsonpatchesmixin) + * [`fn withPriority(priority)`](#fn-specwithpriority) + * [`fn withType(type)`](#fn-specwithtype) + * [`obj spec.jsonPatches`](#obj-specjsonpatches) + * [`fn withName(name)`](#fn-specjsonpatcheswithname) + * [`fn withType(type)`](#fn-specjsonpatcheswithtype) + * [`obj spec.jsonPatches.operation`](#obj-specjsonpatchesoperation) + * [`fn withOp(op)`](#fn-specjsonpatchesoperationwithop) + * [`fn withPath(path)`](#fn-specjsonpatchesoperationwithpath) + * [`fn withValue(value)`](#fn-specjsonpatchesoperationwithvalue) + * [`obj spec.targetRef`](#obj-spectargetref) + * [`fn withGroup(group)`](#fn-spectargetrefwithgroup) + * [`fn withKind(kind)`](#fn-spectargetrefwithkind) + * [`fn withName(name)`](#fn-spectargetrefwithname) + * [`fn withNamespace(namespace)`](#fn-spectargetrefwithnamespace) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of EnvoyPatchPolicy + +## 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 + +"Spec defines the desired state of EnvoyPatchPolicy." + +### fn spec.withJsonPatches + +```ts +withJsonPatches(jsonPatches) +``` + +"JSONPatch defines the JSONPatch configuration." + +### fn spec.withJsonPatchesMixin + +```ts +withJsonPatchesMixin(jsonPatches) +``` + +"JSONPatch defines the JSONPatch configuration." + +**Note:** This function appends passed data to existing values + +### fn spec.withPriority + +```ts +withPriority(priority) +``` + +"Priority of the EnvoyPatchPolicy. If multiple EnvoyPatchPolicies are applied to the same TargetRef, they will be applied in the ascending order of the priority i.e. int32.min has the highest priority and int32.max has the lowest priority. Defaults to 0." + +### fn spec.withType + +```ts +withType(type) +``` + +"Type decides the type of patch. Valid EnvoyPatchType values are \"JSONPatch\"." + +## obj spec.jsonPatches + +"JSONPatch defines the JSONPatch configuration." + +### fn spec.jsonPatches.withName + +```ts +withName(name) +``` + +"Name is the name of the resource" + +### fn spec.jsonPatches.withType + +```ts +withType(type) +``` + +"Type is the typed URL of the Envoy xDS Resource" + +## obj spec.jsonPatches.operation + +"Patch defines the JSON Patch Operation" + +### fn spec.jsonPatches.operation.withOp + +```ts +withOp(op) +``` + +"Op is the type of operation to perform" + +### fn spec.jsonPatches.operation.withPath + +```ts +withPath(path) +``` + +"Path is the location of the target document/field where the operation will be performed Refer to https://datatracker.ietf.org/doc/html/rfc6901 for more details." + +### fn spec.jsonPatches.operation.withValue + +```ts +withValue(value) +``` + +"Value is the new value of the path location." + +## obj spec.targetRef + +"TargetRef is the name of the Gateway API resource this policy is being attached to. Currently only attaching to Gateway is supported This Policy and the TargetRef MUST be in the same namespace for this Policy to have effect and be applied to the Gateway TargetRef" + +### fn spec.targetRef.withGroup + +```ts +withGroup(group) +``` + +"Group is the group of the target resource." + +### fn spec.targetRef.withKind + +```ts +withKind(kind) +``` + +"Kind is kind of the target resource." + +### fn spec.targetRef.withName + +```ts +withName(name) +``` + +"Name is the name of the target resource." + +### fn spec.targetRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of the referent. When unspecified, the local namespace is inferred. Even when policy targets a resource in a different namespace, it MUST only apply to traffic originating from the same namespace as the policy." \ No newline at end of file diff --git a/docs/v0.6.0/gateway/v1alpha1/envoyProxy.md b/docs/v0.6.0/gateway/v1alpha1/envoyProxy.md new file mode 100644 index 0000000..b69c39c --- /dev/null +++ b/docs/v0.6.0/gateway/v1alpha1/envoyProxy.md @@ -0,0 +1,6982 @@ +--- +permalink: /v0.6.0/gateway/v1alpha1/envoyProxy/ +--- + +# gateway.v1alpha1.envoyProxy + +"EnvoyProxy is the schema for the envoyproxies API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withConcurrency(concurrency)`](#fn-specwithconcurrency) + * [`fn withMergeGateways(mergeGateways)`](#fn-specwithmergegateways) + * [`obj spec.bootstrap`](#obj-specbootstrap) + * [`fn withType(type)`](#fn-specbootstrapwithtype) + * [`fn withValue(value)`](#fn-specbootstrapwithvalue) + * [`obj spec.logging`](#obj-speclogging) + * [`fn withLevel(level)`](#fn-specloggingwithlevel) + * [`fn withLevelMixin(level)`](#fn-specloggingwithlevelmixin) + * [`obj spec.provider`](#obj-specprovider) + * [`fn withType(type)`](#fn-specproviderwithtype) + * [`obj spec.provider.kubernetes`](#obj-specproviderkubernetes) + * [`obj spec.provider.kubernetes.envoyDeployment`](#obj-specproviderkubernetesenvoydeployment) + * [`fn withInitContainers(initContainers)`](#fn-specproviderkubernetesenvoydeploymentwithinitcontainers) + * [`fn withInitContainersMixin(initContainers)`](#fn-specproviderkubernetesenvoydeploymentwithinitcontainersmixin) + * [`fn withReplicas(replicas)`](#fn-specproviderkubernetesenvoydeploymentwithreplicas) + * [`obj spec.provider.kubernetes.envoyDeployment.container`](#obj-specproviderkubernetesenvoydeploymentcontainer) + * [`fn withEnv(env)`](#fn-specproviderkubernetesenvoydeploymentcontainerwithenv) + * [`fn withEnvMixin(env)`](#fn-specproviderkubernetesenvoydeploymentcontainerwithenvmixin) + * [`fn withImage(image)`](#fn-specproviderkubernetesenvoydeploymentcontainerwithimage) + * [`fn withVolumeMounts(volumeMounts)`](#fn-specproviderkubernetesenvoydeploymentcontainerwithvolumemounts) + * [`fn withVolumeMountsMixin(volumeMounts)`](#fn-specproviderkubernetesenvoydeploymentcontainerwithvolumemountsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.container.env`](#obj-specproviderkubernetesenvoydeploymentcontainerenv) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentcontainerenvwithname) + * [`fn withValue(value)`](#fn-specproviderkubernetesenvoydeploymentcontainerenvwithvalue) + * [`obj spec.provider.kubernetes.envoyDeployment.container.env.valueFrom`](#obj-specproviderkubernetesenvoydeploymentcontainerenvvaluefrom) + * [`obj spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.configMapKeyRef`](#obj-specproviderkubernetesenvoydeploymentcontainerenvvaluefromconfigmapkeyref) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentcontainerenvvaluefromconfigmapkeyrefwithkey) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentcontainerenvvaluefromconfigmapkeyrefwithname) + * [`fn withOptional(optional)`](#fn-specproviderkubernetesenvoydeploymentcontainerenvvaluefromconfigmapkeyrefwithoptional) + * [`obj spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.fieldRef`](#obj-specproviderkubernetesenvoydeploymentcontainerenvvaluefromfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specproviderkubernetesenvoydeploymentcontainerenvvaluefromfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specproviderkubernetesenvoydeploymentcontainerenvvaluefromfieldrefwithfieldpath) + * [`obj spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.resourceFieldRef`](#obj-specproviderkubernetesenvoydeploymentcontainerenvvaluefromresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specproviderkubernetesenvoydeploymentcontainerenvvaluefromresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specproviderkubernetesenvoydeploymentcontainerenvvaluefromresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specproviderkubernetesenvoydeploymentcontainerenvvaluefromresourcefieldrefwithresource) + * [`obj spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.secretKeyRef`](#obj-specproviderkubernetesenvoydeploymentcontainerenvvaluefromsecretkeyref) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentcontainerenvvaluefromsecretkeyrefwithkey) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentcontainerenvvaluefromsecretkeyrefwithname) + * [`fn withOptional(optional)`](#fn-specproviderkubernetesenvoydeploymentcontainerenvvaluefromsecretkeyrefwithoptional) + * [`obj spec.provider.kubernetes.envoyDeployment.container.resources`](#obj-specproviderkubernetesenvoydeploymentcontainerresources) + * [`fn withClaims(claims)`](#fn-specproviderkubernetesenvoydeploymentcontainerresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-specproviderkubernetesenvoydeploymentcontainerresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-specproviderkubernetesenvoydeploymentcontainerresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specproviderkubernetesenvoydeploymentcontainerresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specproviderkubernetesenvoydeploymentcontainerresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specproviderkubernetesenvoydeploymentcontainerresourceswithrequestsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.container.resources.claims`](#obj-specproviderkubernetesenvoydeploymentcontainerresourcesclaims) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentcontainerresourcesclaimswithname) + * [`obj spec.provider.kubernetes.envoyDeployment.container.securityContext`](#obj-specproviderkubernetesenvoydeploymentcontainersecuritycontext) + * [`fn withAllowPrivilegeEscalation(allowPrivilegeEscalation)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextwithallowprivilegeescalation) + * [`fn withPrivileged(privileged)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextwithprivileged) + * [`fn withProcMount(procMount)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextwithprocmount) + * [`fn withReadOnlyRootFilesystem(readOnlyRootFilesystem)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextwithreadonlyrootfilesystem) + * [`fn withRunAsGroup(runAsGroup)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextwithrunasgroup) + * [`fn withRunAsNonRoot(runAsNonRoot)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextwithrunasnonroot) + * [`fn withRunAsUser(runAsUser)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextwithrunasuser) + * [`obj spec.provider.kubernetes.envoyDeployment.container.securityContext.capabilities`](#obj-specproviderkubernetesenvoydeploymentcontainersecuritycontextcapabilities) + * [`fn withAdd(add)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextcapabilitieswithadd) + * [`fn withAddMixin(add)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextcapabilitieswithaddmixin) + * [`fn withDrop(drop)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextcapabilitieswithdrop) + * [`fn withDropMixin(drop)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextcapabilitieswithdropmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.container.securityContext.seLinuxOptions`](#obj-specproviderkubernetesenvoydeploymentcontainersecuritycontextselinuxoptions) + * [`fn withLevel(level)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextselinuxoptionswithlevel) + * [`fn withRole(role)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextselinuxoptionswithrole) + * [`fn withType(type)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextselinuxoptionswithtype) + * [`fn withUser(user)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextselinuxoptionswithuser) + * [`obj spec.provider.kubernetes.envoyDeployment.container.securityContext.seccompProfile`](#obj-specproviderkubernetesenvoydeploymentcontainersecuritycontextseccompprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextseccompprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextseccompprofilewithtype) + * [`obj spec.provider.kubernetes.envoyDeployment.container.securityContext.windowsOptions`](#obj-specproviderkubernetesenvoydeploymentcontainersecuritycontextwindowsoptions) + * [`fn withGmsaCredentialSpec(gmsaCredentialSpec)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextwindowsoptionswithgmsacredentialspec) + * [`fn withGmsaCredentialSpecName(gmsaCredentialSpecName)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextwindowsoptionswithgmsacredentialspecname) + * [`fn withHostProcess(hostProcess)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextwindowsoptionswithhostprocess) + * [`fn withRunAsUserName(runAsUserName)`](#fn-specproviderkubernetesenvoydeploymentcontainersecuritycontextwindowsoptionswithrunasusername) + * [`obj spec.provider.kubernetes.envoyDeployment.container.volumeMounts`](#obj-specproviderkubernetesenvoydeploymentcontainervolumemounts) + * [`fn withMountPath(mountPath)`](#fn-specproviderkubernetesenvoydeploymentcontainervolumemountswithmountpath) + * [`fn withMountPropagation(mountPropagation)`](#fn-specproviderkubernetesenvoydeploymentcontainervolumemountswithmountpropagation) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentcontainervolumemountswithname) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentcontainervolumemountswithreadonly) + * [`fn withSubPath(subPath)`](#fn-specproviderkubernetesenvoydeploymentcontainervolumemountswithsubpath) + * [`fn withSubPathExpr(subPathExpr)`](#fn-specproviderkubernetesenvoydeploymentcontainervolumemountswithsubpathexpr) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers`](#obj-specproviderkubernetesenvoydeploymentinitcontainers) + * [`fn withArgs(args)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithargs) + * [`fn withArgsMixin(args)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithargsmixin) + * [`fn withCommand(command)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithcommand) + * [`fn withCommandMixin(command)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithcommandmixin) + * [`fn withEnv(env)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithenv) + * [`fn withEnvFrom(envFrom)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithenvfrom) + * [`fn withEnvFromMixin(envFrom)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithenvfrommixin) + * [`fn withEnvMixin(env)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithenvmixin) + * [`fn withImage(image)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithimage) + * [`fn withImagePullPolicy(imagePullPolicy)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithimagepullpolicy) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithname) + * [`fn withPorts(ports)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithports) + * [`fn withPortsMixin(ports)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithportsmixin) + * [`fn withResizePolicy(resizePolicy)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithresizepolicy) + * [`fn withResizePolicyMixin(resizePolicy)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithresizepolicymixin) + * [`fn withRestartPolicy(restartPolicy)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithrestartpolicy) + * [`fn withStdin(stdin)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithstdin) + * [`fn withStdinOnce(stdinOnce)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithstdinonce) + * [`fn withTerminationMessagePath(terminationMessagePath)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithterminationmessagepath) + * [`fn withTerminationMessagePolicy(terminationMessagePolicy)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithterminationmessagepolicy) + * [`fn withTty(tty)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithtty) + * [`fn withVolumeDevices(volumeDevices)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithvolumedevices) + * [`fn withVolumeDevicesMixin(volumeDevices)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithvolumedevicesmixin) + * [`fn withVolumeMounts(volumeMounts)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithvolumemounts) + * [`fn withVolumeMountsMixin(volumeMounts)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithvolumemountsmixin) + * [`fn withWorkingDir(workingDir)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerswithworkingdir) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.env`](#obj-specproviderkubernetesenvoydeploymentinitcontainersenv) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvwithname) + * [`fn withValue(value)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvwithvalue) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom`](#obj-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefrom) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.configMapKeyRef`](#obj-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefromconfigmapkeyref) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefromconfigmapkeyrefwithkey) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefromconfigmapkeyrefwithname) + * [`fn withOptional(optional)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefromconfigmapkeyrefwithoptional) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.fieldRef`](#obj-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefromfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefromfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefromfieldrefwithfieldpath) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.resourceFieldRef`](#obj-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefromresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefromresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefromresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefromresourcefieldrefwithresource) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.secretKeyRef`](#obj-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefromsecretkeyref) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefromsecretkeyrefwithkey) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefromsecretkeyrefwithname) + * [`fn withOptional(optional)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvvaluefromsecretkeyrefwithoptional) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.envFrom`](#obj-specproviderkubernetesenvoydeploymentinitcontainersenvfrom) + * [`fn withPrefix(prefix)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvfromwithprefix) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.envFrom.configMapRef`](#obj-specproviderkubernetesenvoydeploymentinitcontainersenvfromconfigmapref) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvfromconfigmaprefwithname) + * [`fn withOptional(optional)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvfromconfigmaprefwithoptional) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.envFrom.secretRef`](#obj-specproviderkubernetesenvoydeploymentinitcontainersenvfromsecretref) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvfromsecretrefwithname) + * [`fn withOptional(optional)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersenvfromsecretrefwithoptional) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslifecycle) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststart) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.exec`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststartexec) + * [`fn withCommand(command)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststartexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststartexecwithcommandmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.httpGet`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststarthttpget) + * [`fn withHost(host)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststarthttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststarthttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststarthttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststarthttpgetwithpath) + * [`fn withPort(port)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststarthttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststarthttpgetwithscheme) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.httpGet.httpHeaders`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststarthttpgethttpheaders) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststarthttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststarthttpgethttpheaderswithvalue) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.tcpSocket`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststarttcpsocket) + * [`fn withHost(host)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststarttcpsocketwithhost) + * [`fn withPort(port)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecyclepoststarttcpsocketwithport) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestop) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.exec`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestopexec) + * [`fn withCommand(command)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestopexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestopexecwithcommandmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.httpGet`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestophttpget) + * [`fn withHost(host)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestophttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestophttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestophttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestophttpgetwithpath) + * [`fn withPort(port)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestophttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestophttpgetwithscheme) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.httpGet.httpHeaders`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestophttpgethttpheaders) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestophttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestophttpgethttpheaderswithvalue) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.tcpSocket`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestoptcpsocket) + * [`fn withHost(host)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestoptcpsocketwithhost) + * [`fn withPort(port)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslifecycleprestoptcpsocketwithport) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobewithtimeoutseconds) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.exec`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobeexec) + * [`fn withCommand(command)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobeexecwithcommandmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.grpc`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobegrpc) + * [`fn withPort(port)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobegrpcwithport) + * [`fn withService(service)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobegrpcwithservice) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.httpGet`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobehttpget) + * [`fn withHost(host)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobehttpgetwithscheme) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.httpGet.httpHeaders`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobehttpgethttpheaderswithvalue) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.tcpSocket`](#obj-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobetcpsocket) + * [`fn withHost(host)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerslivenessprobetcpsocketwithport) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.ports`](#obj-specproviderkubernetesenvoydeploymentinitcontainersports) + * [`fn withContainerPort(containerPort)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersportswithcontainerport) + * [`fn withHostIP(hostIP)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersportswithhostip) + * [`fn withHostPort(hostPort)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersportswithhostport) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersportswithname) + * [`fn withProtocol(protocol)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersportswithprotocol) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe`](#obj-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobewithtimeoutseconds) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.exec`](#obj-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobeexec) + * [`fn withCommand(command)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobeexecwithcommandmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.grpc`](#obj-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobegrpc) + * [`fn withPort(port)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobegrpcwithport) + * [`fn withService(service)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobegrpcwithservice) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.httpGet`](#obj-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobehttpget) + * [`fn withHost(host)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobehttpgetwithscheme) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.httpGet.httpHeaders`](#obj-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobehttpgethttpheaderswithvalue) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.tcpSocket`](#obj-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobetcpsocket) + * [`fn withHost(host)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersreadinessprobetcpsocketwithport) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.resizePolicy`](#obj-specproviderkubernetesenvoydeploymentinitcontainersresizepolicy) + * [`fn withResourceName(resourceName)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersresizepolicywithresourcename) + * [`fn withRestartPolicy(restartPolicy)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersresizepolicywithrestartpolicy) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.resources`](#obj-specproviderkubernetesenvoydeploymentinitcontainersresources) + * [`fn withClaims(claims)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersresourceswithrequestsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.resources.claims`](#obj-specproviderkubernetesenvoydeploymentinitcontainersresourcesclaims) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersresourcesclaimswithname) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.securityContext`](#obj-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontext) + * [`fn withAllowPrivilegeEscalation(allowPrivilegeEscalation)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextwithallowprivilegeescalation) + * [`fn withPrivileged(privileged)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextwithprivileged) + * [`fn withProcMount(procMount)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextwithprocmount) + * [`fn withReadOnlyRootFilesystem(readOnlyRootFilesystem)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextwithreadonlyrootfilesystem) + * [`fn withRunAsGroup(runAsGroup)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextwithrunasgroup) + * [`fn withRunAsNonRoot(runAsNonRoot)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextwithrunasnonroot) + * [`fn withRunAsUser(runAsUser)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextwithrunasuser) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.capabilities`](#obj-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextcapabilities) + * [`fn withAdd(add)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextcapabilitieswithadd) + * [`fn withAddMixin(add)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextcapabilitieswithaddmixin) + * [`fn withDrop(drop)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextcapabilitieswithdrop) + * [`fn withDropMixin(drop)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextcapabilitieswithdropmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.seLinuxOptions`](#obj-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextselinuxoptions) + * [`fn withLevel(level)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextselinuxoptionswithlevel) + * [`fn withRole(role)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextselinuxoptionswithrole) + * [`fn withType(type)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextselinuxoptionswithtype) + * [`fn withUser(user)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextselinuxoptionswithuser) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.seccompProfile`](#obj-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextseccompprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextseccompprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextseccompprofilewithtype) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.windowsOptions`](#obj-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextwindowsoptions) + * [`fn withGmsaCredentialSpec(gmsaCredentialSpec)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextwindowsoptionswithgmsacredentialspec) + * [`fn withGmsaCredentialSpecName(gmsaCredentialSpecName)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextwindowsoptionswithgmsacredentialspecname) + * [`fn withHostProcess(hostProcess)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextwindowsoptionswithhostprocess) + * [`fn withRunAsUserName(runAsUserName)`](#fn-specproviderkubernetesenvoydeploymentinitcontainerssecuritycontextwindowsoptionswithrunasusername) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe`](#obj-specproviderkubernetesenvoydeploymentinitcontainersstartupprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobewithtimeoutseconds) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.exec`](#obj-specproviderkubernetesenvoydeploymentinitcontainersstartupprobeexec) + * [`fn withCommand(command)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobeexecwithcommandmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.grpc`](#obj-specproviderkubernetesenvoydeploymentinitcontainersstartupprobegrpc) + * [`fn withPort(port)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobegrpcwithport) + * [`fn withService(service)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobegrpcwithservice) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.httpGet`](#obj-specproviderkubernetesenvoydeploymentinitcontainersstartupprobehttpget) + * [`fn withHost(host)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobehttpgetwithscheme) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.httpGet.httpHeaders`](#obj-specproviderkubernetesenvoydeploymentinitcontainersstartupprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobehttpgethttpheaderswithvalue) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.tcpSocket`](#obj-specproviderkubernetesenvoydeploymentinitcontainersstartupprobetcpsocket) + * [`fn withHost(host)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersstartupprobetcpsocketwithport) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.volumeDevices`](#obj-specproviderkubernetesenvoydeploymentinitcontainersvolumedevices) + * [`fn withDevicePath(devicePath)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersvolumedeviceswithdevicepath) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersvolumedeviceswithname) + * [`obj spec.provider.kubernetes.envoyDeployment.initContainers.volumeMounts`](#obj-specproviderkubernetesenvoydeploymentinitcontainersvolumemounts) + * [`fn withMountPath(mountPath)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersvolumemountswithmountpath) + * [`fn withMountPropagation(mountPropagation)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersvolumemountswithmountpropagation) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersvolumemountswithname) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersvolumemountswithreadonly) + * [`fn withSubPath(subPath)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersvolumemountswithsubpath) + * [`fn withSubPathExpr(subPathExpr)`](#fn-specproviderkubernetesenvoydeploymentinitcontainersvolumemountswithsubpathexpr) + * [`obj spec.provider.kubernetes.envoyDeployment.pod`](#obj-specproviderkubernetesenvoydeploymentpod) + * [`fn withAnnotations(annotations)`](#fn-specproviderkubernetesenvoydeploymentpodwithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-specproviderkubernetesenvoydeploymentpodwithannotationsmixin) + * [`fn withLabels(labels)`](#fn-specproviderkubernetesenvoydeploymentpodwithlabels) + * [`fn withLabelsMixin(labels)`](#fn-specproviderkubernetesenvoydeploymentpodwithlabelsmixin) + * [`fn withTolerations(tolerations)`](#fn-specproviderkubernetesenvoydeploymentpodwithtolerations) + * [`fn withTolerationsMixin(tolerations)`](#fn-specproviderkubernetesenvoydeploymentpodwithtolerationsmixin) + * [`fn withVolumes(volumes)`](#fn-specproviderkubernetesenvoydeploymentpodwithvolumes) + * [`fn withVolumesMixin(volumes)`](#fn-specproviderkubernetesenvoydeploymentpodwithvolumesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity`](#obj-specproviderkubernetesenvoydeploymentpodaffinity) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity`](#obj-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinity) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitywithpreferredduringschedulingignoredduringexecution) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitywithpreferredduringschedulingignoredduringexecutionmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution`](#obj-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecution) + * [`fn withWeight(weight)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionwithweight) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference`](#obj-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreference) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchexpressionsmixin) + * [`fn withMatchFields(matchFields)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchfields) + * [`fn withMatchFieldsMixin(matchFields)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchfieldsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions`](#obj-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressions) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithvaluesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields`](#obj-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfields) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithkey) + * [`fn withOperator(operator)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithoperator) + * [`fn withValues(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithvalues) + * [`fn withValuesMixin(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithvaluesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution`](#obj-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecution) + * [`fn withNodeSelectorTerms(nodeSelectorTerms)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionwithnodeselectorterms) + * [`fn withNodeSelectorTermsMixin(nodeSelectorTerms)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionwithnodeselectortermsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms`](#obj-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectorterms) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchexpressionsmixin) + * [`fn withMatchFields(matchFields)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchfields) + * [`fn withMatchFieldsMixin(matchFields)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchfieldsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions`](#obj-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressions) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithvaluesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields`](#obj-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfields) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithkey) + * [`fn withOperator(operator)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithoperator) + * [`fn withValues(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithvalues) + * [`fn withValuesMixin(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithvaluesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodaffinity) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitywithpreferredduringschedulingignoredduringexecution) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitywithpreferredduringschedulingignoredduringexecutionmixin) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitywithrequiredduringschedulingignoredduringexecution) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitywithrequiredduringschedulingignoredduringexecutionmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecution) + * [`fn withWeight(weight)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionwithweight) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm) + * [`fn withNamespaces(namespaces)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithtopologykey) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabelsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecution) + * [`fn withNamespaces(namespaces)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithtopologykey) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabelsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinity) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitywithpreferredduringschedulingignoredduringexecution) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitywithpreferredduringschedulingignoredduringexecutionmixin) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitywithrequiredduringschedulingignoredduringexecution) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitywithrequiredduringschedulingignoredduringexecutionmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecution) + * [`fn withWeight(weight)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionwithweight) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm) + * [`fn withNamespaces(namespaces)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithtopologykey) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabelsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecution) + * [`fn withNamespaces(namespaces)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithtopologykey) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabelsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions`](#obj-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specproviderkubernetesenvoydeploymentpodaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.securityContext`](#obj-specproviderkubernetesenvoydeploymentpodsecuritycontext) + * [`fn withFsGroup(fsGroup)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextwithfsgroup) + * [`fn withFsGroupChangePolicy(fsGroupChangePolicy)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextwithfsgroupchangepolicy) + * [`fn withRunAsGroup(runAsGroup)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextwithrunasgroup) + * [`fn withRunAsNonRoot(runAsNonRoot)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextwithrunasnonroot) + * [`fn withRunAsUser(runAsUser)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextwithrunasuser) + * [`fn withSupplementalGroups(supplementalGroups)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextwithsupplementalgroups) + * [`fn withSupplementalGroupsMixin(supplementalGroups)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextwithsupplementalgroupsmixin) + * [`fn withSysctls(sysctls)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextwithsysctls) + * [`fn withSysctlsMixin(sysctls)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextwithsysctlsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.securityContext.seLinuxOptions`](#obj-specproviderkubernetesenvoydeploymentpodsecuritycontextselinuxoptions) + * [`fn withLevel(level)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextselinuxoptionswithlevel) + * [`fn withRole(role)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextselinuxoptionswithrole) + * [`fn withType(type)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextselinuxoptionswithtype) + * [`fn withUser(user)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextselinuxoptionswithuser) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.securityContext.seccompProfile`](#obj-specproviderkubernetesenvoydeploymentpodsecuritycontextseccompprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextseccompprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextseccompprofilewithtype) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.securityContext.sysctls`](#obj-specproviderkubernetesenvoydeploymentpodsecuritycontextsysctls) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextsysctlswithname) + * [`fn withValue(value)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextsysctlswithvalue) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.securityContext.windowsOptions`](#obj-specproviderkubernetesenvoydeploymentpodsecuritycontextwindowsoptions) + * [`fn withGmsaCredentialSpec(gmsaCredentialSpec)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextwindowsoptionswithgmsacredentialspec) + * [`fn withGmsaCredentialSpecName(gmsaCredentialSpecName)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextwindowsoptionswithgmsacredentialspecname) + * [`fn withHostProcess(hostProcess)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextwindowsoptionswithhostprocess) + * [`fn withRunAsUserName(runAsUserName)`](#fn-specproviderkubernetesenvoydeploymentpodsecuritycontextwindowsoptionswithrunasusername) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.tolerations`](#obj-specproviderkubernetesenvoydeploymentpodtolerations) + * [`fn withEffect(effect)`](#fn-specproviderkubernetesenvoydeploymentpodtolerationswitheffect) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodtolerationswithkey) + * [`fn withOperator(operator)`](#fn-specproviderkubernetesenvoydeploymentpodtolerationswithoperator) + * [`fn withTolerationSeconds(tolerationSeconds)`](#fn-specproviderkubernetesenvoydeploymentpodtolerationswithtolerationseconds) + * [`fn withValue(value)`](#fn-specproviderkubernetesenvoydeploymentpodtolerationswithvalue) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes`](#obj-specproviderkubernetesenvoydeploymentpodvolumes) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodvolumeswithname) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.awsElasticBlockStore`](#obj-specproviderkubernetesenvoydeploymentpodvolumesawselasticblockstore) + * [`fn withFsType(fsType)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesawselasticblockstorewithfstype) + * [`fn withPartition(partition)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesawselasticblockstorewithpartition) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesawselasticblockstorewithreadonly) + * [`fn withVolumeID(volumeID)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesawselasticblockstorewithvolumeid) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.azureDisk`](#obj-specproviderkubernetesenvoydeploymentpodvolumesazuredisk) + * [`fn withCachingMode(cachingMode)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesazurediskwithcachingmode) + * [`fn withDiskName(diskName)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesazurediskwithdiskname) + * [`fn withDiskURI(diskURI)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesazurediskwithdiskuri) + * [`fn withFsType(fsType)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesazurediskwithfstype) + * [`fn withKind(kind)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesazurediskwithkind) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesazurediskwithreadonly) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.azureFile`](#obj-specproviderkubernetesenvoydeploymentpodvolumesazurefile) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesazurefilewithreadonly) + * [`fn withSecretName(secretName)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesazurefilewithsecretname) + * [`fn withShareName(shareName)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesazurefilewithsharename) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.cephfs`](#obj-specproviderkubernetesenvoydeploymentpodvolumescephfs) + * [`fn withMonitors(monitors)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescephfswithmonitors) + * [`fn withMonitorsMixin(monitors)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescephfswithmonitorsmixin) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescephfswithpath) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescephfswithreadonly) + * [`fn withSecretFile(secretFile)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescephfswithsecretfile) + * [`fn withUser(user)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescephfswithuser) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.cephfs.secretRef`](#obj-specproviderkubernetesenvoydeploymentpodvolumescephfssecretref) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescephfssecretrefwithname) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.cinder`](#obj-specproviderkubernetesenvoydeploymentpodvolumescinder) + * [`fn withFsType(fsType)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescinderwithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescinderwithreadonly) + * [`fn withVolumeID(volumeID)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescinderwithvolumeid) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.cinder.secretRef`](#obj-specproviderkubernetesenvoydeploymentpodvolumescindersecretref) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescindersecretrefwithname) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.configMap`](#obj-specproviderkubernetesenvoydeploymentpodvolumesconfigmap) + * [`fn withDefaultMode(defaultMode)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesconfigmapwithdefaultmode) + * [`fn withItems(items)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesconfigmapwithitems) + * [`fn withItemsMixin(items)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesconfigmapwithitemsmixin) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesconfigmapwithoptional) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.configMap.items`](#obj-specproviderkubernetesenvoydeploymentpodvolumesconfigmapitems) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesconfigmapitemswithkey) + * [`fn withMode(mode)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesconfigmapitemswithmode) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesconfigmapitemswithpath) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.csi`](#obj-specproviderkubernetesenvoydeploymentpodvolumescsi) + * [`fn withDriver(driver)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescsiwithdriver) + * [`fn withFsType(fsType)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescsiwithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescsiwithreadonly) + * [`fn withVolumeAttributes(volumeAttributes)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescsiwithvolumeattributes) + * [`fn withVolumeAttributesMixin(volumeAttributes)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescsiwithvolumeattributesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.csi.nodePublishSecretRef`](#obj-specproviderkubernetesenvoydeploymentpodvolumescsinodepublishsecretref) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodvolumescsinodepublishsecretrefwithname) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI`](#obj-specproviderkubernetesenvoydeploymentpodvolumesdownwardapi) + * [`fn withDefaultMode(defaultMode)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesdownwardapiwithdefaultmode) + * [`fn withItems(items)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesdownwardapiwithitems) + * [`fn withItemsMixin(items)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesdownwardapiwithitemsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.items`](#obj-specproviderkubernetesenvoydeploymentpodvolumesdownwardapiitems) + * [`fn withMode(mode)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesdownwardapiitemswithmode) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesdownwardapiitemswithpath) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.items.fieldRef`](#obj-specproviderkubernetesenvoydeploymentpodvolumesdownwardapiitemsfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesdownwardapiitemsfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesdownwardapiitemsfieldrefwithfieldpath) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.items.resourceFieldRef`](#obj-specproviderkubernetesenvoydeploymentpodvolumesdownwardapiitemsresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesdownwardapiitemsresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesdownwardapiitemsresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesdownwardapiitemsresourcefieldrefwithresource) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.emptyDir`](#obj-specproviderkubernetesenvoydeploymentpodvolumesemptydir) + * [`fn withMedium(medium)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesemptydirwithmedium) + * [`fn withSizeLimit(sizeLimit)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesemptydirwithsizelimit) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral`](#obj-specproviderkubernetesenvoydeploymentpodvolumesephemeral) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate`](#obj-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplate) + * [`fn withMetadata(metadata)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatewithmetadata) + * [`fn withMetadataMixin(metadata)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatewithmetadatamixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec`](#obj-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespec) + * [`fn withAccessModes(accessModes)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecwithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecwithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecwithstorageclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecwithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecwithvolumename) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.dataSource`](#obj-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecdatasource) + * [`fn withApiGroup(apiGroup)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecdatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecdatasourcewithkind) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecdatasourcewithname) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef`](#obj-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecdatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithkind) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithnamespace) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.resources`](#obj-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecresources) + * [`fn withClaims(claims)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecresourceswithrequestsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.resources.claims`](#obj-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecresourcesclaims) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecresourcesclaimswithname) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.selector`](#obj-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecselectorwithmatchlabelsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions`](#obj-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecselectormatchexpressions) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithvaluesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.fc`](#obj-specproviderkubernetesenvoydeploymentpodvolumesfc) + * [`fn withFsType(fsType)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesfcwithfstype) + * [`fn withLun(lun)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesfcwithlun) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesfcwithreadonly) + * [`fn withTargetWWNs(targetWWNs)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesfcwithtargetwwns) + * [`fn withTargetWWNsMixin(targetWWNs)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesfcwithtargetwwnsmixin) + * [`fn withWwids(wwids)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesfcwithwwids) + * [`fn withWwidsMixin(wwids)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesfcwithwwidsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.flexVolume`](#obj-specproviderkubernetesenvoydeploymentpodvolumesflexvolume) + * [`fn withDriver(driver)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesflexvolumewithdriver) + * [`fn withFsType(fsType)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesflexvolumewithfstype) + * [`fn withOptions(options)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesflexvolumewithoptions) + * [`fn withOptionsMixin(options)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesflexvolumewithoptionsmixin) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesflexvolumewithreadonly) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.flexVolume.secretRef`](#obj-specproviderkubernetesenvoydeploymentpodvolumesflexvolumesecretref) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesflexvolumesecretrefwithname) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.flocker`](#obj-specproviderkubernetesenvoydeploymentpodvolumesflocker) + * [`fn withDatasetName(datasetName)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesflockerwithdatasetname) + * [`fn withDatasetUUID(datasetUUID)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesflockerwithdatasetuuid) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.gcePersistentDisk`](#obj-specproviderkubernetesenvoydeploymentpodvolumesgcepersistentdisk) + * [`fn withFsType(fsType)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesgcepersistentdiskwithfstype) + * [`fn withPartition(partition)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesgcepersistentdiskwithpartition) + * [`fn withPdName(pdName)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesgcepersistentdiskwithpdname) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesgcepersistentdiskwithreadonly) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.gitRepo`](#obj-specproviderkubernetesenvoydeploymentpodvolumesgitrepo) + * [`fn withDirectory(directory)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesgitrepowithdirectory) + * [`fn withRepository(repository)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesgitrepowithrepository) + * [`fn withRevision(revision)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesgitrepowithrevision) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.glusterfs`](#obj-specproviderkubernetesenvoydeploymentpodvolumesglusterfs) + * [`fn withEndpoints(endpoints)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesglusterfswithendpoints) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesglusterfswithpath) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesglusterfswithreadonly) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.hostPath`](#obj-specproviderkubernetesenvoydeploymentpodvolumeshostpath) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentpodvolumeshostpathwithpath) + * [`fn withType(type)`](#fn-specproviderkubernetesenvoydeploymentpodvolumeshostpathwithtype) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi`](#obj-specproviderkubernetesenvoydeploymentpodvolumesiscsi) + * [`fn withChapAuthDiscovery(chapAuthDiscovery)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesiscsiwithchapauthdiscovery) + * [`fn withChapAuthSession(chapAuthSession)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesiscsiwithchapauthsession) + * [`fn withFsType(fsType)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesiscsiwithfstype) + * [`fn withInitiatorName(initiatorName)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesiscsiwithinitiatorname) + * [`fn withIqn(iqn)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesiscsiwithiqn) + * [`fn withIscsiInterface(iscsiInterface)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesiscsiwithiscsiinterface) + * [`fn withLun(lun)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesiscsiwithlun) + * [`fn withPortals(portals)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesiscsiwithportals) + * [`fn withPortalsMixin(portals)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesiscsiwithportalsmixin) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesiscsiwithreadonly) + * [`fn withTargetPortal(targetPortal)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesiscsiwithtargetportal) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi.secretRef`](#obj-specproviderkubernetesenvoydeploymentpodvolumesiscsisecretref) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesiscsisecretrefwithname) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.nfs`](#obj-specproviderkubernetesenvoydeploymentpodvolumesnfs) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesnfswithpath) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesnfswithreadonly) + * [`fn withServer(server)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesnfswithserver) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.persistentVolumeClaim`](#obj-specproviderkubernetesenvoydeploymentpodvolumespersistentvolumeclaim) + * [`fn withClaimName(claimName)`](#fn-specproviderkubernetesenvoydeploymentpodvolumespersistentvolumeclaimwithclaimname) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumespersistentvolumeclaimwithreadonly) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.photonPersistentDisk`](#obj-specproviderkubernetesenvoydeploymentpodvolumesphotonpersistentdisk) + * [`fn withFsType(fsType)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesphotonpersistentdiskwithfstype) + * [`fn withPdID(pdID)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesphotonpersistentdiskwithpdid) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.portworxVolume`](#obj-specproviderkubernetesenvoydeploymentpodvolumesportworxvolume) + * [`fn withFsType(fsType)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesportworxvolumewithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesportworxvolumewithreadonly) + * [`fn withVolumeID(volumeID)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesportworxvolumewithvolumeid) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected`](#obj-specproviderkubernetesenvoydeploymentpodvolumesprojected) + * [`fn withDefaultMode(defaultMode)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedwithdefaultmode) + * [`fn withSources(sources)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedwithsources) + * [`fn withSourcesMixin(sources)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedwithsourcesmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources`](#obj-specproviderkubernetesenvoydeploymentpodvolumesprojectedsources) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.configMap`](#obj-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesconfigmap) + * [`fn withItems(items)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesconfigmapwithitems) + * [`fn withItemsMixin(items)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesconfigmapwithitemsmixin) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesconfigmapwithoptional) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.configMap.items`](#obj-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesconfigmapitems) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesconfigmapitemswithkey) + * [`fn withMode(mode)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesconfigmapitemswithmode) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesconfigmapitemswithpath) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI`](#obj-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesdownwardapi) + * [`fn withItems(items)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesdownwardapiwithitems) + * [`fn withItemsMixin(items)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesdownwardapiwithitemsmixin) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI.items`](#obj-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesdownwardapiitems) + * [`fn withMode(mode)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesdownwardapiitemswithmode) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesdownwardapiitemswithpath) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI.items.fieldRef`](#obj-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesdownwardapiitemsfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesdownwardapiitemsfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesdownwardapiitemsfieldrefwithfieldpath) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI.items.resourceFieldRef`](#obj-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesdownwardapiitemsresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesdownwardapiitemsresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesdownwardapiitemsresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesdownwardapiitemsresourcefieldrefwithresource) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.secret`](#obj-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcessecret) + * [`fn withItems(items)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcessecretwithitems) + * [`fn withItemsMixin(items)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcessecretwithitemsmixin) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcessecretwithname) + * [`fn withOptional(optional)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcessecretwithoptional) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.secret.items`](#obj-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcessecretitems) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcessecretitemswithkey) + * [`fn withMode(mode)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcessecretitemswithmode) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcessecretitemswithpath) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.serviceAccountToken`](#obj-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesserviceaccounttoken) + * [`fn withAudience(audience)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesserviceaccounttokenwithaudience) + * [`fn withExpirationSeconds(expirationSeconds)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesserviceaccounttokenwithexpirationseconds) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesprojectedsourcesserviceaccounttokenwithpath) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.quobyte`](#obj-specproviderkubernetesenvoydeploymentpodvolumesquobyte) + * [`fn withGroup(group)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesquobytewithgroup) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesquobytewithreadonly) + * [`fn withRegistry(registry)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesquobytewithregistry) + * [`fn withTenant(tenant)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesquobytewithtenant) + * [`fn withUser(user)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesquobytewithuser) + * [`fn withVolume(volume)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesquobytewithvolume) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.rbd`](#obj-specproviderkubernetesenvoydeploymentpodvolumesrbd) + * [`fn withFsType(fsType)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesrbdwithfstype) + * [`fn withImage(image)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesrbdwithimage) + * [`fn withKeyring(keyring)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesrbdwithkeyring) + * [`fn withMonitors(monitors)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesrbdwithmonitors) + * [`fn withMonitorsMixin(monitors)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesrbdwithmonitorsmixin) + * [`fn withPool(pool)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesrbdwithpool) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesrbdwithreadonly) + * [`fn withUser(user)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesrbdwithuser) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.rbd.secretRef`](#obj-specproviderkubernetesenvoydeploymentpodvolumesrbdsecretref) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesrbdsecretrefwithname) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.scaleIO`](#obj-specproviderkubernetesenvoydeploymentpodvolumesscaleio) + * [`fn withFsType(fsType)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesscaleiowithfstype) + * [`fn withGateway(gateway)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesscaleiowithgateway) + * [`fn withProtectionDomain(protectionDomain)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesscaleiowithprotectiondomain) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesscaleiowithreadonly) + * [`fn withSslEnabled(sslEnabled)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesscaleiowithsslenabled) + * [`fn withStorageMode(storageMode)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesscaleiowithstoragemode) + * [`fn withStoragePool(storagePool)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesscaleiowithstoragepool) + * [`fn withSystem(system)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesscaleiowithsystem) + * [`fn withVolumeName(volumeName)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesscaleiowithvolumename) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.scaleIO.secretRef`](#obj-specproviderkubernetesenvoydeploymentpodvolumesscaleiosecretref) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesscaleiosecretrefwithname) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.secret`](#obj-specproviderkubernetesenvoydeploymentpodvolumessecret) + * [`fn withDefaultMode(defaultMode)`](#fn-specproviderkubernetesenvoydeploymentpodvolumessecretwithdefaultmode) + * [`fn withItems(items)`](#fn-specproviderkubernetesenvoydeploymentpodvolumessecretwithitems) + * [`fn withItemsMixin(items)`](#fn-specproviderkubernetesenvoydeploymentpodvolumessecretwithitemsmixin) + * [`fn withOptional(optional)`](#fn-specproviderkubernetesenvoydeploymentpodvolumessecretwithoptional) + * [`fn withSecretName(secretName)`](#fn-specproviderkubernetesenvoydeploymentpodvolumessecretwithsecretname) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.secret.items`](#obj-specproviderkubernetesenvoydeploymentpodvolumessecretitems) + * [`fn withKey(key)`](#fn-specproviderkubernetesenvoydeploymentpodvolumessecretitemswithkey) + * [`fn withMode(mode)`](#fn-specproviderkubernetesenvoydeploymentpodvolumessecretitemswithmode) + * [`fn withPath(path)`](#fn-specproviderkubernetesenvoydeploymentpodvolumessecretitemswithpath) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.storageos`](#obj-specproviderkubernetesenvoydeploymentpodvolumesstorageos) + * [`fn withFsType(fsType)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesstorageoswithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesstorageoswithreadonly) + * [`fn withVolumeName(volumeName)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesstorageoswithvolumename) + * [`fn withVolumeNamespace(volumeNamespace)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesstorageoswithvolumenamespace) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.storageos.secretRef`](#obj-specproviderkubernetesenvoydeploymentpodvolumesstorageossecretref) + * [`fn withName(name)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesstorageossecretrefwithname) + * [`obj spec.provider.kubernetes.envoyDeployment.pod.volumes.vsphereVolume`](#obj-specproviderkubernetesenvoydeploymentpodvolumesvspherevolume) + * [`fn withFsType(fsType)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesvspherevolumewithfstype) + * [`fn withStoragePolicyID(storagePolicyID)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesvspherevolumewithstoragepolicyid) + * [`fn withStoragePolicyName(storagePolicyName)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesvspherevolumewithstoragepolicyname) + * [`fn withVolumePath(volumePath)`](#fn-specproviderkubernetesenvoydeploymentpodvolumesvspherevolumewithvolumepath) + * [`obj spec.provider.kubernetes.envoyDeployment.strategy`](#obj-specproviderkubernetesenvoydeploymentstrategy) + * [`fn withType(type)`](#fn-specproviderkubernetesenvoydeploymentstrategywithtype) + * [`obj spec.provider.kubernetes.envoyDeployment.strategy.rollingUpdate`](#obj-specproviderkubernetesenvoydeploymentstrategyrollingupdate) + * [`fn withMaxSurge(maxSurge)`](#fn-specproviderkubernetesenvoydeploymentstrategyrollingupdatewithmaxsurge) + * [`fn withMaxUnavailable(maxUnavailable)`](#fn-specproviderkubernetesenvoydeploymentstrategyrollingupdatewithmaxunavailable) + * [`obj spec.provider.kubernetes.envoyService`](#obj-specproviderkubernetesenvoyservice) + * [`fn withAllocateLoadBalancerNodePorts(allocateLoadBalancerNodePorts)`](#fn-specproviderkubernetesenvoyservicewithallocateloadbalancernodeports) + * [`fn withAnnotations(annotations)`](#fn-specproviderkubernetesenvoyservicewithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-specproviderkubernetesenvoyservicewithannotationsmixin) + * [`fn withLoadBalancerClass(loadBalancerClass)`](#fn-specproviderkubernetesenvoyservicewithloadbalancerclass) + * [`fn withLoadBalancerIP(loadBalancerIP)`](#fn-specproviderkubernetesenvoyservicewithloadbalancerip) + * [`fn withType(type)`](#fn-specproviderkubernetesenvoyservicewithtype) + * [`obj spec.telemetry`](#obj-spectelemetry) + * [`obj spec.telemetry.accessLog`](#obj-spectelemetryaccesslog) + * [`fn withDisable(disable)`](#fn-spectelemetryaccesslogwithdisable) + * [`fn withSettings(settings)`](#fn-spectelemetryaccesslogwithsettings) + * [`fn withSettingsMixin(settings)`](#fn-spectelemetryaccesslogwithsettingsmixin) + * [`obj spec.telemetry.accessLog.settings`](#obj-spectelemetryaccesslogsettings) + * [`fn withSinks(sinks)`](#fn-spectelemetryaccesslogsettingswithsinks) + * [`fn withSinksMixin(sinks)`](#fn-spectelemetryaccesslogsettingswithsinksmixin) + * [`obj spec.telemetry.accessLog.settings.format`](#obj-spectelemetryaccesslogsettingsformat) + * [`fn withJson(json)`](#fn-spectelemetryaccesslogsettingsformatwithjson) + * [`fn withJsonMixin(json)`](#fn-spectelemetryaccesslogsettingsformatwithjsonmixin) + * [`fn withText(text)`](#fn-spectelemetryaccesslogsettingsformatwithtext) + * [`fn withType(type)`](#fn-spectelemetryaccesslogsettingsformatwithtype) + * [`obj spec.telemetry.accessLog.settings.sinks`](#obj-spectelemetryaccesslogsettingssinks) + * [`fn withType(type)`](#fn-spectelemetryaccesslogsettingssinkswithtype) + * [`obj spec.telemetry.accessLog.settings.sinks.file`](#obj-spectelemetryaccesslogsettingssinksfile) + * [`fn withPath(path)`](#fn-spectelemetryaccesslogsettingssinksfilewithpath) + * [`obj spec.telemetry.accessLog.settings.sinks.openTelemetry`](#obj-spectelemetryaccesslogsettingssinksopentelemetry) + * [`fn withHost(host)`](#fn-spectelemetryaccesslogsettingssinksopentelemetrywithhost) + * [`fn withPort(port)`](#fn-spectelemetryaccesslogsettingssinksopentelemetrywithport) + * [`fn withResources(resources)`](#fn-spectelemetryaccesslogsettingssinksopentelemetrywithresources) + * [`fn withResourcesMixin(resources)`](#fn-spectelemetryaccesslogsettingssinksopentelemetrywithresourcesmixin) + * [`obj spec.telemetry.metrics`](#obj-spectelemetrymetrics) + * [`fn withEnableVirtualHostStats(enableVirtualHostStats)`](#fn-spectelemetrymetricswithenablevirtualhoststats) + * [`fn withMatches(matches)`](#fn-spectelemetrymetricswithmatches) + * [`fn withMatchesMixin(matches)`](#fn-spectelemetrymetricswithmatchesmixin) + * [`fn withSinks(sinks)`](#fn-spectelemetrymetricswithsinks) + * [`fn withSinksMixin(sinks)`](#fn-spectelemetrymetricswithsinksmixin) + * [`obj spec.telemetry.metrics.matches`](#obj-spectelemetrymetricsmatches) + * [`fn withType(type)`](#fn-spectelemetrymetricsmatcheswithtype) + * [`fn withValue(value)`](#fn-spectelemetrymetricsmatcheswithvalue) + * [`obj spec.telemetry.metrics.prometheus`](#obj-spectelemetrymetricsprometheus) + * [`fn withDisable(disable)`](#fn-spectelemetrymetricsprometheuswithdisable) + * [`obj spec.telemetry.metrics.sinks`](#obj-spectelemetrymetricssinks) + * [`fn withType(type)`](#fn-spectelemetrymetricssinkswithtype) + * [`obj spec.telemetry.metrics.sinks.openTelemetry`](#obj-spectelemetrymetricssinksopentelemetry) + * [`fn withHost(host)`](#fn-spectelemetrymetricssinksopentelemetrywithhost) + * [`fn withPort(port)`](#fn-spectelemetrymetricssinksopentelemetrywithport) + * [`obj spec.telemetry.tracing`](#obj-spectelemetrytracing) + * [`fn withCustomTags(customTags)`](#fn-spectelemetrytracingwithcustomtags) + * [`fn withCustomTagsMixin(customTags)`](#fn-spectelemetrytracingwithcustomtagsmixin) + * [`fn withSamplingRate(samplingRate)`](#fn-spectelemetrytracingwithsamplingrate) + * [`obj spec.telemetry.tracing.provider`](#obj-spectelemetrytracingprovider) + * [`fn withHost(host)`](#fn-spectelemetrytracingproviderwithhost) + * [`fn withPort(port)`](#fn-spectelemetrytracingproviderwithport) + * [`fn withType(type)`](#fn-spectelemetrytracingproviderwithtype) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of EnvoyProxy + +## 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 + +"EnvoyProxySpec defines the desired state of EnvoyProxy." + +### fn spec.withConcurrency + +```ts +withConcurrency(concurrency) +``` + +"Concurrency defines the number of worker threads to run. If unset, it defaults to the number of cpuset threads on the platform." + +### fn spec.withMergeGateways + +```ts +withMergeGateways(mergeGateways) +``` + +"MergeGateways defines if Gateway resources should be merged onto the same Envoy Proxy Infrastructure. Setting this field to true would merge all Gateway Listeners under the parent Gateway Class. This means that the port, protocol and hostname tuple must be unique for every listener. If a duplicate listener is detected, the newer listener (based on timestamp) will be rejected and its status will be updated with a \"Accepted=False\" condition." + +## obj spec.bootstrap + +"Bootstrap defines the Envoy Bootstrap as a YAML string. Visit https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/bootstrap/v3/bootstrap.proto#envoy-v3-api-msg-config-bootstrap-v3-bootstrap to learn more about the syntax. If set, this is the Bootstrap configuration used for the managed Envoy Proxy fleet instead of the default Bootstrap configuration set by Envoy Gateway. Some fields within the Bootstrap that are required to communicate with the xDS Server (Envoy Gateway) and receive xDS resources from it are not configurable and will result in the `EnvoyProxy` resource being rejected. Backward compatibility across minor versions is not guaranteed. We strongly recommend using `egctl x translate` to generate a `EnvoyProxy` resource with the `Bootstrap` field set to the default Bootstrap configuration used. You can edit this configuration, and rerun `egctl x translate` to ensure there are no validation errors." + +### fn spec.bootstrap.withType + +```ts +withType(type) +``` + +"Type is the type of the bootstrap configuration, it should be either Replace or Merge. If unspecified, it defaults to Replace." + +### fn spec.bootstrap.withValue + +```ts +withValue(value) +``` + +"Value is a YAML string of the bootstrap." + +## obj spec.logging + +"Logging defines logging parameters for managed proxies." + +### fn spec.logging.withLevel + +```ts +withLevel(level) +``` + +"Level is a map of logging level per component, where the component is the key and the log level is the value. If unspecified, defaults to \"default: warn\"." + +### fn spec.logging.withLevelMixin + +```ts +withLevelMixin(level) +``` + +"Level is a map of logging level per component, where the component is the key and the log level is the value. If unspecified, defaults to \"default: warn\"." + +**Note:** This function appends passed data to existing values + +## obj spec.provider + +"Provider defines the desired resource provider and provider-specific configuration. If unspecified, the \"Kubernetes\" resource provider is used with default configuration parameters." + +### fn spec.provider.withType + +```ts +withType(type) +``` + +"Type is the type of resource provider to use. A resource provider provides infrastructure resources for running the data plane, e.g. Envoy proxy, and optional auxiliary control planes. Supported types are \"Kubernetes\"." + +## obj spec.provider.kubernetes + +"Kubernetes defines the desired state of the Kubernetes resource provider. Kubernetes provides infrastructure resources for running the data plane, e.g. Envoy proxy. If unspecified and type is \"Kubernetes\", default settings for managed Kubernetes resources are applied." + +## obj spec.provider.kubernetes.envoyDeployment + +"EnvoyDeployment defines the desired state of the Envoy deployment resource. If unspecified, default settings for the managed Envoy deployment resource are applied." + +### fn spec.provider.kubernetes.envoyDeployment.withInitContainers + +```ts +withInitContainers(initContainers) +``` + +"List of initialization containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/" + +### fn spec.provider.kubernetes.envoyDeployment.withInitContainersMixin + +```ts +withInitContainersMixin(initContainers) +``` + +"List of initialization containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.withReplicas + +```ts +withReplicas(replicas) +``` + +"Replicas is the number of desired pods. Defaults to 1." + +## obj spec.provider.kubernetes.envoyDeployment.container + +"Container defines the desired specification of main container." + +### fn spec.provider.kubernetes.envoyDeployment.container.withEnv + +```ts +withEnv(env) +``` + +"List of environment variables to set in the container." + +### fn spec.provider.kubernetes.envoyDeployment.container.withEnvMixin + +```ts +withEnvMixin(env) +``` + +"List of environment variables to set in the container." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.container.withImage + +```ts +withImage(image) +``` + +"Image specifies the EnvoyProxy container image to be used, instead of the default image." + +### fn spec.provider.kubernetes.envoyDeployment.container.withVolumeMounts + +```ts +withVolumeMounts(volumeMounts) +``` + +"VolumeMounts are volumes to mount into the container's filesystem. Cannot be updated." + +### fn spec.provider.kubernetes.envoyDeployment.container.withVolumeMountsMixin + +```ts +withVolumeMountsMixin(volumeMounts) +``` + +"VolumeMounts are volumes to mount into the container's filesystem. Cannot be updated." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.container.env + +"List of environment variables to set in the container." + +### fn spec.provider.kubernetes.envoyDeployment.container.env.withName + +```ts +withName(name) +``` + +"Name of the environment variable. Must be a C_IDENTIFIER." + +### fn spec.provider.kubernetes.envoyDeployment.container.env.withValue + +```ts +withValue(value) +``` + +"Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\"." + +## obj spec.provider.kubernetes.envoyDeployment.container.env.valueFrom + +"Source for the environment variable's value. Cannot be used if value is not empty." + +## obj spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.configMapKeyRef + +"Selects a key of a ConfigMap." + +### fn spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.configMapKeyRef.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.configMapKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +### fn spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.configMapKeyRef.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.fieldRef + +"Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs." + +### fn spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.fieldRef.withFieldPath + +```ts +withFieldPath(fieldPath) +``` + +"Path of the field to select in the specified API version." + +## obj spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.resourceFieldRef + +"Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported." + +### fn spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.resourceFieldRef.withContainerName + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.resourceFieldRef.withResource + +```ts +withResource(resource) +``` + +"Required: resource to select" + +## obj spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.secretKeyRef + +"Selects a key of a secret in the pod's namespace" + +### fn spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.secretKeyRef.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.secretKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +### fn spec.provider.kubernetes.envoyDeployment.container.env.valueFrom.secretKeyRef.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.provider.kubernetes.envoyDeployment.container.resources + +"Resources required by this container. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.provider.kubernetes.envoyDeployment.container.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +### fn spec.provider.kubernetes.envoyDeployment.container.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.container.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.provider.kubernetes.envoyDeployment.container.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.container.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.provider.kubernetes.envoyDeployment.container.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.container.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +### fn spec.provider.kubernetes.envoyDeployment.container.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container." + +## obj spec.provider.kubernetes.envoyDeployment.container.securityContext + +"SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.withAllowPrivilegeEscalation + +```ts +withAllowPrivilegeEscalation(allowPrivilegeEscalation) +``` + +"AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.withPrivileged + +```ts +withPrivileged(privileged) +``` + +"Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.withProcMount + +```ts +withProcMount(procMount) +``` + +"procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.withReadOnlyRootFilesystem + +```ts +withReadOnlyRootFilesystem(readOnlyRootFilesystem) +``` + +"Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.withRunAsGroup + +```ts +withRunAsGroup(runAsGroup) +``` + +"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.withRunAsNonRoot + +```ts +withRunAsNonRoot(runAsNonRoot) +``` + +"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.withRunAsUser + +```ts +withRunAsUser(runAsUser) +``` + +"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows." + +## obj spec.provider.kubernetes.envoyDeployment.container.securityContext.capabilities + +"The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.capabilities.withAdd + +```ts +withAdd(add) +``` + +"Added capabilities" + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.capabilities.withAddMixin + +```ts +withAddMixin(add) +``` + +"Added capabilities" + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.capabilities.withDrop + +```ts +withDrop(drop) +``` + +"Removed capabilities" + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.capabilities.withDropMixin + +```ts +withDropMixin(drop) +``` + +"Removed capabilities" + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.container.securityContext.seLinuxOptions + +"The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.seLinuxOptions.withLevel + +```ts +withLevel(level) +``` + +"Level is SELinux level label that applies to the container." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.seLinuxOptions.withRole + +```ts +withRole(role) +``` + +"Role is a SELinux role label that applies to the container." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.seLinuxOptions.withType + +```ts +withType(type) +``` + +"Type is a SELinux type label that applies to the container." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.seLinuxOptions.withUser + +```ts +withUser(user) +``` + +"User is a SELinux user label that applies to the container." + +## obj spec.provider.kubernetes.envoyDeployment.container.securityContext.seccompProfile + +"The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.seccompProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is \"Localhost\". Must NOT be set for any other type." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.seccompProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied." + +## obj spec.provider.kubernetes.envoyDeployment.container.securityContext.windowsOptions + +"The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.windowsOptions.withGmsaCredentialSpec + +```ts +withGmsaCredentialSpec(gmsaCredentialSpec) +``` + +"GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.windowsOptions.withGmsaCredentialSpecName + +```ts +withGmsaCredentialSpecName(gmsaCredentialSpecName) +``` + +"GMSACredentialSpecName is the name of the GMSA credential spec to use." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.windowsOptions.withHostProcess + +```ts +withHostProcess(hostProcess) +``` + +"HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true." + +### fn spec.provider.kubernetes.envoyDeployment.container.securityContext.windowsOptions.withRunAsUserName + +```ts +withRunAsUserName(runAsUserName) +``` + +"The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence." + +## obj spec.provider.kubernetes.envoyDeployment.container.volumeMounts + +"VolumeMounts are volumes to mount into the container's filesystem. Cannot be updated." + +### fn spec.provider.kubernetes.envoyDeployment.container.volumeMounts.withMountPath + +```ts +withMountPath(mountPath) +``` + +"Path within the container at which the volume should be mounted. Must not contain ':'." + +### fn spec.provider.kubernetes.envoyDeployment.container.volumeMounts.withMountPropagation + +```ts +withMountPropagation(mountPropagation) +``` + +"mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10." + +### fn spec.provider.kubernetes.envoyDeployment.container.volumeMounts.withName + +```ts +withName(name) +``` + +"This must match the Name of a Volume." + +### fn spec.provider.kubernetes.envoyDeployment.container.volumeMounts.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false." + +### fn spec.provider.kubernetes.envoyDeployment.container.volumeMounts.withSubPath + +```ts +withSubPath(subPath) +``` + +"Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)." + +### fn spec.provider.kubernetes.envoyDeployment.container.volumeMounts.withSubPathExpr + +```ts +withSubPathExpr(subPathExpr) +``` + +"Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \"\" (volume's root). SubPathExpr and SubPath are mutually exclusive." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers + +"List of initialization containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withArgs + +```ts +withArgs(args) +``` + +"Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withArgsMixin + +```ts +withArgsMixin(args) +``` + +"Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withCommand + +```ts +withCommand(command) +``` + +"Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withEnv + +```ts +withEnv(env) +``` + +"List of environment variables to set in the container. Cannot be updated." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withEnvFrom + +```ts +withEnvFrom(envFrom) +``` + +"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withEnvFromMixin + +```ts +withEnvFromMixin(envFrom) +``` + +"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withEnvMixin + +```ts +withEnvMixin(env) +``` + +"List of environment variables to set in the container. Cannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withImage + +```ts +withImage(image) +``` + +"Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withImagePullPolicy + +```ts +withImagePullPolicy(imagePullPolicy) +``` + +"Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withName + +```ts +withName(name) +``` + +"Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withPorts + +```ts +withPorts(ports) +``` + +"List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withPortsMixin + +```ts +withPortsMixin(ports) +``` + +"List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withResizePolicy + +```ts +withResizePolicy(resizePolicy) +``` + +"Resources resize policy for the container." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withResizePolicyMixin + +```ts +withResizePolicyMixin(resizePolicy) +``` + +"Resources resize policy for the container." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is \"Always\". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as \"Always\" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy \"Always\" will be shut down. This lifecycle differs from normal init containers and is often referred to as a \"sidecar\" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withStdin + +```ts +withStdin(stdin) +``` + +"Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withStdinOnce + +```ts +withStdinOnce(stdinOnce) +``` + +"Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withTerminationMessagePath + +```ts +withTerminationMessagePath(terminationMessagePath) +``` + +"Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withTerminationMessagePolicy + +```ts +withTerminationMessagePolicy(terminationMessagePolicy) +``` + +"Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withTty + +```ts +withTty(tty) +``` + +"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withVolumeDevices + +```ts +withVolumeDevices(volumeDevices) +``` + +"volumeDevices is the list of block devices to be used by the container." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withVolumeDevicesMixin + +```ts +withVolumeDevicesMixin(volumeDevices) +``` + +"volumeDevices is the list of block devices to be used by the container." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withVolumeMounts + +```ts +withVolumeMounts(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem. Cannot be updated." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withVolumeMountsMixin + +```ts +withVolumeMountsMixin(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem. Cannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.withWorkingDir + +```ts +withWorkingDir(workingDir) +``` + +"Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.env + +"List of environment variables to set in the container. Cannot be updated." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.env.withName + +```ts +withName(name) +``` + +"Name of the environment variable. Must be a C_IDENTIFIER." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.env.withValue + +```ts +withValue(value) +``` + +"Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\"." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom + +"Source for the environment variable's value. Cannot be used if value is not empty." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.configMapKeyRef + +"Selects a key of a ConfigMap." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.configMapKeyRef.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.configMapKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.configMapKeyRef.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.fieldRef + +"Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.fieldRef.withFieldPath + +```ts +withFieldPath(fieldPath) +``` + +"Path of the field to select in the specified API version." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.resourceFieldRef + +"Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.resourceFieldRef.withContainerName + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.resourceFieldRef.withResource + +```ts +withResource(resource) +``` + +"Required: resource to select" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.secretKeyRef + +"Selects a key of a secret in the pod's namespace" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.secretKeyRef.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.secretKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.env.valueFrom.secretKeyRef.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.envFrom + +"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.envFrom.withPrefix + +```ts +withPrefix(prefix) +``` + +"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.envFrom.configMapRef + +"The ConfigMap to select from" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.envFrom.configMapRef.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.envFrom.configMapRef.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap must be defined" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.envFrom.secretRef + +"The Secret to select from" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.envFrom.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.envFrom.secretRef.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret must be defined" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle + +"Actions that the management system should take in response to container lifecycle events. Cannot be updated." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart + +"PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.exec + +"Exec specifies the action to take." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.httpGet.withHttpHeadersMixin + +```ts +withHttpHeadersMixin(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.httpGet.withPath + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host. Defaults to HTTP." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.httpGet.httpHeaders + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.httpGet.httpHeaders.withName + +```ts +withName(name) +``` + +"The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.postStart.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop + +"PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.exec + +"Exec specifies the action to take." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.httpGet.withHttpHeadersMixin + +```ts +withHttpHeadersMixin(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.httpGet.withPath + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host. Defaults to HTTP." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.httpGet.httpHeaders + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.httpGet.httpHeaders.withName + +```ts +withName(name) +``` + +"The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.lifecycle.preStop.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe + +"Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.exec + +"Exec specifies the action to take." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.httpGet.withHttpHeadersMixin + +```ts +withHttpHeadersMixin(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.httpGet.withPath + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host. Defaults to HTTP." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.httpGet.httpHeaders + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.httpGet.httpHeaders.withName + +```ts +withName(name) +``` + +"The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.livenessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.ports + +"List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.ports.withContainerPort + +```ts +withContainerPort(containerPort) +``` + +"Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.ports.withHostIP + +```ts +withHostIP(hostIP) +``` + +"What host IP to bind the external port to." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.ports.withHostPort + +```ts +withHostPort(hostPort) +``` + +"Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.ports.withName + +```ts +withName(name) +``` + +"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.ports.withProtocol + +```ts +withProtocol(protocol) +``` + +"Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\"." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe + +"Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.exec + +"Exec specifies the action to take." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.httpGet.withHttpHeadersMixin + +```ts +withHttpHeadersMixin(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.httpGet.withPath + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host. Defaults to HTTP." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.httpGet.httpHeaders + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.httpGet.httpHeaders.withName + +```ts +withName(name) +``` + +"The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.readinessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.resizePolicy + +"Resources resize policy for the container." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.resizePolicy.withResourceName + +```ts +withResourceName(resourceName) +``` + +"Name of the resource to which this resource resize policy applies. Supported values: cpu, memory." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.resizePolicy.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.resources + +"Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.securityContext + +"SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.withAllowPrivilegeEscalation + +```ts +withAllowPrivilegeEscalation(allowPrivilegeEscalation) +``` + +"AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.withPrivileged + +```ts +withPrivileged(privileged) +``` + +"Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.withProcMount + +```ts +withProcMount(procMount) +``` + +"procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.withReadOnlyRootFilesystem + +```ts +withReadOnlyRootFilesystem(readOnlyRootFilesystem) +``` + +"Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.withRunAsGroup + +```ts +withRunAsGroup(runAsGroup) +``` + +"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.withRunAsNonRoot + +```ts +withRunAsNonRoot(runAsNonRoot) +``` + +"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.withRunAsUser + +```ts +withRunAsUser(runAsUser) +``` + +"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.capabilities + +"The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.capabilities.withAdd + +```ts +withAdd(add) +``` + +"Added capabilities" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.capabilities.withAddMixin + +```ts +withAddMixin(add) +``` + +"Added capabilities" + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.capabilities.withDrop + +```ts +withDrop(drop) +``` + +"Removed capabilities" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.capabilities.withDropMixin + +```ts +withDropMixin(drop) +``` + +"Removed capabilities" + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.seLinuxOptions + +"The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.seLinuxOptions.withLevel + +```ts +withLevel(level) +``` + +"Level is SELinux level label that applies to the container." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.seLinuxOptions.withRole + +```ts +withRole(role) +``` + +"Role is a SELinux role label that applies to the container." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.seLinuxOptions.withType + +```ts +withType(type) +``` + +"Type is a SELinux type label that applies to the container." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.seLinuxOptions.withUser + +```ts +withUser(user) +``` + +"User is a SELinux user label that applies to the container." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.seccompProfile + +"The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.seccompProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is \"Localhost\". Must NOT be set for any other type." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.seccompProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.windowsOptions + +"The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.windowsOptions.withGmsaCredentialSpec + +```ts +withGmsaCredentialSpec(gmsaCredentialSpec) +``` + +"GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.windowsOptions.withGmsaCredentialSpecName + +```ts +withGmsaCredentialSpecName(gmsaCredentialSpecName) +``` + +"GMSACredentialSpecName is the name of the GMSA credential spec to use." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.windowsOptions.withHostProcess + +```ts +withHostProcess(hostProcess) +``` + +"HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.securityContext.windowsOptions.withRunAsUserName + +```ts +withRunAsUserName(runAsUserName) +``` + +"The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe + +"StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.exec + +"Exec specifies the action to take." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.httpGet.withHttpHeadersMixin + +```ts +withHttpHeadersMixin(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.httpGet.withPath + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host. Defaults to HTTP." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.httpGet.httpHeaders + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.httpGet.httpHeaders.withName + +```ts +withName(name) +``` + +"The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.startupProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.volumeDevices + +"volumeDevices is the list of block devices to be used by the container." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.volumeDevices.withDevicePath + +```ts +withDevicePath(devicePath) +``` + +"devicePath is the path inside of the container that the device will be mapped to." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.volumeDevices.withName + +```ts +withName(name) +``` + +"name must match the name of a persistentVolumeClaim in the pod" + +## obj spec.provider.kubernetes.envoyDeployment.initContainers.volumeMounts + +"Pod volumes to mount into the container's filesystem. Cannot be updated." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.volumeMounts.withMountPath + +```ts +withMountPath(mountPath) +``` + +"Path within the container at which the volume should be mounted. Must not contain ':'." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.volumeMounts.withMountPropagation + +```ts +withMountPropagation(mountPropagation) +``` + +"mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.volumeMounts.withName + +```ts +withName(name) +``` + +"This must match the Name of a Volume." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.volumeMounts.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.volumeMounts.withSubPath + +```ts +withSubPath(subPath) +``` + +"Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)." + +### fn spec.provider.kubernetes.envoyDeployment.initContainers.volumeMounts.withSubPathExpr + +```ts +withSubPathExpr(subPathExpr) +``` + +"Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \"\" (volume's root). SubPathExpr and SubPath are mutually exclusive." + +## obj spec.provider.kubernetes.envoyDeployment.pod + +"Pod defines the desired specification of pod." + +### fn spec.provider.kubernetes.envoyDeployment.pod.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations are the annotations that should be appended to the pods. By default, no pod annotations are appended." + +### fn spec.provider.kubernetes.envoyDeployment.pod.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations are the annotations that should be appended to the pods. By default, no pod annotations are appended." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.withLabels + +```ts +withLabels(labels) +``` + +"Labels are the additional labels that should be tagged to the pods. By default, no additional pod labels are tagged." + +### fn spec.provider.kubernetes.envoyDeployment.pod.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Labels are the additional labels that should be tagged to the pods. By default, no additional pod labels are tagged." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.withTolerations + +```ts +withTolerations(tolerations) +``` + +"If specified, the pod's tolerations." + +### fn spec.provider.kubernetes.envoyDeployment.pod.withTolerationsMixin + +```ts +withTolerationsMixin(tolerations) +``` + +"If specified, the pod's tolerations." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.withVolumes + +```ts +withVolumes(volumes) +``` + +"Volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes" + +### fn spec.provider.kubernetes.envoyDeployment.pod.withVolumesMixin + +```ts +withVolumesMixin(volumes) +``` + +"Volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes" + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity + +"If specified, the pod's scheduling constraints." + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity + +"Describes node affinity scheduling rules for the pod." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution + +```ts +withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution + +"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight + +```ts +withWeight(weight) +``` + +"Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100." + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference + +"A node selector term, associated with the corresponding weight." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"A list of node selector requirements by node's labels." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"A list of node selector requirements by node's labels." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFields + +```ts +withMatchFields(matchFields) +``` + +"A list of node selector requirements by node's fields." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin + +```ts +withMatchFieldsMixin(matchFields) +``` + +"A list of node selector requirements by node's fields." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions + +"A list of node selector requirements by node's labels." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withKey + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields + +"A list of node selector requirements by node's fields." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withKey + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution + +"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms + +```ts +withNodeSelectorTerms(nodeSelectorTerms) +``` + +"Required. A list of node selector terms. The terms are ORed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin + +```ts +withNodeSelectorTermsMixin(nodeSelectorTerms) +``` + +"Required. A list of node selector terms. The terms are ORed." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms + +"Required. A list of node selector terms. The terms are ORed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"A list of node selector requirements by node's labels." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"A list of node selector requirements by node's labels." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFields + +```ts +withMatchFields(matchFields) +``` + +"A list of node selector requirements by node's fields." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin + +```ts +withMatchFieldsMixin(matchFields) +``` + +"A list of node selector requirements by node's fields." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions + +"A list of node selector requirements by node's labels." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withKey + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields + +"A list of node selector requirements by node's fields." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withKey + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity + +"Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecution + +```ts +withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecution + +```ts +withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution + +"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight + +```ts +withWeight(weight) +``` + +"weight associated with matching the corresponding podAffinityTerm, in the range 1-100." + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm + +"Required. A pod affinity term, associated with the corresponding weight." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed." + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector + +"A label query over a set of resources, in this case pods." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector + +"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution + +"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed." + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector + +"A label query over a set of resources, in this case pods." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector + +"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity + +"Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s))." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution + +```ts +withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution + +```ts +withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution + +"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight + +```ts +withWeight(weight) +``` + +"weight associated with matching the corresponding podAffinityTerm, in the range 1-100." + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm + +"Required. A pod affinity term, associated with the corresponding weight." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed." + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector + +"A label query over a set of resources, in this case pods." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector + +"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution + +"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed." + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector + +"A label query over a set of resources, in this case pods." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector + +"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +### fn spec.provider.kubernetes.envoyDeployment.pod.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.securityContext + +"SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.withFsGroup + +```ts +withFsGroup(fsGroup) +``` + +"A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.withFsGroupChangePolicy + +```ts +withFsGroupChangePolicy(fsGroupChangePolicy) +``` + +"fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.withRunAsGroup + +```ts +withRunAsGroup(runAsGroup) +``` + +"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.withRunAsNonRoot + +```ts +withRunAsNonRoot(runAsNonRoot) +``` + +"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.withRunAsUser + +```ts +withRunAsUser(runAsUser) +``` + +"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.withSupplementalGroups + +```ts +withSupplementalGroups(supplementalGroups) +``` + +"A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.withSupplementalGroupsMixin + +```ts +withSupplementalGroupsMixin(supplementalGroups) +``` + +"A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.withSysctls + +```ts +withSysctls(sysctls) +``` + +"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.withSysctlsMixin + +```ts +withSysctlsMixin(sysctls) +``` + +"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.securityContext.seLinuxOptions + +"The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.seLinuxOptions.withLevel + +```ts +withLevel(level) +``` + +"Level is SELinux level label that applies to the container." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.seLinuxOptions.withRole + +```ts +withRole(role) +``` + +"Role is a SELinux role label that applies to the container." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.seLinuxOptions.withType + +```ts +withType(type) +``` + +"Type is a SELinux type label that applies to the container." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.seLinuxOptions.withUser + +```ts +withUser(user) +``` + +"User is a SELinux user label that applies to the container." + +## obj spec.provider.kubernetes.envoyDeployment.pod.securityContext.seccompProfile + +"The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.seccompProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is \"Localhost\". Must NOT be set for any other type." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.seccompProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied." + +## obj spec.provider.kubernetes.envoyDeployment.pod.securityContext.sysctls + +"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.sysctls.withName + +```ts +withName(name) +``` + +"Name of a property to set" + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.sysctls.withValue + +```ts +withValue(value) +``` + +"Value of a property to set" + +## obj spec.provider.kubernetes.envoyDeployment.pod.securityContext.windowsOptions + +"The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.windowsOptions.withGmsaCredentialSpec + +```ts +withGmsaCredentialSpec(gmsaCredentialSpec) +``` + +"GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.windowsOptions.withGmsaCredentialSpecName + +```ts +withGmsaCredentialSpecName(gmsaCredentialSpecName) +``` + +"GMSACredentialSpecName is the name of the GMSA credential spec to use." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.windowsOptions.withHostProcess + +```ts +withHostProcess(hostProcess) +``` + +"HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true." + +### fn spec.provider.kubernetes.envoyDeployment.pod.securityContext.windowsOptions.withRunAsUserName + +```ts +withRunAsUserName(runAsUserName) +``` + +"The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence." + +## obj spec.provider.kubernetes.envoyDeployment.pod.tolerations + +"If specified, the pod's tolerations." + +### fn spec.provider.kubernetes.envoyDeployment.pod.tolerations.withEffect + +```ts +withEffect(effect) +``` + +"Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute." + +### fn spec.provider.kubernetes.envoyDeployment.pod.tolerations.withKey + +```ts +withKey(key) +``` + +"Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys." + +### fn spec.provider.kubernetes.envoyDeployment.pod.tolerations.withOperator + +```ts +withOperator(operator) +``` + +"Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category." + +### fn spec.provider.kubernetes.envoyDeployment.pod.tolerations.withTolerationSeconds + +```ts +withTolerationSeconds(tolerationSeconds) +``` + +"TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system." + +### fn spec.provider.kubernetes.envoyDeployment.pod.tolerations.withValue + +```ts +withValue(value) +``` + +"Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes + +"Volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.withName + +```ts +withName(name) +``` + +"name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.awsElasticBlockStore + +"awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.awsElasticBlockStore.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.awsElasticBlockStore.withPartition + +```ts +withPartition(partition) +``` + +"partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty)." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.awsElasticBlockStore.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.awsElasticBlockStore.withVolumeID + +```ts +withVolumeID(volumeID) +``` + +"volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.azureDisk + +"azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.azureDisk.withCachingMode + +```ts +withCachingMode(cachingMode) +``` + +"cachingMode is the Host Caching mode: None, Read Only, Read Write." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.azureDisk.withDiskName + +```ts +withDiskName(diskName) +``` + +"diskName is the Name of the data disk in the blob storage" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.azureDisk.withDiskURI + +```ts +withDiskURI(diskURI) +``` + +"diskURI is the URI of data disk in the blob storage" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.azureDisk.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.azureDisk.withKind + +```ts +withKind(kind) +``` + +"kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.azureDisk.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.azureFile + +"azureFile represents an Azure File Service mount on the host and bind mount to the pod." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.azureFile.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.azureFile.withSecretName + +```ts +withSecretName(secretName) +``` + +"secretName is the name of secret that contains Azure Storage Account Name and Key" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.azureFile.withShareName + +```ts +withShareName(shareName) +``` + +"shareName is the azure share Name" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.cephfs + +"cephFS represents a Ceph FS mount on the host that shares a pod's lifetime" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.cephfs.withMonitors + +```ts +withMonitors(monitors) +``` + +"monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.cephfs.withMonitorsMixin + +```ts +withMonitorsMixin(monitors) +``` + +"monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.cephfs.withPath + +```ts +withPath(path) +``` + +"path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.cephfs.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.cephfs.withSecretFile + +```ts +withSecretFile(secretFile) +``` + +"secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.cephfs.withUser + +```ts +withUser(user) +``` + +"user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.cephfs.secretRef + +"secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.cephfs.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.cinder + +"cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.cinder.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.cinder.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.cinder.withVolumeID + +```ts +withVolumeID(volumeID) +``` + +"volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.cinder.secretRef + +"secretRef is optional: points to a secret object containing parameters used to connect to OpenStack." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.cinder.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.configMap + +"configMap represents a configMap that should populate this volume" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.configMap.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.configMap.withItems + +```ts +withItems(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.configMap.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.configMap.withOptional + +```ts +withOptional(optional) +``` + +"optional specify whether the ConfigMap or its keys must be defined" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.configMap.items + +"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.configMap.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.configMap.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.configMap.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.csi + +"csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature)." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.csi.withDriver + +```ts +withDriver(driver) +``` + +"driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.csi.withFsType + +```ts +withFsType(fsType) +``` + +"fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.csi.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly specifies a read-only configuration for the volume. Defaults to false (read/write)." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.csi.withVolumeAttributes + +```ts +withVolumeAttributes(volumeAttributes) +``` + +"volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.csi.withVolumeAttributesMixin + +```ts +withVolumeAttributesMixin(volumeAttributes) +``` + +"volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.csi.nodePublishSecretRef + +"nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.csi.nodePublishSecretRef.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI + +"downwardAPI represents downward API about the pod that should populate this volume" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.withItems + +```ts +withItems(items) +``` + +"Items is a list of downward API volume file" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"Items is a list of downward API volume file" + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.items + +"Items is a list of downward API volume file" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.items.withMode + +```ts +withMode(mode) +``` + +"Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.items.withPath + +```ts +withPath(path) +``` + +"Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.items.fieldRef + +"Required: Selects a field of the pod: only annotations, labels, name and namespace are supported." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.items.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.items.fieldRef.withFieldPath + +```ts +withFieldPath(fieldPath) +``` + +"Path of the field to select in the specified API version." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.items.resourceFieldRef + +"Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.items.resourceFieldRef.withContainerName + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.items.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.downwardAPI.items.resourceFieldRef.withResource + +```ts +withResource(resource) +``` + +"Required: resource to select" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.emptyDir + +"emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.emptyDir.withMedium + +```ts +withMedium(medium) +``` + +"medium represents what type of storage medium should back this directory. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.emptyDir.withSizeLimit + +```ts +withSizeLimit(sizeLimit) +``` + +"sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral + +"ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. \n Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). \n Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. \n Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. \n A pod can use both types of ephemeral volumes and persistent volumes at the same time." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate + +"Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \n An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. \n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \n Required, must not be nil." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.withMetadata + +```ts +withMetadata(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.withMetadataMixin + +```ts +withMetadataMixin(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec + +"The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.dataSource + +"dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.resources + +"resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.fc + +"fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.fc.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.fc.withLun + +```ts +withLun(lun) +``` + +"lun is Optional: FC target lun number" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.fc.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.fc.withTargetWWNs + +```ts +withTargetWWNs(targetWWNs) +``` + +"targetWWNs is Optional: FC target worldwide names (WWNs)" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.fc.withTargetWWNsMixin + +```ts +withTargetWWNsMixin(targetWWNs) +``` + +"targetWWNs is Optional: FC target worldwide names (WWNs)" + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.fc.withWwids + +```ts +withWwids(wwids) +``` + +"wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.fc.withWwidsMixin + +```ts +withWwidsMixin(wwids) +``` + +"wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously." + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.flexVolume + +"flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.flexVolume.withDriver + +```ts +withDriver(driver) +``` + +"driver is the name of the driver to use for this volume." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.flexVolume.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.flexVolume.withOptions + +```ts +withOptions(options) +``` + +"options is Optional: this field holds extra command options if any." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.flexVolume.withOptionsMixin + +```ts +withOptionsMixin(options) +``` + +"options is Optional: this field holds extra command options if any." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.flexVolume.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.flexVolume.secretRef + +"secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.flexVolume.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.flocker + +"flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.flocker.withDatasetName + +```ts +withDatasetName(datasetName) +``` + +"datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.flocker.withDatasetUUID + +```ts +withDatasetUUID(datasetUUID) +``` + +"datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.gcePersistentDisk + +"gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.gcePersistentDisk.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.gcePersistentDisk.withPartition + +```ts +withPartition(partition) +``` + +"partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.gcePersistentDisk.withPdName + +```ts +withPdName(pdName) +``` + +"pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.gcePersistentDisk.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.gitRepo + +"gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.gitRepo.withDirectory + +```ts +withDirectory(directory) +``` + +"directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.gitRepo.withRepository + +```ts +withRepository(repository) +``` + +"repository is the URL" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.gitRepo.withRevision + +```ts +withRevision(revision) +``` + +"revision is the commit hash for the specified revision." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.glusterfs + +"glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.glusterfs.withEndpoints + +```ts +withEndpoints(endpoints) +``` + +"endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.glusterfs.withPath + +```ts +withPath(path) +``` + +"path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.glusterfs.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.hostPath + +"hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.hostPath.withPath + +```ts +withPath(path) +``` + +"path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.hostPath.withType + +```ts +withType(type) +``` + +"type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi + +"iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi.withChapAuthDiscovery + +```ts +withChapAuthDiscovery(chapAuthDiscovery) +``` + +"chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi.withChapAuthSession + +```ts +withChapAuthSession(chapAuthSession) +``` + +"chapAuthSession defines whether support iSCSI Session CHAP authentication" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi.withInitiatorName + +```ts +withInitiatorName(initiatorName) +``` + +"initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi.withIqn + +```ts +withIqn(iqn) +``` + +"iqn is the target iSCSI Qualified Name." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi.withIscsiInterface + +```ts +withIscsiInterface(iscsiInterface) +``` + +"iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp)." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi.withLun + +```ts +withLun(lun) +``` + +"lun represents iSCSI Target Lun number." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi.withPortals + +```ts +withPortals(portals) +``` + +"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi.withPortalsMixin + +```ts +withPortalsMixin(portals) +``` + +"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi.withTargetPortal + +```ts +withTargetPortal(targetPortal) +``` + +"targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi.secretRef + +"secretRef is the CHAP Secret for iSCSI target and initiator authentication" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.iscsi.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.nfs + +"nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.nfs.withPath + +```ts +withPath(path) +``` + +"path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.nfs.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.nfs.withServer + +```ts +withServer(server) +``` + +"server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.persistentVolumeClaim + +"persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.persistentVolumeClaim.withClaimName + +```ts +withClaimName(claimName) +``` + +"claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.persistentVolumeClaim.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly Will force the ReadOnly setting in VolumeMounts. Default false." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.photonPersistentDisk + +"photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.photonPersistentDisk.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.photonPersistentDisk.withPdID + +```ts +withPdID(pdID) +``` + +"pdID is the ID that identifies Photon Controller persistent disk" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.portworxVolume + +"portworxVolume represents a portworx volume attached and mounted on kubelets host machine" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.portworxVolume.withFsType + +```ts +withFsType(fsType) +``` + +"fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.portworxVolume.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.portworxVolume.withVolumeID + +```ts +withVolumeID(volumeID) +``` + +"volumeID uniquely identifies a Portworx volume" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected + +"projected items for all in one resources secrets, configmaps, and downward API" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.withSources + +```ts +withSources(sources) +``` + +"sources is the list of volume projections" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.withSourcesMixin + +```ts +withSourcesMixin(sources) +``` + +"sources is the list of volume projections" + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources + +"sources is the list of volume projections" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.configMap + +"configMap information about the configMap data to project" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.configMap.withItems + +```ts +withItems(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.configMap.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.configMap.withOptional + +```ts +withOptional(optional) +``` + +"optional specify whether the ConfigMap or its keys must be defined" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.configMap.items + +"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.configMap.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.configMap.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.configMap.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI + +"downwardAPI information about the downwardAPI data to project" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI.withItems + +```ts +withItems(items) +``` + +"Items is a list of DownwardAPIVolume file" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"Items is a list of DownwardAPIVolume file" + +**Note:** This function appends passed data to existing values + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI.items + +"Items is a list of DownwardAPIVolume file" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI.items.withMode + +```ts +withMode(mode) +``` + +"Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI.items.withPath + +```ts +withPath(path) +``` + +"Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI.items.fieldRef + +"Required: Selects a field of the pod: only annotations, labels, name and namespace are supported." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI.items.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI.items.fieldRef.withFieldPath + +```ts +withFieldPath(fieldPath) +``` + +"Path of the field to select in the specified API version." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI.items.resourceFieldRef + +"Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withContainerName + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withResource + +```ts +withResource(resource) +``` + +"Required: resource to select" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.secret + +"secret information about the secret data to project" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.secret.withItems + +```ts +withItems(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.secret.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.secret.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.secret.withOptional + +```ts +withOptional(optional) +``` + +"optional field specify whether the Secret or its key must be defined" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.secret.items + +"items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.secret.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.secret.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.secret.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.serviceAccountToken + +"serviceAccountToken is information about the serviceAccountToken data to project" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.serviceAccountToken.withAudience + +```ts +withAudience(audience) +``` + +"audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.serviceAccountToken.withExpirationSeconds + +```ts +withExpirationSeconds(expirationSeconds) +``` + +"expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.projected.sources.serviceAccountToken.withPath + +```ts +withPath(path) +``` + +"path is the path relative to the mount point of the file to project the token into." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.quobyte + +"quobyte represents a Quobyte mount on the host that shares a pod's lifetime" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.quobyte.withGroup + +```ts +withGroup(group) +``` + +"group to map volume access to Default is no group" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.quobyte.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.quobyte.withRegistry + +```ts +withRegistry(registry) +``` + +"registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.quobyte.withTenant + +```ts +withTenant(tenant) +``` + +"tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.quobyte.withUser + +```ts +withUser(user) +``` + +"user to map volume access to Defaults to serivceaccount user" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.quobyte.withVolume + +```ts +withVolume(volume) +``` + +"volume is a string that references an already created Quobyte volume by name." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.rbd + +"rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.rbd.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.rbd.withImage + +```ts +withImage(image) +``` + +"image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.rbd.withKeyring + +```ts +withKeyring(keyring) +``` + +"keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.rbd.withMonitors + +```ts +withMonitors(monitors) +``` + +"monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.rbd.withMonitorsMixin + +```ts +withMonitorsMixin(monitors) +``` + +"monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.rbd.withPool + +```ts +withPool(pool) +``` + +"pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.rbd.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.rbd.withUser + +```ts +withUser(user) +``` + +"user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.rbd.secretRef + +"secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.rbd.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.scaleIO + +"scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.scaleIO.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"xfs\"." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.scaleIO.withGateway + +```ts +withGateway(gateway) +``` + +"gateway is the host address of the ScaleIO API Gateway." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.scaleIO.withProtectionDomain + +```ts +withProtectionDomain(protectionDomain) +``` + +"protectionDomain is the name of the ScaleIO Protection Domain for the configured storage." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.scaleIO.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.scaleIO.withSslEnabled + +```ts +withSslEnabled(sslEnabled) +``` + +"sslEnabled Flag enable/disable SSL communication with Gateway, default false" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.scaleIO.withStorageMode + +```ts +withStorageMode(storageMode) +``` + +"storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.scaleIO.withStoragePool + +```ts +withStoragePool(storagePool) +``` + +"storagePool is the ScaleIO Storage Pool associated with the protection domain." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.scaleIO.withSystem + +```ts +withSystem(system) +``` + +"system is the name of the storage system as configured in ScaleIO." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.scaleIO.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.scaleIO.secretRef + +"secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.scaleIO.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.secret + +"secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.secret.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.secret.withItems + +```ts +withItems(items) +``` + +"items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.secret.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.secret.withOptional + +```ts +withOptional(optional) +``` + +"optional field specify whether the Secret or its keys must be defined" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.secret.withSecretName + +```ts +withSecretName(secretName) +``` + +"secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.secret.items + +"items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.secret.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.secret.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.secret.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.storageos + +"storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.storageos.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.storageos.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.storageos.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.storageos.withVolumeNamespace + +```ts +withVolumeNamespace(volumeNamespace) +``` + +"volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to \"default\" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created." + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.storageos.secretRef + +"secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.storageos.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?" + +## obj spec.provider.kubernetes.envoyDeployment.pod.volumes.vsphereVolume + +"vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine" + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.vsphereVolume.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.vsphereVolume.withStoragePolicyID + +```ts +withStoragePolicyID(storagePolicyID) +``` + +"storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.vsphereVolume.withStoragePolicyName + +```ts +withStoragePolicyName(storagePolicyName) +``` + +"storagePolicyName is the storage Policy Based Management (SPBM) profile name." + +### fn spec.provider.kubernetes.envoyDeployment.pod.volumes.vsphereVolume.withVolumePath + +```ts +withVolumePath(volumePath) +``` + +"volumePath is the path that identifies vSphere volume vmdk" + +## obj spec.provider.kubernetes.envoyDeployment.strategy + +"The deployment strategy to use to replace existing pods with new ones." + +### fn spec.provider.kubernetes.envoyDeployment.strategy.withType + +```ts +withType(type) +``` + +"Type of deployment. Can be \"Recreate\" or \"RollingUpdate\". Default is RollingUpdate." + +## obj spec.provider.kubernetes.envoyDeployment.strategy.rollingUpdate + +"Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. --- TODO: Update this to follow our convention for oneOf, whatever we decide it to be." + +### fn spec.provider.kubernetes.envoyDeployment.strategy.rollingUpdate.withMaxSurge + +```ts +withMaxSurge(maxSurge) +``` + +"The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods." + +### fn spec.provider.kubernetes.envoyDeployment.strategy.rollingUpdate.withMaxUnavailable + +```ts +withMaxUnavailable(maxUnavailable) +``` + +"The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods." + +## obj spec.provider.kubernetes.envoyService + +"EnvoyService defines the desired state of the Envoy service resource. If unspecified, default settings for the managed Envoy service resource are applied." + +### fn spec.provider.kubernetes.envoyService.withAllocateLoadBalancerNodePorts + +```ts +withAllocateLoadBalancerNodePorts(allocateLoadBalancerNodePorts) +``` + +"AllocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is \"true\". It may be set to \"false\" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type." + +### fn spec.provider.kubernetes.envoyService.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations that should be appended to the service. By default, no annotations are appended." + +### fn spec.provider.kubernetes.envoyService.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations that should be appended to the service. By default, no annotations are appended." + +**Note:** This function appends passed data to existing values + +### fn spec.provider.kubernetes.envoyService.withLoadBalancerClass + +```ts +withLoadBalancerClass(loadBalancerClass) +``` + +"LoadBalancerClass, when specified, allows for choosing the LoadBalancer provider implementation if more than one are available or is otherwise expected to be specified" + +### fn spec.provider.kubernetes.envoyService.withLoadBalancerIP + +```ts +withLoadBalancerIP(loadBalancerIP) +``` + +"LoadBalancerIP defines the IP Address of the underlying load balancer service. This field may be ignored if the load balancer provider does not support this feature. This field has been deprecated in Kubernetes, but it is still used for setting the IP Address in some cloud providers such as GCP." + +### fn spec.provider.kubernetes.envoyService.withType + +```ts +withType(type) +``` + +"Type determines how the Service is exposed. Defaults to LoadBalancer. Valid options are ClusterIP, LoadBalancer and NodePort. \"LoadBalancer\" means a service will be exposed via an external load balancer (if the cloud provider supports it). \"ClusterIP\" means a service will only be accessible inside the cluster, via the cluster IP. \"NodePort\" means a service will be exposed on a static Port on all Nodes of the cluster." + +## obj spec.telemetry + +"Telemetry defines telemetry parameters for managed proxies." + +## obj spec.telemetry.accessLog + +"AccessLogs defines accesslog parameters for managed proxies. If unspecified, will send default format to stdout." + +### fn spec.telemetry.accessLog.withDisable + +```ts +withDisable(disable) +``` + +"Disable disables access logging for managed proxies if set to true." + +### fn spec.telemetry.accessLog.withSettings + +```ts +withSettings(settings) +``` + +"Settings defines accesslog settings for managed proxies. If unspecified, will send default format to stdout." + +### fn spec.telemetry.accessLog.withSettingsMixin + +```ts +withSettingsMixin(settings) +``` + +"Settings defines accesslog settings for managed proxies. If unspecified, will send default format to stdout." + +**Note:** This function appends passed data to existing values + +## obj spec.telemetry.accessLog.settings + +"Settings defines accesslog settings for managed proxies. If unspecified, will send default format to stdout." + +### fn spec.telemetry.accessLog.settings.withSinks + +```ts +withSinks(sinks) +``` + +"Sinks defines the sinks of accesslog." + +### fn spec.telemetry.accessLog.settings.withSinksMixin + +```ts +withSinksMixin(sinks) +``` + +"Sinks defines the sinks of accesslog." + +**Note:** This function appends passed data to existing values + +## obj spec.telemetry.accessLog.settings.format + +"Format defines the format of accesslog." + +### fn spec.telemetry.accessLog.settings.format.withJson + +```ts +withJson(json) +``` + +"JSON is additional attributes that describe the specific event occurrence. Structured format for the envoy access logs. Envoy [command operators](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators) can be used as values for fields within the Struct. It's required when the format type is \"JSON\"." + +### fn spec.telemetry.accessLog.settings.format.withJsonMixin + +```ts +withJsonMixin(json) +``` + +"JSON is additional attributes that describe the specific event occurrence. Structured format for the envoy access logs. Envoy [command operators](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators) can be used as values for fields within the Struct. It's required when the format type is \"JSON\"." + +**Note:** This function appends passed data to existing values + +### fn spec.telemetry.accessLog.settings.format.withText + +```ts +withText(text) +``` + +"Text defines the text accesslog format, following Envoy accesslog formatting, It's required when the format type is \"Text\". Envoy [command operators](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators) may be used in the format. The [format string documentation](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#config-access-log-format-strings) provides more information." + +### fn spec.telemetry.accessLog.settings.format.withType + +```ts +withType(type) +``` + +"Type defines the type of accesslog format." + +## obj spec.telemetry.accessLog.settings.sinks + +"Sinks defines the sinks of accesslog." + +### fn spec.telemetry.accessLog.settings.sinks.withType + +```ts +withType(type) +``` + +"Type defines the type of accesslog sink." + +## obj spec.telemetry.accessLog.settings.sinks.file + +"File defines the file accesslog sink." + +### fn spec.telemetry.accessLog.settings.sinks.file.withPath + +```ts +withPath(path) +``` + +"Path defines the file path used to expose envoy access log(e.g. /dev/stdout)." + +## obj spec.telemetry.accessLog.settings.sinks.openTelemetry + +"OpenTelemetry defines the OpenTelemetry accesslog sink." + +### fn spec.telemetry.accessLog.settings.sinks.openTelemetry.withHost + +```ts +withHost(host) +``` + +"Host define the extension service hostname." + +### fn spec.telemetry.accessLog.settings.sinks.openTelemetry.withPort + +```ts +withPort(port) +``` + +"Port defines the port the extension service is exposed on." + +### fn spec.telemetry.accessLog.settings.sinks.openTelemetry.withResources + +```ts +withResources(resources) +``` + +"Resources is a set of labels that describe the source of a log entry, including envoy node info. It's recommended to follow [semantic conventions](https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/)." + +### fn spec.telemetry.accessLog.settings.sinks.openTelemetry.withResourcesMixin + +```ts +withResourcesMixin(resources) +``` + +"Resources is a set of labels that describe the source of a log entry, including envoy node info. It's recommended to follow [semantic conventions](https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/)." + +**Note:** This function appends passed data to existing values + +## obj spec.telemetry.metrics + +"Metrics defines metrics configuration for managed proxies." + +### fn spec.telemetry.metrics.withEnableVirtualHostStats + +```ts +withEnableVirtualHostStats(enableVirtualHostStats) +``` + +"EnableVirtualHostStats enables envoy stat metrics for virtual hosts." + +### fn spec.telemetry.metrics.withMatches + +```ts +withMatches(matches) +``` + +"Matches defines configuration for selecting specific metrics instead of generating all metrics stats that are enabled by default. This helps reduce CPU and memory overhead in Envoy, but eliminating some stats may after critical functionality. Here are the stats that we strongly recommend not disabling: `cluster_manager.warming_clusters`, `cluster..membership_total`,`cluster..membership_healthy`, `cluster..membership_degraded`，reference https://github.com/envoyproxy/envoy/issues/9856, https://github.com/envoyproxy/envoy/issues/14610" + +### fn spec.telemetry.metrics.withMatchesMixin + +```ts +withMatchesMixin(matches) +``` + +"Matches defines configuration for selecting specific metrics instead of generating all metrics stats that are enabled by default. This helps reduce CPU and memory overhead in Envoy, but eliminating some stats may after critical functionality. Here are the stats that we strongly recommend not disabling: `cluster_manager.warming_clusters`, `cluster..membership_total`,`cluster..membership_healthy`, `cluster..membership_degraded`，reference https://github.com/envoyproxy/envoy/issues/9856, https://github.com/envoyproxy/envoy/issues/14610" + +**Note:** This function appends passed data to existing values + +### fn spec.telemetry.metrics.withSinks + +```ts +withSinks(sinks) +``` + +"Sinks defines the metric sinks where metrics are sent to." + +### fn spec.telemetry.metrics.withSinksMixin + +```ts +withSinksMixin(sinks) +``` + +"Sinks defines the metric sinks where metrics are sent to." + +**Note:** This function appends passed data to existing values + +## obj spec.telemetry.metrics.matches + +"Matches defines configuration for selecting specific metrics instead of generating all metrics stats that are enabled by default. This helps reduce CPU and memory overhead in Envoy, but eliminating some stats may after critical functionality. Here are the stats that we strongly recommend not disabling: `cluster_manager.warming_clusters`, `cluster..membership_total`,`cluster..membership_healthy`, `cluster..membership_degraded`，reference https://github.com/envoyproxy/envoy/issues/9856, https://github.com/envoyproxy/envoy/issues/14610" + +### fn spec.telemetry.metrics.matches.withType + +```ts +withType(type) +``` + +"MatcherType defines the stats matcher type" + +### fn spec.telemetry.metrics.matches.withValue + +```ts +withValue(value) +``` + + + +## obj spec.telemetry.metrics.prometheus + +"Prometheus defines the configuration for Admin endpoint `/stats/prometheus`." + +### fn spec.telemetry.metrics.prometheus.withDisable + +```ts +withDisable(disable) +``` + +"Disable the Prometheus endpoint." + +## obj spec.telemetry.metrics.sinks + +"Sinks defines the metric sinks where metrics are sent to." + +### fn spec.telemetry.metrics.sinks.withType + +```ts +withType(type) +``` + +"Type defines the metric sink type. EG currently only supports OpenTelemetry." + +## obj spec.telemetry.metrics.sinks.openTelemetry + +"OpenTelemetry defines the configuration for OpenTelemetry sink. It's required if the sink type is OpenTelemetry." + +### fn spec.telemetry.metrics.sinks.openTelemetry.withHost + +```ts +withHost(host) +``` + +"Host define the service hostname." + +### fn spec.telemetry.metrics.sinks.openTelemetry.withPort + +```ts +withPort(port) +``` + +"Port defines the port the service is exposed on." + +## obj spec.telemetry.tracing + +"Tracing defines tracing configuration for managed proxies. If unspecified, will not send tracing data." + +### fn spec.telemetry.tracing.withCustomTags + +```ts +withCustomTags(customTags) +``` + +"CustomTags defines the custom tags to add to each span. If provider is kubernetes, pod name and namespace are added by default." + +### fn spec.telemetry.tracing.withCustomTagsMixin + +```ts +withCustomTagsMixin(customTags) +``` + +"CustomTags defines the custom tags to add to each span. If provider is kubernetes, pod name and namespace are added by default." + +**Note:** This function appends passed data to existing values + +### fn spec.telemetry.tracing.withSamplingRate + +```ts +withSamplingRate(samplingRate) +``` + +"SamplingRate controls the rate at which traffic will be selected for tracing if no prior sampling decision has been made. Defaults to 100, valid values [0-100]. 100 indicates 100% sampling." + +## obj spec.telemetry.tracing.provider + +"Provider defines the tracing provider. Only OpenTelemetry is supported currently." + +### fn spec.telemetry.tracing.provider.withHost + +```ts +withHost(host) +``` + +"Host define the provider service hostname." + +### fn spec.telemetry.tracing.provider.withPort + +```ts +withPort(port) +``` + +"Port defines the port the provider service is exposed on." + +### fn spec.telemetry.tracing.provider.withType + +```ts +withType(type) +``` + +"Type defines the tracing provider type. EG currently only supports OpenTelemetry." \ No newline at end of file diff --git a/docs/v0.6.0/gateway/v1alpha1/index.md b/docs/v0.6.0/gateway/v1alpha1/index.md new file mode 100644 index 0000000..a7bd454 --- /dev/null +++ b/docs/v0.6.0/gateway/v1alpha1/index.md @@ -0,0 +1,13 @@ +--- +permalink: /v0.6.0/gateway/v1alpha1/ +--- + +# gateway.v1alpha1 + + + +* [backendTrafficPolicy](backendTrafficPolicy.md) +* [clientTrafficPolicy](clientTrafficPolicy.md) +* [envoyPatchPolicy](envoyPatchPolicy.md) +* [envoyProxy](envoyProxy.md) +* [securityPolicy](securityPolicy.md) \ No newline at end of file diff --git a/docs/v0.6.0/gateway/v1alpha1/securityPolicy.md b/docs/v0.6.0/gateway/v1alpha1/securityPolicy.md new file mode 100644 index 0000000..06ffd7f --- /dev/null +++ b/docs/v0.6.0/gateway/v1alpha1/securityPolicy.md @@ -0,0 +1,502 @@ +--- +permalink: /v0.6.0/gateway/v1alpha1/securityPolicy/ +--- + +# gateway.v1alpha1.securityPolicy + +"SecurityPolicy allows the user to configure various security settings for a Gateway." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`obj spec.cors`](#obj-speccors) + * [`fn withAllowHeaders(allowHeaders)`](#fn-speccorswithallowheaders) + * [`fn withAllowHeadersMixin(allowHeaders)`](#fn-speccorswithallowheadersmixin) + * [`fn withAllowMethods(allowMethods)`](#fn-speccorswithallowmethods) + * [`fn withAllowMethodsMixin(allowMethods)`](#fn-speccorswithallowmethodsmixin) + * [`fn withAllowOrigins(allowOrigins)`](#fn-speccorswithalloworigins) + * [`fn withAllowOriginsMixin(allowOrigins)`](#fn-speccorswithalloworiginsmixin) + * [`fn withExposeHeaders(exposeHeaders)`](#fn-speccorswithexposeheaders) + * [`fn withExposeHeadersMixin(exposeHeaders)`](#fn-speccorswithexposeheadersmixin) + * [`fn withMaxAge(maxAge)`](#fn-speccorswithmaxage) + * [`obj spec.cors.allowOrigins`](#obj-speccorsalloworigins) + * [`fn withType(type)`](#fn-speccorsalloworiginswithtype) + * [`fn withValue(value)`](#fn-speccorsalloworiginswithvalue) + * [`obj spec.jwt`](#obj-specjwt) + * [`fn withProviders(providers)`](#fn-specjwtwithproviders) + * [`fn withProvidersMixin(providers)`](#fn-specjwtwithprovidersmixin) + * [`obj spec.jwt.providers`](#obj-specjwtproviders) + * [`fn withAudiences(audiences)`](#fn-specjwtproviderswithaudiences) + * [`fn withAudiencesMixin(audiences)`](#fn-specjwtproviderswithaudiencesmixin) + * [`fn withClaimToHeaders(claimToHeaders)`](#fn-specjwtproviderswithclaimtoheaders) + * [`fn withClaimToHeadersMixin(claimToHeaders)`](#fn-specjwtproviderswithclaimtoheadersmixin) + * [`fn withIssuer(issuer)`](#fn-specjwtproviderswithissuer) + * [`fn withName(name)`](#fn-specjwtproviderswithname) + * [`obj spec.jwt.providers.claimToHeaders`](#obj-specjwtprovidersclaimtoheaders) + * [`fn withClaim(claim)`](#fn-specjwtprovidersclaimtoheaderswithclaim) + * [`fn withHeader(header)`](#fn-specjwtprovidersclaimtoheaderswithheader) + * [`obj spec.jwt.providers.remoteJWKS`](#obj-specjwtprovidersremotejwks) + * [`fn withUri(uri)`](#fn-specjwtprovidersremotejwkswithuri) + * [`obj spec.targetRef`](#obj-spectargetref) + * [`fn withGroup(group)`](#fn-spectargetrefwithgroup) + * [`fn withKind(kind)`](#fn-spectargetrefwithkind) + * [`fn withName(name)`](#fn-spectargetrefwithname) + * [`fn withNamespace(namespace)`](#fn-spectargetrefwithnamespace) + * [`fn withSectionName(sectionName)`](#fn-spectargetrefwithsectionname) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of SecurityPolicy + +## 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 + +"Spec defines the desired state of SecurityPolicy." + +## obj spec.cors + +"CORS defines the configuration for Cross-Origin Resource Sharing (CORS)." + +### fn spec.cors.withAllowHeaders + +```ts +withAllowHeaders(allowHeaders) +``` + +"AllowHeaders defines the headers that are allowed to be sent with requests." + +### fn spec.cors.withAllowHeadersMixin + +```ts +withAllowHeadersMixin(allowHeaders) +``` + +"AllowHeaders defines the headers that are allowed to be sent with requests." + +**Note:** This function appends passed data to existing values + +### fn spec.cors.withAllowMethods + +```ts +withAllowMethods(allowMethods) +``` + +"AllowMethods defines the methods that are allowed to make requests." + +### fn spec.cors.withAllowMethodsMixin + +```ts +withAllowMethodsMixin(allowMethods) +``` + +"AllowMethods defines the methods that are allowed to make requests." + +**Note:** This function appends passed data to existing values + +### fn spec.cors.withAllowOrigins + +```ts +withAllowOrigins(allowOrigins) +``` + +"AllowOrigins defines the origins that are allowed to make requests." + +### fn spec.cors.withAllowOriginsMixin + +```ts +withAllowOriginsMixin(allowOrigins) +``` + +"AllowOrigins defines the origins that are allowed to make requests." + +**Note:** This function appends passed data to existing values + +### fn spec.cors.withExposeHeaders + +```ts +withExposeHeaders(exposeHeaders) +``` + +"ExposeHeaders defines the headers that can be exposed in the responses." + +### fn spec.cors.withExposeHeadersMixin + +```ts +withExposeHeadersMixin(exposeHeaders) +``` + +"ExposeHeaders defines the headers that can be exposed in the responses." + +**Note:** This function appends passed data to existing values + +### fn spec.cors.withMaxAge + +```ts +withMaxAge(maxAge) +``` + +"MaxAge defines how long the results of a preflight request can be cached." + +## obj spec.cors.allowOrigins + +"AllowOrigins defines the origins that are allowed to make requests." + +### fn spec.cors.allowOrigins.withType + +```ts +withType(type) +``` + +"Type specifies how to match against a string." + +### fn spec.cors.allowOrigins.withValue + +```ts +withValue(value) +``` + +"Value specifies the string value that the match must have." + +## obj spec.jwt + +"JWT defines the configuration for JSON Web Token (JWT) authentication." + +### fn spec.jwt.withProviders + +```ts +withProviders(providers) +``` + +"Providers defines the JSON Web Token (JWT) authentication provider type. \n When multiple JWT providers are specified, the JWT is considered valid if any of the providers successfully validate the JWT. For additional details, see https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/jwt_authn_filter.html." + +### fn spec.jwt.withProvidersMixin + +```ts +withProvidersMixin(providers) +``` + +"Providers defines the JSON Web Token (JWT) authentication provider type. \n When multiple JWT providers are specified, the JWT is considered valid if any of the providers successfully validate the JWT. For additional details, see https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/jwt_authn_filter.html." + +**Note:** This function appends passed data to existing values + +## obj spec.jwt.providers + +"Providers defines the JSON Web Token (JWT) authentication provider type. \n When multiple JWT providers are specified, the JWT is considered valid if any of the providers successfully validate the JWT. For additional details, see https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/jwt_authn_filter.html." + +### fn spec.jwt.providers.withAudiences + +```ts +withAudiences(audiences) +``` + +"Audiences is a list of JWT audiences allowed access. For additional details, see https://tools.ietf.org/html/rfc7519#section-4.1.3. If not provided, JWT audiences are not checked." + +### fn spec.jwt.providers.withAudiencesMixin + +```ts +withAudiencesMixin(audiences) +``` + +"Audiences is a list of JWT audiences allowed access. For additional details, see https://tools.ietf.org/html/rfc7519#section-4.1.3. If not provided, JWT audiences are not checked." + +**Note:** This function appends passed data to existing values + +### fn spec.jwt.providers.withClaimToHeaders + +```ts +withClaimToHeaders(claimToHeaders) +``` + +"ClaimToHeaders is a list of JWT claims that must be extracted into HTTP request headers For examples, following config: The claim must be of type; string, int, double, bool. Array type claims are not supported" + +### fn spec.jwt.providers.withClaimToHeadersMixin + +```ts +withClaimToHeadersMixin(claimToHeaders) +``` + +"ClaimToHeaders is a list of JWT claims that must be extracted into HTTP request headers For examples, following config: The claim must be of type; string, int, double, bool. Array type claims are not supported" + +**Note:** This function appends passed data to existing values + +### fn spec.jwt.providers.withIssuer + +```ts +withIssuer(issuer) +``` + +"Issuer is the principal that issued the JWT and takes the form of a URL or email address. For additional details, see https://tools.ietf.org/html/rfc7519#section-4.1.1 for URL format and https://rfc-editor.org/rfc/rfc5322.html for email format. If not provided, the JWT issuer is not checked." + +### fn spec.jwt.providers.withName + +```ts +withName(name) +``` + +"Name defines a unique name for the JWT provider. A name can have a variety of forms, including RFC1123 subdomains, RFC 1123 labels, or RFC 1035 labels." + +## obj spec.jwt.providers.claimToHeaders + +"ClaimToHeaders is a list of JWT claims that must be extracted into HTTP request headers For examples, following config: The claim must be of type; string, int, double, bool. Array type claims are not supported" + +### fn spec.jwt.providers.claimToHeaders.withClaim + +```ts +withClaim(claim) +``` + +"Claim is the JWT Claim that should be saved into the header : it can be a nested claim of type (eg. \"claim.nested.key\", \"sub\"). The nested claim name must use dot \".\" to separate the JSON name path." + +### fn spec.jwt.providers.claimToHeaders.withHeader + +```ts +withHeader(header) +``` + +"Header defines the name of the HTTP request header that the JWT Claim will be saved into." + +## obj spec.jwt.providers.remoteJWKS + +"RemoteJWKS defines how to fetch and cache JSON Web Key Sets (JWKS) from a remote HTTP/HTTPS endpoint." + +### fn spec.jwt.providers.remoteJWKS.withUri + +```ts +withUri(uri) +``` + +"URI is the HTTPS URI to fetch the JWKS. Envoy's system trust bundle is used to validate the server certificate." + +## obj spec.targetRef + +"TargetRef is the name of the Gateway resource this policy is being attached to. This Policy and the TargetRef MUST be in the same namespace for this Policy to have effect and be applied to the Gateway. TargetRef" + +### fn spec.targetRef.withGroup + +```ts +withGroup(group) +``` + +"Group is the group of the target resource." + +### fn spec.targetRef.withKind + +```ts +withKind(kind) +``` + +"Kind is kind of the target resource." + +### fn spec.targetRef.withName + +```ts +withName(name) +``` + +"Name is the name of the target resource." + +### fn spec.targetRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of the referent. When unspecified, the local namespace is inferred. Even when policy targets a resource in a different namespace, it MUST only apply to traffic originating from the same namespace as the policy." + +### fn spec.targetRef.withSectionName + +```ts +withSectionName(sectionName) +``` + +"SectionName is the name of a section within the target resource. When unspecified, this targetRef targets the entire resource. In the following resources, SectionName is interpreted as the following: \n * Gateway: Listener Name * Service: Port Name \n If a SectionName is specified, but does not exist on the targeted object, the Policy must fail to attach, and the policy implementation should record a `ResolvedRefs` or similar Condition in the Policy's status." \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..c1cc75f --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,35 @@ +"edit_uri": "" +"extra_css": + - "stylesheets/extra.css" +"markdown_extensions": + - "pymdownx.highlight" + - "pymdownx.superfences" +"plugins": + - "search": + "indexing": "titles" + "min_search_length": 2 + "prebuild_index": true + "separator": "[\\s\\-\\.]+" + - "minify": + "minify_html": true +"repo_name": "jsonnet-libs/envoy-gateway-libsonnet" +"repo_url": "https://github.com/jsonnet-libs/envoy-gateway-libsonnet" +"site_name": "envoy-gateway jsonnet library" +"site_url": "https://jsonnet-libs.github.io/envoy-gateway-libsonnet" +"theme": + "name": "material" + "palette": + - "accent": "indigo" + "media": "(prefers-color-scheme: light)" + "primary": "indigo" + "scheme": "default" + "toggle": + "icon": "material/toggle-switch-off-outline" + "name": "Switch to dark mode" + - "accent": "red" + "media": "(prefers-color-scheme: dark)" + "primary": "red" + "scheme": "slate" + "toggle": + "icon": "material/toggle-switch" + "name": "Switch to light mode" \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..625beda --- /dev/null +++ b/requirements.txt @@ -0,0 +1,11 @@ +# mkdocs +mkdocs>=1.3.0 + +# To limit search to a subset +mkdocs-exclude-search>=0.5 + +# To minify the HTML +mkdocs-minify-plugin>=0.3 + +# Include the theme +mkdocs-material>=7.1.6 diff --git a/v0.6.0/_gen/gateway/main.libsonnet b/v0.6.0/_gen/gateway/main.libsonnet new file mode 100644 index 0000000..2ee54e4 --- /dev/null +++ b/v0.6.0/_gen/gateway/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='gateway', url='', help=''), + v1alpha1: (import 'v1alpha1/main.libsonnet'), +} diff --git a/v0.6.0/_gen/gateway/v1alpha1/backendTrafficPolicy.libsonnet b/v0.6.0/_gen/gateway/v1alpha1/backendTrafficPolicy.libsonnet new file mode 100644 index 0000000..46fc843 --- /dev/null +++ b/v0.6.0/_gen/gateway/v1alpha1/backendTrafficPolicy.libsonnet @@ -0,0 +1,127 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='backendTrafficPolicy', url='', help='"BackendTrafficPolicy allows the user to configure the behavior of the connection between the downstream client and Envoy Proxy listener."'), + '#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 BackendTrafficPolicy', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'gateway.envoyproxy.io/v1alpha1', + kind: 'BackendTrafficPolicy', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"spec defines the desired state of BackendTrafficPolicy."'), + spec: { + '#loadBalancer':: d.obj(help='"LoadBalancer policy to apply when routing traffic from the gateway to the backend endpoints"'), + loadBalancer: { + '#consistentHash':: d.obj(help='"ConsistentHash defines the configuration when the load balancer type is set to ConsistentHash"'), + consistentHash: { + '#withType':: d.fn(help='"ConsistentHashType defines the type of input to hash on."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { loadBalancer+: { consistentHash+: { type: type } } } }, + }, + '#withType':: d.fn(help='"Type decides the type of Load Balancer policy. Valid LoadBalancerType values are \\"ConsistentHash\\", \\"LeastRequest\\", \\"Random\\", \\"RoundRobin\\","', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { loadBalancer+: { type: type } } }, + }, + '#rateLimit':: d.obj(help='"RateLimit allows the user to limit the number of incoming requests to a predefined value based on attributes within the traffic flow."'), + rateLimit: { + '#global':: d.obj(help='"Global defines global rate limit configuration."'), + global: { + '#rules':: d.obj(help='"Rules are a list of RateLimit selectors and limits. Each rule and its associated limit is applied in a mutually exclusive way i.e. if multiple rules get selected, each of their associated limits get applied, so a single traffic request might increase the rate limit counters for multiple rules if selected."'), + rules: { + '#clientSelectors':: d.obj(help='"ClientSelectors holds the list of select conditions to select specific clients using attributes from the traffic flow. All individual select conditions must hold True for this rule and its limit to be applied. If this field is empty, it is equivalent to True, and the limit is applied."'), + clientSelectors: { + '#headers':: d.obj(help='"Headers is a list of request headers to match. Multiple header values are ANDed together, meaning, a request MUST match all the specified headers."'), + headers: { + '#withName':: d.fn(help='"Name of the HTTP header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withType':: d.fn(help='"Type specifies how to match against the value of the header."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { type: type }, + '#withValue':: d.fn(help='"Value within the HTTP header. Due to the case-insensitivity of header names, \\"foo\\" and \\"Foo\\" are considered equivalent. Do not set this field when Type=\\"Distinct\\", implying matching on any/all unique values within the header."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#sourceCIDR':: d.obj(help='"SourceCIDR is the client IP Address range to match on."'), + sourceCIDR: { + '#withType':: d.fn(help='', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { sourceCIDR+: { type: type } }, + '#withValue':: d.fn(help='"Value is the IP CIDR that represents the range of Source IP Addresses of the client. These could also be the intermediate addresses through which the request has flown through and is part of the `X-Forwarded-For` header. For example, `192.168.0.1/32`, `192.168.0.0/24`, `001:db8::/64`."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { sourceCIDR+: { value: value } }, + }, + '#withHeaders':: d.fn(help='"Headers is a list of request headers to match. Multiple header values are ANDed together, meaning, a request MUST match all the specified headers."', args=[d.arg(name='headers', type=d.T.array)]), + withHeaders(headers): { headers: if std.isArray(v=headers) then headers else [headers] }, + '#withHeadersMixin':: d.fn(help='"Headers is a list of request headers to match. Multiple header values are ANDed together, meaning, a request MUST match all the specified headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='headers', type=d.T.array)]), + withHeadersMixin(headers): { headers+: if std.isArray(v=headers) then headers else [headers] }, + }, + '#limit':: d.obj(help='"Limit holds the rate limit values. This limit is applied for traffic flows when the selectors compute to True, causing the request to be counted towards the limit. The limit is enforced and the request is ratelimited, i.e. a response with 429 HTTP status code is sent back to the client when the selected requests have reached the limit."'), + limit: { + '#withRequests':: d.fn(help='', args=[d.arg(name='requests', type=d.T.integer)]), + withRequests(requests): { limit+: { requests: requests } }, + '#withUnit':: d.fn(help='"RateLimitUnit specifies the intervals for setting rate limits. Valid RateLimitUnit values are \\"Second\\", \\"Minute\\", \\"Hour\\", and \\"Day\\"."', args=[d.arg(name='unit', type=d.T.string)]), + withUnit(unit): { limit+: { unit: unit } }, + }, + '#withClientSelectors':: d.fn(help='"ClientSelectors holds the list of select conditions to select specific clients using attributes from the traffic flow. All individual select conditions must hold True for this rule and its limit to be applied. If this field is empty, it is equivalent to True, and the limit is applied."', args=[d.arg(name='clientSelectors', type=d.T.array)]), + withClientSelectors(clientSelectors): { clientSelectors: if std.isArray(v=clientSelectors) then clientSelectors else [clientSelectors] }, + '#withClientSelectorsMixin':: d.fn(help='"ClientSelectors holds the list of select conditions to select specific clients using attributes from the traffic flow. All individual select conditions must hold True for this rule and its limit to be applied. If this field is empty, it is equivalent to True, and the limit is applied."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='clientSelectors', type=d.T.array)]), + withClientSelectorsMixin(clientSelectors): { clientSelectors+: if std.isArray(v=clientSelectors) then clientSelectors else [clientSelectors] }, + }, + '#withRules':: d.fn(help='"Rules are a list of RateLimit selectors and limits. Each rule and its associated limit is applied in a mutually exclusive way i.e. if multiple rules get selected, each of their associated limits get applied, so a single traffic request might increase the rate limit counters for multiple rules if selected."', args=[d.arg(name='rules', type=d.T.array)]), + withRules(rules): { spec+: { rateLimit+: { global+: { rules: if std.isArray(v=rules) then rules else [rules] } } } }, + '#withRulesMixin':: d.fn(help='"Rules are a list of RateLimit selectors and limits. Each rule and its associated limit is applied in a mutually exclusive way i.e. if multiple rules get selected, each of their associated limits get applied, so a single traffic request might increase the rate limit counters for multiple rules if selected."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='rules', type=d.T.array)]), + withRulesMixin(rules): { spec+: { rateLimit+: { global+: { rules+: if std.isArray(v=rules) then rules else [rules] } } } }, + }, + '#withType':: d.fn(help='"Type decides the scope for the RateLimits. Valid RateLimitType values are \\"Global\\"."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { rateLimit+: { type: type } } }, + }, + '#targetRef':: d.obj(help='"targetRef is the name of the resource this policy is being attached to. This Policy and the TargetRef MUST be in the same namespace for this Policy to have effect and be applied to the Gateway."'), + targetRef: { + '#withGroup':: d.fn(help='"Group is the group of the target resource."', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { spec+: { targetRef+: { group: group } } }, + '#withKind':: d.fn(help='"Kind is kind of the target resource."', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { targetRef+: { kind: kind } } }, + '#withName':: d.fn(help='"Name is the name of the target resource."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { targetRef+: { name: name } } }, + '#withNamespace':: d.fn(help='"Namespace is the namespace of the referent. When unspecified, the local namespace is inferred. Even when policy targets a resource in a different namespace, it MUST only apply to traffic originating from the same namespace as the policy."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { targetRef+: { namespace: namespace } } }, + '#withSectionName':: d.fn(help="\"SectionName is the name of a section within the target resource. When unspecified, this targetRef targets the entire resource. In the following resources, SectionName is interpreted as the following: \\n * Gateway: Listener Name * Service: Port Name \\n If a SectionName is specified, but does not exist on the targeted object, the Policy must fail to attach, and the policy implementation should record a `ResolvedRefs` or similar Condition in the Policy's status.\"", args=[d.arg(name='sectionName', type=d.T.string)]), + withSectionName(sectionName): { spec+: { targetRef+: { sectionName: sectionName } } }, + }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/v0.6.0/_gen/gateway/v1alpha1/clientTrafficPolicy.libsonnet b/v0.6.0/_gen/gateway/v1alpha1/clientTrafficPolicy.libsonnet new file mode 100644 index 0000000..eaa7b91 --- /dev/null +++ b/v0.6.0/_gen/gateway/v1alpha1/clientTrafficPolicy.libsonnet @@ -0,0 +1,77 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='clientTrafficPolicy', url='', help='"ClientTrafficPolicy allows the user to configure the behavior of the connection between the downstream client and Envoy Proxy listener."'), + '#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 ClientTrafficPolicy', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'gateway.envoyproxy.io/v1alpha1', + kind: 'ClientTrafficPolicy', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"Spec defines the desired state of ClientTrafficPolicy."'), + spec: { + '#targetRef':: d.obj(help='"TargetRef is the name of the Gateway resource this policy is being attached to. This Policy and the TargetRef MUST be in the same namespace for this Policy to have effect and be applied to the Gateway. TargetRef"'), + targetRef: { + '#withGroup':: d.fn(help='"Group is the group of the target resource."', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { spec+: { targetRef+: { group: group } } }, + '#withKind':: d.fn(help='"Kind is kind of the target resource."', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { targetRef+: { kind: kind } } }, + '#withName':: d.fn(help='"Name is the name of the target resource."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { targetRef+: { name: name } } }, + '#withNamespace':: d.fn(help='"Namespace is the namespace of the referent. When unspecified, the local namespace is inferred. Even when policy targets a resource in a different namespace, it MUST only apply to traffic originating from the same namespace as the policy."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { targetRef+: { namespace: namespace } } }, + '#withSectionName':: d.fn(help="\"SectionName is the name of a section within the target resource. When unspecified, this targetRef targets the entire resource. In the following resources, SectionName is interpreted as the following: \\n * Gateway: Listener Name * Service: Port Name \\n If a SectionName is specified, but does not exist on the targeted object, the Policy must fail to attach, and the policy implementation should record a `ResolvedRefs` or similar Condition in the Policy's status.\"", args=[d.arg(name='sectionName', type=d.T.string)]), + withSectionName(sectionName): { spec+: { targetRef+: { sectionName: sectionName } } }, + }, + '#tcpKeepalive':: d.obj(help='"TcpKeepalive settings associated with the downstream client connection. If defined, sets SO_KEEPALIVE on the listener socket to enable TCP Keepalives. Disabled by default."'), + tcpKeepalive: { + '#withIdleTime':: d.fn(help='"The duration a connection needs to be idle before keep-alive probes start being sent. The duration format is Defaults to `7200s`."', args=[d.arg(name='idleTime', type=d.T.string)]), + withIdleTime(idleTime): { spec+: { tcpKeepalive+: { idleTime: idleTime } } }, + '#withInterval':: d.fn(help='"The duration between keep-alive probes. Defaults to `75s`."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { tcpKeepalive+: { interval: interval } } }, + '#withProbes':: d.fn(help='"The total number of unacknowledged probes to send before deciding the connection is dead. Defaults to 9."', args=[d.arg(name='probes', type=d.T.integer)]), + withProbes(probes): { spec+: { tcpKeepalive+: { probes: probes } } }, + }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/v0.6.0/_gen/gateway/v1alpha1/envoyPatchPolicy.libsonnet b/v0.6.0/_gen/gateway/v1alpha1/envoyPatchPolicy.libsonnet new file mode 100644 index 0000000..c73a61c --- /dev/null +++ b/v0.6.0/_gen/gateway/v1alpha1/envoyPatchPolicy.libsonnet @@ -0,0 +1,90 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='envoyPatchPolicy', url='', help='"EnvoyPatchPolicy allows the user to modify the generated Envoy xDS resources by Envoy Gateway using this patch 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 EnvoyPatchPolicy', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'gateway.envoyproxy.io/v1alpha1', + kind: 'EnvoyPatchPolicy', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"Spec defines the desired state of EnvoyPatchPolicy."'), + spec: { + '#jsonPatches':: d.obj(help='"JSONPatch defines the JSONPatch configuration."'), + jsonPatches: { + '#operation':: d.obj(help='"Patch defines the JSON Patch Operation"'), + operation: { + '#withOp':: d.fn(help='"Op is the type of operation to perform"', args=[d.arg(name='op', type=d.T.string)]), + withOp(op): { operation+: { op: op } }, + '#withPath':: d.fn(help='"Path is the location of the target document/field where the operation will be performed Refer to https://datatracker.ietf.org/doc/html/rfc6901 for more details."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { operation+: { path: path } }, + '#withValue':: d.fn(help='"Value is the new value of the path location."', args=[d.arg(name='value', type=d.T.any)]), + withValue(value): { operation+: { value: value } }, + }, + '#withName':: d.fn(help='"Name is the name of the resource"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withType':: d.fn(help='"Type is the typed URL of the Envoy xDS Resource"', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { type: type }, + }, + '#targetRef':: d.obj(help='"TargetRef is the name of the Gateway API resource this policy is being attached to. Currently only attaching to Gateway is supported This Policy and the TargetRef MUST be in the same namespace for this Policy to have effect and be applied to the Gateway TargetRef"'), + targetRef: { + '#withGroup':: d.fn(help='"Group is the group of the target resource."', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { spec+: { targetRef+: { group: group } } }, + '#withKind':: d.fn(help='"Kind is kind of the target resource."', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { targetRef+: { kind: kind } } }, + '#withName':: d.fn(help='"Name is the name of the target resource."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { targetRef+: { name: name } } }, + '#withNamespace':: d.fn(help='"Namespace is the namespace of the referent. When unspecified, the local namespace is inferred. Even when policy targets a resource in a different namespace, it MUST only apply to traffic originating from the same namespace as the policy."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { targetRef+: { namespace: namespace } } }, + }, + '#withJsonPatches':: d.fn(help='"JSONPatch defines the JSONPatch configuration."', args=[d.arg(name='jsonPatches', type=d.T.array)]), + withJsonPatches(jsonPatches): { spec+: { jsonPatches: if std.isArray(v=jsonPatches) then jsonPatches else [jsonPatches] } }, + '#withJsonPatchesMixin':: d.fn(help='"JSONPatch defines the JSONPatch configuration."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='jsonPatches', type=d.T.array)]), + withJsonPatchesMixin(jsonPatches): { spec+: { jsonPatches+: if std.isArray(v=jsonPatches) then jsonPatches else [jsonPatches] } }, + '#withPriority':: d.fn(help='"Priority of the EnvoyPatchPolicy. If multiple EnvoyPatchPolicies are applied to the same TargetRef, they will be applied in the ascending order of the priority i.e. int32.min has the highest priority and int32.max has the lowest priority. Defaults to 0."', args=[d.arg(name='priority', type=d.T.integer)]), + withPriority(priority): { spec+: { priority: priority } }, + '#withType':: d.fn(help='"Type decides the type of patch. Valid EnvoyPatchType values are \\"JSONPatch\\"."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { type: type } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/v0.6.0/_gen/gateway/v1alpha1/envoyProxy.libsonnet b/v0.6.0/_gen/gateway/v1alpha1/envoyProxy.libsonnet new file mode 100644 index 0000000..012c8ab --- /dev/null +++ b/v0.6.0/_gen/gateway/v1alpha1/envoyProxy.libsonnet @@ -0,0 +1,1868 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='envoyProxy', url='', help='"EnvoyProxy is the schema for the envoyproxies 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 EnvoyProxy', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'gateway.envoyproxy.io/v1alpha1', + kind: 'EnvoyProxy', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"EnvoyProxySpec defines the desired state of EnvoyProxy."'), + spec: { + '#bootstrap':: d.obj(help='"Bootstrap defines the Envoy Bootstrap as a YAML string. Visit https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/bootstrap/v3/bootstrap.proto#envoy-v3-api-msg-config-bootstrap-v3-bootstrap to learn more about the syntax. If set, this is the Bootstrap configuration used for the managed Envoy Proxy fleet instead of the default Bootstrap configuration set by Envoy Gateway. Some fields within the Bootstrap that are required to communicate with the xDS Server (Envoy Gateway) and receive xDS resources from it are not configurable and will result in the `EnvoyProxy` resource being rejected. Backward compatibility across minor versions is not guaranteed. We strongly recommend using `egctl x translate` to generate a `EnvoyProxy` resource with the `Bootstrap` field set to the default Bootstrap configuration used. You can edit this configuration, and rerun `egctl x translate` to ensure there are no validation errors."'), + bootstrap: { + '#withType':: d.fn(help='"Type is the type of the bootstrap configuration, it should be either Replace or Merge. If unspecified, it defaults to Replace."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { bootstrap+: { type: type } } }, + '#withValue':: d.fn(help='"Value is a YAML string of the bootstrap."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { spec+: { bootstrap+: { value: value } } }, + }, + '#logging':: d.obj(help='"Logging defines logging parameters for managed proxies."'), + logging: { + '#withLevel':: d.fn(help='"Level is a map of logging level per component, where the component is the key and the log level is the value. If unspecified, defaults to \\"default: warn\\"."', args=[d.arg(name='level', type=d.T.object)]), + withLevel(level): { spec+: { logging+: { level: level } } }, + '#withLevelMixin':: d.fn(help='"Level is a map of logging level per component, where the component is the key and the log level is the value. If unspecified, defaults to \\"default: warn\\"."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='level', type=d.T.object)]), + withLevelMixin(level): { spec+: { logging+: { level+: level } } }, + }, + '#provider':: d.obj(help='"Provider defines the desired resource provider and provider-specific configuration. If unspecified, the \\"Kubernetes\\" resource provider is used with default configuration parameters."'), + provider: { + '#kubernetes':: d.obj(help='"Kubernetes defines the desired state of the Kubernetes resource provider. Kubernetes provides infrastructure resources for running the data plane, e.g. Envoy proxy. If unspecified and type is \\"Kubernetes\\", default settings for managed Kubernetes resources are applied."'), + kubernetes: { + '#envoyDeployment':: d.obj(help='"EnvoyDeployment defines the desired state of the Envoy deployment resource. If unspecified, default settings for the managed Envoy deployment resource are applied."'), + envoyDeployment: { + '#container':: d.obj(help='"Container defines the desired specification of main container."'), + container: { + '#env':: d.obj(help='"List of environment variables to set in the container."'), + env: { + '#valueFrom':: d.obj(help="\"Source for the environment variable's value. Cannot be used if value is not empty.\""), + valueFrom: { + '#configMapKeyRef':: d.obj(help='"Selects a key of a ConfigMap."'), + configMapKeyRef: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { configMapKeyRef+: { key: key } } }, + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { configMapKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { configMapKeyRef+: { optional: optional } } }, + }, + '#fieldRef':: d.obj(help="\"Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\u003cKEY\u003e']`, `metadata.annotations['\u003cKEY\u003e']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.\""), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { valueFrom+: { fieldRef+: { apiVersion: apiVersion } } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { valueFrom+: { fieldRef+: { fieldPath: fieldPath } } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { valueFrom+: { resourceFieldRef+: { containerName: containerName } } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { valueFrom+: { resourceFieldRef+: { divisor: divisor } } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { valueFrom+: { resourceFieldRef+: { resource: resource } } }, + }, + '#secretKeyRef':: d.obj(help="\"Selects a key of a secret in the pod's namespace\""), + secretKeyRef: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { secretKeyRef+: { key: key } } }, + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { secretKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { secretKeyRef+: { optional: optional } } }, + }, + }, + '#withName':: d.fn(help='"Name of the environment variable. Must be a C_IDENTIFIER."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\"$$(VAR_NAME)\\" will produce the string literal \\"$(VAR_NAME)\\". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \\"\\"."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#resources':: d.obj(help='"Resources required by this container. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } } } } } } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } } } } } } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { resources+: { limits: limits } } } } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { resources+: { limits+: limits } } } } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { resources+: { requests: requests } } } } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { resources+: { requests+: requests } } } } } } }, + }, + '#securityContext':: d.obj(help='"SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"'), + securityContext: { + '#capabilities':: d.obj(help='"The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows."'), + capabilities: { + '#withAdd':: d.fn(help='"Added capabilities"', args=[d.arg(name='add', type=d.T.array)]), + withAdd(add): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { capabilities+: { add: if std.isArray(v=add) then add else [add] } } } } } } } }, + '#withAddMixin':: d.fn(help='"Added capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='add', type=d.T.array)]), + withAddMixin(add): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { capabilities+: { add+: if std.isArray(v=add) then add else [add] } } } } } } } }, + '#withDrop':: d.fn(help='"Removed capabilities"', args=[d.arg(name='drop', type=d.T.array)]), + withDrop(drop): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { capabilities+: { drop: if std.isArray(v=drop) then drop else [drop] } } } } } } } }, + '#withDropMixin':: d.fn(help='"Removed capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='drop', type=d.T.array)]), + withDropMixin(drop): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { capabilities+: { drop+: if std.isArray(v=drop) then drop else [drop] } } } } } } } }, + }, + '#seLinuxOptions':: d.obj(help='"The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows."'), + seLinuxOptions: { + '#withLevel':: d.fn(help='"Level is SELinux level label that applies to the container."', args=[d.arg(name='level', type=d.T.string)]), + withLevel(level): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { seLinuxOptions+: { level: level } } } } } } } }, + '#withRole':: d.fn(help='"Role is a SELinux role label that applies to the container."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { seLinuxOptions+: { role: role } } } } } } } }, + '#withType':: d.fn(help='"Type is a SELinux type label that applies to the container."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { seLinuxOptions+: { type: type } } } } } } } }, + '#withUser':: d.fn(help='"User is a SELinux user label that applies to the container."', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { seLinuxOptions+: { user: user } } } } } } } }, + }, + '#seccompProfile':: d.obj(help='"The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows."'), + seccompProfile: { + '#withLocalhostProfile':: d.fn(help="\"localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is \\\"Localhost\\\". Must NOT be set for any other type.\"", args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { seccompProfile+: { localhostProfile: localhostProfile } } } } } } } }, + '#withType':: d.fn(help='"type indicates which kind of seccomp profile will be applied. Valid options are: \\n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { seccompProfile+: { type: type } } } } } } } }, + }, + '#windowsOptions':: d.obj(help='"The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux."'), + windowsOptions: { + '#withGmsaCredentialSpec':: d.fn(help='"GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field."', args=[d.arg(name='gmsaCredentialSpec', type=d.T.string)]), + withGmsaCredentialSpec(gmsaCredentialSpec): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { windowsOptions+: { gmsaCredentialSpec: gmsaCredentialSpec } } } } } } } }, + '#withGmsaCredentialSpecName':: d.fn(help='"GMSACredentialSpecName is the name of the GMSA credential spec to use."', args=[d.arg(name='gmsaCredentialSpecName', type=d.T.string)]), + withGmsaCredentialSpecName(gmsaCredentialSpecName): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { windowsOptions+: { gmsaCredentialSpecName: gmsaCredentialSpecName } } } } } } } }, + '#withHostProcess':: d.fn(help="\"HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.\"", args=[d.arg(name='hostProcess', type=d.T.boolean)]), + withHostProcess(hostProcess): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { windowsOptions+: { hostProcess: hostProcess } } } } } } } }, + '#withRunAsUserName':: d.fn(help='"The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsUserName', type=d.T.string)]), + withRunAsUserName(runAsUserName): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { windowsOptions+: { runAsUserName: runAsUserName } } } } } } } }, + }, + '#withAllowPrivilegeEscalation':: d.fn(help='"AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='allowPrivilegeEscalation', type=d.T.boolean)]), + withAllowPrivilegeEscalation(allowPrivilegeEscalation): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { allowPrivilegeEscalation: allowPrivilegeEscalation } } } } } } }, + '#withPrivileged':: d.fn(help='"Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='privileged', type=d.T.boolean)]), + withPrivileged(privileged): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { privileged: privileged } } } } } } }, + '#withProcMount':: d.fn(help='"procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='procMount', type=d.T.string)]), + withProcMount(procMount): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { procMount: procMount } } } } } } }, + '#withReadOnlyRootFilesystem':: d.fn(help='"Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='readOnlyRootFilesystem', type=d.T.boolean)]), + withReadOnlyRootFilesystem(readOnlyRootFilesystem): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { readOnlyRootFilesystem: readOnlyRootFilesystem } } } } } } }, + '#withRunAsGroup':: d.fn(help='"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsGroup', type=d.T.integer)]), + withRunAsGroup(runAsGroup): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { runAsGroup: runAsGroup } } } } } } }, + '#withRunAsNonRoot':: d.fn(help='"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsNonRoot', type=d.T.boolean)]), + withRunAsNonRoot(runAsNonRoot): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { runAsNonRoot: runAsNonRoot } } } } } } }, + '#withRunAsUser':: d.fn(help='"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsUser', type=d.T.integer)]), + withRunAsUser(runAsUser): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { securityContext+: { runAsUser: runAsUser } } } } } } }, + }, + '#volumeMounts':: d.obj(help="\"VolumeMounts are volumes to mount into the container's filesystem. Cannot be updated.\""), + volumeMounts: { + '#withMountPath':: d.fn(help="\"Path within the container at which the volume should be mounted. Must not contain ':'.\"", args=[d.arg(name='mountPath', type=d.T.string)]), + withMountPath(mountPath): { mountPath: mountPath }, + '#withMountPropagation':: d.fn(help='"mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10."', args=[d.arg(name='mountPropagation', type=d.T.string)]), + withMountPropagation(mountPropagation): { mountPropagation: mountPropagation }, + '#withName':: d.fn(help='"This must match the Name of a Volume."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withReadOnly':: d.fn(help='"Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { readOnly: readOnly }, + '#withSubPath':: d.fn(help="\"Path within the volume from which the container's volume should be mounted. Defaults to \\\"\\\" (volume's root).\"", args=[d.arg(name='subPath', type=d.T.string)]), + withSubPath(subPath): { subPath: subPath }, + '#withSubPathExpr':: d.fn(help="\"Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \\\"\\\" (volume's root). SubPathExpr and SubPath are mutually exclusive.\"", args=[d.arg(name='subPathExpr', type=d.T.string)]), + withSubPathExpr(subPathExpr): { subPathExpr: subPathExpr }, + }, + '#withEnv':: d.fn(help='"List of environment variables to set in the container."', args=[d.arg(name='env', type=d.T.array)]), + withEnv(env): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { env: if std.isArray(v=env) then env else [env] } } } } } }, + '#withEnvMixin':: d.fn(help='"List of environment variables to set in the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='env', type=d.T.array)]), + withEnvMixin(env): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { env+: if std.isArray(v=env) then env else [env] } } } } } }, + '#withImage':: d.fn(help='"Image specifies the EnvoyProxy container image to be used, instead of the default image."', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { image: image } } } } } }, + '#withVolumeMounts':: d.fn(help="\"VolumeMounts are volumes to mount into the container's filesystem. Cannot be updated.\"", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMounts(volumeMounts): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { volumeMounts: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] } } } } } }, + '#withVolumeMountsMixin':: d.fn(help="\"VolumeMounts are volumes to mount into the container's filesystem. Cannot be updated.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMountsMixin(volumeMounts): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { container+: { volumeMounts+: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] } } } } } }, + }, + '#initContainers':: d.obj(help='"List of initialization containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/"'), + initContainers: { + '#env':: d.obj(help='"List of environment variables to set in the container. Cannot be updated."'), + env: { + '#valueFrom':: d.obj(help="\"Source for the environment variable's value. Cannot be used if value is not empty.\""), + valueFrom: { + '#configMapKeyRef':: d.obj(help='"Selects a key of a ConfigMap."'), + configMapKeyRef: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { configMapKeyRef+: { key: key } } }, + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { configMapKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { configMapKeyRef+: { optional: optional } } }, + }, + '#fieldRef':: d.obj(help="\"Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\u003cKEY\u003e']`, `metadata.annotations['\u003cKEY\u003e']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.\""), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { valueFrom+: { fieldRef+: { apiVersion: apiVersion } } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { valueFrom+: { fieldRef+: { fieldPath: fieldPath } } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { valueFrom+: { resourceFieldRef+: { containerName: containerName } } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { valueFrom+: { resourceFieldRef+: { divisor: divisor } } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { valueFrom+: { resourceFieldRef+: { resource: resource } } }, + }, + '#secretKeyRef':: d.obj(help="\"Selects a key of a secret in the pod's namespace\""), + secretKeyRef: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { secretKeyRef+: { key: key } } }, + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { secretKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { secretKeyRef+: { optional: optional } } }, + }, + }, + '#withName':: d.fn(help='"Name of the environment variable. Must be a C_IDENTIFIER."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\"$$(VAR_NAME)\\" will produce the string literal \\"$(VAR_NAME)\\". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \\"\\"."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#envFrom':: d.obj(help='"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."'), + envFrom: { + '#configMapRef':: d.obj(help='"The ConfigMap to select from"'), + configMapRef: { + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMapRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMapRef+: { optional: optional } }, + }, + '#secretRef':: d.obj(help='"The Secret to select from"'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secretRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secretRef+: { optional: optional } }, + }, + '#withPrefix':: d.fn(help='"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."', args=[d.arg(name='prefix', type=d.T.string)]), + withPrefix(prefix): { prefix: prefix }, + }, + '#lifecycle':: d.obj(help='"Actions that the management system should take in response to container lifecycle events. Cannot be updated."'), + lifecycle: { + '#postStart':: d.obj(help='"PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"'), + postStart: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { postStart+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { postStart+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set \\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { postStart+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host. Defaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { postStart+: { httpGet+: { scheme: scheme } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { tcpSocket+: { port: port } } } }, + }, + }, + '#preStop':: d.obj(help="\"PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\""), + preStop: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { preStop+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { preStop+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set \\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { preStop+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host. Defaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { preStop+: { httpGet+: { scheme: scheme } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { tcpSocket+: { port: port } } } }, + }, + }, + }, + '#livenessProbe':: d.obj(help='"Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + livenessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { livenessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { livenessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { livenessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \\n If this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { livenessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set \\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { livenessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host. Defaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { livenessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { livenessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { livenessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { livenessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { livenessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { livenessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { livenessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#ports':: d.obj(help='"List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \\"0.0.0.0\\" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated."'), + ports: { + '#withContainerPort':: d.fn(help="\"Number of port to expose on the pod's IP address. This must be a valid port number, 0 \u003c x \u003c 65536.\"", args=[d.arg(name='containerPort', type=d.T.integer)]), + withContainerPort(containerPort): { containerPort: containerPort }, + '#withHostIP':: d.fn(help='"What host IP to bind the external port to."', args=[d.arg(name='hostIP', type=d.T.string)]), + withHostIP(hostIP): { hostIP: hostIP }, + '#withHostPort':: d.fn(help='"Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this."', args=[d.arg(name='hostPort', type=d.T.integer)]), + withHostPort(hostPort): { hostPort: hostPort }, + '#withName':: d.fn(help='"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withProtocol':: d.fn(help='"Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \\"TCP\\"."', args=[d.arg(name='protocol', type=d.T.string)]), + withProtocol(protocol): { protocol: protocol }, + }, + '#readinessProbe':: d.obj(help='"Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + readinessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { readinessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { readinessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { readinessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \\n If this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { readinessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set \\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { readinessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host. Defaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { readinessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { readinessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { readinessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { readinessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { readinessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { readinessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { readinessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#resizePolicy':: d.obj(help='"Resources resize policy for the container."'), + resizePolicy: { + '#withResourceName':: d.fn(help='"Name of the resource to which this resource resize policy applies. Supported values: cpu, memory."', args=[d.arg(name='resourceName', type=d.T.string)]), + withResourceName(resourceName): { resourceName: resourceName }, + '#withRestartPolicy':: d.fn(help='"Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired."', args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + }, + '#resources':: d.obj(help='"Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { resources+: { limits: limits } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { resources+: { limits+: limits } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { resources+: { requests: requests } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { resources+: { requests+: requests } }, + }, + '#securityContext':: d.obj(help='"SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"'), + securityContext: { + '#capabilities':: d.obj(help='"The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows."'), + capabilities: { + '#withAdd':: d.fn(help='"Added capabilities"', args=[d.arg(name='add', type=d.T.array)]), + withAdd(add): { securityContext+: { capabilities+: { add: if std.isArray(v=add) then add else [add] } } }, + '#withAddMixin':: d.fn(help='"Added capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='add', type=d.T.array)]), + withAddMixin(add): { securityContext+: { capabilities+: { add+: if std.isArray(v=add) then add else [add] } } }, + '#withDrop':: d.fn(help='"Removed capabilities"', args=[d.arg(name='drop', type=d.T.array)]), + withDrop(drop): { securityContext+: { capabilities+: { drop: if std.isArray(v=drop) then drop else [drop] } } }, + '#withDropMixin':: d.fn(help='"Removed capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='drop', type=d.T.array)]), + withDropMixin(drop): { securityContext+: { capabilities+: { drop+: if std.isArray(v=drop) then drop else [drop] } } }, + }, + '#seLinuxOptions':: d.obj(help='"The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows."'), + seLinuxOptions: { + '#withLevel':: d.fn(help='"Level is SELinux level label that applies to the container."', args=[d.arg(name='level', type=d.T.string)]), + withLevel(level): { securityContext+: { seLinuxOptions+: { level: level } } }, + '#withRole':: d.fn(help='"Role is a SELinux role label that applies to the container."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { securityContext+: { seLinuxOptions+: { role: role } } }, + '#withType':: d.fn(help='"Type is a SELinux type label that applies to the container."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seLinuxOptions+: { type: type } } }, + '#withUser':: d.fn(help='"User is a SELinux user label that applies to the container."', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { securityContext+: { seLinuxOptions+: { user: user } } }, + }, + '#seccompProfile':: d.obj(help='"The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows."'), + seccompProfile: { + '#withLocalhostProfile':: d.fn(help="\"localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is \\\"Localhost\\\". Must NOT be set for any other type.\"", args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { seccompProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help='"type indicates which kind of seccomp profile will be applied. Valid options are: \\n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seccompProfile+: { type: type } } }, + }, + '#windowsOptions':: d.obj(help='"The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux."'), + windowsOptions: { + '#withGmsaCredentialSpec':: d.fn(help='"GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field."', args=[d.arg(name='gmsaCredentialSpec', type=d.T.string)]), + withGmsaCredentialSpec(gmsaCredentialSpec): { securityContext+: { windowsOptions+: { gmsaCredentialSpec: gmsaCredentialSpec } } }, + '#withGmsaCredentialSpecName':: d.fn(help='"GMSACredentialSpecName is the name of the GMSA credential spec to use."', args=[d.arg(name='gmsaCredentialSpecName', type=d.T.string)]), + withGmsaCredentialSpecName(gmsaCredentialSpecName): { securityContext+: { windowsOptions+: { gmsaCredentialSpecName: gmsaCredentialSpecName } } }, + '#withHostProcess':: d.fn(help="\"HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.\"", args=[d.arg(name='hostProcess', type=d.T.boolean)]), + withHostProcess(hostProcess): { securityContext+: { windowsOptions+: { hostProcess: hostProcess } } }, + '#withRunAsUserName':: d.fn(help='"The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsUserName', type=d.T.string)]), + withRunAsUserName(runAsUserName): { securityContext+: { windowsOptions+: { runAsUserName: runAsUserName } } }, + }, + '#withAllowPrivilegeEscalation':: d.fn(help='"AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='allowPrivilegeEscalation', type=d.T.boolean)]), + withAllowPrivilegeEscalation(allowPrivilegeEscalation): { securityContext+: { allowPrivilegeEscalation: allowPrivilegeEscalation } }, + '#withPrivileged':: d.fn(help='"Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='privileged', type=d.T.boolean)]), + withPrivileged(privileged): { securityContext+: { privileged: privileged } }, + '#withProcMount':: d.fn(help='"procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='procMount', type=d.T.string)]), + withProcMount(procMount): { securityContext+: { procMount: procMount } }, + '#withReadOnlyRootFilesystem':: d.fn(help='"Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='readOnlyRootFilesystem', type=d.T.boolean)]), + withReadOnlyRootFilesystem(readOnlyRootFilesystem): { securityContext+: { readOnlyRootFilesystem: readOnlyRootFilesystem } }, + '#withRunAsGroup':: d.fn(help='"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsGroup', type=d.T.integer)]), + withRunAsGroup(runAsGroup): { securityContext+: { runAsGroup: runAsGroup } }, + '#withRunAsNonRoot':: d.fn(help='"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsNonRoot', type=d.T.boolean)]), + withRunAsNonRoot(runAsNonRoot): { securityContext+: { runAsNonRoot: runAsNonRoot } }, + '#withRunAsUser':: d.fn(help='"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsUser', type=d.T.integer)]), + withRunAsUser(runAsUser): { securityContext+: { runAsUser: runAsUser } }, + }, + '#startupProbe':: d.obj(help="\"StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\""), + startupProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { startupProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { startupProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { startupProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \\n If this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { startupProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set \\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { startupProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host. Defaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { startupProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { startupProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { startupProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { startupProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { startupProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { startupProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { startupProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#volumeDevices':: d.obj(help='"volumeDevices is the list of block devices to be used by the container."'), + volumeDevices: { + '#withDevicePath':: d.fn(help='"devicePath is the path inside of the container that the device will be mapped to."', args=[d.arg(name='devicePath', type=d.T.string)]), + withDevicePath(devicePath): { devicePath: devicePath }, + '#withName':: d.fn(help='"name must match the name of a persistentVolumeClaim in the pod"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#volumeMounts':: d.obj(help="\"Pod volumes to mount into the container's filesystem. Cannot be updated.\""), + volumeMounts: { + '#withMountPath':: d.fn(help="\"Path within the container at which the volume should be mounted. Must not contain ':'.\"", args=[d.arg(name='mountPath', type=d.T.string)]), + withMountPath(mountPath): { mountPath: mountPath }, + '#withMountPropagation':: d.fn(help='"mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10."', args=[d.arg(name='mountPropagation', type=d.T.string)]), + withMountPropagation(mountPropagation): { mountPropagation: mountPropagation }, + '#withName':: d.fn(help='"This must match the Name of a Volume."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withReadOnly':: d.fn(help='"Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { readOnly: readOnly }, + '#withSubPath':: d.fn(help="\"Path within the volume from which the container's volume should be mounted. Defaults to \\\"\\\" (volume's root).\"", args=[d.arg(name='subPath', type=d.T.string)]), + withSubPath(subPath): { subPath: subPath }, + '#withSubPathExpr':: d.fn(help="\"Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \\\"\\\" (volume's root). SubPathExpr and SubPath are mutually exclusive.\"", args=[d.arg(name='subPathExpr', type=d.T.string)]), + withSubPathExpr(subPathExpr): { subPathExpr: subPathExpr }, + }, + '#withArgs':: d.fn(help="\"Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will produce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='args', type=d.T.array)]), + withArgs(args): { args: if std.isArray(v=args) then args else [args] }, + '#withArgsMixin':: d.fn(help="\"Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will produce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='args', type=d.T.array)]), + withArgsMixin(args): { args+: if std.isArray(v=args) then args else [args] }, + '#withCommand':: d.fn(help="\"Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will produce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { command: if std.isArray(v=command) then command else [command] }, + '#withCommandMixin':: d.fn(help="\"Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will produce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { command+: if std.isArray(v=command) then command else [command] }, + '#withEnv':: d.fn(help='"List of environment variables to set in the container. Cannot be updated."', args=[d.arg(name='env', type=d.T.array)]), + withEnv(env): { env: if std.isArray(v=env) then env else [env] }, + '#withEnvFrom':: d.fn(help='"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFrom(envFrom): { envFrom: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvFromMixin':: d.fn(help='"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFromMixin(envFrom): { envFrom+: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvMixin':: d.fn(help='"List of environment variables to set in the container. Cannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='env', type=d.T.array)]), + withEnvMixin(env): { env+: if std.isArray(v=env) then env else [env] }, + '#withImage':: d.fn(help='"Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets."', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { image: image }, + '#withImagePullPolicy':: d.fn(help='"Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images"', args=[d.arg(name='imagePullPolicy', type=d.T.string)]), + withImagePullPolicy(imagePullPolicy): { imagePullPolicy: imagePullPolicy }, + '#withName':: d.fn(help='"Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withPorts':: d.fn(help='"List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \\"0.0.0.0\\" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated."', args=[d.arg(name='ports', type=d.T.array)]), + withPorts(ports): { ports: if std.isArray(v=ports) then ports else [ports] }, + '#withPortsMixin':: d.fn(help='"List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \\"0.0.0.0\\" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ports', type=d.T.array)]), + withPortsMixin(ports): { ports+: if std.isArray(v=ports) then ports else [ports] }, + '#withResizePolicy':: d.fn(help='"Resources resize policy for the container."', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicy(resizePolicy): { resizePolicy: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withResizePolicyMixin':: d.fn(help='"Resources resize policy for the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicyMixin(resizePolicy): { resizePolicy+: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withRestartPolicy':: d.fn(help="\"RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is \\\"Always\\\". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as \\\"Always\\\" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy \\\"Always\\\" will be shut down. This lifecycle differs from normal init containers and is often referred to as a \\\"sidecar\\\" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.\"", args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + '#withStdin':: d.fn(help='"Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false."', args=[d.arg(name='stdin', type=d.T.boolean)]), + withStdin(stdin): { stdin: stdin }, + '#withStdinOnce':: d.fn(help='"Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false"', args=[d.arg(name='stdinOnce', type=d.T.boolean)]), + withStdinOnce(stdinOnce): { stdinOnce: stdinOnce }, + '#withTerminationMessagePath':: d.fn(help="\"Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.\"", args=[d.arg(name='terminationMessagePath', type=d.T.string)]), + withTerminationMessagePath(terminationMessagePath): { terminationMessagePath: terminationMessagePath }, + '#withTerminationMessagePolicy':: d.fn(help='"Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated."', args=[d.arg(name='terminationMessagePolicy', type=d.T.string)]), + withTerminationMessagePolicy(terminationMessagePolicy): { terminationMessagePolicy: terminationMessagePolicy }, + '#withTty':: d.fn(help="\"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.\"", args=[d.arg(name='tty', type=d.T.boolean)]), + withTty(tty): { tty: tty }, + '#withVolumeDevices':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevices(volumeDevices): { volumeDevices: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeDevicesMixin':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevicesMixin(volumeDevices): { volumeDevices+: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeMounts':: d.fn(help="\"Pod volumes to mount into the container's filesystem. Cannot be updated.\"", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMounts(volumeMounts): { volumeMounts: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withVolumeMountsMixin':: d.fn(help="\"Pod volumes to mount into the container's filesystem. Cannot be updated.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMountsMixin(volumeMounts): { volumeMounts+: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withWorkingDir':: d.fn(help="\"Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.\"", args=[d.arg(name='workingDir', type=d.T.string)]), + withWorkingDir(workingDir): { workingDir: workingDir }, + }, + '#pod':: d.obj(help='"Pod defines the desired specification of pod."'), + pod: { + '#affinity':: d.obj(help="\"If specified, the pod's scheduling constraints.\""), + affinity: { + '#nodeAffinity':: d.obj(help='"Describes node affinity scheduling rules for the pod."'), + nodeAffinity: { + '#preferredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \\"weight\\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."'), + preferredDuringSchedulingIgnoredDuringExecution: { + '#preference':: d.obj(help='"A node selector term, associated with the corresponding weight."'), + preference: { + '#matchExpressions':: d.obj(help="\"A list of node selector requirements by node's labels.\""), + matchExpressions: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#matchFields':: d.obj(help="\"A list of node selector requirements by node's fields.\""), + matchFields: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help="\"A list of node selector requirements by node's labels.\"", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { preference+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help="\"A list of node selector requirements by node's labels.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { preference+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchFields':: d.fn(help="\"A list of node selector requirements by node's fields.\"", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFields(matchFields): { preference+: { matchFields: if std.isArray(v=matchFields) then matchFields else [matchFields] } }, + '#withMatchFieldsMixin':: d.fn(help="\"A list of node selector requirements by node's fields.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFieldsMixin(matchFields): { preference+: { matchFields+: if std.isArray(v=matchFields) then matchFields else [matchFields] } }, + }, + '#withWeight':: d.fn(help='"Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100."', args=[d.arg(name='weight', type=d.T.integer)]), + withWeight(weight): { weight: weight }, + }, + '#requiredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node."'), + requiredDuringSchedulingIgnoredDuringExecution: { + '#nodeSelectorTerms':: d.obj(help='"Required. A list of node selector terms. The terms are ORed."'), + nodeSelectorTerms: { + '#matchExpressions':: d.obj(help="\"A list of node selector requirements by node's labels.\""), + matchExpressions: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#matchFields':: d.obj(help="\"A list of node selector requirements by node's fields.\""), + matchFields: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help="\"A list of node selector requirements by node's labels.\"", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] }, + '#withMatchExpressionsMixin':: d.fn(help="\"A list of node selector requirements by node's labels.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] }, + '#withMatchFields':: d.fn(help="\"A list of node selector requirements by node's fields.\"", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFields(matchFields): { matchFields: if std.isArray(v=matchFields) then matchFields else [matchFields] }, + '#withMatchFieldsMixin':: d.fn(help="\"A list of node selector requirements by node's fields.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFieldsMixin(matchFields): { matchFields+: if std.isArray(v=matchFields) then matchFields else [matchFields] }, + }, + '#withNodeSelectorTerms':: d.fn(help='"Required. A list of node selector terms. The terms are ORed."', args=[d.arg(name='nodeSelectorTerms', type=d.T.array)]), + withNodeSelectorTerms(nodeSelectorTerms): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { affinity+: { nodeAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: { nodeSelectorTerms: if std.isArray(v=nodeSelectorTerms) then nodeSelectorTerms else [nodeSelectorTerms] } } } } } } } } }, + '#withNodeSelectorTermsMixin':: d.fn(help='"Required. A list of node selector terms. The terms are ORed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='nodeSelectorTerms', type=d.T.array)]), + withNodeSelectorTermsMixin(nodeSelectorTerms): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { affinity+: { nodeAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: { nodeSelectorTerms+: if std.isArray(v=nodeSelectorTerms) then nodeSelectorTerms else [nodeSelectorTerms] } } } } } } } } }, + }, + '#withPreferredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \\"weight\\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { affinity+: { nodeAffinity+: { preferredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } } } } } }, + '#withPreferredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \\"weight\\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { affinity+: { nodeAffinity+: { preferredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } } } } } }, + }, + '#podAffinity':: d.obj(help='"Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."'), + podAffinity: { + '#preferredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."'), + preferredDuringSchedulingIgnoredDuringExecution: { + '#podAffinityTerm':: d.obj(help='"Required. A pod affinity term, associated with the corresponding weight."'), + podAffinityTerm: { + '#labelSelector':: d.obj(help='"A label query over a set of resources, in this case pods."'), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels+: matchLabels } } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \\\"this pod's namespace\\\". An empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { podAffinityTerm+: { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { podAffinityTerm+: { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { podAffinityTerm+: { topologyKey: topologyKey } }, + }, + '#withWeight':: d.fn(help='"weight associated with matching the corresponding podAffinityTerm, in the range 1-100."', args=[d.arg(name='weight', type=d.T.integer)]), + withWeight(weight): { weight: weight }, + }, + '#requiredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."'), + requiredDuringSchedulingIgnoredDuringExecution: { + '#labelSelector':: d.obj(help='"A label query over a set of resources, in this case pods."'), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { labelSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { labelSelector+: { matchLabels+: matchLabels } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \\\"this pod's namespace\\\". An empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { namespaceSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { namespaceSelector+: { matchLabels+: matchLabels } }, + }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { topologyKey: topologyKey }, + }, + '#withPreferredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { affinity+: { podAffinity+: { preferredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } } } } } }, + '#withPreferredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { affinity+: { podAffinity+: { preferredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } } } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { affinity+: { podAffinity+: { requiredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } } } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { affinity+: { podAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } } } } } }, + }, + '#podAntiAffinity':: d.obj(help='"Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s))."'), + podAntiAffinity: { + '#preferredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."'), + preferredDuringSchedulingIgnoredDuringExecution: { + '#podAffinityTerm':: d.obj(help='"Required. A pod affinity term, associated with the corresponding weight."'), + podAffinityTerm: { + '#labelSelector':: d.obj(help='"A label query over a set of resources, in this case pods."'), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels+: matchLabels } } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \\\"this pod's namespace\\\". An empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { podAffinityTerm+: { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { podAffinityTerm+: { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { podAffinityTerm+: { topologyKey: topologyKey } }, + }, + '#withWeight':: d.fn(help='"weight associated with matching the corresponding podAffinityTerm, in the range 1-100."', args=[d.arg(name='weight', type=d.T.integer)]), + withWeight(weight): { weight: weight }, + }, + '#requiredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."'), + requiredDuringSchedulingIgnoredDuringExecution: { + '#labelSelector':: d.obj(help='"A label query over a set of resources, in this case pods."'), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { labelSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { labelSelector+: { matchLabels+: matchLabels } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \\\"this pod's namespace\\\". An empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { namespaceSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { namespaceSelector+: { matchLabels+: matchLabels } }, + }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { topologyKey: topologyKey }, + }, + '#withPreferredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { affinity+: { podAntiAffinity+: { preferredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } } } } } }, + '#withPreferredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { affinity+: { podAntiAffinity+: { preferredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } } } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { affinity+: { podAntiAffinity+: { requiredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } } } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { affinity+: { podAntiAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } } } } } }, + }, + }, + '#securityContext':: d.obj(help='"SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field."'), + securityContext: { + '#seLinuxOptions':: d.obj(help='"The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows."'), + seLinuxOptions: { + '#withLevel':: d.fn(help='"Level is SELinux level label that applies to the container."', args=[d.arg(name='level', type=d.T.string)]), + withLevel(level): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { seLinuxOptions+: { level: level } } } } } } } }, + '#withRole':: d.fn(help='"Role is a SELinux role label that applies to the container."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { seLinuxOptions+: { role: role } } } } } } } }, + '#withType':: d.fn(help='"Type is a SELinux type label that applies to the container."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { seLinuxOptions+: { type: type } } } } } } } }, + '#withUser':: d.fn(help='"User is a SELinux user label that applies to the container."', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { seLinuxOptions+: { user: user } } } } } } } }, + }, + '#seccompProfile':: d.obj(help='"The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows."'), + seccompProfile: { + '#withLocalhostProfile':: d.fn(help="\"localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is \\\"Localhost\\\". Must NOT be set for any other type.\"", args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { seccompProfile+: { localhostProfile: localhostProfile } } } } } } } }, + '#withType':: d.fn(help='"type indicates which kind of seccomp profile will be applied. Valid options are: \\n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { seccompProfile+: { type: type } } } } } } } }, + }, + '#sysctls':: d.obj(help='"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows."'), + sysctls: { + '#withName':: d.fn(help='"Name of a property to set"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Value of a property to set"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#windowsOptions':: d.obj(help="\"The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.\""), + windowsOptions: { + '#withGmsaCredentialSpec':: d.fn(help='"GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field."', args=[d.arg(name='gmsaCredentialSpec', type=d.T.string)]), + withGmsaCredentialSpec(gmsaCredentialSpec): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { windowsOptions+: { gmsaCredentialSpec: gmsaCredentialSpec } } } } } } } }, + '#withGmsaCredentialSpecName':: d.fn(help='"GMSACredentialSpecName is the name of the GMSA credential spec to use."', args=[d.arg(name='gmsaCredentialSpecName', type=d.T.string)]), + withGmsaCredentialSpecName(gmsaCredentialSpecName): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { windowsOptions+: { gmsaCredentialSpecName: gmsaCredentialSpecName } } } } } } } }, + '#withHostProcess':: d.fn(help="\"HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.\"", args=[d.arg(name='hostProcess', type=d.T.boolean)]), + withHostProcess(hostProcess): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { windowsOptions+: { hostProcess: hostProcess } } } } } } } }, + '#withRunAsUserName':: d.fn(help='"The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsUserName', type=d.T.string)]), + withRunAsUserName(runAsUserName): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { windowsOptions+: { runAsUserName: runAsUserName } } } } } } } }, + }, + '#withFsGroup':: d.fn(help="\"A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \\n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \\n If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.\"", args=[d.arg(name='fsGroup', type=d.T.integer)]), + withFsGroup(fsGroup): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { fsGroup: fsGroup } } } } } } }, + '#withFsGroupChangePolicy':: d.fn(help='"fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \\"OnRootMismatch\\" and \\"Always\\". If not specified, \\"Always\\" is used. Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='fsGroupChangePolicy', type=d.T.string)]), + withFsGroupChangePolicy(fsGroupChangePolicy): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { fsGroupChangePolicy: fsGroupChangePolicy } } } } } } }, + '#withRunAsGroup':: d.fn(help='"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsGroup', type=d.T.integer)]), + withRunAsGroup(runAsGroup): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { runAsGroup: runAsGroup } } } } } } }, + '#withRunAsNonRoot':: d.fn(help='"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsNonRoot', type=d.T.boolean)]), + withRunAsNonRoot(runAsNonRoot): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { runAsNonRoot: runAsNonRoot } } } } } } }, + '#withRunAsUser':: d.fn(help='"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsUser', type=d.T.integer)]), + withRunAsUser(runAsUser): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { runAsUser: runAsUser } } } } } } }, + '#withSupplementalGroups':: d.fn(help="\"A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.\"", args=[d.arg(name='supplementalGroups', type=d.T.array)]), + withSupplementalGroups(supplementalGroups): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { supplementalGroups: if std.isArray(v=supplementalGroups) then supplementalGroups else [supplementalGroups] } } } } } } }, + '#withSupplementalGroupsMixin':: d.fn(help="\"A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='supplementalGroups', type=d.T.array)]), + withSupplementalGroupsMixin(supplementalGroups): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { supplementalGroups+: if std.isArray(v=supplementalGroups) then supplementalGroups else [supplementalGroups] } } } } } } }, + '#withSysctls':: d.fn(help='"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='sysctls', type=d.T.array)]), + withSysctls(sysctls): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { sysctls: if std.isArray(v=sysctls) then sysctls else [sysctls] } } } } } } }, + '#withSysctlsMixin':: d.fn(help='"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sysctls', type=d.T.array)]), + withSysctlsMixin(sysctls): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { securityContext+: { sysctls+: if std.isArray(v=sysctls) then sysctls else [sysctls] } } } } } } }, + }, + '#tolerations':: d.obj(help="\"If specified, the pod's tolerations.\""), + tolerations: { + '#withEffect':: d.fn(help='"Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute."', args=[d.arg(name='effect', type=d.T.string)]), + withEffect(effect): { effect: effect }, + '#withKey':: d.fn(help='"Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withTolerationSeconds':: d.fn(help='"TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system."', args=[d.arg(name='tolerationSeconds', type=d.T.integer)]), + withTolerationSeconds(tolerationSeconds): { tolerationSeconds: tolerationSeconds }, + '#withValue':: d.fn(help='"Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#volumes':: d.obj(help='"Volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes"'), + volumes: { + '#awsElasticBlockStore':: d.obj(help="\"awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\""), + awsElasticBlockStore: { + '#withFsType':: d.fn(help='"fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { awsElasticBlockStore+: { fsType: fsType } }, + '#withPartition':: d.fn(help='"partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \\"1\\". Similarly, the volume partition for /dev/sda is \\"0\\" (or you can leave the property empty)."', args=[d.arg(name='partition', type=d.T.integer)]), + withPartition(partition): { awsElasticBlockStore+: { partition: partition } }, + '#withReadOnly':: d.fn(help='"readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { awsElasticBlockStore+: { readOnly: readOnly } }, + '#withVolumeID':: d.fn(help='"volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"', args=[d.arg(name='volumeID', type=d.T.string)]), + withVolumeID(volumeID): { awsElasticBlockStore+: { volumeID: volumeID } }, + }, + '#azureDisk':: d.obj(help='"azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod."'), + azureDisk: { + '#withCachingMode':: d.fn(help='"cachingMode is the Host Caching mode: None, Read Only, Read Write."', args=[d.arg(name='cachingMode', type=d.T.string)]), + withCachingMode(cachingMode): { azureDisk+: { cachingMode: cachingMode } }, + '#withDiskName':: d.fn(help='"diskName is the Name of the data disk in the blob storage"', args=[d.arg(name='diskName', type=d.T.string)]), + withDiskName(diskName): { azureDisk+: { diskName: diskName } }, + '#withDiskURI':: d.fn(help='"diskURI is the URI of data disk in the blob storage"', args=[d.arg(name='diskURI', type=d.T.string)]), + withDiskURI(diskURI): { azureDisk+: { diskURI: diskURI } }, + '#withFsType':: d.fn(help='"fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { azureDisk+: { fsType: fsType } }, + '#withKind':: d.fn(help='"kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { azureDisk+: { kind: kind } }, + '#withReadOnly':: d.fn(help='"readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { azureDisk+: { readOnly: readOnly } }, + }, + '#azureFile':: d.obj(help='"azureFile represents an Azure File Service mount on the host and bind mount to the pod."'), + azureFile: { + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { azureFile+: { readOnly: readOnly } }, + '#withSecretName':: d.fn(help='"secretName is the name of secret that contains Azure Storage Account Name and Key"', args=[d.arg(name='secretName', type=d.T.string)]), + withSecretName(secretName): { azureFile+: { secretName: secretName } }, + '#withShareName':: d.fn(help='"shareName is the azure share Name"', args=[d.arg(name='shareName', type=d.T.string)]), + withShareName(shareName): { azureFile+: { shareName: shareName } }, + }, + '#cephfs':: d.obj(help="\"cephFS represents a Ceph FS mount on the host that shares a pod's lifetime\""), + cephfs: { + '#secretRef':: d.obj(help='"secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { cephfs+: { secretRef+: { name: name } } }, + }, + '#withMonitors':: d.fn(help='"monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitors(monitors): { cephfs+: { monitors: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withMonitorsMixin':: d.fn(help='"monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitorsMixin(monitors): { cephfs+: { monitors+: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withPath':: d.fn(help='"path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { cephfs+: { path: path } }, + '#withReadOnly':: d.fn(help='"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { cephfs+: { readOnly: readOnly } }, + '#withSecretFile':: d.fn(help='"secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='secretFile', type=d.T.string)]), + withSecretFile(secretFile): { cephfs+: { secretFile: secretFile } }, + '#withUser':: d.fn(help='"user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { cephfs+: { user: user } }, + }, + '#cinder':: d.obj(help='"cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"'), + cinder: { + '#secretRef':: d.obj(help='"secretRef is optional: points to a secret object containing parameters used to connect to OpenStack."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { cinder+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { cinder+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { cinder+: { readOnly: readOnly } }, + '#withVolumeID':: d.fn(help='"volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"', args=[d.arg(name='volumeID', type=d.T.string)]), + withVolumeID(volumeID): { cinder+: { volumeID: volumeID } }, + }, + '#configMap':: d.obj(help='"configMap represents a configMap that should populate this volume"'), + configMap: { + '#items':: d.obj(help="\"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withDefaultMode':: d.fn(help='"defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { configMap+: { defaultMode: defaultMode } }, + '#withItems':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { configMap+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { configMap+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMap+: { name: name } }, + '#withOptional':: d.fn(help='"optional specify whether the ConfigMap or its keys must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMap+: { optional: optional } }, + }, + '#csi':: d.obj(help='"csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature)."'), + csi: { + '#nodePublishSecretRef':: d.obj(help='"nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed."'), + nodePublishSecretRef: { + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { csi+: { nodePublishSecretRef+: { name: name } } }, + }, + '#withDriver':: d.fn(help='"driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster."', args=[d.arg(name='driver', type=d.T.string)]), + withDriver(driver): { csi+: { driver: driver } }, + '#withFsType':: d.fn(help='"fsType to mount. Ex. \\"ext4\\", \\"xfs\\", \\"ntfs\\". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { csi+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly specifies a read-only configuration for the volume. Defaults to false (read/write)."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { csi+: { readOnly: readOnly } }, + '#withVolumeAttributes':: d.fn(help="\"volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.\"", args=[d.arg(name='volumeAttributes', type=d.T.object)]), + withVolumeAttributes(volumeAttributes): { csi+: { volumeAttributes: volumeAttributes } }, + '#withVolumeAttributesMixin':: d.fn(help="\"volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeAttributes', type=d.T.object)]), + withVolumeAttributesMixin(volumeAttributes): { csi+: { volumeAttributes+: volumeAttributes } }, + }, + '#downwardAPI':: d.obj(help='"downwardAPI represents downward API about the pod that should populate this volume"'), + downwardAPI: { + '#items':: d.obj(help='"Items is a list of downward API volume file"'), + items: { + '#fieldRef':: d.obj(help='"Required: Selects a field of the pod: only annotations, labels, name and namespace are supported."'), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { fieldRef+: { apiVersion: apiVersion } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { fieldRef+: { fieldPath: fieldPath } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { resourceFieldRef+: { containerName: containerName } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { resourceFieldRef+: { divisor: divisor } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { resourceFieldRef+: { resource: resource } }, + }, + '#withMode':: d.fn(help='"Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withDefaultMode':: d.fn(help='"Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { downwardAPI+: { defaultMode: defaultMode } }, + '#withItems':: d.fn(help='"Items is a list of downward API volume file"', args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { downwardAPI+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help='"Items is a list of downward API volume file"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { downwardAPI+: { items+: if std.isArray(v=items) then items else [items] } }, + }, + '#emptyDir':: d.obj(help="\"emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\""), + emptyDir: { + '#withMedium':: d.fn(help="\"medium represents what type of storage medium should back this directory. The default is \\\"\\\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\"", args=[d.arg(name='medium', type=d.T.string)]), + withMedium(medium): { emptyDir+: { medium: medium } }, + '#withSizeLimit':: d.fn(help='"sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"', args=[d.arg(name='sizeLimit', type=d.T.any)]), + withSizeLimit(sizeLimit): { emptyDir+: { sizeLimit: sizeLimit } }, + }, + '#ephemeral':: d.obj(help="\"ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. \\n Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). \\n Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. \\n Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. \\n A pod can use both types of ephemeral volumes and persistent volumes at the same time.\""), + ephemeral: { + '#volumeClaimTemplate':: d.obj(help='"Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \\n An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. \\n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \\n Required, must not be nil."'), + volumeClaimTemplate: { + '#spec':: d.obj(help='"The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here."'), + spec: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { apiGroup: apiGroup } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { kind: kind } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { name: name } } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { apiGroup: apiGroup } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { kind: kind } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { name: name } } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { namespace: namespace } } } } }, + }, + '#resources':: d.obj(help='"resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } } } } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \\n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \\n This field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } } } } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits: limits } } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits+: limits } } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests: requests } } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests+: requests } } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels: matchLabels } } } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \\"key\\", the operator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels+: matchLabels } } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { ephemeral+: { volumeClaimTemplate+: { spec+: { storageClassName: storageClassName } } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeMode: volumeMode } } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeName: volumeName } } } }, + }, + '#withMetadata':: d.fn(help='"May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation."', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadata(metadata): { ephemeral+: { volumeClaimTemplate+: { metadata: metadata } } }, + '#withMetadataMixin':: d.fn(help='"May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadataMixin(metadata): { ephemeral+: { volumeClaimTemplate+: { metadata+: metadata } } }, + }, + }, + '#fc':: d.obj(help="\"fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.\""), + fc: { + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { fc+: { fsType: fsType } }, + '#withLun':: d.fn(help='"lun is Optional: FC target lun number"', args=[d.arg(name='lun', type=d.T.integer)]), + withLun(lun): { fc+: { lun: lun } }, + '#withReadOnly':: d.fn(help='"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { fc+: { readOnly: readOnly } }, + '#withTargetWWNs':: d.fn(help='"targetWWNs is Optional: FC target worldwide names (WWNs)"', args=[d.arg(name='targetWWNs', type=d.T.array)]), + withTargetWWNs(targetWWNs): { fc+: { targetWWNs: if std.isArray(v=targetWWNs) then targetWWNs else [targetWWNs] } }, + '#withTargetWWNsMixin':: d.fn(help='"targetWWNs is Optional: FC target worldwide names (WWNs)"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='targetWWNs', type=d.T.array)]), + withTargetWWNsMixin(targetWWNs): { fc+: { targetWWNs+: if std.isArray(v=targetWWNs) then targetWWNs else [targetWWNs] } }, + '#withWwids':: d.fn(help='"wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously."', args=[d.arg(name='wwids', type=d.T.array)]), + withWwids(wwids): { fc+: { wwids: if std.isArray(v=wwids) then wwids else [wwids] } }, + '#withWwidsMixin':: d.fn(help='"wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='wwids', type=d.T.array)]), + withWwidsMixin(wwids): { fc+: { wwids+: if std.isArray(v=wwids) then wwids else [wwids] } }, + }, + '#flexVolume':: d.obj(help='"flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin."'), + flexVolume: { + '#secretRef':: d.obj(help='"secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { flexVolume+: { secretRef+: { name: name } } }, + }, + '#withDriver':: d.fn(help='"driver is the name of the driver to use for this volume."', args=[d.arg(name='driver', type=d.T.string)]), + withDriver(driver): { flexVolume+: { driver: driver } }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \\"ext4\\", \\"xfs\\", \\"ntfs\\". The default filesystem depends on FlexVolume script."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { flexVolume+: { fsType: fsType } }, + '#withOptions':: d.fn(help='"options is Optional: this field holds extra command options if any."', args=[d.arg(name='options', type=d.T.object)]), + withOptions(options): { flexVolume+: { options: options } }, + '#withOptionsMixin':: d.fn(help='"options is Optional: this field holds extra command options if any."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='options', type=d.T.object)]), + withOptionsMixin(options): { flexVolume+: { options+: options } }, + '#withReadOnly':: d.fn(help='"readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { flexVolume+: { readOnly: readOnly } }, + }, + '#flocker':: d.obj(help="\"flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running\""), + flocker: { + '#withDatasetName':: d.fn(help='"datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated"', args=[d.arg(name='datasetName', type=d.T.string)]), + withDatasetName(datasetName): { flocker+: { datasetName: datasetName } }, + '#withDatasetUUID':: d.fn(help='"datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset"', args=[d.arg(name='datasetUUID', type=d.T.string)]), + withDatasetUUID(datasetUUID): { flocker+: { datasetUUID: datasetUUID } }, + }, + '#gcePersistentDisk':: d.obj(help="\"gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\""), + gcePersistentDisk: { + '#withFsType':: d.fn(help='"fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { gcePersistentDisk+: { fsType: fsType } }, + '#withPartition':: d.fn(help='"partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \\"1\\". Similarly, the volume partition for /dev/sda is \\"0\\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"', args=[d.arg(name='partition', type=d.T.integer)]), + withPartition(partition): { gcePersistentDisk+: { partition: partition } }, + '#withPdName':: d.fn(help='"pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"', args=[d.arg(name='pdName', type=d.T.string)]), + withPdName(pdName): { gcePersistentDisk+: { pdName: pdName } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { gcePersistentDisk+: { readOnly: readOnly } }, + }, + '#gitRepo':: d.obj(help="\"gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.\""), + gitRepo: { + '#withDirectory':: d.fn(help="\"directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.\"", args=[d.arg(name='directory', type=d.T.string)]), + withDirectory(directory): { gitRepo+: { directory: directory } }, + '#withRepository':: d.fn(help='"repository is the URL"', args=[d.arg(name='repository', type=d.T.string)]), + withRepository(repository): { gitRepo+: { repository: repository } }, + '#withRevision':: d.fn(help='"revision is the commit hash for the specified revision."', args=[d.arg(name='revision', type=d.T.string)]), + withRevision(revision): { gitRepo+: { revision: revision } }, + }, + '#glusterfs':: d.obj(help="\"glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md\""), + glusterfs: { + '#withEndpoints':: d.fn(help='"endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"', args=[d.arg(name='endpoints', type=d.T.string)]), + withEndpoints(endpoints): { glusterfs+: { endpoints: endpoints } }, + '#withPath':: d.fn(help='"path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { glusterfs+: { path: path } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { glusterfs+: { readOnly: readOnly } }, + }, + '#hostPath':: d.obj(help='"hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write."'), + hostPath: { + '#withPath':: d.fn(help='"path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { hostPath+: { path: path } }, + '#withType':: d.fn(help='"type for HostPath Volume Defaults to \\"\\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { hostPath+: { type: type } }, + }, + '#iscsi':: d.obj(help="\"iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md\""), + iscsi: { + '#secretRef':: d.obj(help='"secretRef is the CHAP Secret for iSCSI target and initiator authentication"'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { iscsi+: { secretRef+: { name: name } } }, + }, + '#withChapAuthDiscovery':: d.fn(help='"chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication"', args=[d.arg(name='chapAuthDiscovery', type=d.T.boolean)]), + withChapAuthDiscovery(chapAuthDiscovery): { iscsi+: { chapAuthDiscovery: chapAuthDiscovery } }, + '#withChapAuthSession':: d.fn(help='"chapAuthSession defines whether support iSCSI Session CHAP authentication"', args=[d.arg(name='chapAuthSession', type=d.T.boolean)]), + withChapAuthSession(chapAuthSession): { iscsi+: { chapAuthSession: chapAuthSession } }, + '#withFsType':: d.fn(help='"fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { iscsi+: { fsType: fsType } }, + '#withInitiatorName':: d.fn(help='"initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection."', args=[d.arg(name='initiatorName', type=d.T.string)]), + withInitiatorName(initiatorName): { iscsi+: { initiatorName: initiatorName } }, + '#withIqn':: d.fn(help='"iqn is the target iSCSI Qualified Name."', args=[d.arg(name='iqn', type=d.T.string)]), + withIqn(iqn): { iscsi+: { iqn: iqn } }, + '#withIscsiInterface':: d.fn(help="\"iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).\"", args=[d.arg(name='iscsiInterface', type=d.T.string)]), + withIscsiInterface(iscsiInterface): { iscsi+: { iscsiInterface: iscsiInterface } }, + '#withLun':: d.fn(help='"lun represents iSCSI Target Lun number."', args=[d.arg(name='lun', type=d.T.integer)]), + withLun(lun): { iscsi+: { lun: lun } }, + '#withPortals':: d.fn(help='"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."', args=[d.arg(name='portals', type=d.T.array)]), + withPortals(portals): { iscsi+: { portals: if std.isArray(v=portals) then portals else [portals] } }, + '#withPortalsMixin':: d.fn(help='"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='portals', type=d.T.array)]), + withPortalsMixin(portals): { iscsi+: { portals+: if std.isArray(v=portals) then portals else [portals] } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { iscsi+: { readOnly: readOnly } }, + '#withTargetPortal':: d.fn(help='"targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."', args=[d.arg(name='targetPortal', type=d.T.string)]), + withTargetPortal(targetPortal): { iscsi+: { targetPortal: targetPortal } }, + }, + '#nfs':: d.obj(help="\"nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\""), + nfs: { + '#withPath':: d.fn(help='"path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { nfs+: { path: path } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { nfs+: { readOnly: readOnly } }, + '#withServer':: d.fn(help='"server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"', args=[d.arg(name='server', type=d.T.string)]), + withServer(server): { nfs+: { server: server } }, + }, + '#persistentVolumeClaim':: d.obj(help='"persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"'), + persistentVolumeClaim: { + '#withClaimName':: d.fn(help='"claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"', args=[d.arg(name='claimName', type=d.T.string)]), + withClaimName(claimName): { persistentVolumeClaim+: { claimName: claimName } }, + '#withReadOnly':: d.fn(help='"readOnly Will force the ReadOnly setting in VolumeMounts. Default false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { persistentVolumeClaim+: { readOnly: readOnly } }, + }, + '#photonPersistentDisk':: d.obj(help='"photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine"'), + photonPersistentDisk: { + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { photonPersistentDisk+: { fsType: fsType } }, + '#withPdID':: d.fn(help='"pdID is the ID that identifies Photon Controller persistent disk"', args=[d.arg(name='pdID', type=d.T.string)]), + withPdID(pdID): { photonPersistentDisk+: { pdID: pdID } }, + }, + '#portworxVolume':: d.obj(help='"portworxVolume represents a portworx volume attached and mounted on kubelets host machine"'), + portworxVolume: { + '#withFsType':: d.fn(help='"fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. \\"ext4\\", \\"xfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { portworxVolume+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { portworxVolume+: { readOnly: readOnly } }, + '#withVolumeID':: d.fn(help='"volumeID uniquely identifies a Portworx volume"', args=[d.arg(name='volumeID', type=d.T.string)]), + withVolumeID(volumeID): { portworxVolume+: { volumeID: volumeID } }, + }, + '#projected':: d.obj(help='"projected items for all in one resources secrets, configmaps, and downward API"'), + projected: { + '#sources':: d.obj(help='"sources is the list of volume projections"'), + sources: { + '#configMap':: d.obj(help='"configMap information about the configMap data to project"'), + configMap: { + '#items':: d.obj(help="\"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withItems':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { configMap+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { configMap+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMap+: { name: name } }, + '#withOptional':: d.fn(help='"optional specify whether the ConfigMap or its keys must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMap+: { optional: optional } }, + }, + '#downwardAPI':: d.obj(help='"downwardAPI information about the downwardAPI data to project"'), + downwardAPI: { + '#items':: d.obj(help='"Items is a list of DownwardAPIVolume file"'), + items: { + '#fieldRef':: d.obj(help='"Required: Selects a field of the pod: only annotations, labels, name and namespace are supported."'), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { fieldRef+: { apiVersion: apiVersion } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { fieldRef+: { fieldPath: fieldPath } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { resourceFieldRef+: { containerName: containerName } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { resourceFieldRef+: { divisor: divisor } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { resourceFieldRef+: { resource: resource } }, + }, + '#withMode':: d.fn(help='"Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withItems':: d.fn(help='"Items is a list of DownwardAPIVolume file"', args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { downwardAPI+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help='"Items is a list of DownwardAPIVolume file"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { downwardAPI+: { items+: if std.isArray(v=items) then items else [items] } }, + }, + '#secret':: d.obj(help='"secret information about the secret data to project"'), + secret: { + '#items':: d.obj(help="\"items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withItems':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { secret+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { secret+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secret+: { name: name } }, + '#withOptional':: d.fn(help='"optional field specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secret+: { optional: optional } }, + }, + '#serviceAccountToken':: d.obj(help='"serviceAccountToken is information about the serviceAccountToken data to project"'), + serviceAccountToken: { + '#withAudience':: d.fn(help='"audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver."', args=[d.arg(name='audience', type=d.T.string)]), + withAudience(audience): { serviceAccountToken+: { audience: audience } }, + '#withExpirationSeconds':: d.fn(help='"expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes."', args=[d.arg(name='expirationSeconds', type=d.T.integer)]), + withExpirationSeconds(expirationSeconds): { serviceAccountToken+: { expirationSeconds: expirationSeconds } }, + '#withPath':: d.fn(help='"path is the path relative to the mount point of the file to project the token into."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { serviceAccountToken+: { path: path } }, + }, + }, + '#withDefaultMode':: d.fn(help='"defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { projected+: { defaultMode: defaultMode } }, + '#withSources':: d.fn(help='"sources is the list of volume projections"', args=[d.arg(name='sources', type=d.T.array)]), + withSources(sources): { projected+: { sources: if std.isArray(v=sources) then sources else [sources] } }, + '#withSourcesMixin':: d.fn(help='"sources is the list of volume projections"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sources', type=d.T.array)]), + withSourcesMixin(sources): { projected+: { sources+: if std.isArray(v=sources) then sources else [sources] } }, + }, + '#quobyte':: d.obj(help="\"quobyte represents a Quobyte mount on the host that shares a pod's lifetime\""), + quobyte: { + '#withGroup':: d.fn(help='"group to map volume access to Default is no group"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { quobyte+: { group: group } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { quobyte+: { readOnly: readOnly } }, + '#withRegistry':: d.fn(help='"registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes"', args=[d.arg(name='registry', type=d.T.string)]), + withRegistry(registry): { quobyte+: { registry: registry } }, + '#withTenant':: d.fn(help='"tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin"', args=[d.arg(name='tenant', type=d.T.string)]), + withTenant(tenant): { quobyte+: { tenant: tenant } }, + '#withUser':: d.fn(help='"user to map volume access to Defaults to serivceaccount user"', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { quobyte+: { user: user } }, + '#withVolume':: d.fn(help='"volume is a string that references an already created Quobyte volume by name."', args=[d.arg(name='volume', type=d.T.string)]), + withVolume(volume): { quobyte+: { volume: volume } }, + }, + '#rbd':: d.obj(help="\"rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md\""), + rbd: { + '#secretRef':: d.obj(help='"secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { rbd+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { rbd+: { fsType: fsType } }, + '#withImage':: d.fn(help='"image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { rbd+: { image: image } }, + '#withKeyring':: d.fn(help='"keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='keyring', type=d.T.string)]), + withKeyring(keyring): { rbd+: { keyring: keyring } }, + '#withMonitors':: d.fn(help='"monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitors(monitors): { rbd+: { monitors: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withMonitorsMixin':: d.fn(help='"monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitorsMixin(monitors): { rbd+: { monitors+: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withPool':: d.fn(help='"pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='pool', type=d.T.string)]), + withPool(pool): { rbd+: { pool: pool } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { rbd+: { readOnly: readOnly } }, + '#withUser':: d.fn(help='"user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { rbd+: { user: user } }, + }, + '#scaleIO':: d.obj(help='"scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes."'), + scaleIO: { + '#secretRef':: d.obj(help='"secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { scaleIO+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Default is \\"xfs\\"."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { scaleIO+: { fsType: fsType } }, + '#withGateway':: d.fn(help='"gateway is the host address of the ScaleIO API Gateway."', args=[d.arg(name='gateway', type=d.T.string)]), + withGateway(gateway): { scaleIO+: { gateway: gateway } }, + '#withProtectionDomain':: d.fn(help='"protectionDomain is the name of the ScaleIO Protection Domain for the configured storage."', args=[d.arg(name='protectionDomain', type=d.T.string)]), + withProtectionDomain(protectionDomain): { scaleIO+: { protectionDomain: protectionDomain } }, + '#withReadOnly':: d.fn(help='"readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { scaleIO+: { readOnly: readOnly } }, + '#withSslEnabled':: d.fn(help='"sslEnabled Flag enable/disable SSL communication with Gateway, default false"', args=[d.arg(name='sslEnabled', type=d.T.boolean)]), + withSslEnabled(sslEnabled): { scaleIO+: { sslEnabled: sslEnabled } }, + '#withStorageMode':: d.fn(help='"storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned."', args=[d.arg(name='storageMode', type=d.T.string)]), + withStorageMode(storageMode): { scaleIO+: { storageMode: storageMode } }, + '#withStoragePool':: d.fn(help='"storagePool is the ScaleIO Storage Pool associated with the protection domain."', args=[d.arg(name='storagePool', type=d.T.string)]), + withStoragePool(storagePool): { scaleIO+: { storagePool: storagePool } }, + '#withSystem':: d.fn(help='"system is the name of the storage system as configured in ScaleIO."', args=[d.arg(name='system', type=d.T.string)]), + withSystem(system): { scaleIO+: { system: system } }, + '#withVolumeName':: d.fn(help='"volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { scaleIO+: { volumeName: volumeName } }, + }, + '#secret':: d.obj(help='"secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret"'), + secret: { + '#items':: d.obj(help="\"items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withDefaultMode':: d.fn(help='"defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { secret+: { defaultMode: defaultMode } }, + '#withItems':: d.fn(help="\"items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { secret+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { secret+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withOptional':: d.fn(help='"optional field specify whether the Secret or its keys must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secret+: { optional: optional } }, + '#withSecretName':: d.fn(help="\"secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret\"", args=[d.arg(name='secretName', type=d.T.string)]), + withSecretName(secretName): { secret+: { secretName: secretName } }, + }, + '#storageos':: d.obj(help='"storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes."'), + storageos: { + '#secretRef':: d.obj(help='"secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted."'), + secretRef: { + '#withName':: d.fn(help='"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { storageos+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { storageos+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { storageos+: { readOnly: readOnly } }, + '#withVolumeName':: d.fn(help='"volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { storageos+: { volumeName: volumeName } }, + '#withVolumeNamespace':: d.fn(help="\"volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to \\\"default\\\" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.\"", args=[d.arg(name='volumeNamespace', type=d.T.string)]), + withVolumeNamespace(volumeNamespace): { storageos+: { volumeNamespace: volumeNamespace } }, + }, + '#vsphereVolume':: d.obj(help='"vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"'), + vsphereVolume: { + '#withFsType':: d.fn(help='"fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { vsphereVolume+: { fsType: fsType } }, + '#withStoragePolicyID':: d.fn(help='"storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName."', args=[d.arg(name='storagePolicyID', type=d.T.string)]), + withStoragePolicyID(storagePolicyID): { vsphereVolume+: { storagePolicyID: storagePolicyID } }, + '#withStoragePolicyName':: d.fn(help='"storagePolicyName is the storage Policy Based Management (SPBM) profile name."', args=[d.arg(name='storagePolicyName', type=d.T.string)]), + withStoragePolicyName(storagePolicyName): { vsphereVolume+: { storagePolicyName: storagePolicyName } }, + '#withVolumePath':: d.fn(help='"volumePath is the path that identifies vSphere volume vmdk"', args=[d.arg(name='volumePath', type=d.T.string)]), + withVolumePath(volumePath): { vsphereVolume+: { volumePath: volumePath } }, + }, + '#withName':: d.fn(help='"name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withAnnotations':: d.fn(help='"Annotations are the annotations that should be appended to the pods. By default, no pod annotations are appended."', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { annotations: annotations } } } } } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations are the annotations that should be appended to the pods. By default, no pod annotations are appended."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { annotations+: annotations } } } } } }, + '#withLabels':: d.fn(help='"Labels are the additional labels that should be tagged to the pods. By default, no additional pod labels are tagged."', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { labels: labels } } } } } }, + '#withLabelsMixin':: d.fn(help='"Labels are the additional labels that should be tagged to the pods. By default, no additional pod labels are tagged."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { labels+: labels } } } } } }, + '#withTolerations':: d.fn(help="\"If specified, the pod's tolerations.\"", args=[d.arg(name='tolerations', type=d.T.array)]), + withTolerations(tolerations): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { tolerations: if std.isArray(v=tolerations) then tolerations else [tolerations] } } } } } }, + '#withTolerationsMixin':: d.fn(help="\"If specified, the pod's tolerations.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='tolerations', type=d.T.array)]), + withTolerationsMixin(tolerations): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { tolerations+: if std.isArray(v=tolerations) then tolerations else [tolerations] } } } } } }, + '#withVolumes':: d.fn(help='"Volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes"', args=[d.arg(name='volumes', type=d.T.array)]), + withVolumes(volumes): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { volumes: if std.isArray(v=volumes) then volumes else [volumes] } } } } } }, + '#withVolumesMixin':: d.fn(help='"Volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumes', type=d.T.array)]), + withVolumesMixin(volumes): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { pod+: { volumes+: if std.isArray(v=volumes) then volumes else [volumes] } } } } } }, + }, + '#strategy':: d.obj(help='"The deployment strategy to use to replace existing pods with new ones."'), + strategy: { + '#rollingUpdate':: d.obj(help='"Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. --- TODO: Update this to follow our convention for oneOf, whatever we decide it to be."'), + rollingUpdate: { + '#withMaxSurge':: d.fn(help='"The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods."', args=[d.arg(name='maxSurge', type=d.T.any)]), + withMaxSurge(maxSurge): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { strategy+: { rollingUpdate+: { maxSurge: maxSurge } } } } } } }, + '#withMaxUnavailable':: d.fn(help='"The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods."', args=[d.arg(name='maxUnavailable', type=d.T.any)]), + withMaxUnavailable(maxUnavailable): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { strategy+: { rollingUpdate+: { maxUnavailable: maxUnavailable } } } } } } }, + }, + '#withType':: d.fn(help='"Type of deployment. Can be \\"Recreate\\" or \\"RollingUpdate\\". Default is RollingUpdate."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { strategy+: { type: type } } } } } }, + }, + '#withInitContainers':: d.fn(help='"List of initialization containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/"', args=[d.arg(name='initContainers', type=d.T.array)]), + withInitContainers(initContainers): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { initContainers: if std.isArray(v=initContainers) then initContainers else [initContainers] } } } } }, + '#withInitContainersMixin':: d.fn(help='"List of initialization containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='initContainers', type=d.T.array)]), + withInitContainersMixin(initContainers): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { initContainers+: if std.isArray(v=initContainers) then initContainers else [initContainers] } } } } }, + '#withReplicas':: d.fn(help='"Replicas is the number of desired pods. Defaults to 1."', args=[d.arg(name='replicas', type=d.T.integer)]), + withReplicas(replicas): { spec+: { provider+: { kubernetes+: { envoyDeployment+: { replicas: replicas } } } } }, + }, + '#envoyService':: d.obj(help='"EnvoyService defines the desired state of the Envoy service resource. If unspecified, default settings for the managed Envoy service resource are applied."'), + envoyService: { + '#withAllocateLoadBalancerNodePorts':: d.fn(help='"AllocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is \\"true\\". It may be set to \\"false\\" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type."', args=[d.arg(name='allocateLoadBalancerNodePorts', type=d.T.boolean)]), + withAllocateLoadBalancerNodePorts(allocateLoadBalancerNodePorts): { spec+: { provider+: { kubernetes+: { envoyService+: { allocateLoadBalancerNodePorts: allocateLoadBalancerNodePorts } } } } }, + '#withAnnotations':: d.fn(help='"Annotations that should be appended to the service. By default, no annotations are appended."', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { spec+: { provider+: { kubernetes+: { envoyService+: { annotations: annotations } } } } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations that should be appended to the service. By default, no annotations are appended."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { spec+: { provider+: { kubernetes+: { envoyService+: { annotations+: annotations } } } } }, + '#withLoadBalancerClass':: d.fn(help='"LoadBalancerClass, when specified, allows for choosing the LoadBalancer provider implementation if more than one are available or is otherwise expected to be specified"', args=[d.arg(name='loadBalancerClass', type=d.T.string)]), + withLoadBalancerClass(loadBalancerClass): { spec+: { provider+: { kubernetes+: { envoyService+: { loadBalancerClass: loadBalancerClass } } } } }, + '#withLoadBalancerIP':: d.fn(help='"LoadBalancerIP defines the IP Address of the underlying load balancer service. This field may be ignored if the load balancer provider does not support this feature. This field has been deprecated in Kubernetes, but it is still used for setting the IP Address in some cloud providers such as GCP."', args=[d.arg(name='loadBalancerIP', type=d.T.string)]), + withLoadBalancerIP(loadBalancerIP): { spec+: { provider+: { kubernetes+: { envoyService+: { loadBalancerIP: loadBalancerIP } } } } }, + '#withType':: d.fn(help='"Type determines how the Service is exposed. Defaults to LoadBalancer. Valid options are ClusterIP, LoadBalancer and NodePort. \\"LoadBalancer\\" means a service will be exposed via an external load balancer (if the cloud provider supports it). \\"ClusterIP\\" means a service will only be accessible inside the cluster, via the cluster IP. \\"NodePort\\" means a service will be exposed on a static Port on all Nodes of the cluster."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { provider+: { kubernetes+: { envoyService+: { type: type } } } } }, + }, + }, + '#withType':: d.fn(help='"Type is the type of resource provider to use. A resource provider provides infrastructure resources for running the data plane, e.g. Envoy proxy, and optional auxiliary control planes. Supported types are \\"Kubernetes\\"."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { provider+: { type: type } } }, + }, + '#telemetry':: d.obj(help='"Telemetry defines telemetry parameters for managed proxies."'), + telemetry: { + '#accessLog':: d.obj(help='"AccessLogs defines accesslog parameters for managed proxies. If unspecified, will send default format to stdout."'), + accessLog: { + '#settings':: d.obj(help='"Settings defines accesslog settings for managed proxies. If unspecified, will send default format to stdout."'), + settings: { + '#format':: d.obj(help='"Format defines the format of accesslog."'), + format: { + '#withJson':: d.fn(help="\"JSON is additional attributes that describe the specific event occurrence. Structured format for the envoy access logs. Envoy [command operators](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators) can be used as values for fields within the Struct. It's required when the format type is \\\"JSON\\\".\"", args=[d.arg(name='json', type=d.T.object)]), + withJson(json): { format+: { json: json } }, + '#withJsonMixin':: d.fn(help="\"JSON is additional attributes that describe the specific event occurrence. Structured format for the envoy access logs. Envoy [command operators](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators) can be used as values for fields within the Struct. It's required when the format type is \\\"JSON\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='json', type=d.T.object)]), + withJsonMixin(json): { format+: { json+: json } }, + '#withText':: d.fn(help="\"Text defines the text accesslog format, following Envoy accesslog formatting, It's required when the format type is \\\"Text\\\". Envoy [command operators](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators) may be used in the format. The [format string documentation](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#config-access-log-format-strings) provides more information.\"", args=[d.arg(name='text', type=d.T.string)]), + withText(text): { format+: { text: text } }, + '#withType':: d.fn(help='"Type defines the type of accesslog format."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { format+: { type: type } }, + }, + '#sinks':: d.obj(help='"Sinks defines the sinks of accesslog."'), + sinks: { + '#file':: d.obj(help='"File defines the file accesslog sink."'), + file: { + '#withPath':: d.fn(help='"Path defines the file path used to expose envoy access log(e.g. /dev/stdout)."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { file+: { path: path } }, + }, + '#openTelemetry':: d.obj(help='"OpenTelemetry defines the OpenTelemetry accesslog sink."'), + openTelemetry: { + '#withHost':: d.fn(help='"Host define the extension service hostname."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { openTelemetry+: { host: host } }, + '#withPort':: d.fn(help='"Port defines the port the extension service is exposed on."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { openTelemetry+: { port: port } }, + '#withResources':: d.fn(help="\"Resources is a set of labels that describe the source of a log entry, including envoy node info. It's recommended to follow [semantic conventions](https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/).\"", args=[d.arg(name='resources', type=d.T.object)]), + withResources(resources): { openTelemetry+: { resources: resources } }, + '#withResourcesMixin':: d.fn(help="\"Resources is a set of labels that describe the source of a log entry, including envoy node info. It's recommended to follow [semantic conventions](https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/).\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='resources', type=d.T.object)]), + withResourcesMixin(resources): { openTelemetry+: { resources+: resources } }, + }, + '#withType':: d.fn(help='"Type defines the type of accesslog sink."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { type: type }, + }, + '#withSinks':: d.fn(help='"Sinks defines the sinks of accesslog."', args=[d.arg(name='sinks', type=d.T.array)]), + withSinks(sinks): { sinks: if std.isArray(v=sinks) then sinks else [sinks] }, + '#withSinksMixin':: d.fn(help='"Sinks defines the sinks of accesslog."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sinks', type=d.T.array)]), + withSinksMixin(sinks): { sinks+: if std.isArray(v=sinks) then sinks else [sinks] }, + }, + '#withDisable':: d.fn(help='"Disable disables access logging for managed proxies if set to true."', args=[d.arg(name='disable', type=d.T.boolean)]), + withDisable(disable): { spec+: { telemetry+: { accessLog+: { disable: disable } } } }, + '#withSettings':: d.fn(help='"Settings defines accesslog settings for managed proxies. If unspecified, will send default format to stdout."', args=[d.arg(name='settings', type=d.T.array)]), + withSettings(settings): { spec+: { telemetry+: { accessLog+: { settings: if std.isArray(v=settings) then settings else [settings] } } } }, + '#withSettingsMixin':: d.fn(help='"Settings defines accesslog settings for managed proxies. If unspecified, will send default format to stdout."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='settings', type=d.T.array)]), + withSettingsMixin(settings): { spec+: { telemetry+: { accessLog+: { settings+: if std.isArray(v=settings) then settings else [settings] } } } }, + }, + '#metrics':: d.obj(help='"Metrics defines metrics configuration for managed proxies."'), + metrics: { + '#matches':: d.obj(help='"Matches defines configuration for selecting specific metrics instead of generating all metrics stats that are enabled by default. This helps reduce CPU and memory overhead in Envoy, but eliminating some stats may after critical functionality. Here are the stats that we strongly recommend not disabling: `cluster_manager.warming_clusters`, `cluster..membership_total`,`cluster..membership_healthy`, `cluster..membership_degraded`，reference https://github.com/envoyproxy/envoy/issues/9856, https://github.com/envoyproxy/envoy/issues/14610"'), + matches: { + '#withType':: d.fn(help='"MatcherType defines the stats matcher type"', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { type: type }, + '#withValue':: d.fn(help='', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#prometheus':: d.obj(help='"Prometheus defines the configuration for Admin endpoint `/stats/prometheus`."'), + prometheus: { + '#withDisable':: d.fn(help='"Disable the Prometheus endpoint."', args=[d.arg(name='disable', type=d.T.boolean)]), + withDisable(disable): { spec+: { telemetry+: { metrics+: { prometheus+: { disable: disable } } } } }, + }, + '#sinks':: d.obj(help='"Sinks defines the metric sinks where metrics are sent to."'), + sinks: { + '#openTelemetry':: d.obj(help="\"OpenTelemetry defines the configuration for OpenTelemetry sink. It's required if the sink type is OpenTelemetry.\""), + openTelemetry: { + '#withHost':: d.fn(help='"Host define the service hostname."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { openTelemetry+: { host: host } }, + '#withPort':: d.fn(help='"Port defines the port the service is exposed on."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { openTelemetry+: { port: port } }, + }, + '#withType':: d.fn(help='"Type defines the metric sink type. EG currently only supports OpenTelemetry."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { type: type }, + }, + '#withEnableVirtualHostStats':: d.fn(help='"EnableVirtualHostStats enables envoy stat metrics for virtual hosts."', args=[d.arg(name='enableVirtualHostStats', type=d.T.boolean)]), + withEnableVirtualHostStats(enableVirtualHostStats): { spec+: { telemetry+: { metrics+: { enableVirtualHostStats: enableVirtualHostStats } } } }, + '#withMatches':: d.fn(help='"Matches defines configuration for selecting specific metrics instead of generating all metrics stats that are enabled by default. This helps reduce CPU and memory overhead in Envoy, but eliminating some stats may after critical functionality. Here are the stats that we strongly recommend not disabling: `cluster_manager.warming_clusters`, `cluster..membership_total`,`cluster..membership_healthy`, `cluster..membership_degraded`，reference https://github.com/envoyproxy/envoy/issues/9856, https://github.com/envoyproxy/envoy/issues/14610"', args=[d.arg(name='matches', type=d.T.array)]), + withMatches(matches): { spec+: { telemetry+: { metrics+: { matches: if std.isArray(v=matches) then matches else [matches] } } } }, + '#withMatchesMixin':: d.fn(help='"Matches defines configuration for selecting specific metrics instead of generating all metrics stats that are enabled by default. This helps reduce CPU and memory overhead in Envoy, but eliminating some stats may after critical functionality. Here are the stats that we strongly recommend not disabling: `cluster_manager.warming_clusters`, `cluster..membership_total`,`cluster..membership_healthy`, `cluster..membership_degraded`，reference https://github.com/envoyproxy/envoy/issues/9856, https://github.com/envoyproxy/envoy/issues/14610"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matches', type=d.T.array)]), + withMatchesMixin(matches): { spec+: { telemetry+: { metrics+: { matches+: if std.isArray(v=matches) then matches else [matches] } } } }, + '#withSinks':: d.fn(help='"Sinks defines the metric sinks where metrics are sent to."', args=[d.arg(name='sinks', type=d.T.array)]), + withSinks(sinks): { spec+: { telemetry+: { metrics+: { sinks: if std.isArray(v=sinks) then sinks else [sinks] } } } }, + '#withSinksMixin':: d.fn(help='"Sinks defines the metric sinks where metrics are sent to."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sinks', type=d.T.array)]), + withSinksMixin(sinks): { spec+: { telemetry+: { metrics+: { sinks+: if std.isArray(v=sinks) then sinks else [sinks] } } } }, + }, + '#tracing':: d.obj(help='"Tracing defines tracing configuration for managed proxies. If unspecified, will not send tracing data."'), + tracing: { + '#provider':: d.obj(help='"Provider defines the tracing provider. Only OpenTelemetry is supported currently."'), + provider: { + '#withHost':: d.fn(help='"Host define the provider service hostname."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { spec+: { telemetry+: { tracing+: { provider+: { host: host } } } } }, + '#withPort':: d.fn(help='"Port defines the port the provider service is exposed on."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { spec+: { telemetry+: { tracing+: { provider+: { port: port } } } } }, + '#withType':: d.fn(help='"Type defines the tracing provider type. EG currently only supports OpenTelemetry."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { telemetry+: { tracing+: { provider+: { type: type } } } } }, + }, + '#withCustomTags':: d.fn(help='"CustomTags defines the custom tags to add to each span. If provider is kubernetes, pod name and namespace are added by default."', args=[d.arg(name='customTags', type=d.T.object)]), + withCustomTags(customTags): { spec+: { telemetry+: { tracing+: { customTags: customTags } } } }, + '#withCustomTagsMixin':: d.fn(help='"CustomTags defines the custom tags to add to each span. If provider is kubernetes, pod name and namespace are added by default."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='customTags', type=d.T.object)]), + withCustomTagsMixin(customTags): { spec+: { telemetry+: { tracing+: { customTags+: customTags } } } }, + '#withSamplingRate':: d.fn(help='"SamplingRate controls the rate at which traffic will be selected for tracing if no prior sampling decision has been made. Defaults to 100, valid values [0-100]. 100 indicates 100% sampling."', args=[d.arg(name='samplingRate', type=d.T.integer)]), + withSamplingRate(samplingRate): { spec+: { telemetry+: { tracing+: { samplingRate: samplingRate } } } }, + }, + }, + '#withConcurrency':: d.fn(help='"Concurrency defines the number of worker threads to run. If unset, it defaults to the number of cpuset threads on the platform."', args=[d.arg(name='concurrency', type=d.T.integer)]), + withConcurrency(concurrency): { spec+: { concurrency: concurrency } }, + '#withMergeGateways':: d.fn(help='"MergeGateways defines if Gateway resources should be merged onto the same Envoy Proxy Infrastructure. Setting this field to true would merge all Gateway Listeners under the parent Gateway Class. This means that the port, protocol and hostname tuple must be unique for every listener. If a duplicate listener is detected, the newer listener (based on timestamp) will be rejected and its status will be updated with a \\"Accepted=False\\" condition."', args=[d.arg(name='mergeGateways', type=d.T.boolean)]), + withMergeGateways(mergeGateways): { spec+: { mergeGateways: mergeGateways } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/v0.6.0/_gen/gateway/v1alpha1/main.libsonnet b/v0.6.0/_gen/gateway/v1alpha1/main.libsonnet new file mode 100644 index 0000000..bbcfd61 --- /dev/null +++ b/v0.6.0/_gen/gateway/v1alpha1/main.libsonnet @@ -0,0 +1,9 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1alpha1', url='', help=''), + backendTrafficPolicy: (import 'backendTrafficPolicy.libsonnet'), + clientTrafficPolicy: (import 'clientTrafficPolicy.libsonnet'), + envoyPatchPolicy: (import 'envoyPatchPolicy.libsonnet'), + envoyProxy: (import 'envoyProxy.libsonnet'), + securityPolicy: (import 'securityPolicy.libsonnet'), +} diff --git a/v0.6.0/_gen/gateway/v1alpha1/securityPolicy.libsonnet b/v0.6.0/_gen/gateway/v1alpha1/securityPolicy.libsonnet new file mode 100644 index 0000000..348f5ce --- /dev/null +++ b/v0.6.0/_gen/gateway/v1alpha1/securityPolicy.libsonnet @@ -0,0 +1,130 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='securityPolicy', url='', help='"SecurityPolicy allows the user to configure various security settings for a Gateway."'), + '#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 SecurityPolicy', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'gateway.envoyproxy.io/v1alpha1', + kind: 'SecurityPolicy', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"Spec defines the desired state of SecurityPolicy."'), + spec: { + '#cors':: d.obj(help='"CORS defines the configuration for Cross-Origin Resource Sharing (CORS)."'), + cors: { + '#allowOrigins':: d.obj(help='"AllowOrigins defines the origins that are allowed to make requests."'), + allowOrigins: { + '#withType':: d.fn(help='"Type specifies how to match against a string."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { type: type }, + '#withValue':: d.fn(help='"Value specifies the string value that the match must have."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withAllowHeaders':: d.fn(help='"AllowHeaders defines the headers that are allowed to be sent with requests."', args=[d.arg(name='allowHeaders', type=d.T.array)]), + withAllowHeaders(allowHeaders): { spec+: { cors+: { allowHeaders: if std.isArray(v=allowHeaders) then allowHeaders else [allowHeaders] } } }, + '#withAllowHeadersMixin':: d.fn(help='"AllowHeaders defines the headers that are allowed to be sent with requests."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='allowHeaders', type=d.T.array)]), + withAllowHeadersMixin(allowHeaders): { spec+: { cors+: { allowHeaders+: if std.isArray(v=allowHeaders) then allowHeaders else [allowHeaders] } } }, + '#withAllowMethods':: d.fn(help='"AllowMethods defines the methods that are allowed to make requests."', args=[d.arg(name='allowMethods', type=d.T.array)]), + withAllowMethods(allowMethods): { spec+: { cors+: { allowMethods: if std.isArray(v=allowMethods) then allowMethods else [allowMethods] } } }, + '#withAllowMethodsMixin':: d.fn(help='"AllowMethods defines the methods that are allowed to make requests."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='allowMethods', type=d.T.array)]), + withAllowMethodsMixin(allowMethods): { spec+: { cors+: { allowMethods+: if std.isArray(v=allowMethods) then allowMethods else [allowMethods] } } }, + '#withAllowOrigins':: d.fn(help='"AllowOrigins defines the origins that are allowed to make requests."', args=[d.arg(name='allowOrigins', type=d.T.array)]), + withAllowOrigins(allowOrigins): { spec+: { cors+: { allowOrigins: if std.isArray(v=allowOrigins) then allowOrigins else [allowOrigins] } } }, + '#withAllowOriginsMixin':: d.fn(help='"AllowOrigins defines the origins that are allowed to make requests."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='allowOrigins', type=d.T.array)]), + withAllowOriginsMixin(allowOrigins): { spec+: { cors+: { allowOrigins+: if std.isArray(v=allowOrigins) then allowOrigins else [allowOrigins] } } }, + '#withExposeHeaders':: d.fn(help='"ExposeHeaders defines the headers that can be exposed in the responses."', args=[d.arg(name='exposeHeaders', type=d.T.array)]), + withExposeHeaders(exposeHeaders): { spec+: { cors+: { exposeHeaders: if std.isArray(v=exposeHeaders) then exposeHeaders else [exposeHeaders] } } }, + '#withExposeHeadersMixin':: d.fn(help='"ExposeHeaders defines the headers that can be exposed in the responses."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='exposeHeaders', type=d.T.array)]), + withExposeHeadersMixin(exposeHeaders): { spec+: { cors+: { exposeHeaders+: if std.isArray(v=exposeHeaders) then exposeHeaders else [exposeHeaders] } } }, + '#withMaxAge':: d.fn(help='"MaxAge defines how long the results of a preflight request can be cached."', args=[d.arg(name='maxAge', type=d.T.string)]), + withMaxAge(maxAge): { spec+: { cors+: { maxAge: maxAge } } }, + }, + '#jwt':: d.obj(help='"JWT defines the configuration for JSON Web Token (JWT) authentication."'), + jwt: { + '#providers':: d.obj(help='"Providers defines the JSON Web Token (JWT) authentication provider type. \\n When multiple JWT providers are specified, the JWT is considered valid if any of the providers successfully validate the JWT. For additional details, see https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/jwt_authn_filter.html."'), + providers: { + '#claimToHeaders':: d.obj(help='"ClaimToHeaders is a list of JWT claims that must be extracted into HTTP request headers For examples, following config: The claim must be of type; string, int, double, bool. Array type claims are not supported"'), + claimToHeaders: { + '#withClaim':: d.fn(help='"Claim is the JWT Claim that should be saved into the header : it can be a nested claim of type (eg. \\"claim.nested.key\\", \\"sub\\"). The nested claim name must use dot \\".\\" to separate the JSON name path."', args=[d.arg(name='claim', type=d.T.string)]), + withClaim(claim): { claim: claim }, + '#withHeader':: d.fn(help='"Header defines the name of the HTTP request header that the JWT Claim will be saved into."', args=[d.arg(name='header', type=d.T.string)]), + withHeader(header): { header: header }, + }, + '#remoteJWKS':: d.obj(help='"RemoteJWKS defines how to fetch and cache JSON Web Key Sets (JWKS) from a remote HTTP/HTTPS endpoint."'), + remoteJWKS: { + '#withUri':: d.fn(help="\"URI is the HTTPS URI to fetch the JWKS. Envoy's system trust bundle is used to validate the server certificate.\"", args=[d.arg(name='uri', type=d.T.string)]), + withUri(uri): { remoteJWKS+: { uri: uri } }, + }, + '#withAudiences':: d.fn(help='"Audiences is a list of JWT audiences allowed access. For additional details, see https://tools.ietf.org/html/rfc7519#section-4.1.3. If not provided, JWT audiences are not checked."', args=[d.arg(name='audiences', type=d.T.array)]), + withAudiences(audiences): { audiences: if std.isArray(v=audiences) then audiences else [audiences] }, + '#withAudiencesMixin':: d.fn(help='"Audiences is a list of JWT audiences allowed access. For additional details, see https://tools.ietf.org/html/rfc7519#section-4.1.3. If not provided, JWT audiences are not checked."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='audiences', type=d.T.array)]), + withAudiencesMixin(audiences): { audiences+: if std.isArray(v=audiences) then audiences else [audiences] }, + '#withClaimToHeaders':: d.fn(help='"ClaimToHeaders is a list of JWT claims that must be extracted into HTTP request headers For examples, following config: The claim must be of type; string, int, double, bool. Array type claims are not supported"', args=[d.arg(name='claimToHeaders', type=d.T.array)]), + withClaimToHeaders(claimToHeaders): { claimToHeaders: if std.isArray(v=claimToHeaders) then claimToHeaders else [claimToHeaders] }, + '#withClaimToHeadersMixin':: d.fn(help='"ClaimToHeaders is a list of JWT claims that must be extracted into HTTP request headers For examples, following config: The claim must be of type; string, int, double, bool. Array type claims are not supported"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claimToHeaders', type=d.T.array)]), + withClaimToHeadersMixin(claimToHeaders): { claimToHeaders+: if std.isArray(v=claimToHeaders) then claimToHeaders else [claimToHeaders] }, + '#withIssuer':: d.fn(help='"Issuer is the principal that issued the JWT and takes the form of a URL or email address. For additional details, see https://tools.ietf.org/html/rfc7519#section-4.1.1 for URL format and https://rfc-editor.org/rfc/rfc5322.html for email format. If not provided, the JWT issuer is not checked."', args=[d.arg(name='issuer', type=d.T.string)]), + withIssuer(issuer): { issuer: issuer }, + '#withName':: d.fn(help='"Name defines a unique name for the JWT provider. A name can have a variety of forms, including RFC1123 subdomains, RFC 1123 labels, or RFC 1035 labels."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withProviders':: d.fn(help='"Providers defines the JSON Web Token (JWT) authentication provider type. \\n When multiple JWT providers are specified, the JWT is considered valid if any of the providers successfully validate the JWT. For additional details, see https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/jwt_authn_filter.html."', args=[d.arg(name='providers', type=d.T.array)]), + withProviders(providers): { spec+: { jwt+: { providers: if std.isArray(v=providers) then providers else [providers] } } }, + '#withProvidersMixin':: d.fn(help='"Providers defines the JSON Web Token (JWT) authentication provider type. \\n When multiple JWT providers are specified, the JWT is considered valid if any of the providers successfully validate the JWT. For additional details, see https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/jwt_authn_filter.html."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='providers', type=d.T.array)]), + withProvidersMixin(providers): { spec+: { jwt+: { providers+: if std.isArray(v=providers) then providers else [providers] } } }, + }, + '#targetRef':: d.obj(help='"TargetRef is the name of the Gateway resource this policy is being attached to. This Policy and the TargetRef MUST be in the same namespace for this Policy to have effect and be applied to the Gateway. TargetRef"'), + targetRef: { + '#withGroup':: d.fn(help='"Group is the group of the target resource."', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { spec+: { targetRef+: { group: group } } }, + '#withKind':: d.fn(help='"Kind is kind of the target resource."', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { targetRef+: { kind: kind } } }, + '#withName':: d.fn(help='"Name is the name of the target resource."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { targetRef+: { name: name } } }, + '#withNamespace':: d.fn(help='"Namespace is the namespace of the referent. When unspecified, the local namespace is inferred. Even when policy targets a resource in a different namespace, it MUST only apply to traffic originating from the same namespace as the policy."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { targetRef+: { namespace: namespace } } }, + '#withSectionName':: d.fn(help="\"SectionName is the name of a section within the target resource. When unspecified, this targetRef targets the entire resource. In the following resources, SectionName is interpreted as the following: \\n * Gateway: Listener Name * Service: Port Name \\n If a SectionName is specified, but does not exist on the targeted object, the Policy must fail to attach, and the policy implementation should record a `ResolvedRefs` or similar Condition in the Policy's status.\"", args=[d.arg(name='sectionName', type=d.T.string)]), + withSectionName(sectionName): { spec+: { targetRef+: { sectionName: sectionName } } }, + }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/v0.6.0/gen.libsonnet b/v0.6.0/gen.libsonnet new file mode 100644 index 0000000..1bc84d8 --- /dev/null +++ b/v0.6.0/gen.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='envoy-gateway', url='github.com/jsonnet-libs/envoy-gateway-libsonnet/v0.6.0/main.libsonnet', help=''), + gateway:: (import '_gen/gateway/main.libsonnet'), +} diff --git a/v0.6.0/main.libsonnet b/v0.6.0/main.libsonnet new file mode 100644 index 0000000..f5597a5 --- /dev/null +++ b/v0.6.0/main.libsonnet @@ -0,0 +1 @@ +(import 'gen.libsonnet')