Parallelstore can import data from, and export data to, Cloud Storage. Data transfers allow you to quickly load data into your Parallelstore instance, and to use Cloud Storage as a durable backing layer for your Parallelstore instance.
Data imports and exports are incremental; they only copy files that don't already exist in the destination, or that have changed since they were transferred.
For expected transfer speeds, see Performance .
Required permissions
The user or service account used for initiating the transfer requires the following permissions:
-
parallelstore.instances.exportData
in order to transfer from Parallelstore to Cloud Storage. -
parallelstore.instances.importData
in order to transfer to Cloud Storage.
Both of these permissions are granted with the roles/parallelstore.admin
role. You can create a custom role
to grant permissions independently.
In addition, the Parallelstore service account requires the following permission:
-
roles/storage.admin
on the Cloud Storage bucket.
To grant this permission, run the following gcloud
command:
gcloud
storage
buckets
add-iam-policy-binding
gs:// BUCKET_NAME
\
--member =
serviceAccount:service- PROJECT_NUMBER
@gcp-sa-parallelstore.iam.gserviceaccount.com
\
--role =
roles/storage.admin
Your PROJECT_NUMBER is not the same as a project ID :
- A project ID
is a unique string that can be a combination of letters,
numbers, and hyphens. You specify a project ID when creating your
project. For example,
example-project-123
. - A project number
is an automatically generated unique identifier for your
project that consists only of numbers. For example,
1234567890
.
To obtain the PROJECT_NUMBER
for a given project ID, use the gcloud projects describe
command:
gcloud
projects
describe
PROJECT_ID
--format =
"value(projectNumber)"
Import data to Parallelstore
You can import data from a Cloud Storage bucket. The bucket can be in the same or a different project. The bucket can be in a different zone or region from your Parallelstore instance, but inter-region transfers might be slower than intra-region transfers.
gcloud
gcloud
beta
parallelstore
instances
import-data
INSTANCE_ID
\
--location =
LOCATION
\
--source-gcs-bucket-uri =
gs:// BUCKET_NAME
\
--destination-parallelstore-path =
PS_PATH
Where:
- INSTANCE_ID is your Parallelstore instance name.
-
--location
must be a supported zone . -
--source-gcs-bucket-uri
specifies the URI to a Cloud Storage bucket, or a path within a bucket, using the formatgs://<bucket_name>/<optional_path_inside_bucket>
. -
--destination-parallelstore-path
specifies the root directory path to the Parallelstore file system. Must start with/
. Default is/
.
The following parameters are optional:
-
--request-id
allows you to assign a unique ID to this request. If you retry this request using the same request ID, the server will ignore the request if it has already been completed. Must be a valid UUID that is not all zeros. For example:--request-id=c288b55f-f2f0-45fe-a8ce-8afe43876d6d
-
--async
returns a response immediately, without waiting for the operation to complete.
REST
POST
h
tt
ps
:
//parallelstore.googleapis.com/v1beta/projects/ PROJECT_ID
/locations/ LOCATION
/instances/ INSTANCE_ID
:importData
Au
t
horiza
t
io
n
:
Bearer
[
YOUR_ACCESS_TOKEN
]
{
"source_gcs_bucket"
:
{
"uri"
:
"gs:// BUCKET_NAME
/"
},
"destination_parallelstore"
:
{
"path"
:
"/ PATH
"
}
}
Where:
- PROJECT_ID is your Google Cloud project ID.
- LOCATION must be the supported zone in which your instance resides.
- INSTANCE_ID is your Parallelstore instance name.
-
source-gcs-bucket
contains auri
key whose value specifies the URI to a Cloud Storage bucket, or a path within a bucket, using the formatgs://<bucket_name>/<optional_path_inside_bucket>
. -
destination-parallelstore
contains apath
key whose value specifies the root directory path to the Parallelstore file system. Must start with/
. Default is/
.
To use your own service account instead of the Google-managed service
agent, the request supports a serviceAccount
field in the JSON object:
"serviceAccount"
:
"projects/ PROJECT_ID
/serviceAccounts/ SERVICE_ACCOUNT_ID
"
An example cURL command looks like:
curl
-X
POST
\
-H
"Authorization: Bearer
$(
gcloud
auth
print-access-token )
"
\
-H
"Content-Type: application/json"
\
https://parallelstore.googleapis.com/v1beta/projects/ PROJECT_ID
/locations/ LOCATION
/instances/ INSTANCE_ID
:importData
\
-d
'{"source_gcs_bucket": {"uri":"gs:// BUCKET_NAME
/"}, "destination_parallelstore": {"path":"/"}}'
Export data
You can export data from your Parallelstore instance to a Cloud Storage bucket in the same or a different project. The bucket can be in a different zone or region from your Parallelstore instance, but inter-region transfers might be slower than intra-region transfers.
gcloud
gcloud
beta
parallelstore
instances
export-data
\
INSTANCE_ID
\
--location =
LOCATION
\
--destination-gcs-bucket-uri =
"gs:// BUCKET_NAME
"
\
--source-parallelstore-path =
"/"
Where:
- INSTANCE_ID is your Parallelstore instance name.
-
--location
must be a supported zone . -
--destination-gcs-bucket-uri
specifies the URI to a Cloud Storage bucket, or a path within a bucket, using the formatgs://<bucket_name>/<optional_path_inside_bucket>
. -
--source-parallelstore-path
specifies the root directory path to the Parallelstore file system. Must start with/
. Default is/
.
The following parameters are optional:
-
--request-id
allows you to assign a unique ID to this request. If you retry this request using the same request ID, the server will ignore the request if it has already been completed. Must be a valid UUID that is not all zeros. For example:--request-id=c288b55f-f2f0-45fe-a8ce-8afe43876d6d
-
--async
returns a response immediately, without waiting for the operation to complete.
REST
POST
h
tt
ps
:
//parallelstore.googleapis.com/v1beta/projects/ PROJECT_ID
/locations/ LOCATION
/instances/ INSTANCE_ID
:exportData
Au
t
horiza
t
io
n
:
Bearer
[
YOUR_ACCESS_TOKEN
]
{
"source_parallelstore"
:
{
"path"
:
"/"
},
"destination_gcs_bucket"
:
{
"uri"
:
"gs:// BUCKET_NAME
/"
}
}
Where:
- PROJECT_ID is your Google Cloud project ID.
- INSTANCE_ID is your Parallelstore instance name.
- LOCATION must be the supported zone in which your Parallelstore instance resides.
-
--source-parallelstore
contains apath
key whose value specifies the root directory path to the Parallelstore file system. Must start with/
. Default is/
. -
--destination-gcs-bucket
contains auri
key whose value specifies the URI to a Cloud Storage bucket, or a path within a bucket, using the formatgs://<bucket_name>/<optional_path_inside_bucket>
.
To use your own service account instead of the Google-managed service
agent, the request supports a serviceAccount
field in the JSON object:
"serviceAccount"
:
"projects/ PROJECT_ID
/serviceAccounts/ SERVICE_ACCOUNT_ID
"
An example cURL command looks like:
curl
-X
POST
\
-H
"Authorization: Bearer
$(
gcloud
auth
print-access-token )
"
\
-H
"Content-Type: application/json"
https://parallelstore.googleapis.com/v1beta/projects/ PROJECT_ID
/locations/ LOCATION
/instances/ INSTANCE_ID
:exportData
\
-d
'{"source_parallelstore": {"path":"/"}, "destination_gcs_bucket": {"uri":"gs:// BUCKET_NAME
/"}}'
Get operation
To see the status of an import or export operation, you'll need the operation ID. This ID is returned by the service when you make an import or export request, and uses the following format:
-
operation-1234567890123-6127783ad26ea-88913969-02748053
gcloud
gcloud
beta
parallelstore
operations
describe
OPERATION_ID
\
--location =
LOCATION
REST
GET
h
tt
ps
:
//parallelstore.googleapis.com/v1beta/projects/ PROJECT_ID
/locations/ LOCATION
/operations/ OPERATION_ID
Au
t
horiza
t
io
n
:
Bearer
[
YOUR_ACCESS_TOKEN
]
An example cURL command looks like:
curl
-X
GET
\
-H
"Authorization: Bearer
$(
gcloud
auth
print-access-token )
"
\
-H
"Content-Type: application/json"
\
https://parallelstore.googleapis.com/v1beta/projects/ PROJECT_ID
/locations/ LOCATION
/operations/ OPERATION_ID
Cancel operation
To cancel an import or export operation, you'll need the operation ID. This ID is returned by the service when you make an import or export request, and uses the following format:
-
operation-1234567890123-6127783ad26ea-88913969-02748053
gcloud
gcloud
beta
parallelstore
operations
cancel
OPERATION_ID
\
--location =
LOCATION
REST
POST
h
tt
ps
:
//parallelstore.googleapis.com/v1beta/projects/ PROJECT_ID
/locations/ LOCATION
/operations/ OPERATION_ID
:cancel
Au
t
horiza
t
io
n
:
Bearer
[
YOUR_ACCESS_TOKEN
]
An example cURL command looks like:
curl
-X
POST
\
-H
"Authorization: Bearer
$(
gcloud
auth
print-access-token )
"
\
-H
"Content-Type: application/json"
\
https://parallelstore.googleapis.com/v1beta/projects/ PROJECT_ID
/locations/ LOCATION
/operations/ OPERATION_ID
:cancel