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

gcloud: Wed Oct 2 09:51:07 UTC 2024

Browse source
This commit is contained in:
Automated 2024-10-02 09:51:07 +00:00
parent 0a5b6f11af
commit 489be55d99
133 changed files with 4948 additions and 242 deletions
Download patch file Download diff file Expand all files Collapse all files

85
gcloud/artifacts/attachments/create Normal file
View file

@ -0,0 +1,85 @@
NAME
gcloud artifacts attachments create - creates an Artifact registry
attachment in a repository
SYNOPSIS
gcloud artifacts attachments create
(ATTACHMENT : --location=LOCATION --repository=REPOSITORY)
--attachment-type=ATTACHMENT_TYPE --files=[FILES,...] --target=TARGET
[--attachment-namespace=ATTACHMENT_NAMESPACE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Creates an Artifact registry attachment in a repository.
EXAMPLES
To create an attachment for target
projects/myproject/locations/us-central1/packages/mypackage/versions/sha256:123
using a file located in /path/to/file/sbom.json:
$ gcloud artifacts attachments create \
--target=projects/myproject/locations/us-central1/packages/\
mypackage/versions/sha256:123 --files=/path/to/file/sbom.json
POSITIONAL ARGUMENTS
Attachment resource - The Artifact Registry attachment name. 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 attachment on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
ATTACHMENT
ID of the attachment or fully qualified identifier for the
attachment.
To set the name attribute:
▸ provide the argument attachment on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Location of the attachment.
To set the location attribute:
▸ provide the argument attachment on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property artifacts/location.
--repository=REPOSITORY
Repository of the attachment.
To set the repository attribute:
▸ provide the argument attachment on the command line with a fully
specified name;
▸ provide the argument --repository on the command line;
▸ set the property artifacts/repository.
REQUIRED FLAGS
--attachment-type=ATTACHMENT_TYPE
Type of the attachment
--files=[FILES,...]
Comma-seperated list of files that are part of this attachment
--target=TARGET
Target of the attachment, should be fully qualified version name
OPTIONAL FLAGS
--attachment-namespace=ATTACHMENT_NAMESPACE
Namespace of the attachment
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.

76
gcloud/artifacts/attachments/delete Normal file
View file

@ -0,0 +1,76 @@
NAME
gcloud artifacts attachments delete - delete an Artifact Registry
attachment
SYNOPSIS
gcloud artifacts attachments delete
(ATTACHMENT : --location=LOCATION --repository=REPOSITORY)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete an Artifact Registry attachment.
EXAMPLES
To delete an attachment my-attachment under the current project,
repository, and location, run:
$ gcloud artifacts attachments delete my-attachment
POSITIONAL ARGUMENTS
Attachment resource - The Artifact Registry attachment 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 attachment on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
ATTACHMENT
ID of the attachment or fully qualified identifier for the
attachment.
To set the attachment attribute:
▸ provide the argument attachment on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Location of the attachment. Overrides the default artifacts/location
property value for this command invocation. To configure the default
location, use the command: gcloud config set artifacts/location.
To set the location attribute:
▸ provide the argument attachment on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property artifacts/location.
--repository=REPOSITORY
The repository associated with the attachment. Overrides the default
artifacts/repository property value for this command invocation. To
configure the default repository, use the command: gcloud config set
artifacts/repository.
To set the repository attribute:
▸ provide the argument attachment on the command line with a fully
specified name;
▸ provide the argument --repository on the command line;
▸ set the property artifacts/repository.
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 artifactregistry/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/artifacts/docs/

84
gcloud/artifacts/attachments/download Normal file
View file

@ -0,0 +1,84 @@
NAME
gcloud artifacts attachments download - download an Artifact registry
attachment from a repository
SYNOPSIS
gcloud artifacts attachments download
[ATTACHMENT : --location=LOCATION --repository=REPOSITORY]
--destination=DESTINATION [--chunk-size=CHUNK_SIZE]
[--oci-version-name=OCI_VERSION_NAME] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Download an Artifact registry attachment from a repository.
EXAMPLES
To download the attachment my-attachment to /path/to/destination/:
$ gcloud artifacts attachments download my-attachment \
--destination=/path/to/destination/
To download the attachment my-attachment in 8000 byte chunks to
/path/to/destination/:
$ gcloud artifacts attachments download my-attachment \
--destination=/path/to/destination/ --chunk-size=8000
POSITIONAL ARGUMENTS
Attachment resource - The Artifact Registry attachment name. 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 attachment on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
ATTACHMENT
ID of the attachment or fully qualified identifier for the
attachment.
To set the name attribute:
▸ provide the argument attachment on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Location of the attachment.
To set the location attribute:
▸ provide the argument attachment on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property artifacts/location.
--repository=REPOSITORY
Repository of the attachment.
To set the repository attribute:
▸ provide the argument attachment on the command line with a fully
specified name;
▸ provide the argument --repository on the command line;
▸ set the property artifacts/repository.
REQUIRED FLAGS
--destination=DESTINATION
Path where you want to save the downloaded attachment files.
OPTIONAL FLAGS
--chunk-size=CHUNK_SIZE
If specified, the chunk size (bytes) to use for downloading the
package.
--oci-version-name=OCI_VERSION_NAME
The version name of the OCI artifact to download.
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.

36
gcloud/artifacts/attachments/help Normal file
View file

@ -0,0 +1,36 @@
NAME
gcloud artifacts attachments - manage Artifact Registry attachments
SYNOPSIS
gcloud artifacts attachments COMMAND [GCLOUD_WIDE_FLAG ...]
EXAMPLES
To list all attachments in the current project, repository and location,
run:
$ gcloud artifacts attachments list
To list attachments under repository my-repo in the current project and
location, run:
$ gcloud artifacts attachments list --repository=my-repo
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
Creates an Artifact registry attachment in a repository.
delete
Delete an Artifact Registry attachment.
download
Download an Artifact registry attachment from a repository.
list
List Artifact Registry attachments.

94
gcloud/artifacts/attachments/list Normal file
View file

@ -0,0 +1,94 @@
NAME
gcloud artifacts attachments list - list Artifact Registry attachments
SYNOPSIS
gcloud artifacts attachments list [--target=TARGET]
[--location=LOCATION --repository=REPOSITORY] [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List all Artifact Registry attachments in the specified repository and
project.
To specify the maximum number of attachments to list, use the --limit flag.
EXAMPLES
The following command lists a maximum of five attachments:
$ gcloud artifacts attachments list --limit=5
FLAGS
--target=TARGET
Target for the list of attachments.
Repository resource - Parent repository for the list of attachments. 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 --repository on the command line with a fully
specified name;
◆ set the property artifacts/repository with a fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
--location=LOCATION
Location of the repository. Overrides the default artifacts/location
property value for this command invocation. To configure the default
location, use the command: gcloud config set artifacts/location.
To set the location attribute:
▸ provide the argument --repository on the command line with a
fully specified name;
▸ set the property artifacts/repository with a fully specified
name;
▸ provide the argument --location on the command line;
▸ set the property artifacts/location.
--repository=REPOSITORY
ID of the repository or fully qualified identifier for the
repository.
To set the repository attribute:
▸ provide the argument --repository on the command line;
▸ set the property artifacts/repository.
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.
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 artifactregistry/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/artifacts/docs/

3
gcloud/artifacts/help
View file

@ -18,6 +18,9 @@ GROUPS
apt
Manage Artifact Registry Debian packages.
attachments
Manage Artifact Registry attachments.
docker
Manage Artifact Registry container images and tags.

8
gcloud/artifacts/sbom/export
View file

@ -2,7 +2,8 @@ NAME
gcloud artifacts sbom export - export SBOM files to Google Cloud Storage
SYNOPSIS
gcloud artifacts sbom export --uri=URI [GCLOUD_WIDE_FLAG ...]
gcloud artifacts sbom export --uri=URI [--location=LOCATION]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Export SBOM files to Google Cloud Storage.
@ -22,6 +23,11 @@ REQUIRED FLAGS
Registry. Make sure 'artifactregistry.projectsettings.get' permission
is granted to the current gcloud user to verify the redirection status.
OPTIONAL FLAGS
--location=LOCATION
If specified, all requests to Artifact Analysis for occurrences will go
to location specified
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,

6
gcloud/artifacts/sbom/list
View file

@ -2,7 +2,7 @@ NAME
gcloud artifacts sbom list - list SBOM file references
SYNOPSIS
gcloud artifacts sbom list
gcloud artifacts sbom list [--location=LOCATION]
[--dependency=DEPENDENCY | --resource=RESOURCE
| --resource-prefix=RESOURCE_PREFIX] [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE]
@ -42,6 +42,10 @@ EXAMPLES
$ gcloud artifacts sbom list --dependency="perl"
FLAGS
--location=LOCATION
If specified, all requests to Artifact Analysis for occurrences will go
to location specified
At most one of these can be specified:
--dependency=DEPENDENCY

6
gcloud/artifacts/sbom/load
View file

@ -5,7 +5,7 @@ NAME
SYNOPSIS
gcloud artifacts sbom load --source=SOURCE --uri=ARTIFACT_URI
[--destination=DESTINATION] [--kms-key-version=KMS_KEY_VERSION]
[GCLOUD_WIDE_FLAG ...]
[--location=LOCATION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Upload an SBOM file and create a reference occurrence.
@ -57,6 +57,10 @@ OPTIONAL FLAGS
provided should be the resource ID in the format of
projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]/cryptoKeyVersions/[KEY_VERSION].
--location=LOCATION
If specified, all requests to Artifact Analysis for occurrences will go
to location specified
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,

6
gcloud/artifacts/vulnerabilities/list
View file

@ -3,7 +3,7 @@ NAME
vulnerabilities. To see all fields, use --format=json
SYNOPSIS
gcloud artifacts vulnerabilities list URI
gcloud artifacts vulnerabilities list URI [--location=LOCATION]
[--occurrence-filter=OCCURRENCE_FILTER] [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
@ -24,6 +24,10 @@ POSITIONAL ARGUMENTS
Google Cloud Registry.
FLAGS
--location=LOCATION
If specified, all requests to Artifact Analysis for occurrences will go
to location specified
--occurrence-filter=OCCURRENCE_FILTER
A filter for the occurrences which will be summarized. See link for
officially supported filters:

6
gcloud/artifacts/vulnerabilities/load-vex
View file

@ -4,7 +4,7 @@ NAME
SYNOPSIS
gcloud artifacts vulnerabilities load-vex --source=SOURCE --uri=URI
[--project=PROJECT] [GCLOUD_WIDE_FLAG ...]
[--location=LOCATION] [--project=PROJECT] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Command loads VEX data from a Common Security Advisory Framework (CSAF)
@ -37,6 +37,10 @@ REQUIRED FLAGS
current gcloud user to verify the redirection status.
OPTIONAL FLAGS
--location=LOCATION
If specified, all requests to Artifact Analysis for occurrences will go
to location specified
--project=PROJECT
The parent project to load security advisory into.