1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 14:56:05 +00:00

gcloud: Thu Jan 19 00:56:33 UTC 2023

This commit is contained in:
Automated 2023-01-19 00:56:33 +00:00
parent 348d9760ee
commit 1248f773ec
1462 changed files with 51835 additions and 5402 deletions

View file

@ -0,0 +1,59 @@
NAME
gcloud alpha edge-cache - manage Media CDN resources
SYNOPSIS
gcloud alpha edge-cache GROUP [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage Media CDN resources.
EXAMPLES
To list EdgeCacheService resources in the active Cloud Platform project,
run:
$ gcloud alpha edge-cache services list
To create an EdgeCacheOrigin resource named 'my-origin' that points to a
Cloud Storage bucket, run:
$ gcloud alpha edge-cache origins create my-origin \
--origin-address="gs://bucket"
To import an EdgeCacheService resource configuration from a YAML
definition, run:
$ gcloud alpha edge-cache services import my-service \
--source=config.yaml
To describe an EdgeCacheKeyset resource named 'my-keyset', run:
$ gcloud alpha edge-cache keysets describe my-keyset
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
keysets
(ALPHA) Interact with and manage EdgeCacheKeyset resources.
operations
(ALPHA) Manage EdgeCache operations.
origins
(ALPHA) Interact with and manage EdgeCacheOrigin resources.
services
(ALPHA) Interact with and manage EdgeCacheService resources.
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. This variant is also available:
$ gcloud edge-cache

View file

@ -0,0 +1,125 @@
NAME
gcloud alpha edge-cache keysets create - create an EdgeCacheKeyset resource
SYNOPSIS
gcloud alpha edge-cache keysets create (KEYSET : --location=LOCATION)
[--async] [--description=DESCRIPTION] [--labels=KEY=VALUE]
[--public-key=PUBLIC_KEY]
[--validation-shared-key=VALIDATION_SHARED_KEY] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create a new EdgeCacheKeyset resource.
EXAMPLES
To create an EdgeCacheKeyset resource called 'my-keyset', run:
$ gcloud alpha edge-cache keysets create my-keyset \
--public-key='id=KEYID,value=BASE64PUBLICKEY'
POSITIONAL ARGUMENTS
Keyset resource - The name of the EdgeCacheKeyset resource 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 keyset 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.
KEYSET
ID of the keyset or fully qualified identifier for the keyset. To set
the keyset attribute:
▸ provide the argument keyset 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 keyset 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
Human-readable description of the resource.
--labels=KEY=VALUE
List of KEY=VALUE labels to attach to this resource.
--public-key=PUBLIC_KEY
Set of public keys to use for validating signed requests, when
associated with a route. This flag can be repeated to create a Keyset
with multiple public keys.
If you are providing your own public keys, specify the key in the form
id=ID,value=BASE64ENCODEDPUBLICKEY.
If you are using Google-managed public keys as part of a dual-token
setup, specify the key in the form id=ID,managed=true.
id
id (name) name of the key within the keyset.
value
URL-safe base64 encoded public key. Cannot be specified if
managed=true.
managed
Boolean indicating this is a Google-managed key. Cannot be
specified if value=true.
To create a public key with id 'foo', pass
--public-key='id=foo,value=VALUE' to gcloud alpha edge-cache keysets
create.
To create a Google-managed public key with id 'bar', pass
--public-key='id=foo,managed=true' to gcloud alpha edge-cache keysets
create.
At least one of public-key or validation-shared-key must be specified.
--validation-shared-key=VALIDATION_SHARED_KEY
An ordered list of shared keys to use for validating signed requests.
To create a validation shared key pointing to a Secret Manager secret
version with name projects/PROJECT/secrets/SECRET/versions/VERSION,
pass
--validation-shared-key='secret_version=projects/PROJECT/secrets/SECRET/versions/VERSION'
to gcloud alpha edge-cache keysets create.
secret_version
The name of the secret in Secret Manager. Must be in the format
projects/PROJECT/secrets/SECRET/versions/VERSION.
At least one of public-key or validation-shared-key must be specified.
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. This variant is also available:
$ gcloud edge-cache keysets create

View file

@ -0,0 +1,69 @@
NAME
gcloud alpha edge-cache keysets delete - delete an EdgeCacheKeyset resource
SYNOPSIS
gcloud alpha edge-cache keysets delete (KEYSET : --location=LOCATION)
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Delete an EdgeCacheKeyset resource.
EXAMPLES
To delete an EdgeCacheKeyset resource called 'my-keyset', run:
$ gcloud alpha edge-cache keysets delete my-keyset
POSITIONAL ARGUMENTS
Keyset resource - The name of the EdgeCacheKeyset resource 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 keyset 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.
KEYSET
ID of the keyset or fully qualified identifier for the keyset. To set
the keyset attribute:
▸ provide the argument keyset 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 keyset 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. This variant is also available:
$ gcloud edge-cache keysets delete

View file

@ -0,0 +1,65 @@
NAME
gcloud alpha edge-cache keysets describe - show details about an
EdgeCacheKeyset resource
SYNOPSIS
gcloud alpha edge-cache keysets describe (KEYSET : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Show details about an EdgeCacheKeyset resource.
EXAMPLES
To show details for an EdgeCacheKeyset resource named 'my-keyset', run:
$ gcloud alpha edge-cache keysets describe my-keyset
POSITIONAL ARGUMENTS
Keyset resource - The EdgeCacheKeyset resource 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 keyset 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.
KEYSET
ID of the keyset or fully qualified identifier for the keyset. To set
the keyset attribute:
▸ provide the argument keyset 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 keyset 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. This variant is also available:
$ gcloud edge-cache keysets describe

View file

@ -0,0 +1,73 @@
NAME
gcloud alpha edge-cache keysets export - export an EdgeCacheKeyset resource
SYNOPSIS
gcloud alpha edge-cache keysets export (KEYSET : --location=LOCATION)
[--destination=DESTINATION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Export an EdgeCacheKeyset resource to YAML.
EXAMPLES
To export an EdgeCacheKeyset resourced named 'my-keyset', run:
$ gcloud alpha edge-cache keysets export my-keyset \
--destination=keyset.yaml
POSITIONAL ARGUMENTS
Keyset resource - The EdgeCacheKeyset resource you want to export. 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 keyset 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.
KEYSET
ID of the keyset or fully qualified identifier for the keyset. To set
the keyset attribute:
▸ provide the argument keyset 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 keyset on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ use global location.
FLAGS
--destination=DESTINATION
Path to a YAML file where the configuration will be exported. The
exported data will not contain any output-only fields. Alternatively,
you may omit this flag to write to standard output. For a schema
describing the export/import format, see
$CLOUDSDKROOT/lib/googlecloudsdk/schemas/...
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. This variant is also available:
$ gcloud edge-cache keysets export

View file

@ -0,0 +1,47 @@
NAME
gcloud alpha edge-cache keysets - interact with and manage EdgeCacheKeyset
resources
SYNOPSIS
gcloud alpha edge-cache keysets COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Interact with and manage EdgeCacheKeyset resources.
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 an EdgeCacheKeyset resource.
delete
(ALPHA) Delete an EdgeCacheKeyset resource.
describe
(ALPHA) Show details about an EdgeCacheKeyset resource.
export
(ALPHA) Export an EdgeCacheKeyset resource.
import
(ALPHA) Import an EdgeCacheKeyset resource.
list
(ALPHA) List EdgeCacheKeyset resources.
update
(ALPHA) Update an EdgeCacheKeyset resource.
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. This variant is also available:
$ gcloud edge-cache keysets

View file

@ -0,0 +1,90 @@
NAME
gcloud alpha edge-cache keysets import - import an EdgeCacheKeyset resource
SYNOPSIS
gcloud alpha edge-cache keysets import (KEYSET : --location=LOCATION)
[--async] [--source=SOURCE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Import an EdgeCacheKeyset resource. If the named EdgeCacheKeyset
resource already exists, the resource will be updated to match the imported
resource configuration.
Note: If you are updating an existing EdgeCacheKeyset resource, you should
ensure that it includes any public keys still needed to validate incoming
user requests.
If the named EdgeCacheKeyset resource does not already exist, a new
EdgeCacheKeyset resource will be created with that name.
EXAMPLES
To import an EdgeCacheKeyset resource named 'my-keyset' from a YAML file,
run:
$ gcloud alpha edge-cache keysets import my-keyset \
--source=my-keyset.yaml
POSITIONAL ARGUMENTS
Keyset resource - The EdgeCacheKeyset resource you want to import. 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 keyset 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.
KEYSET
ID of the keyset or fully qualified identifier for the keyset. To set
the keyset attribute:
▸ provide the argument keyset 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 keyset 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.
--source=SOURCE
Path to a YAML file containing the configuration export data. The YAML
file must not contain any output-only fields. Alternatively, you may
omit this flag to read from standard input. For a schema describing the
export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/...
$CLOUDSDKROOT is can be obtained with the following command:
$ gcloud info --format='value(installation.sdk_root)'
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. This variant is also available:
$ gcloud edge-cache keysets import

View file

@ -0,0 +1,68 @@
NAME
gcloud alpha edge-cache keysets list - list EdgeCacheKeyset resources
SYNOPSIS
gcloud alpha edge-cache keysets list [--filter=EXPRESSION] [--limit=LIMIT]
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List EdgeCacheKeyset resources.
EXAMPLES
To list existing EdgeCacheKeyset resources, run:
$ gcloud alpha edge-cache keysets list
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. This variant is also available:
$ gcloud edge-cache keysets list

View file

@ -0,0 +1,138 @@
NAME
gcloud alpha edge-cache keysets update - update an EdgeCacheKeyset resource
SYNOPSIS
gcloud alpha edge-cache keysets update (KEYSET : --location=LOCATION)
[--async] [--description=DESCRIPTION] [--labels=KEY=VALUE]
[--public-key=PUBLIC_KEY]
[--validation-shared-key=VALIDATION_SHARED_KEY] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update an existing EdgeCacheKeyset resource.
EXAMPLES
To update an EdgeCacheKeyset resource called 'my-keyset', run:
$ gcloud alpha edge-cache keysets update my-keyset \
--public-key='id=KEYID,value=BASE64PUBLICKEY'
The update command appends keys to an existing EdgeCacheKeyset resource. To
add more than one key to an EdgeCacheKeyset resource, provide multiple
--public-key values:
$ gcloud alpha edge-cache keysets update my-keyset \
--public-key='id=KEYID,value=BASE64PUBLICKEY' \
--public-key='id=EXISTING,value=EXISTINGPUBLICKEY'
You can specify, and an EdgeCacheKeyset resource can contain, up to three
(3) public keys. To delete unused public keys within an existing Keyset,
use the import command to specify the EdgeCacheKeyset resource in full,
omitting any unused publicKey items.
POSITIONAL ARGUMENTS
Keyset resource - The name of the EdgeCacheKeyset resource 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 keyset 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.
KEYSET
ID of the keyset or fully qualified identifier for the keyset. To set
the keyset attribute:
▸ provide the argument keyset 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 keyset 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
Human-readable description of the resource.
--labels=KEY=VALUE
List of KEY=VALUE labels to attach to this resource.
--public-key=PUBLIC_KEY
Set of public keys to use for validating signed requests, when
associated with a route. This flag can be repeated to create a Keyset
with multiple public keys.
If you are providing your own public keys, specify the key in the form
id=ID,value=BASE64ENCODEDPUBLICKEY.
If you are using Google-managed public keys as part of a dual-token
setup, specify the key in the form id=ID,managed=true.
id
id (name) name of the key within the keyset.
value
URL-safe base64 encoded public key. Cannot be specified if
managed=true.
managed
Boolean indicating this is a Google-managed key. Cannot be
specified if value=true.
To create a public key with id 'foo', pass
--public-key='id=foo,value=VALUE' to gcloud alpha edge-cache keysets
update.
To create a Google-managed public key with id 'bar', pass
--public-key='id=foo,managed=true' to gcloud alpha edge-cache keysets
update.
At least one of public-key or validation-shared-key must be specified.
--validation-shared-key=VALIDATION_SHARED_KEY
An ordered list of shared keys to use for validating signed requests.
To create a validation shared key pointing to a Secret Manager secret
version with name projects/PROJECT/secrets/SECRET/versions/VERSION,
pass
--validation-shared-key='secret_version=projects/PROJECT/secrets/SECRET/versions/VERSION'
to gcloud alpha edge-cache keysets update.
secret_version
The name of the secret in Secret Manager. Must be in the format
projects/PROJECT/secrets/SECRET/versions/VERSION.
At least one of public-key or validation-shared-key must be specified.
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. This variant is also available:
$ gcloud edge-cache keysets update

View file

@ -0,0 +1,58 @@
NAME
gcloud alpha edge-cache operations describe - describe a long-running
operation
SYNOPSIS
gcloud alpha edge-cache operations describe OPERATION
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Describe a long-running operation. You can use this to inspect
whether a create or update operation was successful or the operation
returned any errors.
EXAMPLES
To describe an operation with name simple-operation, run:
$ gcloud alpha edge-cache operations describe simple-operation
POSITIONAL ARGUMENTS
Operation resource - operation to describe. 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 operation on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line. To set the
location attribute:
◆ provide the argument operation on the command line with a fully
specified name;
◆ use global location.
This must be specified.
OPERATION
ID of the operation or fully qualified identifier for the operation.
To set the operation attribute:
▸ provide the argument operation on the command line.
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. This variant is also available:
$ gcloud edge-cache operations describe

View file

@ -0,0 +1,31 @@
NAME
gcloud alpha edge-cache operations - manage EdgeCache operations
SYNOPSIS
gcloud alpha edge-cache operations COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Commands for managing long-running operations.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
(ALPHA) Describe a long-running operation.
list
(ALPHA) List long-running operations.
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. This variant is also available:
$ gcloud edge-cache operations

View file

@ -0,0 +1,68 @@
NAME
gcloud alpha edge-cache operations list - list long-running operations
SYNOPSIS
gcloud alpha edge-cache operations list [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List long-running operations.
EXAMPLES
To list all operations, run:
$ gcloud alpha edge-cache operations list
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. This variant is also available:
$ gcloud edge-cache operations list

View file

@ -0,0 +1,199 @@
NAME
gcloud alpha edge-cache origins create - create an EdgeCacheOrigin resource
SYNOPSIS
gcloud alpha edge-cache origins create (ORIGIN : --location=LOCATION)
--origin-address=ORIGIN_ADDRESS [--async] [--description=DESCRIPTION]
[--failover-origin=FAILOVER_ORIGIN] [--labels=KEY=VALUE]
[--max-attempts=MAX_ATTEMPTS] [--port=PORT] [--protocol=PROTOCOL]
[--response-timeout=RESPONSE_TIMEOUT]
[--retry-conditions=[RETRY_CONDITIONS,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create a new EdgeCacheOrigin resource.
EXAMPLES
To create a EdgeCacheOrigin resource called 'my-origin', run:
$ gcloud alpha edge-cache origins create my-origin \
--origin-address="origin.example.com"
POSITIONAL ARGUMENTS
Origin resource - The name of the EdgeCacheOrigin resource 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 origin 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.
ORIGIN
ID of the origin or fully qualified identifier for the origin. To set
the origin attribute:
▸ provide the argument origin 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 origin on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ use global location.
REQUIRED FLAGS
--origin-address=ORIGIN_ADDRESS
A fully qualified domain name (FQDN) or IP address reachable over the
public Internet, or the address of a Google Cloud Storage bucket.
This address will be used as the origin for cache requests - e.g.
◆ FQDN: media-backend.example.com
◆ IPv4: 35.218.1.1
◆ IPv6: [2607:f8b0:4012:809::200e]
◆ Cloud Storage: gs://bucketname
When providing an FQDN (hostname), it must be publicly resolvable (e.g.
via Google public DNS) and IP addresses must be publicly routable. If a
Cloud Storage bucket is provided, it must be in the canonical
"gs://bucketname" format. Other forms, such as
"storage.googleapis.com", will be rejected.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--description=DESCRIPTION
Human-readable description of the resource.
--failover-origin=FAILOVER_ORIGIN
Origin resource to try when the current origin cannot be reached. After
maxAttempts is reached, the configured failoverOrigin will be used to
fulfil the request.
For example, the following are both valid URLs to an EdgeCacheOrigin
resource:
◆ /projects/PROJECT/locations/global/edgeCacheOrigins/yourOrigin
◆ yourOrigin
The value of timeout.maxAttemptsTimeout dictates the timeout across all
origins.
--labels=KEY=VALUE
List of KEY=VALUE labels to attach to this resource.
--max-attempts=MAX_ATTEMPTS
Maximum number of attempts to cache fill from this origin. Another
attempt is made when a cache fill fails with one of the
retry_conditions.
Once max_attempts to this origin have failed the failover_origin will
be used, if one is specified. That failover_origin may specify its own
max_attempts, retry_conditions and failover_origin to control its own
cache fill failures.
The total number of allowed attempts to cache fill across this and
failover origins is limited to four. The total time allowed for cache
fill attempts across this and failover origins can be controlled with
max_attempts_timeout.
The last valid response from an origin will be returned to the client.
If no origin returns a valid response, an HTTP 503 will be returned to
the client.
Defaults to 1. Must be a value greater than 0 and less than 4.
--port=PORT
Port to connect to the origin on. Defaults to port 443 for HTTP2 and
HTTPS protocols, and port 80 for HTTP.
--protocol=PROTOCOL
Protocol to use to connect to the configured origin. Defaults to HTTP2,
and it is strongly recommended that users use HTTP2 for both security &
performance.
When using HTTP2 or HTTPS as the protocol, a valid, publicly-signed,
unexpired TLS (SSL) certificate must be presented by the origin server.
PROTOCOL must be one of:
http
HTTP without TLS (SSL). This is not recommended, as communication
outside of Google's network will be unencrypted to the public
endpoint (origin).
http2
HTTP/2 protocol. HTTP/2 refers to "h2", which requires TLS (HTTPS).
Requires a valid (public, unexpired) TLS certificate to be present
on the origin.
https
HTTP/1.1 with TLS (SSL). Requires a valid (public, unexpired) TLS
certificate to be present on the origin.
--response-timeout=RESPONSE_TIMEOUT
Maximum duration to wait for data to arrive when reading from the HTTP
connection/stream.
Defaults to 5 seconds. The timeout must be a value between 1s and 30s.
--retry-conditions=[RETRY_CONDITIONS,...]
Specifies one or more retry conditions for the configured origin.
If the failure mode during a connection attempt to the origin matches
the configured retryCondition(s), the origin request will be retried up
to maxAttempts times. The failoverOrigin, if configured, will then be
used to satisfy the request.
The default retryCondition is "connect-failure".
retryConditions apply to this origin, and not subsequent
failoverOrigin(s), which may specify their own retryConditions and
maxAttempts.
Valid values are:
◆ connect-failure: Retry on failures connecting to origins, for
example due to connection timeouts.
◆ http-5xx: Retry if the origin responds with any 5xx response code,
or if the origin does not respond at all, example: disconnects,
reset, read timeout, connection failure, and refused streams.
◆ gateway-error: Similar to 5xx, but only applies to response codes
502, 503 or 504.
◆ retriable-4xx: Retry for retriable 4xx response codes, which
include HTTP 409 (Conflict) and HTTP 429 (Too Many Requests)
◆ not-found: Retry if the origin returns a HTTP 404 (Not Found). This
can be useful when generating video content, and the segment is not
available yet.
RETRY_CONDITIONS must be one of: connect-failure, forbidden,
gateway-error, http-5xx, not-found, retriable-4xx,
retry-conditions-unspecified.
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. This variant is also available:
$ gcloud edge-cache origins create

View file

@ -0,0 +1,69 @@
NAME
gcloud alpha edge-cache origins delete - delete an EdgeCacheOrigin resource
SYNOPSIS
gcloud alpha edge-cache origins delete (ORIGIN : --location=LOCATION)
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Delete a EdgeCacheOrigin resource.
EXAMPLES
To delete a EdgeCacheOrigin resource called 'my-origin', run:
$ gcloud alpha edge-cache origins delete my-origin
POSITIONAL ARGUMENTS
Origin resource - The name of the EdgeCacheOrigin resource 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 origin 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.
ORIGIN
ID of the origin or fully qualified identifier for the origin. To set
the origin attribute:
▸ provide the argument origin 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 origin 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. This variant is also available:
$ gcloud edge-cache origins delete

View file

@ -0,0 +1,65 @@
NAME
gcloud alpha edge-cache origins describe - show details about an
EdgeCacheOrigin resource
SYNOPSIS
gcloud alpha edge-cache origins describe (ORIGIN : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Show details about an EdgeCacheOrigin resource.
EXAMPLES
To show details about an EdgeCacheOrigin resource named 'my-origin', run:
$ gcloud alpha edge-cache origins describe my-origin
POSITIONAL ARGUMENTS
Origin resource - The EdgeCacheOrigin resource 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 origin 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.
ORIGIN
ID of the origin or fully qualified identifier for the origin. To set
the origin attribute:
▸ provide the argument origin 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 origin 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. This variant is also available:
$ gcloud edge-cache origins describe

View file

@ -0,0 +1,73 @@
NAME
gcloud alpha edge-cache origins export - export an EdgeCacheOrigin resource
SYNOPSIS
gcloud alpha edge-cache origins export (ORIGIN : --location=LOCATION)
[--destination=DESTINATION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Export an EdgeCacheOrigin resource to YAML.
EXAMPLES
To export an EdgeCacheOrigin resource named 'my-origin', run:
$ gcloud alpha edge-cache origins export my-origin \
--destination=my-origin.yaml
POSITIONAL ARGUMENTS
Origin resource - The EdgeCacheOrigin resource you want to export. 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 origin 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.
ORIGIN
ID of the origin or fully qualified identifier for the origin. To set
the origin attribute:
▸ provide the argument origin 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 origin on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ use global location.
FLAGS
--destination=DESTINATION
Path to a YAML file where the configuration will be exported. The
exported data will not contain any output-only fields. Alternatively,
you may omit this flag to write to standard output. For a schema
describing the export/import format, see
$CLOUDSDKROOT/lib/googlecloudsdk/schemas/...
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. This variant is also available:
$ gcloud edge-cache origins export

View file

@ -0,0 +1,47 @@
NAME
gcloud alpha edge-cache origins - interact with and manage EdgeCacheOrigin
resources
SYNOPSIS
gcloud alpha edge-cache origins COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Interact with and manage EdgeCacheOrigin resources.
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 an EdgeCacheOrigin resource.
delete
(ALPHA) Delete an EdgeCacheOrigin resource.
describe
(ALPHA) Show details about an EdgeCacheOrigin resource.
export
(ALPHA) Export an EdgeCacheOrigin resource.
import
(ALPHA) Import an EdgeCacheOrigin resource.
list
(ALPHA) List all EdgeCacheOrigin resources in a project.
update
(ALPHA) Update an EdgeCacheOrigin resource.
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. This variant is also available:
$ gcloud edge-cache origins

View file

@ -0,0 +1,86 @@
NAME
gcloud alpha edge-cache origins import - import an EdgeCacheOrigin resource
SYNOPSIS
gcloud alpha edge-cache origins import (ORIGIN : --location=LOCATION)
[--async] [--source=SOURCE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Import an EdgeCacheOrigin resource. If the named EdgeCacheOrigin
resource already exists, the resource will be updated to match the imported
resource configuration.
If the named EdgeCacheOrigin resource does not already exist, a new
EdgeCacheOrigin resource will be created with that name.
EXAMPLES
To import an EdgeCacheOrigin resource named 'my-origin' from a YAML file,
run:
$ gcloud alpha edge-cache origins import my-origin \
--source=my-origin.yaml
POSITIONAL ARGUMENTS
Origin resource - The EdgeCacheOrigin resource you want to import. 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 origin 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.
ORIGIN
ID of the origin or fully qualified identifier for the origin. To set
the origin attribute:
▸ provide the argument origin 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 origin 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.
--source=SOURCE
Path to a YAML file containing the configuration export data. The YAML
file must not contain any output-only fields. Alternatively, you may
omit this flag to read from standard input. For a schema describing the
export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/...
$CLOUDSDKROOT is can be obtained with the following command:
$ gcloud info --format='value(installation.sdk_root)'
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. This variant is also available:
$ gcloud edge-cache origins import

View file

@ -0,0 +1,69 @@
NAME
gcloud alpha edge-cache origins list - list all EdgeCacheOrigin resources
in a project
SYNOPSIS
gcloud alpha edge-cache origins list [--filter=EXPRESSION] [--limit=LIMIT]
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List EdgeCacheOrigin resources.
EXAMPLES
To list existing EdgeCacheOrigin resources, run:
$ gcloud alpha edge-cache origins list
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. This variant is also available:
$ gcloud edge-cache origins list

View file

@ -0,0 +1,199 @@
NAME
gcloud alpha edge-cache origins update - update an EdgeCacheOrigin resource
SYNOPSIS
gcloud alpha edge-cache origins update (ORIGIN : --location=LOCATION)
[--async] [--description=DESCRIPTION]
[--failover-origin=FAILOVER_ORIGIN] [--labels=KEY=VALUE]
[--max-attempts=MAX_ATTEMPTS] [--origin-address=ORIGIN_ADDRESS]
[--port=PORT] [--protocol=PROTOCOL]
[--response-timeout=RESPONSE_TIMEOUT]
[--retry-conditions=[RETRY_CONDITIONS,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update an existing EdgeCacheOrigin resource.
EXAMPLES
To update an EdgeCacheOrigin resource named 'my-origin', run:
$ gcloud alpha edge-cache origins update my-origin \
--origin-address=new-origin.example.com
POSITIONAL ARGUMENTS
Origin resource - The name of the EdgeCacheOrigin resource 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 origin 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.
ORIGIN
ID of the origin or fully qualified identifier for the origin. To set
the origin attribute:
▸ provide the argument origin 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 origin 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
Human-readable description of the resource.
--failover-origin=FAILOVER_ORIGIN
Origin resource to try when the current origin cannot be reached. After
maxAttempts is reached, the configured failoverOrigin will be used to
fulfil the request.
For example, the following are both valid URLs to an EdgeCacheOrigin
resource:
◆ /projects/PROJECT/locations/global/edgeCacheOrigins/yourOrigin
◆ yourOrigin
The value of timeout.maxAttemptsTimeout dictates the timeout across all
origins.
--labels=KEY=VALUE
List of KEY=VALUE labels to attach to this resource.
--max-attempts=MAX_ATTEMPTS
Maximum number of attempts to cache fill from this origin. Another
attempt is made when a cache fill fails with one of the
retry_conditions.
Once max_attempts to this origin have failed the failover_origin will
be used, if one is specified. That failover_origin may specify its own
max_attempts, retry_conditions and failover_origin to control its own
cache fill failures.
The total number of allowed attempts to cache fill across this and
failover origins is limited to four. The total time allowed for cache
fill attempts across this and failover origins can be controlled with
max_attempts_timeout.
The last valid response from an origin will be returned to the client.
If no origin returns a valid response, an HTTP 503 will be returned to
the client.
Defaults to 1. Must be a value greater than 0 and less than 4.
--origin-address=ORIGIN_ADDRESS
A fully qualified domain name (FQDN) or IP address reachable over the
public Internet, or the address of a Google Cloud Storage bucket.
This address will be used as the origin for cache requests - e.g.
◆ FQDN: media-backend.example.com
◆ IPv4: 35.218.1.1
◆ IPv6: [2607:f8b0:4012:809::200e]
◆ Cloud Storage: gs://bucketname
When providing an FQDN (hostname), it must be publicly resolvable (e.g.
via Google public DNS) and IP addresses must be publicly routable. If a
Cloud Storage bucket is provided, it must be in the canonical
"gs://bucketname" format. Other forms, such as
"storage.googleapis.com", will be rejected.
--port=PORT
Port to connect to the origin on. Defaults to port 443 for HTTP2 and
HTTPS protocols, and port 80 for HTTP.
--protocol=PROTOCOL
Protocol to use to connect to the configured origin. Defaults to HTTP2,
and it is strongly recommended that users use HTTP2 for both security &
performance.
When using HTTP2 or HTTPS as the protocol, a valid, publicly-signed,
unexpired TLS (SSL) certificate must be presented by the origin server.
PROTOCOL must be one of:
http
HTTP without TLS (SSL). This is not recommended, as communication
outside of Google's network will be unencrypted to the public
endpoint (origin).
http2
HTTP/2 protocol. HTTP/2 refers to "h2", which requires TLS (HTTPS).
Requires a valid (public, unexpired) TLS certificate to be present
on the origin.
https
HTTP/1.1 with TLS (SSL). Requires a valid (public, unexpired) TLS
certificate to be present on the origin.
--response-timeout=RESPONSE_TIMEOUT
Maximum duration to wait for data to arrive when reading from the HTTP
connection/stream.
Defaults to 5 seconds. The timeout must be a value between 1s and 30s.
--retry-conditions=[RETRY_CONDITIONS,...]
Specifies one or more retry conditions for the configured origin.
If the failure mode during a connection attempt to the origin matches
the configured retryCondition(s), the origin request will be retried up
to maxAttempts times. The failoverOrigin, if configured, will then be
used to satisfy the request.
The default retryCondition is "connect-failure".
retryConditions apply to this origin, and not subsequent
failoverOrigin(s), which may specify their own retryConditions and
maxAttempts.
Valid values are:
◆ connect-failure: Retry on failures connecting to origins, for
example due to connection timeouts.
◆ http-5xx: Retry if the origin responds with any 5xx response code,
or if the origin does not respond at all, example: disconnects,
reset, read timeout, connection failure, and refused streams.
◆ gateway-error: Similar to 5xx, but only applies to response codes
502, 503 or 504.
◆ retriable-4xx: Retry for retriable 4xx response codes, which
include HTTP 409 (Conflict) and HTTP 429 (Too Many Requests)
◆ not-found: Retry if the origin returns a HTTP 404 (Not Found). This
can be useful when generating video content, and the segment is not
available yet.
RETRY_CONDITIONS must be one of: connect-failure, forbidden,
gateway-error, http-5xx, not-found, retriable-4xx,
retry-conditions-unspecified.
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. This variant is also available:
$ gcloud edge-cache origins update

View file

@ -0,0 +1,70 @@
NAME
gcloud alpha edge-cache services delete - delete an EdgeCacheService
resource
SYNOPSIS
gcloud alpha edge-cache services delete (SERVICE : --location=LOCATION)
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Delete an EdgeCacheService resource.
EXAMPLES
To delete an EdgeCacheService resource named 'my-service', run:
$ gcloud alpha edge-cache services delete my-service
POSITIONAL ARGUMENTS
Service resource - The EdgeCacheService resource 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 service 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.
SERVICE
ID of the service or fully qualified identifier for the service. To
set the service attribute:
▸ provide the argument service 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 service 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. This variant is also available:
$ gcloud edge-cache services delete

View file

@ -0,0 +1,65 @@
NAME
gcloud alpha edge-cache services describe - show details about an
EdgeCacheService resource
SYNOPSIS
gcloud alpha edge-cache services describe (SERVICE : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Show details about an EdgeCacheService resource.
EXAMPLES
To show details about an EdgeCacheService resource named 'my-service', run:
$ gcloud alpha edge-cache services describe my-service
POSITIONAL ARGUMENTS
Service resource - The EdgeCacheService resource 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 service 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.
SERVICE
ID of the service or fully qualified identifier for the service. To
set the service attribute:
▸ provide the argument service 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 service 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. This variant is also available:
$ gcloud edge-cache services describe

View file

@ -0,0 +1,74 @@
NAME
gcloud alpha edge-cache services export - export an EdgeCacheService
resource
SYNOPSIS
gcloud alpha edge-cache services export (SERVICE : --location=LOCATION)
[--destination=DESTINATION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Export an EdgeCacheService resource to YAML.
EXAMPLES
To export an existing EdgeCacheService resource named 'my-service', run:
$ gcloud alpha edge-cache services export my-service \
--destination=my-service.yaml
POSITIONAL ARGUMENTS
Service resource - The EdgeCacheService resource you want to export. 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 service 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.
SERVICE
ID of the service or fully qualified identifier for the service. To
set the service attribute:
▸ provide the argument service 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 service on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ use global location.
FLAGS
--destination=DESTINATION
Path to a YAML file where the configuration will be exported. The
exported data will not contain any output-only fields. Alternatively,
you may omit this flag to write to standard output. For a schema
describing the export/import format, see
$CLOUDSDKROOT/lib/googlecloudsdk/schemas/...
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. This variant is also available:
$ gcloud edge-cache services export

View file

@ -0,0 +1,47 @@
NAME
gcloud alpha edge-cache services - interact with and manage
EdgeCacheService resources
SYNOPSIS
gcloud alpha edge-cache services COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Interact with and manage EdgeCacheService resources.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
delete
(ALPHA) Delete an EdgeCacheService resource.
describe
(ALPHA) Show details about an EdgeCacheService resource.
export
(ALPHA) Export an EdgeCacheService resource.
import
(ALPHA) Import an EdgeCacheService resource.
invalidate-cache
(ALPHA) Invalidate the cache for an EdgeCacheService resource.
list
(ALPHA) List all EdgeCacheService resources in a project.
update
(ALPHA) Update an EdgeCacheService resource.
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. This variant is also available:
$ gcloud edge-cache services

View file

@ -0,0 +1,87 @@
NAME
gcloud alpha edge-cache services import - import an EdgeCacheService
resource
SYNOPSIS
gcloud alpha edge-cache services import (SERVICE : --location=LOCATION)
[--async] [--source=SOURCE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Import an EdgeCacheService resource. If the named EdgeCacheService
resource already exists, the resource will be updated to match the imported
resource configuration.
If the named EdgeCacheService resource does not already exist, a new
EdgeCacheService resource will be created with that name.
EXAMPLES
To import an EdgeCacheService resource named 'my-service' from a YAML file,
run:
$ gcloud alpha edge-cache services import my-service \
--source=my-service.yaml
POSITIONAL ARGUMENTS
Service resource - The EdgeCacheService resource you want to import. 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 service 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.
SERVICE
ID of the service or fully qualified identifier for the service. To
set the service attribute:
▸ provide the argument service 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 service 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.
--source=SOURCE
Path to a YAML file containing the configuration export data. The YAML
file must not contain any output-only fields. Alternatively, you may
omit this flag to read from standard input. For a schema describing the
export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/...
$CLOUDSDKROOT is can be obtained with the following command:
$ gcloud info --format='value(installation.sdk_root)'
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. This variant is also available:
$ gcloud edge-cache services import

View file

@ -0,0 +1,109 @@
NAME
gcloud alpha edge-cache services invalidate-cache - invalidate the cache
for an EdgeCacheService resource
SYNOPSIS
gcloud alpha edge-cache services invalidate-cache
(SERVICE : --location=LOCATION)
(--host=HOST --path=PATH --tags=[TAGS,...]) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Invalidate the cache entries associated with an EdgeCacheService
resource.
EXAMPLES
To invalidate content via a tag, or tags for a given host for an
EdgeCacheService named 'my-service':
$ gcloud alpha edge-cache services invalidate-cache my-service \
--tags="status=404" --host="media.example.com"
To invalidate all content under a specific path, specify an exact path, or
a prefix. Prefixes are denoted with a trailing * character.
$ gcloud alpha edge-cache services invalidate-cache my-service \
--path="/static/*"
You can optionally combine this with a status code. For example, to
invalidate all cached HTTP 404s:
$ gcloud alpha edge-cache services invalidate-cache my-service \
--tags="status=404" --path="/static/*"
POSITIONAL ARGUMENTS
Service resource - The EdgeCacheService resource you want to invalidate
the cache for. 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 service 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.
SERVICE
ID of the service or fully qualified identifier for the service. To
set the service attribute:
▸ provide the argument service 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 service on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ use global location.
REQUIRED FLAGS
At least one of these must be specified:
--host=HOST
The hostname to invalidate against. You can specify an exact or
wildcard host - e.g. "video.example.com" or ".example.com" - based on
host component.
--path=PATH
The path to invalidate against. You can specify an exact or wildcard
host - e.g. "/videos/hls/139123.mp4" or "/manifests/" - based on path
component.
--tags=[TAGS,...]
A list of cache tags used to identify cached objects.
▸ Cache tags are specified when the response is first cached, by
setting the "Cache-Tag" response header at the origin.
▸ By default, all objects have a cache tag representing the HTTP
status code of the response, the MIME content-type, and the origin.
▸ Multiple cache tags in the same revalidation request are treated
as boolean OR - e.g. tag1 OR tag2 OR tag3.
▸ If a host and/or path are also specified, these are treated as
boolean AND with any tags.
Up to 10 tags may be specified in a single invalidation request.
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. This variant is also available:
$ gcloud edge-cache services invalidate-cache

View file

@ -0,0 +1,69 @@
NAME
gcloud alpha edge-cache services list - list all EdgeCacheService resources
in a project
SYNOPSIS
gcloud alpha edge-cache services list [--filter=EXPRESSION] [--limit=LIMIT]
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List EdgeCacheService resources.
EXAMPLES
To list existing EdgeCacheService resources, run:
$ gcloud alpha edge-cache services list
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. This variant is also available:
$ gcloud edge-cache services list

View file

@ -0,0 +1,123 @@
NAME
gcloud alpha edge-cache services update - update an EdgeCacheService
resource
SYNOPSIS
gcloud alpha edge-cache services update (SERVICE : --location=LOCATION)
[--async] [--description=DESCRIPTION]
[--edge-security-policy=EDGE_SECURITY_POLICY]
[--edge-ssl-certificate=[EDGE_SSL_CERTIFICATE,...]] [--enable-logging]
[--labels=KEY=VALUE] [--logging-sample-rate=LOGGING_SAMPLE_RATE]
[--require-tls] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update an existing EdgeCacheService resource.
EXAMPLES
To update an EdgeCacheService resource called 'my-service' run:
$ gcloud alpha edge-cache services update my-service \
--description="new description"
POSITIONAL ARGUMENTS
Service resource - The name of the EdgeCacheService resource 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 service 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.
SERVICE
ID of the service or fully qualified identifier for the service. To
set the service attribute:
▸ provide the argument service 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 service 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
Human-readable description of the resource.
--edge-security-policy=EDGE_SECURITY_POLICY
Resource URL that points at the Cloud Armor edge security policy that
is applied on each request against the EdgeCacheService.
Security Policies should be specified as relative resource URLs - for
example projects/my-project/locations/global/securityPolicies/my-policy
Note that only security policies with a type of EDGE can be attached to
an EdgeCacheService.
--edge-ssl-certificate=[EDGE_SSL_CERTIFICATE,...]
URLs to sslCertificate resources that are used to authenticate
connections between users and the EdgeCacheService.
Certificates should be specified as relative resource URLs - for
example projects/my-project/locations/global/certificates/my-cert
Note that only "global" certificates with a "scope" of EDGE_CACHE can
be attached to an EdgeCacheService.
You may specify up to 5 SSL certificates per Service.
--enable-logging
Specifies whether to enable logging for traffic served by this service.
Defaults to false.
--labels=KEY=VALUE
List of KEY=VALUE labels to attach to this resource.
--logging-sample-rate=LOGGING_SAMPLE_RATE
Configures the sampling rate of requests, where 1.0 means all logged
requests are reported and 0.0 means no logged requests are reported.
The default value is 1.0, and the value of the field must be in [0, 1].
This field can only be specified if logging is enabled for this
service.
--require-tls
Require TLS (HTTPS) for all clients connecting to this service.
Clients who connect over HTTP (port 80) will receive a HTTP 301 to the
same URL over HTTPS (port 443). You must have at least one (1)
edgeSslCertificate specified to enable this.
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. This variant is also available:
$ gcloud edge-cache services update