mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-18 14:56:05 +00:00
gcloud: Wed Jan 10 10:17:49 UTC 2024
This commit is contained in:
Automated
parent
08ad88258a
commit
5fec13c692
262 changed files with 3211 additions and 4501 deletions
239
gcloud/infra-manager/previews/create
Normal file
239
gcloud/infra-manager/previews/create
Normal file
|
|
@ -0,0 +1,239 @@
|
|||
NAME
|
||||
gcloud infra-manager previews create - create a preview
|
||||
|
||||
SYNOPSIS
|
||||
gcloud infra-manager previews create [PREVIEW]
|
||||
[--artifacts-gcs-bucket=ARTIFACTS_GCS_BUCKET] [--async]
|
||||
[--deployment=DEPLOYMENT] [--labels=[KEY=VALUE,...]]
|
||||
[--location=LOCATION] [--preview-mode=PREVIEW_MODE]
|
||||
[--service-account=SERVICE_ACCOUNT] [--worker-pool=WORKER_POOL]
|
||||
[--gcs-source=GCS_SOURCE | --git-source-directory=GIT_SOURCE_DIRECTORY
|
||||
--git-source-ref=GIT_SOURCE_REF --git-source-repo=GIT_SOURCE_REPO
|
||||
| --ignore-file=IGNORE_FILE
|
||||
--local-source=LOCAL_SOURCE --input-values=[KEY=VALUE,...]
|
||||
| --inputs-file=INPUTS_FILE] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
This command creates a preview.
|
||||
|
||||
EXAMPLES
|
||||
Create a preview named my-preview from a storage my-bucket:
|
||||
|
||||
$ gcloud infra-manager previews create \
|
||||
projects/p1/locations/us-central1/previews/my-preview \
|
||||
--gcs-source="gs://my-bucket" \
|
||||
--input-values="project=p1,region=us-central1"
|
||||
|
||||
Create a preview named my-preview from git repo
|
||||
"https://github.com/examples/repository.git", "staging/compute" folder,
|
||||
"mainline" branch:
|
||||
|
||||
$ gcloud infra-manager previews create \
|
||||
projects/p1/locations/us-central1/previews/my-preview \
|
||||
--git-source-repo="https://github.com/examples/repository.git" \
|
||||
--git-source-directory="staging/compute" \
|
||||
--git-source-ref="mainline"
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Preview resource - the preview to be used as parent. It is optional and
|
||||
will be generated if not specified with a fully specified name. This
|
||||
represents a Cloud resource. (NOTE) Some attributes are not given
|
||||
arguments in this group but can be set in other ways.
|
||||
|
||||
To set the project attribute:
|
||||
◆ provide the argument PREVIEW on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
To set the location attribute:
|
||||
◆ provide the argument PREVIEW on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --location on the command line;
|
||||
◆ set the property infra-manager/location.
|
||||
|
||||
PREVIEW
|
||||
ID of the preview or fully qualified identifier for the preview.
|
||||
|
||||
To set the preview attribute:
|
||||
▸ provide the argument PREVIEW on the command line.
|
||||
|
||||
FLAGS
|
||||
--artifacts-gcs-bucket=ARTIFACTS_GCS_BUCKET
|
||||
user-defined location of Cloud Build logs, artifacts, and Terraform
|
||||
state files in Google Cloud Storage. Format: gs://{bucket}/{folder} A
|
||||
default bucket will be bootstrapped if the field is not set or empty
|
||||
|
||||
--async
|
||||
Return immediately, without waiting for the operation in progress to
|
||||
complete.
|
||||
|
||||
--deployment=DEPLOYMENT
|
||||
Deployment reference for preview.
|
||||
|
||||
--labels=[KEY=VALUE,...]
|
||||
Labels to apply to the preview. Existing values are overwritten. To
|
||||
retain the existing labels on a preview, do not specify this flag.
|
||||
|
||||
Examples:
|
||||
|
||||
Update labels for an existing preview:
|
||||
|
||||
$ gcloud infra-manager previews create \
|
||||
projects/p1/locations/us-central1/previews/my-preview \
|
||||
--gcs-source="gs://my-bucket" --labels="env=prod,team=finance"
|
||||
|
||||
Clear labels for an existing preview:
|
||||
|
||||
$ gcloud infra-manager previews create \
|
||||
projects/p1/locations/us-central1/previews/my-preview \
|
||||
--gcs-source="gs://my-bucket" --labels=""
|
||||
|
||||
Add a label to an existing preview:
|
||||
|
||||
First, fetch the current labels using the `describe` command, then follow the
|
||||
preceding example for updating labels.
|
||||
|
||||
Location resource - the location to be used as parent. This represents a
|
||||
Cloud resource. (NOTE) Some attributes are not given arguments in this
|
||||
group but can be set in other ways.
|
||||
|
||||
To set the project attribute:
|
||||
◆ provide the argument --location on the command line with a fully
|
||||
specified name;
|
||||
◆ set the property infra-manager/location with a fully specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
--location=LOCATION
|
||||
ID of the location or fully qualified identifier for the location.
|
||||
|
||||
To set the location attribute:
|
||||
▸ provide the argument --location on the command line;
|
||||
▸ set the property infra-manager/location.
|
||||
|
||||
--preview-mode=PREVIEW_MODE
|
||||
Preview mode to set it to either default or delete.
|
||||
|
||||
--service-account=SERVICE_ACCOUNT
|
||||
User-specified Service Account (SA) to be used as credential to manage
|
||||
resources. Format:
|
||||
projects/{projectID}/serviceAccounts/{serviceAccount}
|
||||
|
||||
--worker-pool=WORKER_POOL
|
||||
User-specified Worker Pool resource in which the Cloud Build jobwill
|
||||
execute. Format:
|
||||
projects/{project}/locations/{location}/workerPools/{workerPoolId}
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--gcs-source=GCS_SOURCE
|
||||
URI of an object in Google Cloud Storage. e.g. gs://{bucket}/{object}
|
||||
|
||||
Examples:
|
||||
|
||||
Create a deployment from a storage my-bucket:
|
||||
|
||||
$ gcloud infra-manager previews create \
|
||||
projects/p1/location/us-central1/deployments/my-deployment \
|
||||
--gcs-source="gs://my-bucket"
|
||||
|
||||
--git-source-directory=GIT_SOURCE_DIRECTORY
|
||||
Subdirectory inside the repository. Example: 'staging/my-package'
|
||||
|
||||
Use in conjunction with --git-source-repo and --git-source-ref
|
||||
|
||||
Examples:
|
||||
|
||||
Create a deployment from the
|
||||
"https://github.com/examples/repository.git" repo, "staging/compute"
|
||||
folder, "mainline" branch:
|
||||
|
||||
$ gcloud infra-manager previews create \
|
||||
projects/p1/location/us-central1/deployments/my-deployment \
|
||||
--git-source-repo="https://github.com/examples/repository.git"
|
||||
--git-source-directory="staging/compute" --git-source-ref="mainline"
|
||||
|
||||
--git-source-ref=GIT_SOURCE_REF
|
||||
Subdirectory inside the repository. Example: 'staging/my-package'
|
||||
|
||||
Use in conjunction with --git-source-repo and --git-source-directory
|
||||
|
||||
Examples:
|
||||
|
||||
Create a deployment from the
|
||||
"https://github.com/examples/repository.git" repo, "staging/compute"
|
||||
folder, "mainline" branch:
|
||||
|
||||
$ gcloud infra-manager previews create \
|
||||
projects/p1/location/us-central1/deployments/my-deployment \
|
||||
--git-source-repo="https://github.com/examples/repository.git"
|
||||
--git-source-directory="staging/compute" --git-source-ref="mainline"
|
||||
|
||||
--git-source-repo=GIT_SOURCE_REPO
|
||||
Repository URL. Example: 'https://github.com/examples/repository.git'
|
||||
|
||||
Use in conjunction with --git-source-directory and --git-source_ref
|
||||
|
||||
Examples:
|
||||
|
||||
Create a deployment from the
|
||||
"https://github.com/examples/repository.git" repo, "staging/compute"
|
||||
folder, "mainline" branch:
|
||||
|
||||
$ gcloud infra-manager previews create \
|
||||
projects/p1/location/us-central1/deployments/my-deployment \
|
||||
--git-source-repo="https://github.com/examples/repository.git"
|
||||
--git-source-directory="staging/compute" --git-source-ref="mainline"
|
||||
|
||||
--ignore-file=IGNORE_FILE
|
||||
Override the .gcloudignore file and use the specified file instead.
|
||||
See gcloud topic gcloudignore for more information.
|
||||
|
||||
--local-source=LOCAL_SOURCE
|
||||
Local storage path where config files are stored. e.g.
|
||||
./path/to/blueprint
|
||||
|
||||
Examples:
|
||||
|
||||
Create a deployment from a local storage path ./path/to/blueprint:
|
||||
|
||||
$ gcloud infra-manager previews create \
|
||||
projects/p1/location/us-central1/deployments/my-deployment \
|
||||
--local-source="./path/to/blueprint"
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--input-values=[KEY=VALUE,...]
|
||||
Input variable values for the Terraform blueprint. It only accepts
|
||||
(key, value) pairs where value is a scalar value.
|
||||
|
||||
Examples:
|
||||
|
||||
Pass input values on command line:
|
||||
|
||||
$ gcloud infra-manager previews create \
|
||||
projects/p1/location/us-central1/deployments/my-deployment \
|
||||
--gcs-source="gs://my-bucket" \
|
||||
--input-values=projects=p1,region=r
|
||||
|
||||
--inputs-file=INPUTS_FILE
|
||||
A .tfvars file containing terraform variable values. --inputs-file
|
||||
flag is supported for python version 3.6 and above.
|
||||
|
||||
Examples:
|
||||
|
||||
Pass input values on the command line:
|
||||
|
||||
$ gcloud infra-manager previews create \
|
||||
projects/p1/location/us-central1/deployments/my-deployment \
|
||||
--gcs-source="gs://my-bucket" \
|
||||
--inputs-file=path-to-tfvar-file.tfvar
|
||||
|
||||
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 $ gcloud help for details.
|
||||
Loading…
Add table
Add a link
Reference in a new issue