.TH "GCLOUD_AI_INDEX\-ENDPOINTS_DEPLOY\-INDEX" 1



.SH "NAME"
.HP
gcloud ai index\-endpoints deploy\-index \- deploy an index to a Vertex AI index endpoint



.SH "SYNOPSIS"
.HP
\f5gcloud ai index\-endpoints deploy\-index\fR (\fIINDEX_ENDPOINT\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) \fB\-\-deployed\-index\-id\fR=\fIDEPLOYED_INDEX_ID\fR \fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR \fB\-\-index\fR=\fIINDEX\fR [\fB\-\-allowed\-issuers\fR=[\fIALLOWED_ISSUERS\fR,...]] [\fB\-\-audiences\fR=[\fIAUDIENCES\fR,...]] [\fB\-\-deployment\-group\fR=\fIDEPLOYMENT_GROUP\fR] [\fB\-\-enable\-access\-logging\fR] [\fB\-\-machine\-type\fR=\fIMACHINE_TYPE\fR] [\fB\-\-max\-replica\-count\fR=\fIMAX_REPLICA_COUNT\fR] [\fB\-\-min\-replica\-count\fR=\fIMIN_REPLICA_COUNT\fR] [\fB\-\-psc\-automation\-configs\fR=[\fInetwork\fR=\fINETWORK\fR],[\fIproject\-id\fR=\fIPROJECT\-ID\fR]] [\fB\-\-reserved\-ip\-ranges\fR=[\fIRESERVED_IP_RANGES\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Deploy an index to a Vertex AI index endpoint.



.SH "EXAMPLES"

To deploy index \f5\fI345\fR\fR to an index endpoint \f5\fI456\fR\fR with 2 min
replica count and 10 max replica count under project \f5\fIexample\fR\fR in
region \f5\fIus\-central1\fR\fR, within reserved ip ranges
\f5\fIvertex\-ai\-ip\-range\-1\fR\fR and \f5\fIvertex\-ai\-ip\-range\-2\fR\fR
run:

.RS 2m
$ gcloud ai index\-endpoints deploy\-index 456 \-\-project=example \e
    \-\-region=us\-central1 \-\-index=345 \e
    \-\-deployed\-index\-id=deployed\-index\-345 \e
    \-\-display\-name=deployed\-index\-345 \-\-min\-replica\-count=2 \e
    \-\-max\-replica\-count=10 \e
    \-\-reserved\-ip\-ranges=vertex\-ai\-ip\-range\-1,vertex\-ai\-ip\-range\-2
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Index endpoint resource \- The index endpoint to deploy an index. 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 \f5index_endpoint\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
\fIINDEX_ENDPOINT\fR

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

To set the \f5name\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5index_endpoint\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\-\-region\fR=\fIREGION\fR

Cloud region for the index_endpoint.

To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5index_endpoint\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-region\fR on the command line;
.IP "\(bu" 2m
set the property \f5ai/region\fR;
.IP "\(bu" 2m
choose one from the prompted list of available regions.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-deployed\-index\-id\fR=\fIDEPLOYED_INDEX_ID\fR

Id of the deployed index.

.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

Display name of the deployed index.

.TP 2m
\fB\-\-index\fR=\fIINDEX\fR

ID of the index.


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-allowed\-issuers\fR=[\fIALLOWED_ISSUERS\fR,...]

List of allowed JWT issuers for a deployed index.

Each entry must be a valid Google service account, in the following format:
\f5service\-account\-name@project\-id.iam.gserviceaccount.com\fR

.TP 2m
\fB\-\-audiences\fR=[\fIAUDIENCES\fR,...]

List of JWT audiences that are allowed to access a deployed index.

JWT containing any of these audiences
(https://tools.ietf.org/html/draft\-ietf\-oauth\-json\-web\-token\-32#section
\-4.1.3) will be accepted.

.TP 2m
\fB\-\-deployment\-group\fR=\fIDEPLOYMENT_GROUP\fR

Deployment group can be no longer than 64 characters (eg:\f5test\fR,
\f5prod\fR). If not set, we will use the \f5default\fR deployment group.

Creating deployment_groups with \f5reserved_ip_ranges\fR is a recommended
practice when the peered network has multiple peering ranges.This creates your
deployments from predictable IP spaces for easier traffic administration.

.TP 2m
\fB\-\-enable\-access\-logging\fR

If true, online prediction access logs are sent to Cloud Logging.

These logs are standard server access logs, containing information like
timestamp and latency for each prediction request.

.TP 2m
\fB\-\-machine\-type\fR=\fIMACHINE_TYPE\fR

The machine resources to be used for each node of this deployment. For available
machine types, see
https://cloud.google.com/ai\-platform\-unified/docs/predictions/machine\-types.

.TP 2m
\fB\-\-max\-replica\-count\fR=\fIMAX_REPLICA_COUNT\fR

Maximum number of machine replicas the deployed index will be always deployed
on.

.TP 2m
\fB\-\-min\-replica\-count\fR=\fIMIN_REPLICA_COUNT\fR

Minimum number of machine replicas the deployed index will be always deployed
on. If specified, the value must be equal to or larger than 1.

.TP 2m
\fB\-\-psc\-automation\-configs\fR=[\fInetwork\fR=\fINETWORK\fR],[\fIproject\-id\fR=\fIPROJECT\-ID\fR]

A pair of \f5project\-id\fR and \f5network\fR the PSC index will be deployed to.
For example:
\f5\-\-psc\-automation\-configs=project\-id=my\-project,network=my\-network\fR.
For multiple networks, this flag can be repeated:
\f5\-\-psc\-automation\-configs=project\-id=my\-project,network=my\-network
\-\-psc\-automation\-configs=project\-id=my\-project2,network=my\-network2\fR

.TP 2m
\fB\-\-reserved\-ip\-ranges\fR=[\fIRESERVED_IP_RANGES\fR,...]

List of reserved IP ranges deployed index will be deployed to.


.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 "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha ai index\-endpoints deploy\-index
.RE

.RS 2m
$ gcloud beta ai index\-endpoints deploy\-index
.RE