Viewing: docs.cloud.google.com

Once you've created an instance, Google Cloud Managed Lustre lets you list, get, update, and delete instances.

Instance states

A Managed Lustre instance can be in any of the following states:

State	Description
`CREATING`	The instance is being created and is not yet ready for use.
`ACTIVE`	The instance is available for use.
`REPAIRING`	The instance is being repaired.
`MAINTENANCE` or `UPGRADING`	The instance is undergoing maintenance. See Maintenance events and policies. for more information.
`SUSPENDED`	The instance is suspended, typically due to an issue with a. customer-managed encryption key (CMEK).
`DELETING`	The instance is being deleted.

List instances

To list all the instances in a project:

Google Cloud console

Go to the Managed Lustre page in the Google Cloud console.

Go to Managed Lustre

Your project's instances are listed.

gcloud CLI

Use the gcloud lustre instances list command:

gcloud lustre instances list --location=LOCATION

Replace LOCATION with a specific zone to list all instances in that location. To view projects in all locations, enter - as the value. For example:

gcloud lustre instances list --location=-

REST

To list instances using the REST API, send a request to the following endpoint:

GET https://lustre.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/instances
Authorization: Bearer [YOUR_ACCESS_TOKEN]

Where the following values must be specified:

PROJECT_ID is your Google Cloud project ID.
ZONE is the zone for which to list all instances. To list instances from all zones, use - as the value.

See the instances.list API reference for more details.

Get an instance

To get an instance's details:

Google Cloud console

Go to the Managed Lustre page in the Google Cloud console.

Go to Managed Lustre
Click the instance name to view details about a specific instance.

gcloud CLI

Use the gcloud lustre instances describe command:

gcloud lustre instances describe INSTANCE_NAME --location=LOCATION

REST

To get details about a particular instance using the REST API, send a request to the following endpoint:

GET https://lustre.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/instances/INSTANCE_NAME
Authorization: Bearer [YOUR_ACCESS_TOKEN]

Where the following values must be specified:

PROJECT_ID is your Google Cloud project ID.
ZONE must be a valid Google Cloud zone that is supported by Managed Lustre. See Supported locations for a full list.
INSTANCE_NAME is the name of the Managed Lustre instance to return.

See the instances.get API reference for more details.

Update an instance

You can update the following properties of an existing instance:

Description
Labels
Storage capacity
Maintenance policy

For information about increasing an instance's storage capacity, see Increase the capacity of an instance.

For information about configuring maintenance policies, see Maintenance events and policies.

To update an instance:

Google Cloud console

Go to the Managed Lustre page in the Google Cloud console.

Go to Managed Lustre
Click the Instance name of the instance to update. The instance overview page is displayed.
Click Edit.
Enter the new value(s).
Click Submit.

gcloud CLI

Use the gcloud lustre instances update command:

gcloud lustre instances update INSTANCE_NAME \
  --location=LOCATION \
  --capacity-gib=NEW_CAPACITY \
  --description=NEW_DESCRIPTION \
  --maintenance-policy-weekly-windows=dayOfWeek=DAY,startTime={START_TIME}

Where:

INSTANCE_NAME is the instance to update.
LOCATION is the zone in which the instance resides.
NEW_CAPACITY is the new storage capacity for this instance in gibibytes (GiB). The value cannot exceed the maximum allowed capacity and must be a multiple of the step size. See Increase the capacity of an instance for more details.
NEW_DESCRIPTION is a new value for the description field, which overwrites any existing description.
DAY: The day of the week for the maintenance window (e.g., TUESDAY).
START_TIME: The UTC start time of the maintenance window in dictionary format (e.g., {hours=1,minutes=0}).

To update labels, see the available commands in the gcloud lustre instances update documentation.

REST

To update an instance using the REST API, send a PATCH request to its specific endpoint:

PATCH https://lustre.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/instances/INSTANCE_NAME?updateMask=UPDATE_MASK
Authorization: Bearer [YOUR_ACCESS_TOKEN]

{
  "capacityGib": 72000,
  "description": "updated description",
  "labels": {
    "key1": "value1"
  },
  "maintenancePolicy": {
    "weeklyMaintenanceWindows": [
      {
        "dayOfWeek": "DAY",
        "startTime": {
          "hours": HOURS,
          "minutes": MINUTES
        }
      }
    ]
  }
}

Where the following values must be specified:

PROJECT_ID is your Google Cloud project ID.
ZONE is the instance's Google Cloud zone.
INSTANCE_NAME is the name of the Managed Lustre instance to update.
UPDATE_MASK is a comma-separated list of fields to update. A field will only be overwritten if it is in the mask.

The request body must contain one or more of the following fields:

capacityGiB is the new storage capacity for this instance in gibibytes (GiB). The value cannot exceed the maximum allowed capacity and must be a multiple of the step size. See Increase the capacity of an instance for more details.
description is the new description for this instance.
labels is the new set of labels for this instance. The value of labels is a JSON object containing one or more key:value pairs.
maintenancePolicy is the maintenance policy for the instance. See Maintenance events and policies for details.

See the instances.patch API reference for more details.

Unable to queue operation

If you see an error similar to the following when attempting to update an instance:

ERROR: (gcloud.lustre.instances.update) ABORTED: unable to queue the operation

This error occurs when you attempt to start an operation while another operation of the same type is already in progress on the same instance. Managed Lustre allows one active update per instance at a time, and allows an additional update operation to be queued.

To resolve this issue, wait for the current operation to complete before starting a new one.

Delete an instance

To delete an instance:

Google Cloud console

Go to the Managed Lustre page in the Google Cloud console.

Go to Managed Lustre
Select the three-dot menu next to the instance to delete.
Select Delete instance. Confirm the deletion by clicking Delete again.

gcloud CLI

Use the gcloud lustre instances delete command:

gcloud lustre instances delete INSTANCE_NAME --location=LOCATION

You are prompted to confirm deletion. Type Y or press enter to continue.

Tip: Specifying the --quiet or -q flag with the command skips the interactive confirmation requirement.

REST

To delete an instance using the REST API, send a request to the following endpoint:

DELETE https://lustre.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/instances/INSTANCE_NAME
Authorization: Bearer [YOUR_ACCESS_TOKEN]

Where the following values must be specified:

PROJECT_ID is your Google Cloud project ID.
ZONE is the Google Cloud zone in which the instance is located.
INSTANCE_NAME is the name of the Managed Lustre instance to delete.

See the instances.delete API reference for more details.

Delete requests are long-running requests, and return an operation ID that can be queried for operation status. See the operations.get reference for details.

Manage Google Cloud Managed Lustre instances Stay organized with collections Save and categorize content based on your preferences.

Instance states

List instances

Google Cloud console

gcloud CLI

REST

Get an instance

Google Cloud console

gcloud CLI

REST

Update an instance

Google Cloud console

gcloud CLI

REST

Unable to queue operation

Delete an instance

Google Cloud console

gcloud CLI

REST

Products and pricing

Support

Resources

Engage