Skip to content

integreatly.v1alpha1.grafana

"Grafana is the Schema for the grafanas API"

Index

Fields

fn new

new(name)

new returns an instance of Grafana

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

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

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

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

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

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

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

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

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

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

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

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

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

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

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

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

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

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"

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

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

fn spec.withBaseImage

withBaseImage(baseImage)

fn spec.withConfigMaps

withConfigMaps(configMaps)

fn spec.withConfigMapsMixin

withConfigMapsMixin(configMaps)

Note: This function appends passed data to existing values

fn spec.withContainers

withContainers(containers)

fn spec.withContainersMixin

withContainersMixin(containers)

Note: This function appends passed data to existing values

fn spec.withDashboardLabelSelector

withDashboardLabelSelector(dashboardLabelSelector)

fn spec.withDashboardLabelSelectorMixin

withDashboardLabelSelectorMixin(dashboardLabelSelector)

Note: This function appends passed data to existing values

fn spec.withInitImage

withInitImage(initImage)

fn spec.withSecrets

withSecrets(secrets)

fn spec.withSecretsMixin

withSecretsMixin(secrets)

Note: This function appends passed data to existing values

obj spec.client

"GrafanaClient contains the Grafana API client settings"

fn spec.client.withPreferService

withPreferService(preferService)

fn spec.client.withTimeout

withTimeout(timeout)

obj spec.config

"GrafanaConfig is the configuration for grafana"

obj spec.config.alerting

fn spec.config.alerting.withConcurrent_render_limit

withConcurrent_render_limit(concurrent_render_limit)

fn spec.config.alerting.withEnabled

withEnabled(enabled)

fn spec.config.alerting.withError_or_timeout

withError_or_timeout(error_or_timeout)

fn spec.config.alerting.withEvaluation_timeout_seconds

withEvaluation_timeout_seconds(evaluation_timeout_seconds)

fn spec.config.alerting.withExecute_alerts

withExecute_alerts(execute_alerts)

fn spec.config.alerting.withMax_attempts

withMax_attempts(max_attempts)

fn spec.config.alerting.withNodata_or_nullvalues

withNodata_or_nullvalues(nodata_or_nullvalues)

fn spec.config.alerting.withNotification_timeout_seconds

withNotification_timeout_seconds(notification_timeout_seconds)

obj spec.config.analytics

fn spec.config.analytics.withCheck_for_updates

withCheck_for_updates(check_for_updates)

fn spec.config.analytics.withGoogle_analytics_ua_id

withGoogle_analytics_ua_id(google_analytics_ua_id)

fn spec.config.analytics.withReporting_enabled

withReporting_enabled(reporting_enabled)

obj spec.config.auth

fn spec.config.auth.withDisable_login_form

withDisable_login_form(disable_login_form)

fn spec.config.auth.withDisable_signout_menu

withDisable_signout_menu(disable_signout_menu)

withLogin_cookie_name(login_cookie_name)

fn spec.config.auth.withLogin_maximum_inactive_lifetime_days

withLogin_maximum_inactive_lifetime_days(login_maximum_inactive_lifetime_days)

fn spec.config.auth.withLogin_maximum_inactive_lifetime_duration

withLogin_maximum_inactive_lifetime_duration(login_maximum_inactive_lifetime_duration)

fn spec.config.auth.withLogin_maximum_lifetime_days

withLogin_maximum_lifetime_days(login_maximum_lifetime_days)

fn spec.config.auth.withLogin_maximum_lifetime_duration

withLogin_maximum_lifetime_duration(login_maximum_lifetime_duration)

fn spec.config.auth.withOauth_auto_login

withOauth_auto_login(oauth_auto_login)

fn spec.config.auth.withSignout_redirect_url

withSignout_redirect_url(signout_redirect_url)

fn spec.config.auth.withSigv4_auth_enabled

withSigv4_auth_enabled(sigv4_auth_enabled)

fn spec.config.auth.withToken_rotation_interval_minutes

withToken_rotation_interval_minutes(token_rotation_interval_minutes)

obj spec.config.auth.anonymous

fn spec.config.auth.anonymous.withEnabled

withEnabled(enabled)

fn spec.config.auth.anonymous.withOrg_name

withOrg_name(org_name)

fn spec.config.auth.anonymous.withOrg_role

withOrg_role(org_role)

obj spec.config.auth.azuread

fn spec.config.auth.azuread.withAllow_sign_up

withAllow_sign_up(allow_sign_up)

fn spec.config.auth.azuread.withAllowed_domains

withAllowed_domains(allowed_domains)

fn spec.config.auth.azuread.withAllowed_groups

withAllowed_groups(allowed_groups)

fn spec.config.auth.azuread.withAuth_url

withAuth_url(auth_url)

fn spec.config.auth.azuread.withClient_id

withClient_id(client_id)

fn spec.config.auth.azuread.withClient_secret

withClient_secret(client_secret)

fn spec.config.auth.azuread.withEnabled

withEnabled(enabled)

fn spec.config.auth.azuread.withScopes

withScopes(scopes)

fn spec.config.auth.azuread.withToken_url

withToken_url(token_url)

obj spec.config.auth.basic

fn spec.config.auth.basic.withEnabled

withEnabled(enabled)

obj spec.config.auth.generic_oauth

fn spec.config.auth.generic_oauth.withAllow_sign_up

withAllow_sign_up(allow_sign_up)

fn spec.config.auth.generic_oauth.withAllowed_domains

withAllowed_domains(allowed_domains)

fn spec.config.auth.generic_oauth.withApi_url

withApi_url(api_url)

fn spec.config.auth.generic_oauth.withAuth_url

withAuth_url(auth_url)

fn spec.config.auth.generic_oauth.withClient_id

withClient_id(client_id)

fn spec.config.auth.generic_oauth.withClient_secret

withClient_secret(client_secret)

fn spec.config.auth.generic_oauth.withEmail_attribute_path

withEmail_attribute_path(email_attribute_path)

fn spec.config.auth.generic_oauth.withEnabled

withEnabled(enabled)

fn spec.config.auth.generic_oauth.withRole_attribute_path

withRole_attribute_path(role_attribute_path)

fn spec.config.auth.generic_oauth.withRole_attribute_strict

withRole_attribute_strict(role_attribute_strict)

fn spec.config.auth.generic_oauth.withScopes

withScopes(scopes)

fn spec.config.auth.generic_oauth.withTls_client_ca

withTls_client_ca(tls_client_ca)

fn spec.config.auth.generic_oauth.withTls_client_cert

withTls_client_cert(tls_client_cert)

fn spec.config.auth.generic_oauth.withTls_client_key

withTls_client_key(tls_client_key)

fn spec.config.auth.generic_oauth.withTls_skip_verify_insecure

withTls_skip_verify_insecure(tls_skip_verify_insecure)

fn spec.config.auth.generic_oauth.withToken_url

withToken_url(token_url)

obj spec.config.auth.github

fn spec.config.auth.github.withAllow_sign_up

withAllow_sign_up(allow_sign_up)

fn spec.config.auth.github.withAllowed_organizations

withAllowed_organizations(allowed_organizations)

fn spec.config.auth.github.withApi_url

withApi_url(api_url)

fn spec.config.auth.github.withAuth_url

withAuth_url(auth_url)

fn spec.config.auth.github.withClient_id

withClient_id(client_id)

fn spec.config.auth.github.withClient_secret

withClient_secret(client_secret)

fn spec.config.auth.github.withEnabled

withEnabled(enabled)

fn spec.config.auth.github.withScopes

withScopes(scopes)

fn spec.config.auth.github.withTeam_ids

withTeam_ids(team_ids)

fn spec.config.auth.github.withToken_url

withToken_url(token_url)

obj spec.config.auth.gitlab

fn spec.config.auth.gitlab.withAllow_sign_up

withAllow_sign_up(allow_sign_up)

fn spec.config.auth.gitlab.withAllowed_groups

withAllowed_groups(allowed_groups)

fn spec.config.auth.gitlab.withApi_url

withApi_url(api_url)

fn spec.config.auth.gitlab.withAuth_url

withAuth_url(auth_url)

fn spec.config.auth.gitlab.withClient_id

withClient_id(client_id)

fn spec.config.auth.gitlab.withClient_secret

withClient_secret(client_secret)

fn spec.config.auth.gitlab.withEnabled

withEnabled(enabled)

fn spec.config.auth.gitlab.withScopes

withScopes(scopes)

fn spec.config.auth.gitlab.withToken_url

withToken_url(token_url)

obj spec.config.auth.google

fn spec.config.auth.google.withAllow_sign_up

withAllow_sign_up(allow_sign_up)

fn spec.config.auth.google.withAllowed_domains

withAllowed_domains(allowed_domains)

fn spec.config.auth.google.withAuth_url

withAuth_url(auth_url)

fn spec.config.auth.google.withClient_id

withClient_id(client_id)

fn spec.config.auth.google.withClient_secret

withClient_secret(client_secret)

fn spec.config.auth.google.withEnabled

withEnabled(enabled)

fn spec.config.auth.google.withScopes

withScopes(scopes)

fn spec.config.auth.google.withToken_url

withToken_url(token_url)

obj spec.config.auth.ldap

fn spec.config.auth.ldap.withAllow_sign_up

withAllow_sign_up(allow_sign_up)

fn spec.config.auth.ldap.withConfig_file

withConfig_file(config_file)

fn spec.config.auth.ldap.withEnabled

withEnabled(enabled)

obj spec.config.auth.okta

fn spec.config.auth.okta.withAllow_sign_up

withAllow_sign_up(allow_sign_up)

fn spec.config.auth.okta.withAllowed_domains

withAllowed_domains(allowed_domains)

fn spec.config.auth.okta.withAllowed_groups

withAllowed_groups(allowed_groups)

fn spec.config.auth.okta.withApi_url

withApi_url(api_url)

fn spec.config.auth.okta.withAuth_url

withAuth_url(auth_url)

fn spec.config.auth.okta.withClient_id

withClient_id(client_id)

fn spec.config.auth.okta.withClient_secret

withClient_secret(client_secret)

fn spec.config.auth.okta.withEnabled

withEnabled(enabled)

fn spec.config.auth.okta.withName

withName(name)

fn spec.config.auth.okta.withRole_attribute_path

withRole_attribute_path(role_attribute_path)

fn spec.config.auth.okta.withRole_attribute_strict

withRole_attribute_strict(role_attribute_strict)

fn spec.config.auth.okta.withScopes

withScopes(scopes)

fn spec.config.auth.okta.withToken_url

withToken_url(token_url)

obj spec.config.auth.proxy

fn spec.config.auth.proxy.withAuto_sign_up

withAuto_sign_up(auto_sign_up)

fn spec.config.auth.proxy.withEnable_login_token

withEnable_login_token(enable_login_token)

fn spec.config.auth.proxy.withEnabled

withEnabled(enabled)

fn spec.config.auth.proxy.withHeader_name

withHeader_name(header_name)

fn spec.config.auth.proxy.withHeader_property

withHeader_property(header_property)

fn spec.config.auth.proxy.withHeaders

withHeaders(headers)

fn spec.config.auth.proxy.withLdap_sync_ttl

withLdap_sync_ttl(ldap_sync_ttl)

fn spec.config.auth.proxy.withWhitelist

withWhitelist(whitelist)

obj spec.config.auth.saml

fn spec.config.auth.saml.withAllow_idp_initiated

withAllow_idp_initiated(allow_idp_initiated)

fn spec.config.auth.saml.withAllowed_organizations

withAllowed_organizations(allowed_organizations)

fn spec.config.auth.saml.withAssertion_attribute_email

withAssertion_attribute_email(assertion_attribute_email)

fn spec.config.auth.saml.withAssertion_attribute_groups

withAssertion_attribute_groups(assertion_attribute_groups)

fn spec.config.auth.saml.withAssertion_attribute_login

withAssertion_attribute_login(assertion_attribute_login)

fn spec.config.auth.saml.withAssertion_attribute_name

withAssertion_attribute_name(assertion_attribute_name)

fn spec.config.auth.saml.withAssertion_attribute_org

withAssertion_attribute_org(assertion_attribute_org)

fn spec.config.auth.saml.withAssertion_attribute_role

withAssertion_attribute_role(assertion_attribute_role)

fn spec.config.auth.saml.withCertificate_path

withCertificate_path(certificate_path)

fn spec.config.auth.saml.withEnabled

withEnabled(enabled)

fn spec.config.auth.saml.withIdp_metadata_url

withIdp_metadata_url(idp_metadata_url)

fn spec.config.auth.saml.withMax_issue_delay

withMax_issue_delay(max_issue_delay)

fn spec.config.auth.saml.withMetadata_valid_duration

withMetadata_valid_duration(metadata_valid_duration)

fn spec.config.auth.saml.withOrg_mapping

withOrg_mapping(org_mapping)

fn spec.config.auth.saml.withPrivate_key_path

withPrivate_key_path(private_key_path)

fn spec.config.auth.saml.withRelay_state

withRelay_state(relay_state)

fn spec.config.auth.saml.withRole_values_admin

withRole_values_admin(role_values_admin)

fn spec.config.auth.saml.withRole_values_editor

withRole_values_editor(role_values_editor)

fn spec.config.auth.saml.withRole_values_grafana_admin

withRole_values_grafana_admin(role_values_grafana_admin)

fn spec.config.auth.saml.withSignature_algorithm

withSignature_algorithm(signature_algorithm)

fn spec.config.auth.saml.withSingle_logout

withSingle_logout(single_logout)

obj spec.config.dashboards

fn spec.config.dashboards.withDefault_home_dashboard_path

withDefault_home_dashboard_path(default_home_dashboard_path)

fn spec.config.dashboards.withVersions_to_keep

withVersions_to_keep(versions_to_keep)

obj spec.config.database

fn spec.config.database.withCa_cert_path

withCa_cert_path(ca_cert_path)

fn spec.config.database.withCache_mode

withCache_mode(cache_mode)

fn spec.config.database.withClient_cert_path

withClient_cert_path(client_cert_path)

fn spec.config.database.withClient_key_path

withClient_key_path(client_key_path)

fn spec.config.database.withConn_max_lifetime

withConn_max_lifetime(conn_max_lifetime)

fn spec.config.database.withHost

withHost(host)

fn spec.config.database.withLog_queries

withLog_queries(log_queries)

fn spec.config.database.withMax_idle_conn

withMax_idle_conn(max_idle_conn)

fn spec.config.database.withMax_open_conn

withMax_open_conn(max_open_conn)

fn spec.config.database.withName

withName(name)

fn spec.config.database.withPassword

withPassword(password)

fn spec.config.database.withPath

withPath(path)

fn spec.config.database.withServer_cert_name

withServer_cert_name(server_cert_name)

fn spec.config.database.withSsl_mode

withSsl_mode(ssl_mode)

fn spec.config.database.withType

withType(type)

fn spec.config.database.withUrl

withUrl(url)

fn spec.config.database.withUser

withUser(user)

obj spec.config.dataproxy

fn spec.config.dataproxy.withLogging

withLogging(logging)

fn spec.config.dataproxy.withSend_user_header

withSend_user_header(send_user_header)

fn spec.config.dataproxy.withTimeout

withTimeout(timeout)

obj spec.config.external_image_storage

fn spec.config.external_image_storage.withProvider

withProvider(provider)

obj spec.config.external_image_storage.azure_blob

fn spec.config.external_image_storage.azure_blob.withAccount_key

withAccount_key(account_key)

fn spec.config.external_image_storage.azure_blob.withAccount_name

withAccount_name(account_name)

fn spec.config.external_image_storage.azure_blob.withContainer_name

withContainer_name(container_name)

obj spec.config.external_image_storage.gcs

fn spec.config.external_image_storage.gcs.withBucket

withBucket(bucket)

fn spec.config.external_image_storage.gcs.withKey_file

withKey_file(key_file)

fn spec.config.external_image_storage.gcs.withPath

withPath(path)

obj spec.config.external_image_storage.s3

fn spec.config.external_image_storage.s3.withAccess_key

withAccess_key(access_key)

fn spec.config.external_image_storage.s3.withBucket

withBucket(bucket)

fn spec.config.external_image_storage.s3.withBucket_url

withBucket_url(bucket_url)

fn spec.config.external_image_storage.s3.withPath

withPath(path)

fn spec.config.external_image_storage.s3.withRegion

withRegion(region)

fn spec.config.external_image_storage.s3.withSecret_key

withSecret_key(secret_key)

obj spec.config.external_image_storage.webdav

fn spec.config.external_image_storage.webdav.withPassword

withPassword(password)

fn spec.config.external_image_storage.webdav.withPublic_url

withPublic_url(public_url)

fn spec.config.external_image_storage.webdav.withUrl

withUrl(url)

fn spec.config.external_image_storage.webdav.withUsername

withUsername(username)

obj spec.config.feature_toggles

fn spec.config.feature_toggles.withEnable

withEnable(enable)

obj spec.config.live

fn spec.config.live.withAllowed_origins

withAllowed_origins(allowed_origins)

fn spec.config.live.withMax_connections

withMax_connections(max_connections)

obj spec.config.log

fn spec.config.log.withFilters

withFilters(filters)

fn spec.config.log.withLevel

withLevel(level)

fn spec.config.log.withMode

withMode(mode)

obj spec.config.log.console

fn spec.config.log.console.withFormat

withFormat(format)

fn spec.config.log.console.withLevel

withLevel(level)

obj spec.config.log.frontend

fn spec.config.log.frontend.withCustom_endpoint

withCustom_endpoint(custom_endpoint)

fn spec.config.log.frontend.withEnabled

withEnabled(enabled)

fn spec.config.log.frontend.withLog_endpoint_burst_limit

withLog_endpoint_burst_limit(log_endpoint_burst_limit)

fn spec.config.log.frontend.withLog_endpoint_requests_per_second_limit

withLog_endpoint_requests_per_second_limit(log_endpoint_requests_per_second_limit)

fn spec.config.log.frontend.withSample_rate

withSample_rate(sample_rate)

fn spec.config.log.frontend.withSentry_dsn

withSentry_dsn(sentry_dsn)

obj spec.config.metrics

fn spec.config.metrics.withBasic_auth_password

withBasic_auth_password(basic_auth_password)

fn spec.config.metrics.withBasic_auth_username

withBasic_auth_username(basic_auth_username)

fn spec.config.metrics.withEnabled

withEnabled(enabled)

fn spec.config.metrics.withInterval_seconds

withInterval_seconds(interval_seconds)

obj spec.config.metrics.graphite

fn spec.config.metrics.graphite.withAddress

withAddress(address)

fn spec.config.metrics.graphite.withPrefix

withPrefix(prefix)

obj spec.config.panels

fn spec.config.panels.withDisable_sanitize_html

withDisable_sanitize_html(disable_sanitize_html)

obj spec.config.paths

fn spec.config.paths.withTemp_data_lifetime

withTemp_data_lifetime(temp_data_lifetime)

obj spec.config.plugins

fn spec.config.plugins.withEnable_alpha

withEnable_alpha(enable_alpha)

obj spec.config.remote_cache

fn spec.config.remote_cache.withConnstr

withConnstr(connstr)

fn spec.config.remote_cache.withType

withType(type)

obj spec.config.rendering

fn spec.config.rendering.withCallback_url

withCallback_url(callback_url)

fn spec.config.rendering.withConcurrent_render_request_limit

withConcurrent_render_request_limit(concurrent_render_request_limit)

fn spec.config.rendering.withServer_url

withServer_url(server_url)

obj spec.config.security

fn spec.config.security.withAdmin_password

withAdmin_password(admin_password)

fn spec.config.security.withAdmin_user

withAdmin_user(admin_user)

fn spec.config.security.withAllow_embedding

withAllow_embedding(allow_embedding)

fn spec.config.security.withCookie_samesite

withCookie_samesite(cookie_samesite)

fn spec.config.security.withCookie_secure

withCookie_secure(cookie_secure)

fn spec.config.security.withData_source_proxy_whitelist

withData_source_proxy_whitelist(data_source_proxy_whitelist)

fn spec.config.security.withDisable_gravatar

withDisable_gravatar(disable_gravatar)

fn spec.config.security.withLogin_remember_days

withLogin_remember_days(login_remember_days)

fn spec.config.security.withSecret_key

withSecret_key(secret_key)

fn spec.config.security.withStrict_transport_security

withStrict_transport_security(strict_transport_security)

fn spec.config.security.withStrict_transport_security_max_age_seconds

withStrict_transport_security_max_age_seconds(strict_transport_security_max_age_seconds)

fn spec.config.security.withStrict_transport_security_preload

withStrict_transport_security_preload(strict_transport_security_preload)

fn spec.config.security.withStrict_transport_security_subdomains

withStrict_transport_security_subdomains(strict_transport_security_subdomains)

fn spec.config.security.withX_content_type_options

withX_content_type_options(x_content_type_options)

fn spec.config.security.withX_xss_protection

withX_xss_protection(x_xss_protection)

obj spec.config.server

fn spec.config.server.withCert_file

withCert_file(cert_file)

fn spec.config.server.withCert_key

withCert_key(cert_key)

fn spec.config.server.withDomain

withDomain(domain)

fn spec.config.server.withEnable_gzip

withEnable_gzip(enable_gzip)

fn spec.config.server.withEnforce_domain

withEnforce_domain(enforce_domain)

fn spec.config.server.withHttp_addr

withHttp_addr(http_addr)

fn spec.config.server.withHttp_port

withHttp_port(http_port)

fn spec.config.server.withProtocol

withProtocol(protocol)

fn spec.config.server.withRoot_url

withRoot_url(root_url)

fn spec.config.server.withRouter_logging

withRouter_logging(router_logging)

fn spec.config.server.withServe_from_sub_path

withServe_from_sub_path(serve_from_sub_path)

fn spec.config.server.withSocket

withSocket(socket)

fn spec.config.server.withStatic_root_path

withStatic_root_path(static_root_path)

obj spec.config.smtp

fn spec.config.smtp.withCert_file

withCert_file(cert_file)

fn spec.config.smtp.withEhlo_identity

withEhlo_identity(ehlo_identity)

fn spec.config.smtp.withEnabled

withEnabled(enabled)

fn spec.config.smtp.withFrom_address

withFrom_address(from_address)

fn spec.config.smtp.withFrom_name

withFrom_name(from_name)

fn spec.config.smtp.withHost

withHost(host)

fn spec.config.smtp.withKey_file

withKey_file(key_file)

fn spec.config.smtp.withPassword

withPassword(password)

fn spec.config.smtp.withSkip_verify

withSkip_verify(skip_verify)

fn spec.config.smtp.withUser

withUser(user)

obj spec.config.snapshots

fn spec.config.snapshots.withExternal_enabled

withExternal_enabled(external_enabled)

fn spec.config.snapshots.withExternal_snapshot_name

withExternal_snapshot_name(external_snapshot_name)

fn spec.config.snapshots.withExternal_snapshot_url

withExternal_snapshot_url(external_snapshot_url)

fn spec.config.snapshots.withSnapshot_remove_expired

withSnapshot_remove_expired(snapshot_remove_expired)

obj spec.config.unified_alerting

fn spec.config.unified_alerting.withEnabled

withEnabled(enabled)

fn spec.config.unified_alerting.withEvaluation_timeout

withEvaluation_timeout(evaluation_timeout)

fn spec.config.unified_alerting.withExecute_alerts

withExecute_alerts(execute_alerts)

fn spec.config.unified_alerting.withMax_attempts

withMax_attempts(max_attempts)

fn spec.config.unified_alerting.withMin_interval

withMin_interval(min_interval)

obj spec.config.users

fn spec.config.users.withAllow_org_create

withAllow_org_create(allow_org_create)

fn spec.config.users.withAllow_sign_up

withAllow_sign_up(allow_sign_up)

fn spec.config.users.withAuto_assign_org

withAuto_assign_org(auto_assign_org)

fn spec.config.users.withAuto_assign_org_id

withAuto_assign_org_id(auto_assign_org_id)

fn spec.config.users.withAuto_assign_org_role

withAuto_assign_org_role(auto_assign_org_role)

fn spec.config.users.withDefault_theme

withDefault_theme(default_theme)

fn spec.config.users.withEditors_can_admin

withEditors_can_admin(editors_can_admin)

fn spec.config.users.withLogin_hint

withLogin_hint(login_hint)

fn spec.config.users.withPassword_hint

withPassword_hint(password_hint)

fn spec.config.users.withViewers_can_edit

withViewers_can_edit(viewers_can_edit)

obj spec.containers

fn spec.containers.withArgs

withArgs(args)

"Arguments to the entrypoint. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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.containers.withArgsMixin

withArgsMixin(args)

"Arguments to the entrypoint. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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.containers.withCommand

withCommand(command)

"Entrypoint array. Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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.containers.withCommandMixin

withCommandMixin(command)

"Entrypoint array. Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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.containers.withEnv

withEnv(env)

"List of environment variables to set in the container. Cannot be updated."

fn spec.containers.withEnvFrom

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.containers.withEnvFromMixin

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.containers.withEnvMixin

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.containers.withImage

withImage(image)

"Docker 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.containers.withImagePullPolicy

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.containers.withName

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.containers.withPorts

withPorts(ports)

"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. Cannot be updated."

fn spec.containers.withPortsMixin

withPortsMixin(ports)

"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. Cannot be updated."

Note: This function appends passed data to existing values

fn spec.containers.withStdin

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.containers.withStdinOnce

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.containers.withTerminationMessagePath

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.containers.withTerminationMessagePolicy

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.containers.withTty

withTty(tty)

"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false."

fn spec.containers.withVolumeDevices

withVolumeDevices(volumeDevices)

"volumeDevices is the list of block devices to be used by the container."

fn spec.containers.withVolumeDevicesMixin

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.containers.withVolumeMounts

withVolumeMounts(volumeMounts)

"Pod volumes to mount into the container's filesystem. Cannot be updated."

fn spec.containers.withVolumeMountsMixin

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.containers.withWorkingDir

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.containers.env

"List of environment variables to set in the container. Cannot be updated."

fn spec.containers.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.containers.env.withValue

withValue(value)

"Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\"."

obj spec.containers.env.valueFrom

"Source for the environment variable's value. Cannot be used if value is not empty."

obj spec.containers.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.containers.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.containers.env.valueFrom.configMapKeyRef.withName

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.containers.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.containers.env.valueFrom.fieldRef

"Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."

fn spec.containers.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.containers.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.containers.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.containers.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.containers.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.containers.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.containers.env.valueFrom.secretKeyRef

"Selects a key of a secret in the pod's namespace"

fn spec.containers.env.valueFrom.secretKeyRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.containers.env.valueFrom.secretKeyRef.withName

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.containers.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.containers.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.containers.envFrom.withPrefix

withPrefix(prefix)

"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."

obj spec.containers.envFrom.configMapRef

"The ConfigMap to select from"

fn spec.containers.envFrom.configMapRef.withName

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.containers.envFrom.configMapRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap must be defined"

obj spec.containers.envFrom.secretRef

"The Secret to select from"

fn spec.containers.envFrom.secretRef.withName

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.containers.envFrom.secretRef.withOptional

withOptional(optional)

"Specify whether the Secret must be defined"

obj spec.containers.lifecycle

"Actions that the management system should take in response to container lifecycle events. Cannot be updated."

obj spec.containers.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.containers.lifecycle.postStart.exec

"One and only one of the following should be specified. Exec specifies the action to take."

fn spec.containers.lifecycle.postStart.exec.withCommand

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.containers.lifecycle.postStart.exec.withCommandMixin

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.containers.lifecycle.postStart.httpGet

"HTTPGet specifies the http request to perform."

fn spec.containers.lifecycle.postStart.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.containers.lifecycle.postStart.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.lifecycle.postStart.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.containers.lifecycle.postStart.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.containers.lifecycle.postStart.httpGet.withPort

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.containers.lifecycle.postStart.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.containers.lifecycle.postStart.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.lifecycle.postStart.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.containers.lifecycle.postStart.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.containers.lifecycle.postStart.tcpSocket

"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook"

fn spec.containers.lifecycle.postStart.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.containers.lifecycle.postStart.tcpSocket.withPort

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.containers.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 reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. 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.containers.lifecycle.preStop.exec

"One and only one of the following should be specified. Exec specifies the action to take."

fn spec.containers.lifecycle.preStop.exec.withCommand

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.containers.lifecycle.preStop.exec.withCommandMixin

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.containers.lifecycle.preStop.httpGet

"HTTPGet specifies the http request to perform."

fn spec.containers.lifecycle.preStop.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.containers.lifecycle.preStop.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.lifecycle.preStop.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.containers.lifecycle.preStop.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.containers.lifecycle.preStop.httpGet.withPort

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.containers.lifecycle.preStop.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.containers.lifecycle.preStop.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.lifecycle.preStop.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.containers.lifecycle.preStop.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.containers.lifecycle.preStop.tcpSocket

"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook"

fn spec.containers.lifecycle.preStop.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.containers.lifecycle.preStop.tcpSocket.withPort

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.containers.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.containers.livenessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn spec.containers.livenessProbe.withInitialDelaySeconds

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.containers.livenessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn spec.containers.livenessProbe.withSuccessThreshold

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.containers.livenessProbe.withTimeoutSeconds

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.containers.livenessProbe.exec

"One and only one of the following should be specified. Exec specifies the action to take."

fn spec.containers.livenessProbe.exec.withCommand

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.containers.livenessProbe.exec.withCommandMixin

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.containers.livenessProbe.httpGet

"HTTPGet specifies the http request to perform."

fn spec.containers.livenessProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.containers.livenessProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.livenessProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.containers.livenessProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.containers.livenessProbe.httpGet.withPort

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.containers.livenessProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.containers.livenessProbe.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.livenessProbe.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.containers.livenessProbe.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.containers.livenessProbe.tcpSocket

"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook"

fn spec.containers.livenessProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.containers.livenessProbe.tcpSocket.withPort

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.containers.ports

"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. Cannot be updated."

fn spec.containers.ports.withContainerPort

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.containers.ports.withHostIP

withHostIP(hostIP)

"What host IP to bind the external port to."

fn spec.containers.ports.withHostPort

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.containers.ports.withName

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.containers.ports.withProtocol

withProtocol(protocol)

"Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\"."

obj spec.containers.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.containers.readinessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn spec.containers.readinessProbe.withInitialDelaySeconds

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.containers.readinessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn spec.containers.readinessProbe.withSuccessThreshold

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.containers.readinessProbe.withTimeoutSeconds

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.containers.readinessProbe.exec

"One and only one of the following should be specified. Exec specifies the action to take."

fn spec.containers.readinessProbe.exec.withCommand

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.containers.readinessProbe.exec.withCommandMixin

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.containers.readinessProbe.httpGet

"HTTPGet specifies the http request to perform."

fn spec.containers.readinessProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.containers.readinessProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.readinessProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.containers.readinessProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.containers.readinessProbe.httpGet.withPort

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.containers.readinessProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.containers.readinessProbe.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.readinessProbe.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.containers.readinessProbe.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.containers.readinessProbe.tcpSocket

"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook"

fn spec.containers.readinessProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.containers.readinessProbe.tcpSocket.withPort

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.containers.resources

"Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn spec.containers.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn spec.containers.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

Note: This function appends passed data to existing values

fn spec.containers.resources.withRequests

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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn spec.containers.resources.withRequestsMixin

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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

Note: This function appends passed data to existing values

obj spec.containers.securityContext

"Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"

fn spec.containers.securityContext.withAllowPrivilegeEscalation

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"

fn spec.containers.securityContext.withPrivileged

withPrivileged(privileged)

"Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false."

fn spec.containers.securityContext.withProcMount

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."

fn spec.containers.securityContext.withReadOnlyRootFilesystem

withReadOnlyRootFilesystem(readOnlyRootFilesystem)

"Whether this container has a read-only root filesystem. Default is false."

fn spec.containers.securityContext.withRunAsGroup

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."

fn spec.containers.securityContext.withRunAsNonRoot

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.containers.securityContext.withRunAsUser

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."

obj spec.containers.securityContext.capabilities

"The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime."

fn spec.containers.securityContext.capabilities.withAdd

withAdd(add)

"Added capabilities"

fn spec.containers.securityContext.capabilities.withAddMixin

withAddMixin(add)

"Added capabilities"

Note: This function appends passed data to existing values

fn spec.containers.securityContext.capabilities.withDrop

withDrop(drop)

"Removed capabilities"

fn spec.containers.securityContext.capabilities.withDropMixin

withDropMixin(drop)

"Removed capabilities"

Note: This function appends passed data to existing values

obj spec.containers.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."

fn spec.containers.securityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn spec.containers.securityContext.seLinuxOptions.withRole

withRole(role)

"Role is a SELinux role label that applies to the container."

fn spec.containers.securityContext.seLinuxOptions.withType

withType(type)

"Type is a SELinux type label that applies to the container."

fn spec.containers.securityContext.seLinuxOptions.withUser

withUser(user)

"User is a SELinux user label that applies to the container."

obj spec.containers.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."

fn spec.containers.securityContext.seccompProfile.withLocalhostProfile

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 only be set if type is \"Localhost\"."

fn spec.containers.securityContext.seccompProfile.withType

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.containers.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."

fn spec.containers.securityContext.windowsOptions.withGmsaCredentialSpec

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.containers.securityContext.windowsOptions.withGmsaCredentialSpecName

withGmsaCredentialSpecName(gmsaCredentialSpecName)

"GMSACredentialSpecName is the name of the GMSA credential spec to use."

fn spec.containers.securityContext.windowsOptions.withRunAsUserName

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.containers.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.containers.startupProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn spec.containers.startupProbe.withInitialDelaySeconds

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.containers.startupProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn spec.containers.startupProbe.withSuccessThreshold

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.containers.startupProbe.withTimeoutSeconds

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.containers.startupProbe.exec

"One and only one of the following should be specified. Exec specifies the action to take."

fn spec.containers.startupProbe.exec.withCommand

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.containers.startupProbe.exec.withCommandMixin

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.containers.startupProbe.httpGet

"HTTPGet specifies the http request to perform."

fn spec.containers.startupProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.containers.startupProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.startupProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.containers.startupProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.containers.startupProbe.httpGet.withPort

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.containers.startupProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.containers.startupProbe.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.containers.startupProbe.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.containers.startupProbe.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.containers.startupProbe.tcpSocket

"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook"

fn spec.containers.startupProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.containers.startupProbe.tcpSocket.withPort

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.containers.volumeDevices

"volumeDevices is the list of block devices to be used by the container."

fn spec.containers.volumeDevices.withDevicePath

withDevicePath(devicePath)

"devicePath is the path inside of the container that the device will be mapped to."

fn spec.containers.volumeDevices.withName

withName(name)

"name must match the name of a persistentVolumeClaim in the pod"

obj spec.containers.volumeMounts

"Pod volumes to mount into the container's filesystem. Cannot be updated."

fn spec.containers.volumeMounts.withMountPath

withMountPath(mountPath)

"Path within the container at which the volume should be mounted. Must not contain ':'."

fn spec.containers.volumeMounts.withMountPropagation

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.containers.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.containers.volumeMounts.withReadOnly

withReadOnly(readOnly)

"Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false."

fn spec.containers.volumeMounts.withSubPath

withSubPath(subPath)

"Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)."

fn spec.containers.volumeMounts.withSubPathExpr

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.dashboardLabelSelector

fn spec.dashboardLabelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.dashboardLabelSelector.withMatchExpressionsMixin

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.dashboardLabelSelector.withMatchLabels

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.dashboardLabelSelector.withMatchLabelsMixin

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.dashboardLabelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.dashboardLabelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.dashboardLabelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.dashboardLabelSelector.matchExpressions.withValues

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.dashboardLabelSelector.matchExpressions.withValuesMixin

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.dashboardNamespaceSelector

"A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects."

fn spec.dashboardNamespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.dashboardNamespaceSelector.withMatchExpressionsMixin

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.dashboardNamespaceSelector.withMatchLabels

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.dashboardNamespaceSelector.withMatchLabelsMixin

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.dashboardNamespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.dashboardNamespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.dashboardNamespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.dashboardNamespaceSelector.matchExpressions.withValues

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.dashboardNamespaceSelector.matchExpressions.withValuesMixin

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.dataStorage

"GrafanaDataStorage provides a means to configure the grafana data storage"

fn spec.dataStorage.withAccessModes

withAccessModes(accessModes)

fn spec.dataStorage.withAccessModesMixin

withAccessModesMixin(accessModes)

Note: This function appends passed data to existing values

fn spec.dataStorage.withAnnotations

withAnnotations(annotations)

fn spec.dataStorage.withAnnotationsMixin

withAnnotationsMixin(annotations)

Note: This function appends passed data to existing values

fn spec.dataStorage.withClass

withClass(class)

fn spec.dataStorage.withLabels

withLabels(labels)

fn spec.dataStorage.withLabelsMixin

withLabelsMixin(labels)

Note: This function appends passed data to existing values

fn spec.dataStorage.withSize

withSize(size)

obj spec.deployment

"GrafanaDeployment provides a means to configure the deployment"

fn spec.deployment.withAnnotations

withAnnotations(annotations)

fn spec.deployment.withAnnotationsMixin

withAnnotationsMixin(annotations)

Note: This function appends passed data to existing values

fn spec.deployment.withEnv

withEnv(env)

fn spec.deployment.withEnvFrom

withEnvFrom(envFrom)

fn spec.deployment.withEnvFromMixin

withEnvFromMixin(envFrom)

Note: This function appends passed data to existing values

fn spec.deployment.withEnvMixin

withEnvMixin(env)

Note: This function appends passed data to existing values

fn spec.deployment.withExtraVolumeMounts

withExtraVolumeMounts(extraVolumeMounts)

fn spec.deployment.withExtraVolumeMountsMixin

withExtraVolumeMountsMixin(extraVolumeMounts)

Note: This function appends passed data to existing values

fn spec.deployment.withExtraVolumes

withExtraVolumes(extraVolumes)

fn spec.deployment.withExtraVolumesMixin

withExtraVolumesMixin(extraVolumes)

Note: This function appends passed data to existing values

fn spec.deployment.withHostNetwork

withHostNetwork(hostNetwork)

fn spec.deployment.withLabels

withLabels(labels)

fn spec.deployment.withLabelsMixin

withLabelsMixin(labels)

Note: This function appends passed data to existing values

fn spec.deployment.withNodeSelector

withNodeSelector(nodeSelector)

fn spec.deployment.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

Note: This function appends passed data to existing values

fn spec.deployment.withPriorityClassName

withPriorityClassName(priorityClassName)

fn spec.deployment.withReplicas

withReplicas(replicas)

fn spec.deployment.withSkipCreateAdminAccount

withSkipCreateAdminAccount(skipCreateAdminAccount)

fn spec.deployment.withTerminationGracePeriodSeconds

withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)

fn spec.deployment.withTolerations

withTolerations(tolerations)

fn spec.deployment.withTolerationsMixin

withTolerationsMixin(tolerations)

Note: This function appends passed data to existing values

obj spec.deployment.affinity

"Affinity is a group of affinity scheduling rules."

obj spec.deployment.affinity.nodeAffinity

"Describes node affinity scheduling rules for the pod."

fn spec.deployment.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

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.deployment.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

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.deployment.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.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100."

obj spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference

"A node selector term, associated with the corresponding weight."

fn spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressions

withMatchExpressions(matchExpressions)

"A list of node selector requirements by node's labels."

fn spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"A list of node selector requirements by node's labels."

Note: This function appends passed data to existing values

fn spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFields

withMatchFields(matchFields)

"A list of node selector requirements by node's fields."

fn spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

"A list of node selector requirements by node's fields."

Note: This function appends passed data to existing values

obj spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions

"A list of node selector requirements by node's labels."

fn spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues

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.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin

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.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields

"A list of node selector requirements by node's fields."

fn spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues

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.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin

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.deployment.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.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms

withNodeSelectorTerms(nodeSelectorTerms)

"Required. A list of node selector terms. The terms are ORed."

fn spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin

withNodeSelectorTermsMixin(nodeSelectorTerms)

"Required. A list of node selector terms. The terms are ORed."

Note: This function appends passed data to existing values

obj spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

"Required. A list of node selector terms. The terms are ORed."

fn spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressions

withMatchExpressions(matchExpressions)

"A list of node selector requirements by node's labels."

fn spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"A list of node selector requirements by node's labels."

Note: This function appends passed data to existing values

fn spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFields

withMatchFields(matchFields)

"A list of node selector requirements by node's fields."

fn spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

"A list of node selector requirements by node's fields."

Note: This function appends passed data to existing values

obj spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions

"A list of node selector requirements by node's labels."

fn spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues

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.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin

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.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields

"A list of node selector requirements by node's fields."

fn spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues

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.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin

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.deployment.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.deployment.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

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.deployment.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

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.deployment.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

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.deployment.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

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.deployment.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.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"weight associated with matching the corresponding podAffinityTerm, in the range 1-100."

obj spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

"Required. A pod affinity term, associated with the corresponding weight."

fn spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces

withNamespaces(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

fn spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

Note: This function appends passed data to existing values

fn spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

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.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

"A label query over a set of resources, in this case pods."

fn spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

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.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

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.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

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.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

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.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

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.deployment.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.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces

withNamespaces(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

fn spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

Note: This function appends passed data to existing values

fn spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

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.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

"A label query over a set of resources, in this case pods."

fn spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

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.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

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.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

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.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

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.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

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.deployment.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.deployment.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

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.deployment.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

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.deployment.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

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.deployment.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

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.deployment.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.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"weight associated with matching the corresponding podAffinityTerm, in the range 1-100."

obj spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

"Required. A pod affinity term, associated with the corresponding weight."

fn spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces

withNamespaces(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

fn spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

Note: This function appends passed data to existing values

fn spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

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.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

"A label query over a set of resources, in this case pods."

fn spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

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.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

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.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

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.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

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.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

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.deployment.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.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces

withNamespaces(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

fn spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\

Note: This function appends passed data to existing values

fn spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

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.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

"A label query over a set of resources, in this case pods."

fn spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

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.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

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.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

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.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

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.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

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.deployment.containerSecurityContext

"SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence."

fn spec.deployment.containerSecurityContext.withAllowPrivilegeEscalation

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"

fn spec.deployment.containerSecurityContext.withPrivileged

withPrivileged(privileged)

"Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false."

fn spec.deployment.containerSecurityContext.withProcMount

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."

fn spec.deployment.containerSecurityContext.withReadOnlyRootFilesystem

withReadOnlyRootFilesystem(readOnlyRootFilesystem)

"Whether this container has a read-only root filesystem. Default is false."

fn spec.deployment.containerSecurityContext.withRunAsGroup

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."

fn spec.deployment.containerSecurityContext.withRunAsNonRoot

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.deployment.containerSecurityContext.withRunAsUser

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."

obj spec.deployment.containerSecurityContext.capabilities

"The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime."

fn spec.deployment.containerSecurityContext.capabilities.withAdd

withAdd(add)

"Added capabilities"

fn spec.deployment.containerSecurityContext.capabilities.withAddMixin

withAddMixin(add)

"Added capabilities"

Note: This function appends passed data to existing values

fn spec.deployment.containerSecurityContext.capabilities.withDrop

withDrop(drop)

"Removed capabilities"

fn spec.deployment.containerSecurityContext.capabilities.withDropMixin

withDropMixin(drop)

"Removed capabilities"

Note: This function appends passed data to existing values

obj spec.deployment.containerSecurityContext.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."

fn spec.deployment.containerSecurityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn spec.deployment.containerSecurityContext.seLinuxOptions.withRole

withRole(role)

"Role is a SELinux role label that applies to the container."

fn spec.deployment.containerSecurityContext.seLinuxOptions.withType

withType(type)

"Type is a SELinux type label that applies to the container."

fn spec.deployment.containerSecurityContext.seLinuxOptions.withUser

withUser(user)

"User is a SELinux user label that applies to the container."

obj spec.deployment.containerSecurityContext.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."

fn spec.deployment.containerSecurityContext.seccompProfile.withLocalhostProfile

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 only be set if type is \"Localhost\"."

fn spec.deployment.containerSecurityContext.seccompProfile.withType

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.deployment.containerSecurityContext.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."

fn spec.deployment.containerSecurityContext.windowsOptions.withGmsaCredentialSpec

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.deployment.containerSecurityContext.windowsOptions.withGmsaCredentialSpecName

withGmsaCredentialSpecName(gmsaCredentialSpecName)

"GMSACredentialSpecName is the name of the GMSA credential spec to use."

fn spec.deployment.containerSecurityContext.windowsOptions.withRunAsUserName

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.deployment.env

fn spec.deployment.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.deployment.env.withValue

withValue(value)

"Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\"."

obj spec.deployment.env.valueFrom

"Source for the environment variable's value. Cannot be used if value is not empty."

obj spec.deployment.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.deployment.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.deployment.env.valueFrom.configMapKeyRef.withName

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.deployment.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.deployment.env.valueFrom.fieldRef

"Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."

fn spec.deployment.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.deployment.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.deployment.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.deployment.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.deployment.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.deployment.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.deployment.env.valueFrom.secretKeyRef

"Selects a key of a secret in the pod's namespace"

fn spec.deployment.env.valueFrom.secretKeyRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.deployment.env.valueFrom.secretKeyRef.withName

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.deployment.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.deployment.envFrom

fn spec.deployment.envFrom.withPrefix

withPrefix(prefix)

"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."

obj spec.deployment.envFrom.configMapRef

"The ConfigMap to select from"

fn spec.deployment.envFrom.configMapRef.withName

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.deployment.envFrom.configMapRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap must be defined"

obj spec.deployment.envFrom.secretRef

"The Secret to select from"

fn spec.deployment.envFrom.secretRef.withName

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.deployment.envFrom.secretRef.withOptional

withOptional(optional)

"Specify whether the Secret must be defined"

obj spec.deployment.extraVolumeMounts

fn spec.deployment.extraVolumeMounts.withMountPath

withMountPath(mountPath)

"Path within the container at which the volume should be mounted. Must not contain ':'."

fn spec.deployment.extraVolumeMounts.withMountPropagation

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.deployment.extraVolumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.deployment.extraVolumeMounts.withReadOnly

withReadOnly(readOnly)

"Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false."

fn spec.deployment.extraVolumeMounts.withSubPath

withSubPath(subPath)

"Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)."

fn spec.deployment.extraVolumeMounts.withSubPathExpr

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.deployment.extraVolumes

fn spec.deployment.extraVolumes.withName

withName(name)

"Volume's name. 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.deployment.extraVolumes.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.deployment.extraVolumes.awsElasticBlockStore.withFsType

withFsType(fsType)

"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.deployment.extraVolumes.awsElasticBlockStore.withPartition

withPartition(partition)

"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.deployment.extraVolumes.awsElasticBlockStore.withReadOnly

withReadOnly(readOnly)

"Specify \"true\" to force and set the ReadOnly property in VolumeMounts to \"true\". If omitted, the default is \"false\". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"

fn spec.deployment.extraVolumes.awsElasticBlockStore.withVolumeID

withVolumeID(volumeID)

"Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"

obj spec.deployment.extraVolumes.azureDisk

"AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod."

fn spec.deployment.extraVolumes.azureDisk.withCachingMode

withCachingMode(cachingMode)

"Host Caching mode: None, Read Only, Read Write."

fn spec.deployment.extraVolumes.azureDisk.withDiskName

withDiskName(diskName)

"The Name of the data disk in the blob storage"

fn spec.deployment.extraVolumes.azureDisk.withDiskURI

withDiskURI(diskURI)

"The URI the data disk in the blob storage"

fn spec.deployment.extraVolumes.azureDisk.withFsType

withFsType(fsType)

"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.deployment.extraVolumes.azureDisk.withKind

withKind(kind)

"Expected values 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.deployment.extraVolumes.azureDisk.withReadOnly

withReadOnly(readOnly)

"Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

obj spec.deployment.extraVolumes.azureFile

"AzureFile represents an Azure File Service mount on the host and bind mount to the pod."

fn spec.deployment.extraVolumes.azureFile.withReadOnly

withReadOnly(readOnly)

"Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.deployment.extraVolumes.azureFile.withSecretName

withSecretName(secretName)

"the name of secret that contains Azure Storage Account Name and Key"

fn spec.deployment.extraVolumes.azureFile.withShareName

withShareName(shareName)

"Share Name"

obj spec.deployment.extraVolumes.cephfs

"CephFS represents a Ceph FS mount on the host that shares a pod's lifetime"

fn spec.deployment.extraVolumes.cephfs.withMonitors

withMonitors(monitors)

"Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.deployment.extraVolumes.cephfs.withMonitorsMixin

withMonitorsMixin(monitors)

"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.deployment.extraVolumes.cephfs.withPath

withPath(path)

"Optional: Used as the mounted root, rather than the full Ceph tree, default is /"

fn spec.deployment.extraVolumes.cephfs.withReadOnly

withReadOnly(readOnly)

"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.deployment.extraVolumes.cephfs.withSecretFile

withSecretFile(secretFile)

"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.deployment.extraVolumes.cephfs.withUser

withUser(user)

"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.deployment.extraVolumes.cephfs.secretRef

"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.deployment.extraVolumes.cephfs.secretRef.withName

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.deployment.extraVolumes.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.deployment.extraVolumes.cinder.withFsType

withFsType(fsType)

"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.deployment.extraVolumes.cinder.withReadOnly

withReadOnly(readOnly)

"Optional: 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.deployment.extraVolumes.cinder.withVolumeID

withVolumeID(volumeID)

"volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

obj spec.deployment.extraVolumes.cinder.secretRef

"Optional: points to a secret object containing parameters used to connect to OpenStack."

fn spec.deployment.extraVolumes.cinder.secretRef.withName

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.deployment.extraVolumes.configMap

"ConfigMap represents a configMap that should populate this volume"

fn spec.deployment.extraVolumes.configMap.withDefaultMode

withDefaultMode(defaultMode)

"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.deployment.extraVolumes.configMap.withItems

withItems(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.deployment.extraVolumes.configMap.withItemsMixin

withItemsMixin(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.deployment.extraVolumes.configMap.withName

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.deployment.extraVolumes.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its keys must be defined"

obj spec.deployment.extraVolumes.configMap.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.deployment.extraVolumes.configMap.items.withKey

withKey(key)

"The key to project."

fn spec.deployment.extraVolumes.configMap.items.withMode

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.deployment.extraVolumes.configMap.items.withPath

withPath(path)

"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.deployment.extraVolumes.csi

"CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature)."

fn spec.deployment.extraVolumes.csi.withDriver

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.deployment.extraVolumes.csi.withFsType

withFsType(fsType)

"Filesystem type 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.deployment.extraVolumes.csi.withReadOnly

withReadOnly(readOnly)

"Specifies a read-only configuration for the volume. Defaults to false (read/write)."

fn spec.deployment.extraVolumes.csi.withVolumeAttributes

withVolumeAttributes(volumeAttributes)

"VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values."

fn spec.deployment.extraVolumes.csi.withVolumeAttributesMixin

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.deployment.extraVolumes.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.deployment.extraVolumes.csi.nodePublishSecretRef.withName

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.deployment.extraVolumes.downwardAPI

"DownwardAPI represents downward API about the pod that should populate this volume"

fn spec.deployment.extraVolumes.downwardAPI.withDefaultMode

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.deployment.extraVolumes.downwardAPI.withItems

withItems(items)

"Items is a list of downward API volume file"

fn spec.deployment.extraVolumes.downwardAPI.withItemsMixin

withItemsMixin(items)

"Items is a list of downward API volume file"

Note: This function appends passed data to existing values

obj spec.deployment.extraVolumes.downwardAPI.items

"Items is a list of downward API volume file"

fn spec.deployment.extraVolumes.downwardAPI.items.withMode

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.deployment.extraVolumes.downwardAPI.items.withPath

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.deployment.extraVolumes.downwardAPI.items.fieldRef

"Required: Selects a field of the pod: only annotations, labels, name and namespace are supported."

fn spec.deployment.extraVolumes.downwardAPI.items.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.deployment.extraVolumes.downwardAPI.items.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.deployment.extraVolumes.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.deployment.extraVolumes.downwardAPI.items.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.deployment.extraVolumes.downwardAPI.items.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.deployment.extraVolumes.downwardAPI.items.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.deployment.extraVolumes.emptyDir

"EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"

fn spec.deployment.extraVolumes.emptyDir.withMedium

withMedium(medium)

"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.deployment.extraVolumes.emptyDir.withSizeLimit

withSizeLimit(sizeLimit)

"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: http://kubernetes.io/docs/user-guide/volumes#emptydir"

obj spec.deployment.extraVolumes.ephemeral

"Ephemeral represents a volume that is handled by a cluster storage driver (Alpha feature). 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."

fn spec.deployment.extraVolumes.ephemeral.withReadOnly

withReadOnly(readOnly)

"Specifies a read-only configuration for the volume. Defaults to false (read/write)."

obj spec.deployment.extraVolumes.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 <pod name>-<volume name> where <volume name> 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.deployment.extraVolumes.ephemeral.volumeClaimTemplate.withMetadata

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.deployment.extraVolumes.ephemeral.volumeClaimTemplate.withMetadataMixin

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.deployment.extraVolumes.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.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.withAccessModes

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.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.withAccessModesMixin

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.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.withStorageClassName

withStorageClassName(storageClassName)

"Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"

fn spec.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.withVolumeMode

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.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.withVolumeName

withVolumeName(volumeName)

"VolumeName is the binding reference to the PersistentVolume backing this claim."

obj spec.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.dataSource

"This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. 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."

fn spec.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.dataSource.withApiGroup

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.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.dataSource.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn spec.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.dataSource.withName

withName(name)

"Name is the name of resource being referenced"

obj spec.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.resources

"Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"

fn spec.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn spec.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

Note: This function appends passed data to existing values

fn spec.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.resources.withRequests

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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn spec.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.resources.withRequestsMixin

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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

Note: This function appends passed data to existing values

obj spec.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.selector

"A label query over volumes to consider for binding."

fn spec.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin

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.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabels

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.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabelsMixin

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.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValues

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.deployment.extraVolumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin

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.deployment.extraVolumes.fc

"FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod."

fn spec.deployment.extraVolumes.fc.withFsType

withFsType(fsType)

"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.deployment.extraVolumes.fc.withLun

withLun(lun)

"Optional: FC target lun number"

fn spec.deployment.extraVolumes.fc.withReadOnly

withReadOnly(readOnly)

"Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.deployment.extraVolumes.fc.withTargetWWNs

withTargetWWNs(targetWWNs)

"Optional: FC target worldwide names (WWNs)"

fn spec.deployment.extraVolumes.fc.withTargetWWNsMixin

withTargetWWNsMixin(targetWWNs)

"Optional: FC target worldwide names (WWNs)"

Note: This function appends passed data to existing values

fn spec.deployment.extraVolumes.fc.withWwids

withWwids(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.deployment.extraVolumes.fc.withWwidsMixin

withWwidsMixin(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.deployment.extraVolumes.flexVolume

"FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin."

fn spec.deployment.extraVolumes.flexVolume.withDriver

withDriver(driver)

"Driver is the name of the driver to use for this volume."

fn spec.deployment.extraVolumes.flexVolume.withFsType

withFsType(fsType)

"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.deployment.extraVolumes.flexVolume.withOptions

withOptions(options)

"Optional: Extra command options if any."

fn spec.deployment.extraVolumes.flexVolume.withOptionsMixin

withOptionsMixin(options)

"Optional: Extra command options if any."

Note: This function appends passed data to existing values

fn spec.deployment.extraVolumes.flexVolume.withReadOnly

withReadOnly(readOnly)

"Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

obj spec.deployment.extraVolumes.flexVolume.secretRef

"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.deployment.extraVolumes.flexVolume.secretRef.withName

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.deployment.extraVolumes.flocker

"Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running"

fn spec.deployment.extraVolumes.flocker.withDatasetName

withDatasetName(datasetName)

"Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated"

fn spec.deployment.extraVolumes.flocker.withDatasetUUID

withDatasetUUID(datasetUUID)

"UUID of the dataset. This is unique identifier of a Flocker dataset"

obj spec.deployment.extraVolumes.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.deployment.extraVolumes.gcePersistentDisk.withFsType

withFsType(fsType)

"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.deployment.extraVolumes.gcePersistentDisk.withPartition

withPartition(partition)

"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.deployment.extraVolumes.gcePersistentDisk.withPdName

withPdName(pdName)

"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.deployment.extraVolumes.gcePersistentDisk.withReadOnly

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.deployment.extraVolumes.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.deployment.extraVolumes.gitRepo.withDirectory

withDirectory(directory)

"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.deployment.extraVolumes.gitRepo.withRepository

withRepository(repository)

"Repository URL"

fn spec.deployment.extraVolumes.gitRepo.withRevision

withRevision(revision)

"Commit hash for the specified revision."

obj spec.deployment.extraVolumes.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.deployment.extraVolumes.glusterfs.withEndpoints

withEndpoints(endpoints)

"EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"

fn spec.deployment.extraVolumes.glusterfs.withPath

withPath(path)

"Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"

fn spec.deployment.extraVolumes.glusterfs.withReadOnly

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.deployment.extraVolumes.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.deployment.extraVolumes.hostPath.withPath

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.deployment.extraVolumes.hostPath.withType

withType(type)

"Type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"

obj spec.deployment.extraVolumes.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.deployment.extraVolumes.iscsi.withChapAuthDiscovery

withChapAuthDiscovery(chapAuthDiscovery)

"whether support iSCSI Discovery CHAP authentication"

fn spec.deployment.extraVolumes.iscsi.withChapAuthSession

withChapAuthSession(chapAuthSession)

"whether support iSCSI Session CHAP authentication"

fn spec.deployment.extraVolumes.iscsi.withFsType

withFsType(fsType)

"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.deployment.extraVolumes.iscsi.withInitiatorName

withInitiatorName(initiatorName)

"Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection."

fn spec.deployment.extraVolumes.iscsi.withIqn

withIqn(iqn)

"Target iSCSI Qualified Name."

fn spec.deployment.extraVolumes.iscsi.withIscsiInterface

withIscsiInterface(iscsiInterface)

"iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp)."

fn spec.deployment.extraVolumes.iscsi.withLun

withLun(lun)

"iSCSI Target Lun number."

fn spec.deployment.extraVolumes.iscsi.withPortals

withPortals(portals)

"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.deployment.extraVolumes.iscsi.withPortalsMixin

withPortalsMixin(portals)

"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.deployment.extraVolumes.iscsi.withReadOnly

withReadOnly(readOnly)

"ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false."

fn spec.deployment.extraVolumes.iscsi.withTargetPortal

withTargetPortal(targetPortal)

"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.deployment.extraVolumes.iscsi.secretRef

"CHAP Secret for iSCSI target and initiator authentication"

fn spec.deployment.extraVolumes.iscsi.secretRef.withName

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.deployment.extraVolumes.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.deployment.extraVolumes.nfs.withPath

withPath(path)

"Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"

fn spec.deployment.extraVolumes.nfs.withReadOnly

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.deployment.extraVolumes.nfs.withServer

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.deployment.extraVolumes.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.deployment.extraVolumes.persistentVolumeClaim.withClaimName

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.deployment.extraVolumes.persistentVolumeClaim.withReadOnly

withReadOnly(readOnly)

"Will force the ReadOnly setting in VolumeMounts. Default false."

obj spec.deployment.extraVolumes.photonPersistentDisk

"PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine"

fn spec.deployment.extraVolumes.photonPersistentDisk.withFsType

withFsType(fsType)

"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.deployment.extraVolumes.photonPersistentDisk.withPdID

withPdID(pdID)

"ID that identifies Photon Controller persistent disk"

obj spec.deployment.extraVolumes.portworxVolume

"PortworxVolume represents a portworx volume attached and mounted on kubelets host machine"

fn spec.deployment.extraVolumes.portworxVolume.withFsType

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.deployment.extraVolumes.portworxVolume.withReadOnly

withReadOnly(readOnly)

"Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.deployment.extraVolumes.portworxVolume.withVolumeID

withVolumeID(volumeID)

"VolumeID uniquely identifies a Portworx volume"

obj spec.deployment.extraVolumes.projected

"Items for all in one resources secrets, configmaps, and downward API"

fn spec.deployment.extraVolumes.projected.withDefaultMode

withDefaultMode(defaultMode)

"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.deployment.extraVolumes.projected.withSources

withSources(sources)

"list of volume projections"

fn spec.deployment.extraVolumes.projected.withSourcesMixin

withSourcesMixin(sources)

"list of volume projections"

Note: This function appends passed data to existing values

obj spec.deployment.extraVolumes.projected.sources

"list of volume projections"

obj spec.deployment.extraVolumes.projected.sources.configMap

"information about the configMap data to project"

fn spec.deployment.extraVolumes.projected.sources.configMap.withItems

withItems(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.deployment.extraVolumes.projected.sources.configMap.withItemsMixin

withItemsMixin(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.deployment.extraVolumes.projected.sources.configMap.withName

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.deployment.extraVolumes.projected.sources.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its keys must be defined"

obj spec.deployment.extraVolumes.projected.sources.configMap.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.deployment.extraVolumes.projected.sources.configMap.items.withKey

withKey(key)

"The key to project."

fn spec.deployment.extraVolumes.projected.sources.configMap.items.withMode

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.deployment.extraVolumes.projected.sources.configMap.items.withPath

withPath(path)

"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.deployment.extraVolumes.projected.sources.downwardAPI

"information about the downwardAPI data to project"

fn spec.deployment.extraVolumes.projected.sources.downwardAPI.withItems

withItems(items)

"Items is a list of DownwardAPIVolume file"

fn spec.deployment.extraVolumes.projected.sources.downwardAPI.withItemsMixin

withItemsMixin(items)

"Items is a list of DownwardAPIVolume file"

Note: This function appends passed data to existing values

obj spec.deployment.extraVolumes.projected.sources.downwardAPI.items

"Items is a list of DownwardAPIVolume file"

fn spec.deployment.extraVolumes.projected.sources.downwardAPI.items.withMode

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.deployment.extraVolumes.projected.sources.downwardAPI.items.withPath

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.deployment.extraVolumes.projected.sources.downwardAPI.items.fieldRef

"Required: Selects a field of the pod: only annotations, labels, name and namespace are supported."

fn spec.deployment.extraVolumes.projected.sources.downwardAPI.items.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.deployment.extraVolumes.projected.sources.downwardAPI.items.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.deployment.extraVolumes.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.deployment.extraVolumes.projected.sources.downwardAPI.items.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.deployment.extraVolumes.projected.sources.downwardAPI.items.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.deployment.extraVolumes.projected.sources.downwardAPI.items.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.deployment.extraVolumes.projected.sources.secret

"information about the secret data to project"

fn spec.deployment.extraVolumes.projected.sources.secret.withItems

withItems(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.deployment.extraVolumes.projected.sources.secret.withItemsMixin

withItemsMixin(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.deployment.extraVolumes.projected.sources.secret.withName

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.deployment.extraVolumes.projected.sources.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.deployment.extraVolumes.projected.sources.secret.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.deployment.extraVolumes.projected.sources.secret.items.withKey

withKey(key)

"The key to project."

fn spec.deployment.extraVolumes.projected.sources.secret.items.withMode

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.deployment.extraVolumes.projected.sources.secret.items.withPath

withPath(path)

"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.deployment.extraVolumes.projected.sources.serviceAccountToken

"information about the serviceAccountToken data to project"

fn spec.deployment.extraVolumes.projected.sources.serviceAccountToken.withAudience

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.deployment.extraVolumes.projected.sources.serviceAccountToken.withExpirationSeconds

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.deployment.extraVolumes.projected.sources.serviceAccountToken.withPath

withPath(path)

"Path is the path relative to the mount point of the file to project the token into."

obj spec.deployment.extraVolumes.quobyte

"Quobyte represents a Quobyte mount on the host that shares a pod's lifetime"

fn spec.deployment.extraVolumes.quobyte.withGroup

withGroup(group)

"Group to map volume access to Default is no group"

fn spec.deployment.extraVolumes.quobyte.withReadOnly

withReadOnly(readOnly)

"ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false."

fn spec.deployment.extraVolumes.quobyte.withRegistry

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.deployment.extraVolumes.quobyte.withTenant

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.deployment.extraVolumes.quobyte.withUser

withUser(user)

"User to map volume access to Defaults to serivceaccount user"

fn spec.deployment.extraVolumes.quobyte.withVolume

withVolume(volume)

"Volume is a string that references an already created Quobyte volume by name."

obj spec.deployment.extraVolumes.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.deployment.extraVolumes.rbd.withFsType

withFsType(fsType)

"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.deployment.extraVolumes.rbd.withImage

withImage(image)

"The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.deployment.extraVolumes.rbd.withKeyring

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.deployment.extraVolumes.rbd.withMonitors

withMonitors(monitors)

"A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.deployment.extraVolumes.rbd.withMonitorsMixin

withMonitorsMixin(monitors)

"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.deployment.extraVolumes.rbd.withPool

withPool(pool)

"The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.deployment.extraVolumes.rbd.withReadOnly

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.deployment.extraVolumes.rbd.withUser

withUser(user)

"The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

obj spec.deployment.extraVolumes.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.deployment.extraVolumes.rbd.secretRef.withName

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.deployment.extraVolumes.scaleIO

"ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes."

fn spec.deployment.extraVolumes.scaleIO.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"xfs\"."

fn spec.deployment.extraVolumes.scaleIO.withGateway

withGateway(gateway)

"The host address of the ScaleIO API Gateway."

fn spec.deployment.extraVolumes.scaleIO.withProtectionDomain

withProtectionDomain(protectionDomain)

"The name of the ScaleIO Protection Domain for the configured storage."

fn spec.deployment.extraVolumes.scaleIO.withReadOnly

withReadOnly(readOnly)

"Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.deployment.extraVolumes.scaleIO.withSslEnabled

withSslEnabled(sslEnabled)

"Flag to enable/disable SSL communication with Gateway, default false"

fn spec.deployment.extraVolumes.scaleIO.withStorageMode

withStorageMode(storageMode)

"Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned."

fn spec.deployment.extraVolumes.scaleIO.withStoragePool

withStoragePool(storagePool)

"The ScaleIO Storage Pool associated with the protection domain."

fn spec.deployment.extraVolumes.scaleIO.withSystem

withSystem(system)

"The name of the storage system as configured in ScaleIO."

fn spec.deployment.extraVolumes.scaleIO.withVolumeName

withVolumeName(volumeName)

"The name of a volume already created in the ScaleIO system that is associated with this volume source."

obj spec.deployment.extraVolumes.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.deployment.extraVolumes.scaleIO.secretRef.withName

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.deployment.extraVolumes.secret

"Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret"

fn spec.deployment.extraVolumes.secret.withDefaultMode

withDefaultMode(defaultMode)

"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.deployment.extraVolumes.secret.withItems

withItems(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.deployment.extraVolumes.secret.withItemsMixin

withItemsMixin(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.deployment.extraVolumes.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its keys must be defined"

fn spec.deployment.extraVolumes.secret.withSecretName

withSecretName(secretName)

"Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret"

obj spec.deployment.extraVolumes.secret.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.deployment.extraVolumes.secret.items.withKey

withKey(key)

"The key to project."

fn spec.deployment.extraVolumes.secret.items.withMode

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.deployment.extraVolumes.secret.items.withPath

withPath(path)

"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.deployment.extraVolumes.storageos

"StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes."

fn spec.deployment.extraVolumes.storageos.withFsType

withFsType(fsType)

"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.deployment.extraVolumes.storageos.withReadOnly

withReadOnly(readOnly)

"Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.deployment.extraVolumes.storageos.withVolumeName

withVolumeName(volumeName)

"VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace."

fn spec.deployment.extraVolumes.storageos.withVolumeNamespace

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.deployment.extraVolumes.storageos.secretRef

"SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted."

fn spec.deployment.extraVolumes.storageos.secretRef.withName

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.deployment.extraVolumes.vsphereVolume

"VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"

fn spec.deployment.extraVolumes.vsphereVolume.withFsType

withFsType(fsType)

"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.deployment.extraVolumes.vsphereVolume.withStoragePolicyID

withStoragePolicyID(storagePolicyID)

"Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName."

fn spec.deployment.extraVolumes.vsphereVolume.withStoragePolicyName

withStoragePolicyName(storagePolicyName)

"Storage Policy Based Management (SPBM) profile name."

fn spec.deployment.extraVolumes.vsphereVolume.withVolumePath

withVolumePath(volumePath)

"Path that identifies vSphere volume vmdk"

obj spec.deployment.httpProxy

"GrafanaHttpProxy provides a means to configure the Grafana deployment to use an HTTP(S) proxy when making requests and resolving plugins."

fn spec.deployment.httpProxy.withEnabled

withEnabled(enabled)

fn spec.deployment.httpProxy.withSecureUrl

withSecureUrl(secureUrl)

fn spec.deployment.httpProxy.withUrl

withUrl(url)

obj spec.deployment.securityContext

"PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext."

fn spec.deployment.securityContext.withFsGroup

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."

fn spec.deployment.securityContext.withFsGroupChangePolicy

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."

fn spec.deployment.securityContext.withRunAsGroup

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."

fn spec.deployment.securityContext.withRunAsNonRoot

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.deployment.securityContext.withRunAsUser

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."

fn spec.deployment.securityContext.withSupplementalGroups

withSupplementalGroups(supplementalGroups)

"A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container."

fn spec.deployment.securityContext.withSupplementalGroupsMixin

withSupplementalGroupsMixin(supplementalGroups)

"A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container."

Note: This function appends passed data to existing values

fn spec.deployment.securityContext.withSysctls

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."

fn spec.deployment.securityContext.withSysctlsMixin

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: This function appends passed data to existing values

obj spec.deployment.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."

fn spec.deployment.securityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn spec.deployment.securityContext.seLinuxOptions.withRole

withRole(role)

"Role is a SELinux role label that applies to the container."

fn spec.deployment.securityContext.seLinuxOptions.withType

withType(type)

"Type is a SELinux type label that applies to the container."

fn spec.deployment.securityContext.seLinuxOptions.withUser

withUser(user)

"User is a SELinux user label that applies to the container."

obj spec.deployment.securityContext.seccompProfile

"The seccomp options to use by the containers in this pod."

fn spec.deployment.securityContext.seccompProfile.withLocalhostProfile

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 only be set if type is \"Localhost\"."

fn spec.deployment.securityContext.seccompProfile.withType

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.deployment.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."

fn spec.deployment.securityContext.sysctls.withName

withName(name)

"Name of a property to set"

fn spec.deployment.securityContext.sysctls.withValue

withValue(value)

"Value of a property to set"

obj spec.deployment.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."

fn spec.deployment.securityContext.windowsOptions.withGmsaCredentialSpec

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.deployment.securityContext.windowsOptions.withGmsaCredentialSpecName

withGmsaCredentialSpecName(gmsaCredentialSpecName)

"GMSACredentialSpecName is the name of the GMSA credential spec to use."

fn spec.deployment.securityContext.windowsOptions.withRunAsUserName

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.deployment.strategy

"DeploymentStrategy describes how to replace existing pods with new ones."

fn spec.deployment.strategy.withType

withType(type)

"Type of deployment. Can be \"Recreate\" or \"RollingUpdate\". Default is RollingUpdate."

obj spec.deployment.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.deployment.strategy.rollingUpdate.withMaxSurge

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.deployment.strategy.rollingUpdate.withMaxUnavailable

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.deployment.tolerations

fn spec.deployment.tolerations.withEffect

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.deployment.tolerations.withKey

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.deployment.tolerations.withOperator

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.deployment.tolerations.withTolerationSeconds

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.deployment.tolerations.withValue

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.ingress

"GrafanaIngress provides a means to configure the ingress created"

fn spec.ingress.withAnnotations

withAnnotations(annotations)

fn spec.ingress.withAnnotationsMixin

withAnnotationsMixin(annotations)

Note: This function appends passed data to existing values

fn spec.ingress.withEnabled

withEnabled(enabled)

fn spec.ingress.withHostname

withHostname(hostname)

fn spec.ingress.withIngressClassName

withIngressClassName(ingressClassName)

fn spec.ingress.withLabels

withLabels(labels)

fn spec.ingress.withLabelsMixin

withLabelsMixin(labels)

Note: This function appends passed data to existing values

fn spec.ingress.withPath

withPath(path)

fn spec.ingress.withPathType

withPathType(pathType)

fn spec.ingress.withTargetPort

withTargetPort(targetPort)

fn spec.ingress.withTermination

withTermination(termination)

"TLSTerminationType dictates where the secure communication will stop TODO: Reconsider this type in v2"

fn spec.ingress.withTlsEnabled

withTlsEnabled(tlsEnabled)

fn spec.ingress.withTlsSecretName

withTlsSecretName(tlsSecretName)

obj spec.initResources

"ResourceRequirements describes the compute resource requirements."

fn spec.initResources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn spec.initResources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

Note: This function appends passed data to existing values

fn spec.initResources.withRequests

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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn spec.initResources.withRequestsMixin

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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

Note: This function appends passed data to existing values

obj spec.jsonnet

obj spec.jsonnet.libraryLabelSelector

"A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects."

fn spec.jsonnet.libraryLabelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.jsonnet.libraryLabelSelector.withMatchExpressionsMixin

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.jsonnet.libraryLabelSelector.withMatchLabels

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.jsonnet.libraryLabelSelector.withMatchLabelsMixin

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.jsonnet.libraryLabelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.jsonnet.libraryLabelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.jsonnet.libraryLabelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.jsonnet.libraryLabelSelector.matchExpressions.withValues

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.jsonnet.libraryLabelSelector.matchExpressions.withValuesMixin

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.livenessProbeSpec

fn spec.livenessProbeSpec.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.livenessProbeSpec.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.livenessProbeSpec.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.livenessProbeSpec.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

fn spec.livenessProbeSpec.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.livenessProbeSpec.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.readinessProbeSpec

fn spec.readinessProbeSpec.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.readinessProbeSpec.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.readinessProbeSpec.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.readinessProbeSpec.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

fn spec.readinessProbeSpec.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.readinessProbeSpec.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.resources

"ResourceRequirements describes the compute resource requirements."

fn spec.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn spec.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

Note: This function appends passed data to existing values

fn spec.resources.withRequests

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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn spec.resources.withRequestsMixin

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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

Note: This function appends passed data to existing values

obj spec.service

"GrafanaService provides a means to configure the service"

fn spec.service.withAnnotations

withAnnotations(annotations)

fn spec.service.withAnnotationsMixin

withAnnotationsMixin(annotations)

Note: This function appends passed data to existing values

fn spec.service.withClusterIP

withClusterIP(clusterIP)

fn spec.service.withLabels

withLabels(labels)

fn spec.service.withLabelsMixin

withLabelsMixin(labels)

Note: This function appends passed data to existing values

fn spec.service.withName

withName(name)

fn spec.service.withPorts

withPorts(ports)

fn spec.service.withPortsMixin

withPortsMixin(ports)

Note: This function appends passed data to existing values

fn spec.service.withType

withType(type)

"Service Type string describes ingress methods for a service"

obj spec.service.ports

fn spec.service.ports.withAppProtocol

withAppProtocol(appProtocol)

"The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default."

fn spec.service.ports.withName

withName(name)

"The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service."

fn spec.service.ports.withNodePort

withNodePort(nodePort)

"The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport"

fn spec.service.ports.withPort

withPort(port)

"The port that will be exposed by this service."

fn spec.service.ports.withProtocol

withProtocol(protocol)

"The IP protocol for this port. Supports \"TCP\", \"UDP\", and \"SCTP\". Default is TCP."

fn spec.service.ports.withTargetPort

withTargetPort(targetPort)

"Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service"

obj spec.serviceAccount

fn spec.serviceAccount.withAnnotations

withAnnotations(annotations)

fn spec.serviceAccount.withAnnotationsMixin

withAnnotationsMixin(annotations)

Note: This function appends passed data to existing values

fn spec.serviceAccount.withImagePullSecrets

withImagePullSecrets(imagePullSecrets)

fn spec.serviceAccount.withImagePullSecretsMixin

withImagePullSecretsMixin(imagePullSecrets)

Note: This function appends passed data to existing values

fn spec.serviceAccount.withLabels

withLabels(labels)

fn spec.serviceAccount.withLabelsMixin

withLabelsMixin(labels)

Note: This function appends passed data to existing values

fn spec.serviceAccount.withSkip

withSkip(skip)

obj spec.serviceAccount.imagePullSecrets

fn spec.serviceAccount.imagePullSecrets.withName

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?"