Reference documentation and code samples for the Distributed Cloud Edge Container V1 API class Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local.
Configuration specific to clusters with a control plane hosted locally.
Warning: Local control plane clusters must be created in their own
project. Local control plane clusters cannot coexist in the same
project with any other type of clusters, including non-GDCE clusters.
Mixing local control plane GDCE clusters with any other type of
clusters in the same project can result in data loss.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#control_plane_node_storage_schema
defcontrol_plane_node_storage_schema()->::String
Returns
(::String) — Optional. Name for the storage schema of control plane nodes.
Warning: Configurable node local storage schema feature is an
experimental feature, and is not recommended for general use
in production clusters/nodepools.
value (::String) — Optional. Name for the storage schema of control plane nodes.
Warning: Configurable node local storage schema feature is an
experimental feature, and is not recommended for general use
in production clusters/nodepools.
Returns
(::String) — Optional. Name for the storage schema of control plane nodes.
Warning: Configurable node local storage schema feature is an
experimental feature, and is not recommended for general use
in production clusters/nodepools.
#machine_filter
defmachine_filter()->::String
Returns
(::String) — Only machines matching this filter will be allowed to host control
plane nodes. The filtering language accepts strings like "name=
#machine_filter=
defmachine_filter=(value)->::String
Parameter
value (::String) — Only machines matching this filter will be allowed to host control
plane nodes. The filtering language accepts strings like "name=
Returns
(::String) — Only machines matching this filter will be allowed to host control
plane nodes. The filtering language accepts strings like "name=
#node_count
defnode_count()->::Integer
Returns
(::Integer) — The number of nodes to serve as replicas of the Control Plane.
#node_count=
defnode_count=(value)->::Integer
Parameter
value (::Integer) — The number of nodes to serve as replicas of the Control Plane.
Returns
(::Integer) — The number of nodes to serve as replicas of the Control Plane.
#node_location
defnode_location()->::String
Returns
(::String) — Name of the Google Distributed Cloud Edge zones where this node pool
will be created. For example: us-central1-edge-customer-a.
#node_location=
defnode_location=(value)->::String
Parameter
value (::String) — Name of the Google Distributed Cloud Edge zones where this node pool
will be created. For example: us-central1-edge-customer-a.
Returns
(::String) — Name of the Google Distributed Cloud Edge zones where this node pool
will be created. For example: us-central1-edge-customer-a.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Distributed Cloud Edge Container V1 API - Class Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local (v1.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.0 (latest)](/ruby/docs/reference/google-cloud-edge_container-v1/latest/Google-Cloud-EdgeContainer-V1-Cluster-ControlPlane-Local)\n- [1.0.1](/ruby/docs/reference/google-cloud-edge_container-v1/1.0.1/Google-Cloud-EdgeContainer-V1-Cluster-ControlPlane-Local)\n- [0.4.0](/ruby/docs/reference/google-cloud-edge_container-v1/0.4.0/Google-Cloud-EdgeContainer-V1-Cluster-ControlPlane-Local)\n- [0.3.0](/ruby/docs/reference/google-cloud-edge_container-v1/0.3.0/Google-Cloud-EdgeContainer-V1-Cluster-ControlPlane-Local)\n- [0.2.0](/ruby/docs/reference/google-cloud-edge_container-v1/0.2.0/Google-Cloud-EdgeContainer-V1-Cluster-ControlPlane-Local)\n- [0.1.1](/ruby/docs/reference/google-cloud-edge_container-v1/0.1.1/Google-Cloud-EdgeContainer-V1-Cluster-ControlPlane-Local) \nReference documentation and code samples for the Distributed Cloud Edge Container V1 API class Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local.\n\nConfiguration specific to clusters with a control plane hosted locally.\n\n\n\u003cbr /\u003e\n\nWarning: Local control plane clusters must be created in their own\nproject. Local control plane clusters cannot coexist in the same\nproject with any other type of clusters, including non-GDCE clusters.\nMixing local control plane GDCE clusters with any other type of\nclusters in the same project can result in data loss. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #control_plane_node_storage_schema\n\n def control_plane_node_storage_schema() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Name for the storage schema of control plane nodes.\n\n Warning: Configurable node local storage schema feature is an\n experimental feature, and is not recommended for general use\n in production clusters/nodepools.\n\n### #control_plane_node_storage_schema=\n\n def control_plane_node_storage_schema=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. Name for the storage schema of control plane nodes.\n\n\n Warning: Configurable node local storage schema feature is an\n experimental feature, and is not recommended for general use\nin production clusters/nodepools. \n**Returns**\n\n- (::String) --- Optional. Name for the storage schema of control plane nodes.\n\n Warning: Configurable node local storage schema feature is an\n experimental feature, and is not recommended for general use\n in production clusters/nodepools.\n\n### #machine_filter\n\n def machine_filter() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Only machines matching this filter will be allowed to host control plane nodes. The filtering language accepts strings like \"name=\n\n### #machine_filter=\n\n def machine_filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Only machines matching this filter will be allowed to host control plane nodes. The filtering language accepts strings like \"name= \n**Returns**\n\n- (::String) --- Only machines matching this filter will be allowed to host control plane nodes. The filtering language accepts strings like \"name=\n\n### #node_count\n\n def node_count() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- The number of nodes to serve as replicas of the Control Plane.\n\n### #node_count=\n\n def node_count=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- The number of nodes to serve as replicas of the Control Plane. \n**Returns**\n\n- (::Integer) --- The number of nodes to serve as replicas of the Control Plane.\n\n### #node_location\n\n def node_location() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Name of the Google Distributed Cloud Edge zones where this node pool will be created. For example: `us-central1-edge-customer-a`.\n\n### #node_location=\n\n def node_location=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Name of the Google Distributed Cloud Edge zones where this node pool will be created. For example: `us-central1-edge-customer-a`. \n**Returns**\n\n- (::String) --- Name of the Google Distributed Cloud Edge zones where this node pool will be created. For example: `us-central1-edge-customer-a`.\n\n### #shared_deployment_policy\n\n def shared_deployment_policy() -\u003e ::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy\n\n**Returns**\n\n- ([::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy](./Google-Cloud-EdgeContainer-V1-Cluster-ControlPlane-SharedDeploymentPolicy)) --- Policy configuration about how user applications are deployed.\n\n### #shared_deployment_policy=\n\n def shared_deployment_policy=(value) -\u003e ::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy\n\n**Parameter**\n\n- **value** ([::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy](./Google-Cloud-EdgeContainer-V1-Cluster-ControlPlane-SharedDeploymentPolicy)) --- Policy configuration about how user applications are deployed. \n**Returns**\n\n- ([::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy](./Google-Cloud-EdgeContainer-V1-Cluster-ControlPlane-SharedDeploymentPolicy)) --- Policy configuration about how user applications are deployed."]]
