mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-08 10:35:03 +00:00
gcloud: Thu Sep 8 09:21:50 UTC 2022
This commit is contained in:
parent
6749f65ca2
commit
e7bec9b31b
154 changed files with 2457 additions and 577 deletions
|
|
@ -3,7 +3,8 @@ NAME
|
|||
|
||||
SYNOPSIS
|
||||
gcloud logging buckets create BUCKET_ID --location=LOCATION
|
||||
[--description=DESCRIPTION] [--index=[KEY=VALUE, ...,...]]
|
||||
[--cmek-kms-key-name=CMEK_KMS_KEY_NAME] [--description=DESCRIPTION]
|
||||
[--index=[KEY=VALUE, ...,...]]
|
||||
[--restricted-fields=[RESTRICTED_FIELD,...]]
|
||||
[--retention-days=RETENTION_DAYS] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
|
|
@ -30,6 +31,11 @@ EXAMPLES
|
|||
$ gcloud logging buckets create my-bucket \
|
||||
--index=fieldPath=jsonPayload.foo,type=INDEX_TYPE_STRING
|
||||
|
||||
To create a bucket with custom CMEK, run:
|
||||
|
||||
$ gcloud logging buckets create my-bucket --location=us-central1 \
|
||||
--cmek-kms-key-name=CMEK_KMS_KEY_NAME
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
BUCKET_ID
|
||||
ID of the bucket to create.
|
||||
|
|
@ -40,6 +46,9 @@ REQUIRED FLAGS
|
|||
location cannot be changed.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
--cmek-kms-key-name=CMEK_KMS_KEY_NAME
|
||||
A valid kms_key_name will enable CMEK for the bucket.
|
||||
|
||||
--description=DESCRIPTION
|
||||
A textual description for the bucket.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@ NAME
|
|||
SYNOPSIS
|
||||
gcloud logging buckets update BUCKET_ID --location=LOCATION
|
||||
[--add-index=[KEY=VALUE, ...,...]] [--clear-indexes]
|
||||
[--description=DESCRIPTION] [--locked]
|
||||
[--remove-indexes=[FIELD PATH,...]]
|
||||
[--cmek-kms-key-name=CMEK_KMS_KEY_NAME] [--description=DESCRIPTION]
|
||||
[--locked] [--remove-indexes=[FIELD PATH,...]]
|
||||
[--restricted-fields=[RESTRICTED_FIELD,...]]
|
||||
[--retention-days=RETENTION_DAYS] [--update-index=[KEY=VALUE, ...,...]]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
|
@ -39,6 +39,11 @@ EXAMPLES
|
|||
$ gcloud logging buckets update my-bucket --location=global \
|
||||
--update-index=fieldPath=jsonPayload.foo,type=INDEX_TYPE_INTEGER
|
||||
|
||||
To update a bucket in your project and update existing cmek, run:
|
||||
|
||||
$ gcloud logging buckets update my-bucket --location=global \
|
||||
--cmek-kms-key-name=CMEK_KEY_NAME
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
BUCKET_ID
|
||||
The id of the bucket to update.
|
||||
|
|
@ -67,6 +72,9 @@ OPTIONAL FLAGS
|
|||
--clear-indexes
|
||||
Remove all logging indexes from the bucket.
|
||||
|
||||
--cmek-kms-key-name=CMEK_KMS_KEY_NAME
|
||||
A valid kms_key_name will enable CMEK for the bucket.
|
||||
|
||||
--description=DESCRIPTION
|
||||
A new description for the bucket.
|
||||
|
||||
|
|
|
|||
82
gcloud/logging/copy
Normal file
82
gcloud/logging/copy
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
NAME
|
||||
gcloud logging copy - copy log entries
|
||||
|
||||
SYNOPSIS
|
||||
gcloud logging copy BUCKET_ID DESTINATION --location=LOCATION
|
||||
[--log-filter=LOG_FILTER]
|
||||
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
|
||||
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
gcloud logging copy starts the process to copy log entries from a log
|
||||
bucket to a destination.
|
||||
|
||||
EXAMPLES
|
||||
To start a copy log entries operation, run:
|
||||
|
||||
$ gcloud logging copy "BUCKET_ID DESTINATION --location=LOCATION"
|
||||
|
||||
To copy log entries in a specific time window, run:
|
||||
|
||||
$ gcloud logging copy \
|
||||
'BUCKET_ID DESTINATION --location=LOCATION
|
||||
--log-filter=timestamp<="2021-05-31T23:59:59Z" AND
|
||||
timestamp>="2021-05-31T00:00:00Z"'
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
BUCKET_ID
|
||||
Id of the bucket to copy.
|
||||
|
||||
DESTINATION
|
||||
destination to which to copy logs.
|
||||
|
||||
REQUIRED FLAGS
|
||||
--location=LOCATION
|
||||
Location of the bucket.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
--log-filter=LOG_FILTER
|
||||
A filter specifying which log entries to copy. The filter must be no
|
||||
more than 20k characters. An empty filter matches all log entries.
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--billing-account=BILLING_ACCOUNT_ID
|
||||
Copy log entries associated with this billing account.
|
||||
|
||||
--folder=FOLDER_ID
|
||||
Copy log entries associated with this folder.
|
||||
|
||||
--organization=ORGANIZATION_ID
|
||||
Copy log entries associated with this organization.
|
||||
|
||||
--project=PROJECT_ID
|
||||
Copy log entries associated with this project.
|
||||
|
||||
The Google Cloud project ID to use for this invocation. If omitted,
|
||||
then the current project is assumed; the current project can be
|
||||
listed using gcloud config list --format='text(core.project)' and can
|
||||
be set using gcloud config set project PROJECTID.
|
||||
|
||||
--project and its fallback core/project property play two roles in
|
||||
the invocation. It specifies the project of the resource to operate
|
||||
on. It also specifies the project for API enablement check, quota,
|
||||
and billing. To specify a different project for quota and billing,
|
||||
use --billing-project or billing/quota_project property.
|
||||
|
||||
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
|
||||
These variants are also available:
|
||||
|
||||
$ gcloud alpha logging copy
|
||||
|
||||
$ gcloud beta logging copy
|
||||
|
||||
|
|
@ -27,9 +27,15 @@ GROUPS
|
|||
metrics
|
||||
Manages logs-based metrics.
|
||||
|
||||
operations
|
||||
Manage long running operations.
|
||||
|
||||
resource-descriptors
|
||||
Get information about resource descriptors.
|
||||
|
||||
settings
|
||||
Manages the org settings for the Cloud Logging Logs Router.
|
||||
|
||||
sinks
|
||||
Manages sinks used to route logs to storage or export destinations.
|
||||
|
||||
|
|
@ -39,6 +45,9 @@ GROUPS
|
|||
COMMANDS
|
||||
COMMAND is one of the following:
|
||||
|
||||
copy
|
||||
Copy log entries.
|
||||
|
||||
read
|
||||
Read log entries.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@ NAME
|
|||
SYNOPSIS
|
||||
gcloud logging metrics create METRIC_NAME
|
||||
(--config-from-file=CONFIG_FROM_FILE
|
||||
| --description=DESCRIPTION --log-filter=LOG_FILTER)
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
| [--description=DESCRIPTION --log-filter=LOG_FILTER
|
||||
: --bucket-name=BUCKET_NAME]) [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Creates a logs-based metric to count the number of log entries that match a
|
||||
|
|
@ -33,6 +33,12 @@ EXAMPLES
|
|||
how to configure metrics can be found at:
|
||||
https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.metrics#LogMetric.
|
||||
|
||||
To create a bucket log-based metric, run:
|
||||
|
||||
$ gcloud logging metrics create my_bucket_metric \
|
||||
--description="DESCRIPTION" --log-filter="LOG_FILTER" \
|
||||
--bucket-name="BUCKET_NAME"
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
METRIC_NAME
|
||||
The name of the new metric.
|
||||
|
|
@ -60,6 +66,9 @@ REQUIRED FLAGS
|
|||
This flag argument must be specified if any of the other arguments
|
||||
in this group are specified.
|
||||
|
||||
--bucket-name=BUCKET_NAME
|
||||
The Log Bucket name which owns the log-based metric.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --access-token-file, --account,
|
||||
--billing-project, --configuration, --flags-file, --flatten, --format,
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@ NAME
|
|||
|
||||
SYNOPSIS
|
||||
gcloud logging metrics update METRIC_NAME
|
||||
(--config-from-file=CONFIG_FROM_FILE
|
||||
| --description=DESCRIPTION --log-filter=LOG_FILTER)
|
||||
(--config-from-file=CONFIG_FROM_FILE | --bucket-name=BUCKET_NAME
|
||||
--description=DESCRIPTION --log-filter=LOG_FILTER)
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
|
|
@ -38,6 +38,11 @@ EXAMPLES
|
|||
Any top-level fields in the LogMetric definition that aren't specified in
|
||||
the config file will not be updated in the metric.
|
||||
|
||||
To update the bucket associated with a bucket log-based metric, run:
|
||||
|
||||
$ gcloud logging metrics update my-bucket-metric \
|
||||
--bucket-name="NEW_BUCKET_NAME"
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
METRIC_NAME
|
||||
The name of the log-based metric to update.
|
||||
|
|
@ -54,6 +59,9 @@ REQUIRED FLAGS
|
|||
Arguments to specify information about simple counter logs-based
|
||||
metrics.
|
||||
|
||||
--bucket-name=BUCKET_NAME
|
||||
The Log Bucket name which owns the log-based metric.
|
||||
|
||||
--description=DESCRIPTION
|
||||
A new description for the metric. If omitted, the description is
|
||||
not changed.
|
||||
|
|
|
|||
68
gcloud/logging/operations/cancel
Normal file
68
gcloud/logging/operations/cancel
Normal file
|
|
@ -0,0 +1,68 @@
|
|||
NAME
|
||||
gcloud logging operations cancel - cancel a long running operation
|
||||
|
||||
SYNOPSIS
|
||||
gcloud logging operations cancel OPERATION_ID --location=LOCATION
|
||||
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
|
||||
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Cancel a long running operation with given OPERATION_ID in given LOCATION.
|
||||
This operation can be a copy_log_entries operation which is scheduled
|
||||
before.
|
||||
|
||||
EXAMPLES
|
||||
To cancel an operation, run:
|
||||
|
||||
$ gcloud logging operations cancel OPERATION_ID --location=LOCATION
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
OPERATION_ID
|
||||
The Id of the operation.
|
||||
|
||||
REQUIRED FLAGS
|
||||
--location=LOCATION
|
||||
Location of the operation.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
At most one of these can be specified:
|
||||
|
||||
--billing-account=BILLING_ACCOUNT_ID
|
||||
Cancel operation associated with this billing account.
|
||||
|
||||
--folder=FOLDER_ID
|
||||
Cancel operation associated with this folder.
|
||||
|
||||
--organization=ORGANIZATION_ID
|
||||
Cancel operation associated with this organization.
|
||||
|
||||
--project=PROJECT_ID
|
||||
Cancel operation associated with this project.
|
||||
|
||||
The Google Cloud project ID to use for this invocation. If omitted,
|
||||
then the current project is assumed; the current project can be
|
||||
listed using gcloud config list --format='text(core.project)' and can
|
||||
be set using gcloud config set project PROJECTID.
|
||||
|
||||
--project and its fallback core/project property play two roles in
|
||||
the invocation. It specifies the project of the resource to operate
|
||||
on. It also specifies the project for API enablement check, quota,
|
||||
and billing. To specify a different project for quota and billing,
|
||||
use --billing-project or billing/quota_project property.
|
||||
|
||||
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
|
||||
These variants are also available:
|
||||
|
||||
$ gcloud alpha logging operations cancel
|
||||
|
||||
$ gcloud beta logging operations cancel
|
||||
|
||||
69
gcloud/logging/operations/describe
Normal file
69
gcloud/logging/operations/describe
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
NAME
|
||||
gcloud logging operations describe - describe a long running operation
|
||||
|
||||
SYNOPSIS
|
||||
gcloud logging operations describe OPERATION_ID --location=LOCATION
|
||||
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
|
||||
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Describe a long running operation which was scheduled before. For example,
|
||||
a copy_log_entries operation scheduled by command: "gcloud alpha logging
|
||||
copy BUCKET_ID DESTINATION --location=LOCATION" OPERATION_ID and LOCATION
|
||||
are required to locate such operation.
|
||||
|
||||
EXAMPLES
|
||||
To describe an operation, run:
|
||||
|
||||
$ gcloud logging operations describe OPERATION_ID --location=LOCATION
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
OPERATION_ID
|
||||
The Id of the operation.
|
||||
|
||||
REQUIRED FLAGS
|
||||
--location=LOCATION
|
||||
Location of the operation.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
At most one of these can be specified:
|
||||
|
||||
--billing-account=BILLING_ACCOUNT_ID
|
||||
Describe operation associated with this billing account.
|
||||
|
||||
--folder=FOLDER_ID
|
||||
Describe operation associated with this folder.
|
||||
|
||||
--organization=ORGANIZATION_ID
|
||||
Describe operation associated with this organization.
|
||||
|
||||
--project=PROJECT_ID
|
||||
Describe operation associated with this project.
|
||||
|
||||
The Google Cloud project ID to use for this invocation. If omitted,
|
||||
then the current project is assumed; the current project can be
|
||||
listed using gcloud config list --format='text(core.project)' and can
|
||||
be set using gcloud config set project PROJECTID.
|
||||
|
||||
--project and its fallback core/project property play two roles in
|
||||
the invocation. It specifies the project of the resource to operate
|
||||
on. It also specifies the project for API enablement check, quota,
|
||||
and billing. To specify a different project for quota and billing,
|
||||
use --billing-project or billing/quota_project property.
|
||||
|
||||
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
|
||||
These variants are also available:
|
||||
|
||||
$ gcloud alpha logging operations describe
|
||||
|
||||
$ gcloud beta logging operations describe
|
||||
|
||||
33
gcloud/logging/operations/help
Normal file
33
gcloud/logging/operations/help
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
NAME
|
||||
gcloud logging operations - manage long running operations
|
||||
|
||||
SYNOPSIS
|
||||
gcloud logging operations COMMAND [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Manage 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:
|
||||
|
||||
cancel
|
||||
Cancel a long running operation.
|
||||
|
||||
describe
|
||||
Describe a long running operation.
|
||||
|
||||
list
|
||||
List long running operations.
|
||||
|
||||
NOTES
|
||||
These variants are also available:
|
||||
|
||||
$ gcloud alpha logging operations
|
||||
|
||||
$ gcloud beta logging operations
|
||||
|
||||
120
gcloud/logging/operations/list
Normal file
120
gcloud/logging/operations/list
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
NAME
|
||||
gcloud logging operations list - list long running operations
|
||||
|
||||
SYNOPSIS
|
||||
gcloud logging operations list --location=LOCATION
|
||||
--operation-filter=OPERATION_FILTER
|
||||
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
|
||||
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
|
||||
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Return a list of long running operation details in given LOCATION. The
|
||||
operations were scheduled by other gcloud commands. For example: a
|
||||
copy_log_entries operation scheduled by command: gcloud alpha logging
|
||||
operations copy BUCKET_ID DESTINATION --location=LOCATION. Note: while
|
||||
listing the operations, the request_type must be specified in filter.
|
||||
Example: --operation-filter=request_type=CopyLogEntries, Supported
|
||||
operation types are: CopyLogEntries, CreateBucket and UpdateBucket. Other
|
||||
supported filter expression are: operation_start_time,
|
||||
operation_finish_time and operation_state.
|
||||
|
||||
EXAMPLES
|
||||
To list CopyLogEntries operations, run:
|
||||
|
||||
$ gcloud logging operations list --location=LOCATION \
|
||||
--operation-filter=request_type=CopyLogEntries
|
||||
|
||||
To list CopyLogEntries operations that started after a specified time, run:
|
||||
|
||||
$ gcloud logging operations list --location=LOCATION \
|
||||
--operation-filter=request_type=CopyLogEntries AND \
|
||||
operation_start_time>TIMESTAMP
|
||||
|
||||
To list CopyLogEntries operations that finished before a specified time,
|
||||
run:
|
||||
|
||||
$ gcloud logging operations list --location=LOCATION \
|
||||
--operation-filter=request_type=CopyLogEntries AND \
|
||||
operation_finish_time<TIMESTAMP
|
||||
|
||||
To list CopyLogEntries operations that have a specified state, run:
|
||||
|
||||
$ gcloud logging operations list --location=LOCATION \
|
||||
--operation-filter=request_type=CopyLogEntries AND \
|
||||
operation_state=STATE
|
||||
|
||||
To list CopyLogEntries operations that don't have a specified state, run:
|
||||
|
||||
$ gcloud logging operations list --location=LOCATION \
|
||||
--operation-filter=request_type=CopyLogEntries AND \
|
||||
operation_state!=STATE
|
||||
|
||||
REQUIRED FLAGS
|
||||
--location=LOCATION
|
||||
Location of the operations.
|
||||
|
||||
--operation-filter=OPERATION_FILTER
|
||||
Filter expression that specifies the operations to return.
|
||||
|
||||
FLAGS
|
||||
At most one of these can be specified:
|
||||
|
||||
--billing-account=BILLING_ACCOUNT_ID
|
||||
List operations associated with this billing account.
|
||||
|
||||
--folder=FOLDER_ID
|
||||
List operations associated with this folder.
|
||||
|
||||
--organization=ORGANIZATION_ID
|
||||
List operations associated with this organization.
|
||||
|
||||
--project=PROJECT_ID
|
||||
List operations associated with this project.
|
||||
|
||||
The Google Cloud project ID to use for this invocation. If omitted,
|
||||
then the current project is assumed; the current project can be
|
||||
listed using gcloud config list --format='text(core.project)' and can
|
||||
be set using gcloud config set project PROJECTID.
|
||||
|
||||
--project and its fallback core/project property play two roles in
|
||||
the invocation. It specifies the project of the resource to operate
|
||||
on. It also specifies the project for API enablement check, quota,
|
||||
and billing. To specify a different project for quota and billing,
|
||||
use --billing-project or billing/quota_project property.
|
||||
|
||||
LIST COMMAND FLAGS
|
||||
--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.
|
||||
|
||||
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
|
||||
These variants are also available:
|
||||
|
||||
$ gcloud alpha logging operations list
|
||||
|
||||
$ gcloud beta logging operations list
|
||||
|
||||
71
gcloud/logging/settings/describe
Normal file
71
gcloud/logging/settings/describe
Normal file
|
|
@ -0,0 +1,71 @@
|
|||
NAME
|
||||
gcloud logging settings describe - displays the settings for the Cloud
|
||||
Logging Logs Router
|
||||
|
||||
SYNOPSIS
|
||||
gcloud logging settings describe
|
||||
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
|
||||
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
If kmsKeyName is present in the output, then CMEK is enabled for your
|
||||
project, folder, organization or billing-account. You can also find the
|
||||
Logs Router service account using this command.
|
||||
|
||||
EXAMPLES
|
||||
To describe the Logs Router settings for a project, run:
|
||||
|
||||
$ gcloud logging settings describe --project=[PROJECT_ID]
|
||||
|
||||
To describe the Logs Router settings for an organization, run:
|
||||
|
||||
$ gcloud logging settings describe --organization=[ORGANIZATION_ID]
|
||||
|
||||
kmsKeyName:
|
||||
'projects/my-project/locations/my-location/keyRings/my-keyring/cryptoKeys/key'
|
||||
name: 'organizations/[ORGANIZATION_ID]/settings'
|
||||
serviceAccountId:
|
||||
'[SERVICE_ACCOUNT_ID]@gcp-sa-logging.iam.gserviceaccount.com'
|
||||
|
||||
FLAGS
|
||||
At most one of these can be specified:
|
||||
|
||||
--billing-account=BILLING_ACCOUNT_ID
|
||||
Describe settings associated with this billing account.
|
||||
|
||||
--folder=FOLDER_ID
|
||||
Describe settings associated with this folder.
|
||||
|
||||
--organization=ORGANIZATION_ID
|
||||
Describe settings associated with this organization.
|
||||
|
||||
--project=PROJECT_ID
|
||||
Describe settings associated with this project.
|
||||
|
||||
The Google Cloud project ID to use for this invocation. If omitted,
|
||||
then the current project is assumed; the current project can be
|
||||
listed using gcloud config list --format='text(core.project)' and can
|
||||
be set using gcloud config set project PROJECTID.
|
||||
|
||||
--project and its fallback core/project property play two roles in
|
||||
the invocation. It specifies the project of the resource to operate
|
||||
on. It also specifies the project for API enablement check, quota,
|
||||
and billing. To specify a different project for quota and billing,
|
||||
use --billing-project or billing/quota_project property.
|
||||
|
||||
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
|
||||
These variants are also available:
|
||||
|
||||
$ gcloud alpha logging settings describe
|
||||
|
||||
$ gcloud beta logging settings describe
|
||||
|
||||
31
gcloud/logging/settings/help
Normal file
31
gcloud/logging/settings/help
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
NAME
|
||||
gcloud logging settings - manages the org settings for the Cloud Logging
|
||||
Logs Router
|
||||
|
||||
SYNOPSIS
|
||||
gcloud logging settings COMMAND [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Manages the org settings for the Cloud Logging Logs Router.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --help.
|
||||
|
||||
Run $ gcloud help for details.
|
||||
|
||||
COMMANDS
|
||||
COMMAND is one of the following:
|
||||
|
||||
describe
|
||||
Displays the settings for the Cloud Logging Logs Router.
|
||||
|
||||
update
|
||||
Updates the settings for the Cloud Logging Logs Router.
|
||||
|
||||
NOTES
|
||||
These variants are also available:
|
||||
|
||||
$ gcloud alpha logging settings
|
||||
|
||||
$ gcloud beta logging settings
|
||||
|
||||
133
gcloud/logging/settings/update
Normal file
133
gcloud/logging/settings/update
Normal file
|
|
@ -0,0 +1,133 @@
|
|||
NAME
|
||||
gcloud logging settings update - updates the settings for the Cloud Logging
|
||||
Logs Router
|
||||
|
||||
SYNOPSIS
|
||||
gcloud logging settings update
|
||||
(--folder=FOLDER_ID | --organization=ORGANIZATION_ID)
|
||||
[--disable-default-sink] [--storage-location=STORAGE_LOCATION]
|
||||
[--clear-kms-key | [--kms-key-name=KMS_KEY_NAME
|
||||
: --kms-keyring=KMS_KEYRING
|
||||
--kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Use this command to update the --kms-key-name, --storage-location and
|
||||
--disable-default-sink associated with the Cloud Logging Logs Router.
|
||||
|
||||
The Cloud KMS key must already exist and Cloud Logging must have permission
|
||||
to access it.
|
||||
|
||||
The storage location must be allowed by Org Policy.
|
||||
|
||||
Customer-managed encryption keys (CMEK) for the Logs Router can currently
|
||||
only be configured at the organization-level and will apply to all projects
|
||||
in the organization.
|
||||
|
||||
EXAMPLES
|
||||
To enable CMEK for the Logs Router for an organization, run:
|
||||
|
||||
$ gcloud logging settings update --organization=[ORGANIZATION_ID] \
|
||||
--kms-key-name='projects/my-project/locations/my-location/keyRin\
|
||||
gs/my-keyring/cryptoKeys/key'
|
||||
|
||||
To disable CMEK for the Logs Router for an organization, run:
|
||||
|
||||
$ gcloud logging settings update --organization=[ORGANIZATION_ID] \
|
||||
--clear-kms-key
|
||||
|
||||
To update storage location for the Logs Router for an organization, run:
|
||||
|
||||
$ gcloud logging settings update --organization=[ORGANIZATION_ID] \
|
||||
--storage-location=[LOCATION_ID]
|
||||
|
||||
To update storage location for the Logs Router for a folder, run:
|
||||
|
||||
$ gcloud logging settings update --folder=[FOLDER_ID] \
|
||||
--storage-location=[LOCATION_ID]
|
||||
|
||||
To disable default sink for the Logs Router for an organization, run:
|
||||
|
||||
$ gcloud logging settings update --organization=[ORGANIZATION_ID] \
|
||||
--disable-default-sink=true
|
||||
|
||||
To enable default sink for the Logs Router for an organization, run:
|
||||
|
||||
$ gcloud logging settings update --organization=[ORGANIZATION_ID] \
|
||||
--disable-default-sink=false
|
||||
|
||||
REQUIRED FLAGS
|
||||
Exactly one of these must be specified:
|
||||
|
||||
--folder=FOLDER_ID
|
||||
Folder to update Logs Router settings for.
|
||||
|
||||
--organization=ORGANIZATION_ID
|
||||
Organization to update Logs Router settings for.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
--disable-default-sink
|
||||
Enable or disable Default sink for the Default bucket. Specify
|
||||
--no-disable-default-sink to enable a disabled Default sink. Note: It
|
||||
only applies to the newly created projects and will not affect the
|
||||
projects created before.
|
||||
|
||||
--storage-location=STORAGE_LOCATION
|
||||
Update the storage location for Default bucket and Required bucket.
|
||||
Note: It only applies to the newly created projects and will not affect
|
||||
the projects created before.
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--clear-kms-key
|
||||
Disable CMEK for the Logs Router by clearing out Cloud KMS cryptokey
|
||||
in the organization's CMEK settings.
|
||||
|
||||
Key resource - The Cloud KMS (Key Management Service) cryptokey that
|
||||
will be used to protect the logs being processed by the Cloud Logging
|
||||
Logs Router. The Cloud KMS CryptoKey Encrypter/Decryper role must be
|
||||
assigned to the Cloud Logging Logs Router service account. The arguments
|
||||
in this group can be used to specify the attributes of this resource.
|
||||
|
||||
--kms-key-name=KMS_KEY_NAME
|
||||
ID of the key or fully qualified identifier for the key. To set the
|
||||
kms-key attribute:
|
||||
▫ provide the argument --kms-key-name on the command line.
|
||||
|
||||
This flag argument must be specified if any of the other arguments
|
||||
in this group are specified.
|
||||
|
||||
--kms-keyring=KMS_KEYRING
|
||||
The KMS keyring of the key. To set the kms-keyring attribute:
|
||||
▫ provide the argument --kms-key-name on the command line with a
|
||||
fully specified name;
|
||||
▫ provide the argument --kms-keyring on the command line.
|
||||
|
||||
--kms-location=KMS_LOCATION
|
||||
The Cloud location for the key. To set the kms-location attribute:
|
||||
▫ provide the argument --kms-key-name on the command line with a
|
||||
fully specified name;
|
||||
▫ provide the argument --kms-location on the command line.
|
||||
|
||||
--kms-project=KMS_PROJECT
|
||||
The Cloud project for the key. To set the kms-project attribute:
|
||||
▫ provide the argument --kms-key-name on the command line with a
|
||||
fully specified name;
|
||||
▫ provide the argument --kms-project on the command line;
|
||||
▫ set the property core/project.
|
||||
|
||||
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
|
||||
These variants are also available:
|
||||
|
||||
$ gcloud alpha logging settings update
|
||||
|
||||
$ gcloud beta logging settings update
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue