.TH "GCLOUD_ALPHA_METASTORE_SERVICES_CREATE" 1



.SH "NAME"
.HP
gcloud alpha metastore services create \- create a Dataproc Metastore service



.SH "SYNOPSIS"
.HP
\f5gcloud alpha metastore services create\fR (\fISERVICE\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-async\fR] [\fB\-\-autoscaling\-enabled\fR] [\fB\-\-data\-catalog\-sync\fR] [\fB\-\-database\-type\fR=\fIDATABASE_TYPE\fR;\ default="mysql"] [\fB\-\-deletion\-protection\fR] [\fB\-\-endpoint\-protocol\fR=\fIENDPOINT_PROTOCOL\fR;\ default="thrift"] [\fB\-\-hive\-metastore\-version\fR=\fIHIVE_METASTORE_VERSION\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-port\fR=\fIPORT\fR;\ default=9083] [\fB\-\-release\-channel\fR=\fIRELEASE_CHANNEL\fR;\ default="stable"] [\fB\-\-tags\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-auxiliary\-versions\fR=[\fIAUXILIARY_VERSIONS\fR,...]\ |\ \fB\-\-auxiliary\-versions\-from\-file\fR=\fIAUXILIARY_VERSIONS_FROM_FILE\fR] [\fB\-\-consumer\-subnetworks\fR=[\fICONSUMER_SUBNETWORKS\fR,...]\ |\ \fB\-\-network\fR=\fINETWORK\fR\ |\ \fB\-\-network\-config\-from\-file\fR=\fINETWORK_CONFIG_FROM_FILE\fR] [\fB\-\-encryption\-kms\-key\fR=\fIENCRYPTION_KMS_KEY\fR\ |\ \fB\-\-encryption\-kms\-keys\fR=[\fIENCRYPTION_KMS_KEYS\fR,...]] [\fB\-\-hive\-metastore\-configs\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ |\ \fB\-\-hive\-metastore\-configs\-from\-file\fR=\fIPATH_TO_FILE\fR] [\fB\-\-instance\-size\fR=\fIINSTANCE_SIZE\fR\ |\ \fB\-\-scaling\-factor\fR=\fISCALING_FACTOR\fR\ |\ \fB\-\-tier\fR=\fITIER\fR\ |\ \fB\-\-max\-scaling\-factor\fR=\fIMAX_SCALING_FACTOR\fR\ \fB\-\-min\-scaling\-factor\fR=\fIMIN_SCALING_FACTOR\fR] [\fB\-\-kerberos\-principal\fR=\fIKERBEROS_PRINCIPAL\fR\ \fB\-\-keytab\fR=\fIKEYTAB\fR\ \fB\-\-krb5\-config\fR=\fIKRB5_CONFIG\fR] [\fB\-\-maintenance\-window\-day\fR=\fIMAINTENANCE_WINDOW_DAY\fR\ \fB\-\-maintenance\-window\-hour\fR=\fIMAINTENANCE_WINDOW_HOUR\fR] [\fB\-\-read\-only\-regions\fR=[\fIREAD_ONLY_REGIONS\fR,...]\ \fB\-\-read\-write\-regions\fR=[\fIREAD_WRITE_REGIONS\fR,...]] [\fB\-\-scheduled\-backup\-configs\-from\-file\fR=\fIPATH_TO_FILE\fR\ |\ \fB\-\-enable\-scheduled\-backup\fR\ \fB\-\-scheduled\-backup\-cron\fR=\fISCHEDULED_BACKUP_CRON\fR\ \fB\-\-scheduled\-backup\-location\fR=\fISCHEDULED_BACKUP_LOCATION\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Create a new Dataproc Metastore service with the given name and
configurations.

If run asynchronously with \f5\-\-async\fR, exits after printing one operation
name that can be used to poll the status of the creation via:

.RS 2m
gcloud metastore operations describe
.RE



.SH "EXAMPLES"

To create a Dataproc Metastore service with the name
\f5my\-metastore\-service\fR in location \f5us\-central\fR using a non default
port 9090, run:

.RS 2m
$ gcloud alpha metastore services create my\-metastore\-service \e
  \-\-location=us\-central1 \-\-port=9090
.RE

To create a Dataproc Metastore service with the name
\f5my\-metastore\-service\fR in location \f5us\-central\fR using a non default
network foo, run:

.RS 2m
$ gcloud alpha metastore services create my\-metastore\-service \e
  \-\-location=us\-central1 \-\-network=foo
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Service resource \- Arguments and flags that specify the Dataproc Metastore
service you want to create. The arguments in this group can be used to specify
the attributes of this resource. (NOTE) Some attributes are not given arguments
in this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5service\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fISERVICE\fR

ID of the service or fully qualified identifier for the service.

To set the \f5service\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5service\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

The location of the Dataproc Metastore service.

If not specified, will use \f5default\fR metastore/location.


To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5service\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line;
.IP "\(bu" 2m
set the property \f5metastore/location\fR.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-autoscaling\-enabled\fR

A boolean flag to determine whether Dataproc Metastore autoscaling should be
enabled, false if unspecified.

The default minimum and maximum scaling factors are 0.1 and 6.0, respectively.

The minimum and maximum scaling factors can be specified using
\-\-min\-scaling\-factor and \-\-max\-scaling\-factor.

.TP 2m
\fB\-\-data\-catalog\-sync\fR

A boolean flag to determine whether Dataproc Metastore metadata sync to Data
Catalog should be enabled, false if unspecified. Mutually exclusive with flag
\f5\-\-encryption\-kms\-key\fR.

.TP 2m
\fB\-\-database\-type\fR=\fIDATABASE_TYPE\fR; default="mysql"

The type of database the Dataproc Metastore service will store data in.
\fIDATABASE_TYPE\fR must be one of:

.RS 2m
.TP 2m
\fBmysql\fR
\f5MYSQL\fR database type is a Dataproc Metastore service backed by MySQL
CloudSQL.

.TP 2m
\fBspanner\fR
\f5SPANNER\fR database type is a Dataproc Metastore service backed by Cloud
Spanner.

.RE
.sp


.TP 2m
\fB\-\-deletion\-protection\fR

Flag that enables delete protection on Dataproc Metastore instance to prevent
accidental deletions of the instance. Use \-\-deletion\-protection to enable.

.TP 2m
\fB\-\-endpoint\-protocol\fR=\fIENDPOINT_PROTOCOL\fR; default="thrift"

The protocol to use for the metastore service endpoint. If unspecified, defaults
to \f5THRIFT\fR. \fIENDPOINT_PROTOCOL\fR must be one of:

.RS 2m
.TP 2m
\fBgrpc\fR
The modernized \f5GRPC\fR protocol.

.TP 2m
\fBthrift\fR
The legacy Apache \f5THRIFT\fR protocol.

.RE
.sp


.TP 2m
\fB\-\-hive\-metastore\-version\fR=\fIHIVE_METASTORE_VERSION\fR

The Hive metastore schema version. The supported versions of a location are
listed via:

.RS 2m
gcloud metastore locations describe
.RE

If unspecified, the default version chosen by the server will be used.

.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to add.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m
\fB\-\-port\fR=\fIPORT\fR; default=9083

The TCP port on which the Metastore service will listen. If unspecified, the
default port 9083 will be used.

.TP 2m
\fB\-\-release\-channel\fR=\fIRELEASE_CHANNEL\fR; default="stable"

The release channel of the service. \fIRELEASE_CHANNEL\fR must be one of:

.RS 2m
.TP 2m
\fBcanary\fR
The \f5CANARY\fR release channel contains the newest features, which may be
unstable and subject to unresolved issues with no known workarounds. Services
using the \f5CANARY\fR release channel are not subject to any SLAs.

.TP 2m
\fBstable\fR
The \f5STABLE\fR release channel contains features that are considered stable
and have been validated for production use.

.RE
.sp


.TP 2m
\fB\-\-tags\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of tag KEY=VALUE pairs to add.

.TP 2m

Auxiliary versions configuration for the Dataproc Metastore service. When
specified, a secondary Hive metastore service is created along with the primary
service.


At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-auxiliary\-versions\fR=[\fIAUXILIARY_VERSIONS\fR,...]

Comma\-separated list of auxiliary Hive metastore versions to deploy. Auxiliary
Hive metastore versions must be less than the primary Hive metastore service's
version.

.TP 2m
\fB\-\-auxiliary\-versions\-from\-file\fR=\fIAUXILIARY_VERSIONS_FROM_FILE\fR

Path to a YAML file containing the auxiliary versions configuration for Dataproc
Metastore instance. The file should contain a unique auxiliary service name and
auxiliary version that is lower than the primary service version. The primary
version's Hive metastore configs are applied to the auxiliary version.
Additional Hive metastore configs can be specified for the auxiliary version
using "config_overrides". If a specified config property has already been
overridden in the primary Hive metastore version's configs, the auxiliary
version's override takes precedence. The contents of the file should be
structured as follows:

YAML:

.RS 2m
  \- name: aux\-service1
    version: x.y.z
    config_overrides:
      key1: value1
      key2: value2
    ...
  \- name: aux\-service2
    version: x.y.z
    config_overrides:
      key1: value1
      key2: value2
    ...
  ...
.RE

.RE
.sp
.TP 2m

Network configuration for the metastore service.


At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-consumer\-subnetworks\fR=[\fICONSUMER_SUBNETWORKS\fR,...]

The list of subnetworks from which the service can be accessed. This can be the
subnetwork's ID, fully\-qualified URL, or relative name in the form
\f5projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork}\fR.

.TP 2m
\fB\-\-network\fR=\fINETWORK\fR

The name of the network on which the service can be accessed. This can be the
network's ID, fully\-qualified URL, or relative name in the form
\f5projects/{project_id}/global/networks/{network}\fR. If "network",
"consumer\-subnetworks" and "network\-config" are unspecified, the "default"
network will be used.

.TP 2m
\fB\-\-network\-config\-from\-file\fR=\fINETWORK_CONFIG_FROM_FILE\fR

Path to a YAML file containing the network configuration for Dataproc Metastore
instance. The contents of the file should be structured as follows:

YAML: consumers:
.RS 2m
.IP "\(bu" 2m
subnetwork:
projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id}
.IP "\(bu" 2m
subnetwork:
projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id} ...
.RE
.sp

.RE
.sp
.TP 2m

Encryption configuration for the metastore service.


At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-encryption\-kms\-key\fR=\fIENCRYPTION_KMS_KEY\fR

The name of the Cloud KMS key to use for customer data encryption. Cannot be
changed once the service is created. Mutually exclusive with flag
\f5\-\-data\-catalog\-sync\fR. This can be provided as a fully\-qualified URL,
or a relative name in the form
\f5projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}\fR.

.TP 2m
\fB\-\-encryption\-kms\-keys\fR=[\fIENCRYPTION_KMS_KEYS\fR,...]

Comma\-separated list of the Cloud KMS keys to use for customer data encryption.
Cannot be changed once the service is created. Mutually exclusive with flag
\f5\-\-data\-catalog\-sync\fR and \f5\-\-encryption\-kms\-key\fR. Each key can
be provided as a fully\-qualified URL, or a relative name in the form
\f5projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}\fR.

.RE
.sp
.TP 2m

Configuration properties specific to running Hive metastore software as the
metastore service.


At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-hive\-metastore\-configs\fR=[\fIKEY\fR=\fIVALUE\fR,...]

A mapping of Hive metastore configuration key\-value pairs to apply to the Hive
metastore.

.TP 2m
\fB\-\-hive\-metastore\-configs\-from\-file\fR=\fIPATH_TO_FILE\fR

Path to a XML file containing a mapping of Hive metastore configuration
key\-value pairs to apply to the Hive metastore.

For example:

.RS 2m
hive\-site.xml
    <configuration>
      <property>
        <name>hive.metastore.warehouse.dir</name>
        <value>${test.warehouse.dir}</value>
        <description></description>
      </property>
    </configuration>
.RE

Use a full or relative path to a local file containing the value of
hive_metastore_configs.

.RE
.sp
.TP 2m

The instance size of the Dataproc Metastore instance.


At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-instance\-size\fR=\fIINSTANCE_SIZE\fR

The instance size of the service. \fIINSTANCE_SIZE\fR must be one of:

.RS 2m
.TP 2m
\fBextra\-large\fR
Extra large instance size, maps to a scaling factor of 6.0.

.TP 2m
\fBextra\-small\fR
Extra small instance size, maps to a scaling factor of 0.1.

.TP 2m
\fBlarge\fR
Large instance size, maps to a scaling factor of 3.0.

.TP 2m
\fBmedium\fR
Medium instance size, maps to a scaling factor of 1.0.

.TP 2m
\fBsmall\fR
Small instance size, maps to a scaling factor of 0.5.

.RE
.sp


.TP 2m
\fB\-\-scaling\-factor\fR=\fISCALING_FACTOR\fR

The scaling factor of the service. Can be one of [0.1, 0.2, 0.3, 0.4, 0.5, 0.6,
0.7, 0.8, 0.9, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0].

.TP 2m
\fB\-\-tier\fR=\fITIER\fR

The tier of the service. \fITIER\fR must be one of:

.RS 2m
.TP 2m
\fBdeveloper\fR
The developer tier provides limited scalability and no fault tolerance. Good for
low\-cost proof\-of\-concept.

.TP 2m
\fBenterprise\fR
The enterprise tier provides multi\-zone high availability, and sufficient
scalability for enterprise\-level Dataproc Metastore workloads.

.RE
.sp


.TP 2m

The autoscaling configuration of the Dataproc Metastore instance.



.RS 2m
.TP 2m
\fB\-\-max\-scaling\-factor\fR=\fIMAX_SCALING_FACTOR\fR

The maximum scaling factor allowed by the autoscaler. Can be one of [0.1, 0.2,
0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0]. The default
value is 6.0.

.TP 2m
\fB\-\-min\-scaling\-factor\fR=\fIMIN_SCALING_FACTOR\fR

The minimum scaling factor allowed by the autoscaler. Can be one of [0.1, 0.2,
0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0]. The default
value is 0.1.

.RE
.RE
.sp
.TP 2m

Information used to configure the Hive metastore service as a service principal
in a Kerberos realm.



.RS 2m
.TP 2m
\fB\-\-kerberos\-principal\fR=\fIKERBEROS_PRINCIPAL\fR

A Kerberos principal that exists in the KDC to authenticate as. A typical
principal is of the form "primary/instance@REALM", but there is no exact format.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-keytab\fR=\fIKEYTAB\fR

A Kerberos keytab file that can be used to authenticate a service principal with
a Kerberos Key Distribution Center. This is a Secret Manager secret version, and
can be fully\-qualified URL, or relative name in the form
\f5projects/{project_id}/secrets/{secret_id}/versions/{version_id}\fR.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-krb5\-config\fR=\fIKRB5_CONFIG\fR

A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the
form gs://{bucket_name}/path/krb5.conf, although the file does not need to be
named krb5.conf explicitly.

This flag argument must be specified if any of the other arguments in this group
are specified.

.RE
.sp
.TP 2m

The one hour maintenance window that specifies when Dataproc Metastore may
perform system maintenance operation to the service, in UTC time.



.RS 2m
.TP 2m
\fB\-\-maintenance\-window\-day\fR=\fIMAINTENANCE_WINDOW_DAY\fR

The day of week when the window starts, e.g., \f5sun\fR.
\fIMAINTENANCE_WINDOW_DAY\fR must be one of: \fBfri\fR, \fBmon\fR, \fBsat\fR,
\fBsun\fR, \fBthu\fR, \fBtue\fR, \fBwed\fR.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-maintenance\-window\-hour\fR=\fIMAINTENANCE_WINDOW_HOUR\fR

The hour of day (0\-23) when the window starts.

This flag argument must be specified if any of the other arguments in this group
are specified.

.RE
.sp
.TP 2m

Custom region configuration for the metastore service.



.RS 2m
.TP 2m
\fB\-\-read\-only\-regions\fR=[\fIREAD_ONLY_REGIONS\fR,...]

The list of read\-only regions where the metastore service runs in. These
regions should be part (or subset) of the multi\-region.

.TP 2m
\fB\-\-read\-write\-regions\fR=[\fIREAD_WRITE_REGIONS\fR,...]

The list of read\-write regions where the metastore service runs in. These
regions should be part (or subset) of the multi\-region.

.RE
.sp
.TP 2m

Scheduled backup configurations to enable a scheduled backup of the metastore
service.


At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-scheduled\-backup\-configs\-from\-file\fR=\fIPATH_TO_FILE\fR

Path to a JSON file containing a mapping of scheduled backup configurations
key\-value pairs to apply to the scheduled backup.

For example:

.RS 2m
backup_configs.json
    {
      "enabled": true,
      "cron_schedule": "0 * * * *",
      "backup_location": "gs://example\-bucket",
      "time_zone": "UTC"
    }
.RE

Use a full or relative path to a local file containing the value of
scheduled_backup_configs.

.TP 2m

Scheduled backup configurations to enable a scheduled backup of the metastore
service.



.RS 2m
.TP 2m
\fB\-\-enable\-scheduled\-backup\fR

Enable or disable scheduled backups for the Metastore service.

.TP 2m
\fB\-\-scheduled\-backup\-cron\fR=\fISCHEDULED_BACKUP_CRON\fR

Specify the frequency of a scheduled backup of the metastore service.

.TP 2m
\fB\-\-scheduled\-backup\-location\fR=\fISCHEDULED_BACKUP_LOCATION\fR

Set the Cloud Storage URI to store the scheduled backups of the metastore
service.


.RE
.RE
.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBmetastore/v1alpha\fR API. The full documentation for
this API can be found at: https://cloud.google.com/dataproc\-metastore/docs



.SH "NOTES"

This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. These variants are also available:

.RS 2m
$ gcloud metastore services create
.RE

.RS 2m
$ gcloud beta metastore services create
.RE