Linux Windows
Shared sole-tenant node groups are similar to local sole-tenant node groups. For example, shared node groups cost the same, consume the same quota, and reside under a parent project in the resource hierarchy.
The difference between shared node groups and local node groups is that other projects in your organization can provision virtual machine (VM) instances in the shared node groups.
Sharing a node group across multiple projects or an organization can help you do the following:
Consolidate node groups that you manage into a single project and then share those nodes with other projects or the entire organization
Decrease costs by deleting nodes after consolidating VMs from various projects into underutilized node groups
Manage sole-tenant nodes with a single team
Share sole-tenant nodes with smaller projects and retain security and access control boundaries between those projects
Perform a live migration between node groups within the same project
Improve the utilization of your node groups and reduce the number of reserved maintenance nodes when using the Migrate within node group maintenance policy
The following diagram shows a node group that is shared with other projects so that other departments that manage VMs in those projects can provision VMs in a shared node group.
The following table compares projects that use local node groups with projects that use shared node groups. Notice that vCPU underutilization decreases in projects that use shared node groups.
Project configuration Local node groups Shared node groups Projects 10 10 vCPU / project 24 24 Node groups 10 1 Nodes / node group 1 3 vCPU / node 80 80 Utilization / node group 24 80 Underutilization / node group 56 0 Total underutilization 10 x 56 = 560 vCPUs 1 x 0 = 0 vCPUs Settings for sharing node groupsCompute Engine uses the following settings for sharing node groups and provisioning VMs in the shared node groups:
A share setting that you configure when you create or update the sole-tenant node group. To specify whether to share the node group with other projects or with the entire organization, use the gcloud CLI settings (--share-setting
, --share-with
) or REST settings (shareSetting
, shareWith
).
A default compute.googleapis.com/project
node affinity label that you use when you provision a VM in a shared node group by using node affinity labels. For information about the other default node affinity labels, see Default affinity labels.
When a node group uses the Migrate within node group maintenance policy, Compute Engine reserves at least 1 node for live migration events, so the node group must have at least 2 nodes. You can't schedule VMs on the reserved node, so node groups with this maintenance policy often have lower overall utilization. This makes workloads that require the Migrate within node group maintenance policy good candidates for node group sharing, as they often see the greatest benefit from improved utilization.
IAM roles and permissionsKeep in mind the following information about IAM roles and permissions when you share a node group:
If a node group is shared with a project, any user that can create VMs in the listed projects or in the organization can provision VMs from those projects onto the shared node group without any changes to IAM roles or permissions.
The compute.soleTenantViewer
IAM role lets you list and view node groups (gcloud CLI / REST). You cannot modify node groups with this role. Any user with this role or with permissions to list node groups, regardless of the IAM permissions on the VM, can view the project ID, name, machine type, and information about local SSDs and GPUs for all VMs in the node group.
Compliance regime limitations:
Google Cloud console limitations:
Sharing limitations:
projects
share setting.VMs in shared node groups don't incur additional charges, and there are no additional charges for sharing node groups. For more information about sole-tenant node pricing, see Sole-tenant node pricing.
Before you beginSelect the tab for how you plan to use the samples on this page:
ConsoleWhen you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.
gcloudInstall the Google Cloud CLI. After installation, initialize the Google Cloud CLI by running the following command:
gcloud init
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
Note: If you installed the gcloud CLI previously, make sure you have the latest version by runninggcloud components update
.To use the REST API samples on this page in a local development environment, you use the credentials you provide to the gcloud CLI.
Install the Google Cloud CLI. After installation, initialize the Google Cloud CLI by running the following command:
gcloud init
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
For more information, see Authenticate for using REST in the Google Cloud authentication documentation.
To create a new node group and share it with other projects or with the entire organization, use the Google Cloud console, gcloud CLI, or REST.
Permissions required for this taskTo perform this task, you must have the following permissions:
compute.nodeGroups.create
permissions on the projectCreate a sole-tenant node group. For more information, see Create a sole-tenant node group.
Configure the share settings by specifying one of the following in Configure share settings:
If you don't want to share the node group, choose Do not share this node group with other projects.
To create a shared node group, use the following gcloud compute sole-tenancy node-groups create
command.
gcloud compute sole-tenancy node-groups create NODE_GROUP \ --zone=ZONE \ --node-template=NODE_TEMPLATE \ --target-size=SIZE \ --share-setting=SHARE_SETTING \ --share-with=PROJECTS
Replace the following:
NODE_GROUP
: the name of the node group.
ZONE
: the zone to create the node group in.
NODE_TEMPLATE
: the name of the previously created node template.
SIZE
: the number of nodes in the node group.
SHARE_SETTING
: the share setting for the node group. Set to projects
to share with specific projects, or set to organization
to share with the entire organization.
PROJECTS
: a list of project IDs or project numbers to share the node group with. Only required if you set SHARE_SETTING
to projects
.
To create a shared node group, use the following nodeGroups.insert
method.
POST https://compute.googleapis.com/compute/v1/projects/PROJECT/zones/ZONE/nodeGroups { ... "name": NODE_GROUP, "nodeTemplate": NODE_TEMPLATE, "size": SIZE, "shareSettings": { "shareType": SHARE_TYPE, "projectMap": { string: { "projectId": PROJECTS }, } } ... }
Replace the following:
PROJECT
: the name of project to create the node group in.
ZONE
: the zone to create the node group in.
NODE_GROUP
: the name of the node group.
NODE_TEMPLATE
: the name of the previously created node template.
SIZE
: the number of nodes in the node group.
SHARE_TYPE
: the share setting for the node group. Set to SPECIFIC_PROJECTS
to share with specific projects, or set to ORGANIZATION
to share with the entire organization.
PROJECTS
: a list of project IDs or project numbers to share the node group with. Only required if you set SHARE_TYPE
to SPECIFIC_PROJECTS
.
To provision a sole-tenant VM in a shared node group, use the Google Cloud console, gcloud CLI, or REST.
ConsoleIn the Google Cloud console, switch to a project that you've shared a node group with.
Go to the VM instances page.
Click Create instance.
In Zone, choose the zone of the shared node group.
In Machine configuration > Series, choose the same machine type that the shared sole-tenant node group template specifies.
Expand the Advanced options section.
Expand the Sole-tenancy section.
Click Browse.
Choose Select project and specify the project that contains the shared node group.
Choose the sole-tenant node group or a specific sole-tenant node in that group to provision the VM on.
Provision a VM in a shared node group by using the node group name
To provision a sole-tenant VM in a shared node group by using the node group name, use the following gcloud compute instances create
command.
gcloud compute instances create VM_NAME \ --machine-type=MACHINE_TYPE \ --node-group=NODE_GROUP \ --node-project=NODE_PROJECT
Replace the following:
VM_NAME
: the name of the new sole-tenant VM to create in a shared node group
MACHINE_TYPE
: the machine type for the new sole-tenant VM
NODE_GROUP
: the name of the shared node group to create the sole-tenant VM in
NODE_PROJECT
: the project containing the node group to provision the VM in
Provision a VM in a shared node group by using a node affinity file
To provision a sole-tenant VM in a shared node group by using a node affinity file, use the following gcloud compute instances create
command.
gcloud compute instances create VM_NAME \ --machine-type=MACHINE_TYPE \ --node-affinity-file=NODE_AFFINITY_FILE
Replace the following:
VM_NAME
: the name of the sole-tenant VM to create in a shared node group by using an affinity label.
MACHINE_TYPE
: the machine type of the sole-tenant VM to create in a shared node group.
NODE_AFFINITY_FILE
: the name of the .json
file containing the node affinity information. In the node affinity file, set the affinity label key to "compute.googleapis.com/project"
, the operator equal to "IN"
, and the value equal to the project containing the node group. For more information about how to configure node affinity, see Configure node affinity labels.
To provision a sole-tenant VM in a shared node group by using a node affinity file, use the following nodeGroups.insert
method.
POST https://compute.googleapis.com/compute/v1/projects/PROJECT/zones/ZONE/instances { ... "name": VM_NAME, "machineType": MACHINE_TYPE, "scheduling": { ... "nodeAffinities": [ { "key": KEY, "operator": OPERATOR, "values": [ VALUE ] } ], ... }, ... }
Replace the following:
PROJECT
: the name of the project that owns the node group.
ZONE
: the zone of the node group.
VM_NAME
: the name of the sole-tenant VM to create in a shared node group by using an affinity label.
MACHINE_TYPE
: the machine type of the sole-tenant VM to create in a shared node group.
KEY
: the affinity label. Set to "compute.googleapis.com/project"
.
OPERATOR
: the affinity label operator. Set to "IN"
.
VALUE
: the project containing the node group to provision the VM in. Specify one project by using either the project name or project ID.
For more information about how to configure node affinity, see Configure node affinity labels.
View the sharing settings of a node groupTo view the sharing settings of a node group, use the Google Cloud console, gcloud CLI, or REST.
Permissions required for this taskTo perform this task, you must have the following permissions:
compute.nodeGroups.list
permissions on the projectIn the Google Cloud console, go to the Sole-tenant nodes page.
To view the properties of the node group, in the Name column, click the name of the node group.
To view the sharing settings of a node group, use the following gcloud compute sole-tenancy node-groups describe
command.
gcloud compute sole-tenancy node-groups describe NODE_GROUP
Replace NODE_GROUP
with the name of the node group to view the sharing settings of.
To view the sharing settings of a node group, use the following nodeGroups.get
method.
GET https://compute.googleapis.com/compute/v1/projects/PROJECT/zones/ZONE/nodeGroups
Replace the following:
PROJECT
: the name of project with the node group to view the sharing settings of
ZONE
: the zone containing the node group to view the sharing settings of
To share an existing node group with other projects or the entire organization, use the Google Cloud console, gcloud CLI, or REST.
Permissions required for this taskTo perform this task, you must have the following permissions:
compute.nodeGroups.update
permissions on the project in which you created the node groupIn the Google Cloud console, go to the Sole-tenant nodes page.
In the Name column, click the name of the node group.
To share the node group with all projects within the organization or with selected projects within the organization, in Overview > Shared with, click Edit edit.
To update the sharing settings of a node group, use the following gcloud compute sole-tenancy node-groups update
command.
gcloud compute sole-tenancy node-groups update NODE_GROUP \ --zone=ZONE \ --share-setting=SHARE_SETTING \ --share-with=PROJECTS
Replace the following:
NODE_GROUP
: the name of the node group to update the sharing settings of.
SHARE_SETTING
: the share setting for the node group. Set to projects
to share with specific projects, or set to organization
to share with the entire organization.
PROJECTS
: a list of project IDs or project numbers to share the node group with. Only required if you set SHARE_SETTING
to projects
.
To update the sharing settings of a node group, use the following nodeGroups.patch
method.
PATCH https://compute.googleapis.com/compute/v1/projects/PROJECT/zones/ZONE/nodeGroups/NODE_GROUP { "shareSettings": { "shareType": SHARE_TYPE, "projectMap": { string: { "projectId": PROJECTS }, } } }
Replace the following:
PROJECT
: the name of the project with the node groups to update the sharing settings of.
ZONE
: the zone containing the node groups to update the sharing settings of.
NODE_GROUP
: the name of the node group to update the sharing settings of.
SHARE_TYPE
: the share setting for the node group. Set to projects
to share with specific projects, or set to organization
to share with the entire organization.
PROJECTS
: a list of project IDs or project numbers to share the node group with. Only required if you set SHARE_SETTING
to SPECIFIC_PROJECTS
.
To stop sharing a node group with other projects or the entire organization, use the gcloud CLI or REST.
Permissions required for this taskTo perform this task, you must have the following permissions:
compute.nodeGroups.update
permissions on the project in which you created the node groupIn the Google Cloud console, go to the Sole-tenant nodes page.
Click the Name of the node group.
In Overview > Shared with, click Edit edit.
To stop sharing, choose Do not share this node group with other projects.
To stop sharing a node group with other projects or the entire organization, use the following gcloud compute sole-tenancy node-groups update
command.
gcloud compute sole-tenancy node-groups update NODE_GROUP \ --zone=ZONE \ --share-setting=local
Replace the NODE_GROUP
with the name of the node group to stop sharing.
To stop sharing a node group with other projects or the entire organization, use the following nodeGroups.patch
method.
PATCH https://compute.googleapis.com/compute/v1/projects/PROJECT/zones/ZONE/nodeGroups/NODE_GROUP { "shareSettings": { "shareType": LOCAL } }
Replace the following:
PROJECT
: the name of the project with the node group to stop sharing
ZONE
: the zone containing the node group to stop sharing
NODE_GROUP
: the name of the node group to stop sharing
To delete a shared node group from the owning project, use the Google Cloud console, gcloud CLI, or REST. Before deleting a node group, stop all VMs that are running in the node group.
Permissions required for this taskTo perform this task, you must have the following permissions:
compute.nodeGroups.delete
permissions on the project in which you created the node groupIn the Google Cloud console, go to the Sole-tenant nodes page.
In the Name column, click the name of the node group.
Click Delete.
To delete a shared node group from the owning project, use the following gcloud compute sole-tenancy node-groups delete
command.
gcloud compute sole-tenancy node-groups delete NODE_GROUP
Replace NODE_GROUP
with the name of the node group to delete.
To delete a shared node group from the owning project, use the following nodeGroups.delete
method.
DELETE https://compute.googleapis.com/compute/v1/projects/PROJECT/zones/ZONE/nodeGroups/NODE_GROUP
Replace the following:
PROJECT
: the name of the project with the node group to delete
ZONE
: the zone containing the node group to delete
NODE_GROUP
: the name of the node group to delete
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4