gcloud topic configurations - supplementary help for named configurations
Supplementary help for named configurations.
gcloud properties can be stored in named configurations, which are collections of key-value pairs that influence the behavior of gcloud.
Named configurations are intended to be an advanced feature, and you can probably ignore them entirely if you only work with one project.
Properties that are commonly stored in configurations include default Google Compute Engine zone, verbosity level, project ID, and active user or service account. Configurations allow you to define and enable these and other settings together as a group.
Configurations are especially useful if you:
o Work with multiple projects. You can create a separate configuration for each project.
o Use multiple accounts, for example, a user account and a service account, etc.
o Perform generally orthogonal tasks (work on an appengine app in project foo, administer a Google Compute Engine cluster in zone user-central-1a, manage the network configurations for region asia-east-1, etc.)
Property information stored in named configurations are readable by all gcloud commands and may be modified by gcloud config set and gcloud config unset.
Named configurations maybe be defined by users or built into gcloud.
User defined configurations have lowercase names, such as johndoe, default, 'jeff-staging, or foo2. These are defined by the following regular expression: ^[a-z][-a-z0-9]*$
Additionally there is a builtin configuration named NONE that has no properties set.
The easiest way to create a brand new configuration is by running
$ gcloud init
This will guide you through setting up your first named configuration, creating a new named configuration, or reinitializing an existing named configuration. (Note: reinitializing an existing configuration will remove all its existing properties!)
You can create a new empty configuration with
$ gcloud config configurations create my-config
gcloud may have at most one active configuration which provides property values. Inactive configurations have no effect on gcloud executions.
You can activate a configuration with
$ gcloud config configurations activate my-config
You can view and change the properties of your active configuration using the following commands:
$ gcloud config list $ gcloud config set
Additionally, commands under gcloud config configurations allow you to to list, activate, describe, and delete configurations that may or may not be active.
You can activate a configuration for a single gcloud invocation using flag, --configuration my-config, or environment variable CLOUDSDK_ACTIVE_CONFIG_NAME=my-config.
accountThe account gcloud should use for authentication. You can run gcloud auth list to see the accounts you currently have available.disable_color
If True, color will not be used when printing messages in the terminal.disable_prompts
If True, the default answer will be assumed for all user prompts. For any prompts that require user input, an error will be raised. This is the equivalent of using the global --quiet flag.disable_usage_reporting
If True, anonymous statistics on SDK usage will not be collected. This is value is set based on your choices during installation, but can be changed at any time. For more information, see: https://cloud.google.com/sdk/usage-statisticslog_http
If True, log http requests and responses to the logs. You may need to adjust your verbosity setting if you want to see in the terminal, otherwise it is available in the log files.project
The project id of the Cloud Platform project to operate on by default. This can be overridden by using the global --project flag.user_output_enabled
If False, messages to the user and command output on both standard out and standard error will be suppressed.verbosity
The default logging verbosity for gcloud commands. This is the equivalent of using the global --verbosity flag.
docker_buildSet to local to run docker build using a local docker installation, or remote to do the build on a Google Compute Engine VM.stop_previous_version
If True, when deploying a new version of a service, the previously deployed version is stopped. If False, older versions must be stopped manually.use_cloud_build
If True, use the Container Builder API to perform docker builds.
additional_repositoriesA comma separated list of additional repositories to check for components. This property is automatically managed by the gcloud components repositories commands.disable_update_check
If True, the Cloud SDK will not automatically check for updates.
regionThe default region to use when working with regional Compute Engine resources. When a --region flag is required but not provided, the command will fall back to this value, if set.zone
The default zone to use when working with zonal Compute Engine resources. When a --zone flag is required but not provided, the command will fall back to this value, if set.
clusterThe name of the cluster to use by default when working with Container Engine.
addressThe hostname or IP address of your proxy server.password
If your proxy requires authentication, the password to use when connecting.port
The port to use when connected to your proxy server.type
The type of proxy you are using. Supported proxy types are: [http, http_no_tunnel, socks4, socks5].username
If your proxy requires authentication, the username to use when connecting.