gkehub.v1beta1.gkeHubFeatureMembership

"GKEHubFeatureMembership is the Schema for the gkehub API"

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of GKEHubFeatureMembership

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"

fn metadata.withSelfLink

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

withLocation(location)

"Immutable. The location of the feature"

fn spec.withMembershipLocation

withMembershipLocation(membershipLocation)

"Immutable. The location of the membership"

obj spec.configmanagement

"Config Management-specific spec."

fn spec.configmanagement.withVersion

withVersion(version)

"Optional. Version of ACM to install. Defaults to the latest version."

obj spec.configmanagement.binauthz

"DEPRECATED Binauthz configuration for the cluster. This field will be ignored and should not be set."

fn spec.configmanagement.binauthz.withEnabled

withEnabled(enabled)

"Whether binauthz is enabled in this cluster."

obj spec.configmanagement.configSync

"Config Sync configuration for the cluster."

fn spec.configmanagement.configSync.withPreventDrift

withPreventDrift(preventDrift)

"Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts."

fn spec.configmanagement.configSync.withSourceFormat

withSourceFormat(sourceFormat)

"Specifies whether the Config Sync Repo is in \"hierarchical\" or \"unstructured\" mode."

obj spec.configmanagement.configSync.git

fn spec.configmanagement.configSync.git.withHttpsProxy

withHttpsProxy(httpsProxy)

"URL for the HTTPS proxy to be used when communicating with the Git repo."

fn spec.configmanagement.configSync.git.withPolicyDir

withPolicyDir(policyDir)

"The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository."

fn spec.configmanagement.configSync.git.withSecretType

withSecretType(secretType)

"Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive."

fn spec.configmanagement.configSync.git.withSyncBranch

withSyncBranch(syncBranch)

"The branch of the repository to sync from. Default: master."

fn spec.configmanagement.configSync.git.withSyncRepo

withSyncRepo(syncRepo)

"The URL of the Git repository to use as the source of truth."

fn spec.configmanagement.configSync.git.withSyncRev

withSyncRev(syncRev)

"Git revision (tag or hash) to check out. Default HEAD."

fn spec.configmanagement.configSync.git.withSyncWaitSecs

withSyncWaitSecs(syncWaitSecs)

"Period in seconds between consecutive syncs. Default: 15."

obj spec.configmanagement.configSync.git.gcpServiceAccountRef

fn spec.configmanagement.configSync.git.gcpServiceAccountRef.withExternal

withExternal(external)

"The email field of an IAMServiceAccount resource."

fn spec.configmanagement.configSync.git.gcpServiceAccountRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.configmanagement.configSync.git.gcpServiceAccountRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.configmanagement.configSync.metricsGcpServiceAccountRef

fn spec.configmanagement.configSync.metricsGcpServiceAccountRef.withExternal

withExternal(external)

"The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring. The GSA should have the Monitoring Metric Writer(roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount default in the namespace config-management-monitoring should be bound to the GSA. Allowed value: The email field of an IAMServiceAccount resource."

fn spec.configmanagement.configSync.metricsGcpServiceAccountRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.configmanagement.configSync.metricsGcpServiceAccountRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.configmanagement.configSync.oci

fn spec.configmanagement.configSync.oci.withPolicyDir

withPolicyDir(policyDir)

"The absolute path of the directory that contains the local resources. Default: the root directory of the image."

fn spec.configmanagement.configSync.oci.withSecretType

withSecretType(secretType)

"Type of secret configured for access to the OCI Image. Must be one of gcenode, gcpserviceaccount or none. The validation of this is case-sensitive."

fn spec.configmanagement.configSync.oci.withSyncRepo

withSyncRepo(syncRepo)

"The OCI image repository URL for the package to sync from. e.g. LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME."

fn spec.configmanagement.configSync.oci.withSyncWaitSecs

withSyncWaitSecs(syncWaitSecs)

"Period in seconds(int64 format) between consecutive syncs. Default: 15."

obj spec.configmanagement.configSync.oci.gcpServiceAccountRef

fn spec.configmanagement.configSync.oci.gcpServiceAccountRef.withExternal

withExternal(external)

"The email field of an IAMServiceAccount resource."

fn spec.configmanagement.configSync.oci.gcpServiceAccountRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.configmanagement.configSync.oci.gcpServiceAccountRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.configmanagement.hierarchyController

"Hierarchy Controller is no longer available. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead."

fn spec.configmanagement.hierarchyController.withEnableHierarchicalResourceQuota

withEnableHierarchicalResourceQuota(enableHierarchicalResourceQuota)

"Whether hierarchical resource quota is enabled in this cluster."

fn spec.configmanagement.hierarchyController.withEnablePodTreeLabels

withEnablePodTreeLabels(enablePodTreeLabels)

"Whether pod tree labels are enabled in this cluster."

fn spec.configmanagement.hierarchyController.withEnabled

withEnabled(enabled)

"Whether Hierarchy Controller is enabled in this cluster."

obj spec.configmanagement.policyController

"DEPRECATED Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead."

fn spec.configmanagement.policyController.withAuditIntervalSeconds

withAuditIntervalSeconds(auditIntervalSeconds)

"Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether."

fn spec.configmanagement.policyController.withEnabled

withEnabled(enabled)

"Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect."

fn spec.configmanagement.policyController.withExemptableNamespaces

withExemptableNamespaces(exemptableNamespaces)

"The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster."

fn spec.configmanagement.policyController.withExemptableNamespacesMixin

withExemptableNamespacesMixin(exemptableNamespaces)

"The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster."

Note: This function appends passed data to existing values

fn spec.configmanagement.policyController.withLogDeniesEnabled

withLogDeniesEnabled(logDeniesEnabled)

"Logs all denies and dry run failures."

fn spec.configmanagement.policyController.withMutationEnabled

withMutationEnabled(mutationEnabled)

"Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster."

fn spec.configmanagement.policyController.withReferentialRulesEnabled

withReferentialRulesEnabled(referentialRulesEnabled)

"Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated."

fn spec.configmanagement.policyController.withTemplateLibraryInstalled

withTemplateLibraryInstalled(templateLibraryInstalled)

"Installs the default template library along with Policy Controller."

obj spec.configmanagement.policyController.monitoring

"Specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: [\"cloudmonitoring\", \"prometheus\"]. Default: [\"cloudmonitoring\", \"prometheus\"]"

fn spec.configmanagement.policyController.monitoring.withBackends

withBackends(backends)

"Specifies the list of backends Policy Controller will export to. Specifying an empty value [] disables metrics export."

fn spec.configmanagement.policyController.monitoring.withBackendsMixin

withBackendsMixin(backends)

"Specifies the list of backends Policy Controller will export to. Specifying an empty value [] disables metrics export."

Note: This function appends passed data to existing values

obj spec.featureRef

"Immutable."

fn spec.featureRef.withExternal

withExternal(external)

"The name of the feature. Allowed value: The Google Cloud resource name of a GKEHubFeature resource (format: projects/{{project}}/locations/{{location}}/features/{{name}})."

fn spec.featureRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.featureRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.membershipRef

"Immutable."

fn spec.membershipRef.withExternal

withExternal(external)

"The name of the membership. Allowed value: The Google Cloud resource name of a GKEHubMembership resource (format: projects/{{project}}/locations/{{location}}/memberships/{{name}})."

fn spec.membershipRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.membershipRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.mesh

"Manage Mesh Features"

fn spec.mesh.withControlPlane

withControlPlane(controlPlane)

"DEPRECATED Whether to automatically manage Service Mesh control planes. Possible values: CONTROL_PLANE_MANAGEMENT_UNSPECIFIED, AUTOMATIC, MANUAL"

fn spec.mesh.withManagement

withManagement(management)

"Whether to automatically manage Service Mesh. Possible values: MANAGEMENT_UNSPECIFIED, MANAGEMENT_AUTOMATIC, MANAGEMENT_MANUAL"

obj spec.policycontroller

"Policy Controller-specific spec."

fn spec.policycontroller.withVersion

withVersion(version)

"Optional. Version of Policy Controller to install. Defaults to the latest version."

obj spec.policycontroller.policyControllerHubConfig

"Policy Controller configuration for the cluster."

fn spec.policycontroller.policyControllerHubConfig.withAuditIntervalSeconds

withAuditIntervalSeconds(auditIntervalSeconds)

"Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether."

fn spec.policycontroller.policyControllerHubConfig.withConstraintViolationLimit

withConstraintViolationLimit(constraintViolationLimit)

"The maximum number of audit violations to be stored in a constraint. If not set, the internal default of 20 will be used."

fn spec.policycontroller.policyControllerHubConfig.withExemptableNamespaces

withExemptableNamespaces(exemptableNamespaces)

"The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster."

fn spec.policycontroller.policyControllerHubConfig.withExemptableNamespacesMixin

withExemptableNamespacesMixin(exemptableNamespaces)

"The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster."

Note: This function appends passed data to existing values

fn spec.policycontroller.policyControllerHubConfig.withInstallSpec

withInstallSpec(installSpec)

"Configures the mode of the Policy Controller installation. Possible values: INSTALL_SPEC_UNSPECIFIED, INSTALL_SPEC_NOT_INSTALLED, INSTALL_SPEC_ENABLED, INSTALL_SPEC_SUSPENDED, INSTALL_SPEC_DETACHED"

fn spec.policycontroller.policyControllerHubConfig.withLogDeniesEnabled

withLogDeniesEnabled(logDeniesEnabled)

"Logs all denies and dry run failures."

fn spec.policycontroller.policyControllerHubConfig.withMutationEnabled

withMutationEnabled(mutationEnabled)

"Enables the ability to mutate resources using Policy Controller."

fn spec.policycontroller.policyControllerHubConfig.withReferentialRulesEnabled

withReferentialRulesEnabled(referentialRulesEnabled)

"Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated."

obj spec.policycontroller.policyControllerHubConfig.monitoring

"Specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: [\"cloudmonitoring\", \"prometheus\"]. Default: [\"cloudmonitoring\", \"prometheus\"]"

fn spec.policycontroller.policyControllerHubConfig.monitoring.withBackends

withBackends(backends)

"Specifies the list of backends Policy Controller will export to. Specifying an empty value [] disables metrics export."

fn spec.policycontroller.policyControllerHubConfig.monitoring.withBackendsMixin

withBackendsMixin(backends)

"Specifies the list of backends Policy Controller will export to. Specifying an empty value [] disables metrics export."

Note: This function appends passed data to existing values

obj spec.policycontroller.policyControllerHubConfig.policyContent

"Specifies the desired policy content on the cluster."

obj spec.policycontroller.policyControllerHubConfig.policyContent.templateLibrary

"Configures the installation of the Template Library."

fn spec.policycontroller.policyControllerHubConfig.policyContent.templateLibrary.withInstallation

withInstallation(installation)

"Configures the manner in which the template library is installed on the cluster. Possible values: INSTALLATION_UNSPECIFIED, NOT_INSTALLED, ALL"

obj spec.projectRef

"Immutable. The Project that this resource belongs to."

fn spec.projectRef.withExternal

withExternal(external)

"The project of the feature. Allowed value: The Google Cloud resource name of a Project resource (format: projects/{{name}})."

fn spec.projectRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.projectRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"