@swamp/gcp/gkeonprem
v2026.04.23.1
Google Cloud gkeonprem infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-cloudgkeonpremcloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/gcp/gkeonprem@swamp/gcp/gkeonprem/baremetaladminclustersv2026.04.23.1baremetaladminclusters.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | Annotations on the bare metal admin cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. |
| bareMetalVersion? | string | The Anthos clusters on bare metal version for the bare metal admin cluster. |
| binaryAuthorization? | object | Configuration for Binary Authorization. |
| clusterOperations? | object | BareMetalAdminClusterOperationsConfig specifies the admin cluster's observability infrastructure. |
| controlPlane? | object | BareMetalAdminControlPlaneConfig specifies the control plane configuration. |
| description? | string | A human readable description of this bare metal admin cluster. |
| fleet? | object | Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## |
| loadBalancer? | object | BareMetalAdminLoadBalancerConfig specifies the load balancer configuration. |
| maintenanceConfig? | object | BareMetalAdminMaintenanceConfig specifies configurations to put bare metal Admin cluster CRs nodes in and out of maintenance. |
| maintenanceStatus? | object | BareMetalAdminMaintenanceStatus represents the maintenance status for bare metal Admin cluster CR's nodes. |
| name? | string | Immutable. The bare metal admin cluster resource name. |
| networkConfig? | object | BareMetalAdminNetworkConfig specifies the cluster network configuration. |
| nodeAccessConfig? | object | Specifies the node access related settings for the bare metal admin cluster. |
| nodeConfig? | object | BareMetalAdminWorkloadNodeConfig specifies the workload node configurations. |
| osEnvironmentConfig? | object | Specifies operating system operation settings for cluster provisioning. |
| proxy? | object | BareMetalAdminProxyConfig specifies the cluster proxy configuration. |
| securityConfig? | object | Specifies the security related settings for the bare metal admin cluster. |
| status? | object | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). |
| storage? | object | BareMetalAdminStorageConfig specifies the cluster storage configuration. |
| validationCheck? | object | ValidationCheck represents the result of preflight check. |
| allowPreflightFailure? | string | Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with "cluster already exists" error and hence a update cluster is required to fix the cluster. |
| bareMetalAdminClusterId? | string | Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/ |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a bareMetalAdminClusters
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a bareMetalAdminClusters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bareMetalAdminClusters |
updateUpdate bareMetalAdminClusters attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
syncSync bareMetalAdminClusters state from GCP
enrollenroll
| Argument | Type | Description |
|---|---|---|
| bareMetalAdminClusterId? | any | |
| membership? | any |
query_version_configquery version config
unenrollunenroll
Resources
state(infinite)— Resource that represents a bare metal admin cluster.
@swamp/gcp/gkeonprem/baremetalclustersv2026.04.23.1baremetalclusters.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| adminClusterMembership? | string | Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. |
| annotations? | record | Annotations on the bare metal user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. |
| bareMetalVersion? | string | Required. The Anthos clusters on bare metal version for your user cluster. |
| binaryAuthorization? | object | Configuration for Binary Authorization. |
| clusterOperations? | object | Specifies the bare metal user cluster's observability infrastructure. |
| controlPlane? | object | Specifies the control plane configuration. |
| description? | string | A human readable description of this bare metal user cluster. |
| fleet? | object | Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## |
| loadBalancer? | object | Specifies the load balancer configuration. |
| maintenanceConfig? | object | Specifies configurations to put bare metal nodes in and out of maintenance. |
| maintenanceStatus? | object | Represents the maintenance status of the bare metal user cluster. |
| name? | string | Immutable. The bare metal user cluster resource name. |
| networkConfig? | object | Specifies the cluster network configuration. |
| nodeAccessConfig? | object | Specifies the node access related settings for the bare metal user cluster. |
| nodeConfig? | object | Specifies the workload node configurations. |
| osEnvironmentConfig? | object | Specifies operating system settings for cluster provisioning. |
| proxy? | object | Specifies the cluster proxy configuration. |
| securityConfig? | object | Specifies the security related settings for the bare metal user cluster. |
| status? | object | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). |
| storage? | object | BareMetalStorageConfig specifies the cluster storage configuration. |
| upgradePolicy? | object | BareMetalClusterUpgradePolicy defines the cluster upgrade policy. |
| validationCheck? | object | ValidationCheck represents the result of preflight check. |
| allowPreflightFailure? | string | Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with "cluster already exists" error and hence a update cluster is required to fix the cluster. |
| bareMetalClusterId? | string | Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/ |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a bareMetalClusters
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a bareMetalClusters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bareMetalClusters |
updateUpdate bareMetalClusters attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the bareMetalClusters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bareMetalClusters |
syncSync bareMetalClusters state from GCP
enrollenroll
| Argument | Type | Description |
|---|---|---|
| adminClusterMembership? | any | |
| bareMetalClusterId? | any | |
| localName? | any | |
| localNamespace? | any |
query_version_configquery version config
unenrollunenroll
Resources
state(infinite)— Resource that represents a bare metal user cluster.
@swamp/gcp/gkeonprem/baremetalclusters-baremetalnodepoolsv2026.04.23.1baremetalclusters_baremetalnodepools.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | Annotations on the bare metal node pool. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. |
| displayName? | string | The display name for the bare metal node pool. |
| name? | string | Immutable. The bare metal node pool resource name. |
| nodePoolConfig? | object | BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. |
| status? | object | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). |
| upgradePolicy? | object | BareMetalNodePoolUpgradePolicy defines the node pool upgrade policy. |
| bareMetalNodePoolId? | string | The ID to use for the node pool, which will become the final component of the node pool's resource name. This value must be up to 63 characters, and valid characters are /a-z-/. The value must not be permitted to be a UUID (or UUID-like: anything matching /^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$/i). |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a bareMetalNodePools
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a bareMetalNodePools
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bareMetalNodePools |
updateUpdate bareMetalNodePools attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the bareMetalNodePools
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bareMetalNodePools |
syncSync bareMetalNodePools state from GCP
enrollenroll
| Argument | Type | Description |
|---|---|---|
| bareMetalNodePoolId? | any | |
| validateOnly? | any |
unenrollunenroll
Resources
state(infinite)— Resource that represents a bare metal node pool.
@swamp/gcp/gkeonprem/locationsv2026.04.23.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
syncSync locations state from GCP
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/gkeonprem/vmwareadminclustersv2026.04.23.1vmwareadminclusters.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| addonNode? | object | VmwareAdminAddonNodeConfig contains add-on node configurations for VMware admin cluster. |
| annotations? | record | Annotations on the VMware admin cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. |
| antiAffinityGroups? | object | Specifies anti affinity group config for the VMware user cluster. |
| authorization? | object | VmwareAdminAuthorizationConfig represents configuration for admin cluster authorization. |
| autoRepairConfig? | object | Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. |
| bootstrapClusterMembership? | string | The bootstrap cluster this VMware admin cluster belongs to. |
| controlPlaneNode? | object | VmwareAdminControlPlaneNodeConfig contains control plane node configuration for VMware admin cluster. |
| description? | string | A human readable description of this VMware admin cluster. |
| enableAdvancedCluster? | boolean | Enable advanced cluster. |
| fleet? | object | Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## |
| imageType? | string | The OS image type for the VMware admin cluster. |
| loadBalancer? | object | VmwareAdminLoadBalancerConfig contains load balancer configuration for VMware admin cluster. |
| name? | string | Immutable. The VMware admin cluster resource name. |
| networkConfig? | object | VmwareAdminNetworkConfig contains network configuration for VMware admin cluster. |
| onPremVersion? | string | The Anthos clusters on the VMware version for the admin cluster. |
| platformConfig? | object | VmwarePlatformConfig represents configuration for the VMware platform. |
| preparedSecrets? | object | VmwareAdminPreparedSecretsConfig represents configuration for admin cluster prepared secrets. |
| privateRegistryConfig? | object | VmwareAdminPrivateRegistryConfig represents configuration for admin cluster registry. |
| proxy? | object | VmwareAdminProxy represents configuration for admin cluster proxy. |
| status? | object | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). |
| validationCheck? | object | ValidationCheck represents the result of preflight check. |
| vcenter? | object | VmwareAdminVCenterConfig contains VCenter configuration for VMware admin cluster. |
| allowPreflightFailure? | string | Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with "cluster already exists" error and hence a update cluster is required to fix the cluster. |
| skipValidations? | string | Optional. If set, skip the specified validations. |
| vmwareAdminClusterId? | string | Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/ |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a vmwareAdminClusters
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a vmwareAdminClusters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the vmwareAdminClusters |
updateUpdate vmwareAdminClusters attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
syncSync vmwareAdminClusters state from GCP
enrollenroll
| Argument | Type | Description |
|---|---|---|
| membership? | any | |
| vmwareAdminClusterId? | any |
unenrollunenroll
Resources
state(infinite)— Resource that represents a VMware admin cluster.
@swamp/gcp/gkeonprem/vmwareclustersv2026.04.23.1vmwareclusters.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| adminClusterMembership? | string | Required. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources. |
| annotations? | record | Annotations on the VMware user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. |
| antiAffinityGroups? | object | Specifies anti affinity group config for the VMware user cluster. |
| authorization? | object | Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. |
| autoRepairConfig? | object | Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. |
| binaryAuthorization? | object | Configuration for Binary Authorization. |
| controlPlaneNode? | object | Specifies control plane node config for the VMware user cluster. |
| dataplaneV2? | object | Contains configurations for Dataplane V2, which is optimized dataplane for Kubernetes networking. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dataplane-v2 |
| description? | string | A human readable description of this VMware user cluster. |
| disableBundledIngress? | boolean | Disable bundled ingress. |
| enableAdvancedCluster? | boolean | Enable advanced cluster. |
| enableControlPlaneV2? | boolean | Enable control plane V2. Default to false. |
| fleet? | object | Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## |
| loadBalancer? | object | Specifies the locad balancer config for the VMware user cluster. |
| name? | string | Immutable. The VMware user cluster resource name. |
| networkConfig? | object | Specifies network config for the VMware user cluster. |
| onPremVersion? | string | Required. The Anthos clusters on the VMware version for your user cluster. |
| status? | object | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). |
| storage? | object | Specifies vSphere CSI components deployment config in the VMware user cluster. |
| upgradePolicy? | object | VmwareClusterUpgradePolicy defines the cluster upgrade policy. |
| validationCheck? | object | ValidationCheck represents the result of preflight check. |
| vcenter? | object | Represents configuration for the VMware VCenter for the user cluster. |
| vmTrackingEnabled? | boolean | Enable VM tracking. |
| allowPreflightFailure? | string | Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with "cluster already exists" error and hence a update cluster is required to fix the cluster. |
| skipValidations? | string | Optional. List of validations to skip during cluster creation. |
| vmwareClusterId? | string | User provided identifier that is used as part of the resource name; This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a vmwareClusters
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a vmwareClusters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the vmwareClusters |
updateUpdate vmwareClusters attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the vmwareClusters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the vmwareClusters |
syncSync vmwareClusters state from GCP
enrollenroll
| Argument | Type | Description |
|---|---|---|
| adminClusterMembership? | any | |
| localName? | any | |
| validateOnly? | any | |
| vmwareClusterId? | any |
query_version_configquery version config
unenrollunenroll
Resources
state(infinite)— Resource that represents a VMware user cluster. ##
@swamp/gcp/gkeonprem/vmwareclusters-vmwarenodepoolsv2026.04.23.1vmwareclusters_vmwarenodepools.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | Annotations on the node pool. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. |
| config? | object | Parameters that describe the configuration of all nodes within a given node pool. |
| displayName? | string | The display name for the node pool. |
| name? | string | Immutable. The resource name of this node pool. |
| nodePoolAutoscaling? | object | NodePoolAutoscaling config for the NodePool to allow for the kubernetes to scale NodePool. |
| onPremVersion? | string | Anthos version for the node pool. Defaults to the user cluster version. |
| status? | object | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). |
| vmwareNodePoolId? | string | The ID to use for the node pool, which will become the final component of the node pool's resource name. This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format. The value must not be permitted to be a UUID (or UUID-like: anything matching /^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$/i). |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a vmwareNodePools
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a vmwareNodePools
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the vmwareNodePools |
updateUpdate vmwareNodePools attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the vmwareNodePools
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the vmwareNodePools |
syncSync vmwareNodePools state from GCP
enrollenroll
| Argument | Type | Description |
|---|---|---|
| vmwareNodePoolId? | any |
unenrollunenroll
Resources
state(infinite)— Resource VmwareNodePool represents a VMware node pool. ##
2026.04.04.1111.1 KBApr 4, 2026
Google Cloud gkeonprem infrastructure models
Release Notes
- Updated: baremetaladminclusters, baremetalclusters, vmwareadminclusters, vmwareclusters
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudgkeonpremcloudinfrastructure
2026.04.03.3115.1 KBApr 3, 2026
Google Cloud gkeonprem infrastructure models
Release Notes
- Updated: locations, baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudgkeonpremcloudinfrastructure
2026.04.03.1113.9 KBApr 3, 2026
Google Cloud gkeonprem infrastructure models
Release Notes
- Updated: locations, baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudgkeonpremcloudinfrastructure
2026.04.02.2113.9 KBApr 2, 2026
Google Cloud gkeonprem infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudgkeonpremcloudinfrastructure
2026.03.27.1112.9 KBMar 27, 2026
Google Cloud gkeonprem infrastructure models
Release Notes
- Added: locations, baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudgkeonpremcloudinfrastructure