imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 23:08:48 +00:00
Code Activity

gcloud: Wed Oct 11 10:37:28 UTC 2023

Browse source
This commit is contained in:
Automated 2023-10-11 10:37:28 +00:00
parent 9641ff6585
commit c30bb7b4ce
137 changed files with 3139 additions and 267 deletions
Download patch file Download diff file Expand all files Collapse all files

134
gcloud/alpha/service-extensions/wasm-plugins/create Normal file
View file

@ -0,0 +1,134 @@
NAME
gcloud alpha service-extensions wasm-plugins create - create a WasmPlugin
SYNOPSIS
gcloud alpha service-extensions wasm-plugins create
(WASM_PLUGIN : --location=LOCATION) [--async]
[--description=DESCRIPTION] [--labels=[KEY=VALUE,...]]
[--log-config=[LOG_CONFIG,...]]
[--image=IMAGE
--main-version=MAIN_VERSION --plugin-config=PLUGIN_CONFIG
| --plugin-config-file=PLUGIN_CONFIG_FILE
| --plugin-config-uri=PLUGIN_CONFIG_URI] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create a new WasmPlugin and optionally create a WasmPluginVersion
and set it as main (serving) one.
EXAMPLES
To create a WasmPlugin called my-plugin, run:
$ gcloud alpha service-extensions wasm-plugins create my-plugin
To create a WasmPlugin called my-plugin, together with a new version called
v1, and set it as main, run:
$ gcloud alpha service-extensions wasm-plugins create my-plugin \
--main-version=v1 \
--image=...-docker.pkg.dev/my-project/repository/container:tag
POSITIONAL ARGUMENTS
WasmPlugin resource - The ID of the WasmPlugin 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 project attribute:
◆ provide the argument wasm_plugin on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
WASM_PLUGIN
ID of the WasmPlugin or fully qualified identifier for the
WasmPlugin.
To set the wasm_plugin attribute:
▸ provide the argument wasm_plugin on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location Id.
To set the location attribute:
▸ provide the argument wasm_plugin on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ use global location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--description=DESCRIPTION
Provides an optional, human-readable description of the service.
--labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens
(-), underscores (_), lowercase characters, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
--log-config=[LOG_CONFIG,...]
Logging options for the activity performed by this WasmPlugin.
Following options can be set:
◆ enable - whether to enable logging. If log-config flag is set,
enable option is required.
◆ sample-rate - configures the sampling rate of activity logs, where
1.0 means all logged activity is reported and 0.0 means no activity
is reported. The default value is 1.0, and the value of the field
must be in [0, 1].
◆ min-log-level - specificies the lowest level of the logs which
should be exported to Cloud Logging. The default value is INFO.
Example usage:
--log-config=enable=True,sample-rate=0.5,min-log-level=INFO
--log_config=enable=False
--image=IMAGE
URI of the container image containing the Wasm module, stored in the
Artifact Registry.
--main-version=MAIN_VERSION
ID of the WasmPluginVersion that will be created for that WasmPlugin
and that will be set as the current main version.
Configuration for the WasmPlugin, provided to the plugin at runtime via
the proxy_on_configure call (the exact name of the invoked function
depends on the Proxy-Wasm SDK used).
At most one of these can be specified:
--plugin-config=PLUGIN_CONFIG
WasmPlugin configuration in the textual format.
--plugin-config-file=PLUGIN_CONFIG_FILE
Path to a local file containing the plugin configuration.
--plugin-config-uri=PLUGIN_CONFIG_URI
URI of the container image containing the plugin configuration,
stored in the Artifact Registry.
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.
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.

71
gcloud/alpha/service-extensions/wasm-plugins/delete Normal file
View file

@ -0,0 +1,71 @@
NAME
gcloud alpha service-extensions wasm-plugins delete - delete a WasmPlugin
SYNOPSIS
gcloud alpha service-extensions wasm-plugins delete
(WASM_PLUGIN : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Delete a WasmPlugin.
EXAMPLES
To delete a WasmPlugin called 'my-plugin', run:
$ gcloud alpha service-extensions wasm-plugins delete my-plugin
POSITIONAL ARGUMENTS
WasmPlugin resource - The WasmPlugin to delete. 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 project attribute:
◆ provide the argument wasm_plugin on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
WASM_PLUGIN
ID of the WasmPlugin or fully qualified identifier for the
WasmPlugin.
To set the wasm_plugin attribute:
▸ provide the argument wasm_plugin on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location Id.
To set the location attribute:
▸ provide the argument wasm_plugin on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ use global location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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.
API REFERENCE
This command uses the networkservices/v1alpha1 API. The full documentation
for this API can be found at: https://cloud.google.com/networking
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.

67
gcloud/alpha/service-extensions/wasm-plugins/describe Normal file
View file

@ -0,0 +1,67 @@
NAME
gcloud alpha service-extensions wasm-plugins describe - show details about
a WasmPlugin
SYNOPSIS
gcloud alpha service-extensions wasm-plugins describe
(WASM_PLUGIN : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Show details about a WasmPlugin.
EXAMPLES
To show details about a WasmPlugin, run:
$ gcloud alpha service-extensions wasm-plugins describe my-plugin
POSITIONAL ARGUMENTS
WasmPlugin resource - The WasmPlugin you want to describe. 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 project attribute:
◆ provide the argument wasm_plugin on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
WASM_PLUGIN
ID of the WasmPlugin or fully qualified identifier for the
WasmPlugin.
To set the wasm_plugin attribute:
▸ provide the argument wasm_plugin on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location Id.
To set the location attribute:
▸ provide the argument wasm_plugin on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ use global location.
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.
API REFERENCE
This command uses the networkservices/v1alpha1 API. The full documentation
for this API can be found at: https://cloud.google.com/networking
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.

39
gcloud/alpha/service-extensions/wasm-plugins/help Normal file
View file

@ -0,0 +1,39 @@
NAME
gcloud alpha service-extensions wasm-plugins - interact with and manage
Service Extensions WasmPlugins
SYNOPSIS
gcloud alpha service-extensions wasm-plugins COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Interact with and manage Service Extensions WasmPlugins.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
(ALPHA) Create a WasmPlugin.
delete
(ALPHA) Delete a WasmPlugin.
describe
(ALPHA) Show details about a WasmPlugin.
list
(ALPHA) List all WasmPlugins.
update
(ALPHA) Update a WasmPlugin.
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.

85
gcloud/alpha/service-extensions/wasm-plugins/list Normal file
View file

@ -0,0 +1,85 @@
NAME
gcloud alpha service-extensions wasm-plugins list - list all WasmPlugins
SYNOPSIS
gcloud alpha service-extensions wasm-plugins list [--location=LOCATION]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List WasmPlugins.
EXAMPLES
To list existing WasmPlugins, run:
$ gcloud alpha service-extensions wasm-plugins list
FLAGS
Location resource - The parent location. 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;
◆ use global location with a fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
--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;
▸ use global location.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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.
API REFERENCE
This command uses the networkservices/v1alpha1 API. The full documentation
for this API can be found at: https://cloud.google.com/networking
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.

156
gcloud/alpha/service-extensions/wasm-plugins/update Normal file
View file

@ -0,0 +1,156 @@
NAME
gcloud alpha service-extensions wasm-plugins update - update a WasmPlugin
SYNOPSIS
gcloud alpha service-extensions wasm-plugins update
(WASM_PLUGIN : --location=LOCATION) [--async]
[--description=DESCRIPTION] [--labels=[KEY=VALUE,...]]
[--log-config=[LOG_CONFIG,...]]
[--image=IMAGE
--main-version=MAIN_VERSION --plugin-config=PLUGIN_CONFIG
| --plugin-config-file=PLUGIN_CONFIG_FILE
| --plugin-config-uri=PLUGIN_CONFIG_URI] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update an existing WasmPlugin and optionally create a
WasmPluginVersion and set it as main (serving) one.
If --image is not specified:
▪ the method only updates the WasmPlugin resource without creating a
WasmPluginVersion.
▪ the --plugin-config** flags are disallowed.
▪ if --main-version is set, then the referenced WasmPluginVersion must
already exists and it will be set as main (serving) one.
If --image is specified:
▪ the --main-version flag should also be specified.
▪ the method updates the WasmPlugin resource and creates a new
WasmPluginVersion with --main-version name and sets it as main
(serving) one.
▪ the --plugin-config** flags are allowed.
▪ the --async flag is disallowed.
EXAMPLES
To update a WasmPlugin called my-plugin, run:
$ gcloud alpha service-extensions wasm-plugins update my-plugin \
--main-version=new-version --description="A new description." \
--labels=label1=value1
To update a WasmPlugin called my-plugin and also create a new version
called v1 and set it as main:
$ gcloud alpha service-extensions wasm-plugins update my-plugin \
--main-version=v1 --description="A new description." \
--labels=label1=value1 \
--image=...-docker.pkg.dev/my-project/repository/container:tag
POSITIONAL ARGUMENTS
WasmPlugin resource - The ID of the WasmPlugin to update. 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 project attribute:
◆ provide the argument wasm_plugin on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
WASM_PLUGIN
ID of the WasmPlugin or fully qualified identifier for the
WasmPlugin.
To set the wasm_plugin attribute:
▸ provide the argument wasm_plugin on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location Id.
To set the location attribute:
▸ provide the argument wasm_plugin on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ use global location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--description=DESCRIPTION
Provides an optional, human-readable description of the service.
--labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens
(-), underscores (_), lowercase characters, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
--log-config=[LOG_CONFIG,...]
Logging options for the activity performed by this WasmPlugin.
Following options can be set:
◆ enable - whether to enable logging. If log-config flag is set,
enable option is required.
◆ sample-rate - configures the sampling rate of activity logs, where
1.0 means all logged activity is reported and 0.0 means no activity
is reported. The default value is 1.0, and the value of the field
must be in [0, 1].
◆ min-log-level - specificies the lowest level of the logs which
should be exported to Cloud Logging. The default value is INFO.
Example usage:
--log-config=enable=True,sample-rate=0.5,min-log-level=INFO
--log_config=enable=False
--image=IMAGE
URI of the container image containing the Wasm module, stored in the
Artifact Registry.
--main-version=MAIN_VERSION
The ID of the WasmPluginVersion that should be the currently serving
one. The version referred to must be a child of this WasmPlugin.
If the --image flag was also provided, the WasmPluginVersion will be
created for that WasmPlugin and will be set as the current main
version.
Configuration for the WasmPlugin, provided to the plugin at runtime via
the proxy_on_configure call (the exact name of the invoked function
depends on the Proxy-Wasm SDK used).
At most one of these can be specified:
--plugin-config=PLUGIN_CONFIG
WasmPlugin configuration in the textual format.
--plugin-config-file=PLUGIN_CONFIG_FILE
Path to a local file containing the plugin configuration.
--plugin-config-uri=PLUGIN_CONFIG_URI
URI of the container image containing the plugin configuration,
stored in the Artifact Registry.
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.
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.