From 01248d2ae77a47325a633cf109456fa117f947ed Mon Sep 17 00:00:00 2001 From: Farhad Koushan Date: Tue, 14 Nov 2023 20:04:39 -0800 Subject: [PATCH 01/18] created new pages --- pages/common/gcloud-IAM.md | 4 ++++ pages/common/gcloud-VM_CE.md | 4 ++++ pages/common/gcloud-auth_creds.md | 4 ++++ pages/common/gcloud-docker_GKE.md | 4 ++++ pages/common/gcloud-help.md | 4 ++++ pages/common/gcloud-miscellaneous.md | 4 ++++ pages/common/gcloud-personalization.md | 4 ++++ pages/common/gcloud-projects.md | 4 ++++ pages/common/gcloud-serverless_app-engine.md | 4 ++++ pages/common/gcloud-starting.md | 4 ++++ 10 files changed, 40 insertions(+) create mode 100644 pages/common/gcloud-IAM.md create mode 100644 pages/common/gcloud-VM_CE.md create mode 100644 pages/common/gcloud-auth_creds.md create mode 100644 pages/common/gcloud-docker_GKE.md create mode 100644 pages/common/gcloud-help.md create mode 100644 pages/common/gcloud-miscellaneous.md create mode 100644 pages/common/gcloud-personalization.md create mode 100644 pages/common/gcloud-projects.md create mode 100644 pages/common/gcloud-serverless_app-engine.md create mode 100644 pages/common/gcloud-starting.md diff --git a/pages/common/gcloud-IAM.md b/pages/common/gcloud-IAM.md new file mode 100644 index 0000000000..dd374fcc94 --- /dev/null +++ b/pages/common/gcloud-IAM.md @@ -0,0 +1,4 @@ +# gcloud CLI IAM + +> The official CLI tool for Google Cloud Platform. +> More information: . diff --git a/pages/common/gcloud-VM_CE.md b/pages/common/gcloud-VM_CE.md new file mode 100644 index 0000000000..3c3f9842dd --- /dev/null +++ b/pages/common/gcloud-VM_CE.md @@ -0,0 +1,4 @@ +# gcloud CLI Virtual Machines and Computer Engine + +> The official CLI tool for Google Cloud Platform. +> More information: . diff --git a/pages/common/gcloud-auth_creds.md b/pages/common/gcloud-auth_creds.md new file mode 100644 index 0000000000..5346c43192 --- /dev/null +++ b/pages/common/gcloud-auth_creds.md @@ -0,0 +1,4 @@ +# gcloud CLI Authorization and Credentials + +> The official CLI tool for Google Cloud Platform. +> More information: . diff --git a/pages/common/gcloud-docker_GKE.md b/pages/common/gcloud-docker_GKE.md new file mode 100644 index 0000000000..b12870fd03 --- /dev/null +++ b/pages/common/gcloud-docker_GKE.md @@ -0,0 +1,4 @@ +# gcloud CLI Docker and Google Kubernetes Engine + +> The official CLI tool for Google Cloud Platform. +> More information: . diff --git a/pages/common/gcloud-help.md b/pages/common/gcloud-help.md new file mode 100644 index 0000000000..a0f7fc1352 --- /dev/null +++ b/pages/common/gcloud-help.md @@ -0,0 +1,4 @@ +# gcloud CLI Help + +> The official CLI tool for Google Cloud Platform. +> More information: . diff --git a/pages/common/gcloud-miscellaneous.md b/pages/common/gcloud-miscellaneous.md new file mode 100644 index 0000000000..085dd18cda --- /dev/null +++ b/pages/common/gcloud-miscellaneous.md @@ -0,0 +1,4 @@ +# gcloud CLI Miscellaneous Commands + +> The official CLI tool for Google Cloud Platform. +> More information: . diff --git a/pages/common/gcloud-personalization.md b/pages/common/gcloud-personalization.md new file mode 100644 index 0000000000..288c2a43c4 --- /dev/null +++ b/pages/common/gcloud-personalization.md @@ -0,0 +1,4 @@ +# gcloud CLI Personalization + +> The official CLI tool for Google Cloud Platform. +> More information: . diff --git a/pages/common/gcloud-projects.md b/pages/common/gcloud-projects.md new file mode 100644 index 0000000000..54308306cc --- /dev/null +++ b/pages/common/gcloud-projects.md @@ -0,0 +1,4 @@ +# gcloud CLI Projects + +> The official CLI tool for Google Cloud Platform. +> More information: . diff --git a/pages/common/gcloud-serverless_app-engine.md b/pages/common/gcloud-serverless_app-engine.md new file mode 100644 index 0000000000..75570e6e56 --- /dev/null +++ b/pages/common/gcloud-serverless_app-engine.md @@ -0,0 +1,4 @@ +# gcloud CLI Serverless and App Engine + +> The official CLI tool for Google Cloud Platform. +> More information: diff --git a/pages/common/gcloud-starting.md b/pages/common/gcloud-starting.md new file mode 100644 index 0000000000..44719bd4ca --- /dev/null +++ b/pages/common/gcloud-starting.md @@ -0,0 +1,4 @@ +# gcloud CLI Getting started + +> The official CLI tool for Google Cloud Platform. +> More information: . From fdfebc70888765adc7bcac6a5ef63651af9ae6fa Mon Sep 17 00:00:00 2001 From: Farhad Koushan Date: Thu, 30 Nov 2023 23:14:37 -0800 Subject: [PATCH 02/18] all gcloud pages added --- pages/common/gcloud-IAM.md | 15 +++++++++++++++ pages/common/gcloud-VM_CE.md | 20 ++++++++++++++++++++ pages/common/gcloud-auth_creds.md | 15 +++++++++++++++ pages/common/gcloud-docker_GKE.md | 13 +++++++++++++ pages/common/gcloud-help.md | 9 +++++++++ pages/common/gcloud-miscellaneous.md | 11 +++++++++++ pages/common/gcloud-personalization.md | 15 +++++++++++++++ pages/common/gcloud-projects.md | 7 +++++++ pages/common/gcloud-serverless_app-engine.md | 13 +++++++++++++ pages/common/gcloud-starting.md | 15 +++++++++++++++ 10 files changed, 133 insertions(+) diff --git a/pages/common/gcloud-IAM.md b/pages/common/gcloud-IAM.md index dd374fcc94..2ce1127442 100644 --- a/pages/common/gcloud-IAM.md +++ b/pages/common/gcloud-IAM.md @@ -2,3 +2,18 @@ > The official CLI tool for Google Cloud Platform. > More information: . + +IAM +Configuring Identity and Access Management (IAM) preferences and service accounts. + +`gcloud iam list-grantable-roles`: List IAM grantable roles for a resource (https://cloud.google.com/sdk/gcloud/reference/iam/list-grantable-roles) + +`gcloud iam roles create`: Create a custom role for a project or org (https://cloud.google.com/sdk/gcloud/reference/iam/roles/create) + +`gcloud iam service-accounts create`: Create a service account for a project (https://cloud.google.com/sdk/gcloud/reference/iam/service-accounts/create) + +`gcloud iam service-accounts add-iam-policy-binding`: Add an IAM policy binding to a service account (https://cloud.google.com/sdk/gcloud/reference/iam/service-accounts/add-iam-policy-binding) + +`gcloud iam service-accounts set-iam-policy-binding`: Replace existing IAM policy binding (https://cloud.google.com/sdk/gcloud/reference/iam/service-accounts/set-iam-policy) + +`gcloud iam service-accounts keys list`: List a service account's keys (https://cloud.google.com/sdk/gcloud/reference/iam/service-accounts/keys/list) diff --git a/pages/common/gcloud-VM_CE.md b/pages/common/gcloud-VM_CE.md index 3c3f9842dd..806d704bea 100644 --- a/pages/common/gcloud-VM_CE.md +++ b/pages/common/gcloud-VM_CE.md @@ -2,3 +2,23 @@ > The official CLI tool for Google Cloud Platform. > More information: . + +Virtual Machines & Compute Engine + +Create, run, and manage VMs on Google Cloud infrastructure. + +`gcloud compute zones list`: List Compute Engine zones (https://cloud.google.com/sdk/gcloud/reference/compute/zones/list) + +`gcloud compute instances create`: Create a VM instance (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create) + +`gcloud compute instances describe`: Display a VM instance's details (https://cloud.google.com/sdk/gcloud/reference/compute/instances/describe) + +`gcloud compute instances list`: List all VM instances in a project (https://cloud.google.com/sdk/gcloud/reference/compute/instances/list) + +`gcloud compute disks snapshot`: Create snapshot of persistent disks (https://cloud.google.com/sdk/gcloud/reference/compute/disks/snapshot) + +`gcloud compute snapshots describe`: Display a snapshot's details (https://cloud.google.com/sdk/gcloud/reference/compute/snapshots/describe) + +`gcloud compute snapshots delete`: Delete a snapshot (https://cloud.google.com/sdk/gcloud/reference/compute/snapshots/delete) + +`gcloud compute ssh`: Connect to a VM instance by using SSH (https://cloud.google.com/sdk/gcloud/reference/compute/ssh) diff --git a/pages/common/gcloud-auth_creds.md b/pages/common/gcloud-auth_creds.md index 5346c43192..533af2520b 100644 --- a/pages/common/gcloud-auth_creds.md +++ b/pages/common/gcloud-auth_creds.md @@ -2,3 +2,18 @@ > The official CLI tool for Google Cloud Platform. > More information: . + +Authorization and Credentials +Grant and revoke authorization to the gcloud CLI and manage credentials. + +`gcloud auth login`: Authorize Google Cloud access for the gcloud CLI with Google Cloud user credentials and set the current account as active (https://cloud.google.com/sdk/gcloud/reference/auth/login) + +`gcloud auth activate-service-account`: Authorize Google Cloud access similar to gcloud auth login but with service account credentials (https://cloud.google.com/sdk/gcloud/reference/auth/activate-service-account) + +`gcloud auth application-default`: Manage your Application Default Credentials (ADC) for Cloud Client Libraries (https://cloud.google.com/sdk/gcloud/reference/auth/application-default) + +`gcloud auth list`: List all credentialed accounts (https://cloud.google.com/sdk/gcloud/reference/auth/list) + +`gcloud auth print-access-token`: Display the current account's access token (https://cloud.google.com/sdk/gcloud/reference/auth/print-access-token) + +`gcloud auth revoke`: Remove access credentials for an account (https://cloud.google.com/sdk/gcloud/reference/auth/revoke) diff --git a/pages/common/gcloud-docker_GKE.md b/pages/common/gcloud-docker_GKE.md index b12870fd03..ffb19bfe14 100644 --- a/pages/common/gcloud-docker_GKE.md +++ b/pages/common/gcloud-docker_GKE.md @@ -2,3 +2,16 @@ > The official CLI tool for Google Cloud Platform. > More information: . + +Docker & Google Kubernetes Engine (GKE) +Manage containerized applications on Kubernetes. + +`gcloud auth configure-docker`: Register the gcloud CLI as a Docker credential helper (https://cloud.google.com/sdk/gcloud/reference/auth/configure-docker) + +`gcloud container clusters create`: Create a cluster to run GKE containers (https://cloud.google.com/sdk/gcloud/reference/container/clusters/create) + +`gcloud container clusters list`: List clusters for running GKE containers (https://cloud.google.com/sdk/gcloud/reference/container/clusters/list) + +`gcloud container clusters get-credentials`: Update kubeconfig to get kubectl to use a GKE cluster (https://cloud.google.com/sdk/gcloud/reference/container/clusters/get-credentials) + +`gcloud container images list-tags`: List tag and digest metadata for a container image (https://cloud.google.com/sdk/gcloud/reference/container/images/list-tags) diff --git a/pages/common/gcloud-help.md b/pages/common/gcloud-help.md index a0f7fc1352..efcec7f4ae 100644 --- a/pages/common/gcloud-help.md +++ b/pages/common/gcloud-help.md @@ -2,3 +2,12 @@ > The official CLI tool for Google Cloud Platform. > More information: . + +Help +gcloud CLI is happy to help. + +`gcloud help`: Search the gcloud CLI reference documents for specific terms (https://cloud.google.com/sdk/gcloud/reference/help) + +`gcloud feedback`: Provide feedback to the gcloud CLI team (https://cloud.google.com/sdk/gcloud/reference/feedback) + +`gcloud topic`: Supplementary help material for non-command topics like accessibility, filtering, and formatting (https://cloud.google.com/sdk/gcloud/reference/topic) diff --git a/pages/common/gcloud-miscellaneous.md b/pages/common/gcloud-miscellaneous.md index 085dd18cda..8996fdadb2 100644 --- a/pages/common/gcloud-miscellaneous.md +++ b/pages/common/gcloud-miscellaneous.md @@ -2,3 +2,14 @@ > The official CLI tool for Google Cloud Platform. > More information: . + +Miscellaneous +Commands that might come in handy + +`gcloud kms decrypt`: Decrypt ciphertext (to a plaintext file) using a Cloud Key Management Service key (https://cloud.google.com/sdk/gcloud/reference/kms/decrypt) + +`gcloud logging logs list`: List your project's logs (https://cloud.google.com/sdk/gcloud/reference/logging/logs/list) + +`gcloud sql backups describe`: Display info about a Cloud SQL instance backup (https://cloud.google.com/sdk/gcloud/reference/sql/backups/describe) + +`gcloud sql export sql`: Export data from a Cloud SQL instance to a SQL file (https://cloud.google.com/sdk/gcloud/reference/sql/export/sql) diff --git a/pages/common/gcloud-personalization.md b/pages/common/gcloud-personalization.md index 288c2a43c4..8f7bd204fb 100644 --- a/pages/common/gcloud-personalization.md +++ b/pages/common/gcloud-personalization.md @@ -2,3 +2,18 @@ > The official CLI tool for Google Cloud Platform. > More information: . + +Personalization +Make the gcloud CLI your own; personalize your configuration with properties. + +`gcloud config set`: Define a property (like compute/zone) for the current configuration (https://cloud.google.com/sdk/gcloud/reference/config/set) + +`gcloud config get`: Fetch the value of a gcloud CLI property (https://cloud.google.com/sdk/gcloud/reference/config/get) + +`gcloud config list`: Display all the properties for the current configuration (https://cloud.google.com/sdk/gcloud/reference/config/list) + +`gcloud config configurations create`: Create a new named configuration (https://cloud.google.com/sdk/gcloud/reference/config/configurations/create) + +`gcloud config configurations list`: Display a list of all available configurations (https://cloud.google.com/sdk/gcloud/reference/config/configurations/list) + +`gcloud config configurations activate`: Switch to an existing named configuration (https://cloud.google.com/sdk/gcloud/reference/config/configurations/activate) diff --git a/pages/common/gcloud-projects.md b/pages/common/gcloud-projects.md index 54308306cc..b49bc03b17 100644 --- a/pages/common/gcloud-projects.md +++ b/pages/common/gcloud-projects.md @@ -2,3 +2,10 @@ > The official CLI tool for Google Cloud Platform. > More information: . + +Projects +Manage project access policies. + +`gcloud projects describe`: Display metadata for a project (including its ID) (https://cloud.google.com/sdk/gcloud/reference/projects/describe) + +`gcloud projects add-iam-policy-binding`: Add an IAM policy binding to a specified project (https://cloud.google.com/sdk/gcloud/reference/projects/add-iam-policy-binding) diff --git a/pages/common/gcloud-serverless_app-engine.md b/pages/common/gcloud-serverless_app-engine.md index 75570e6e56..575d740969 100644 --- a/pages/common/gcloud-serverless_app-engine.md +++ b/pages/common/gcloud-serverless_app-engine.md @@ -2,3 +2,16 @@ > The official CLI tool for Google Cloud Platform. > More information: + +Serverless & App Engine +Build highly scalable applications on a fully managed serverless platform + +`gcloud app deploy`: Deploy your app's code and configuration to the App Engine server (https://cloud.google.com/sdk/gcloud/reference/app/deploy) + +`gcloud app versions list`: List all versions of all services deployed to the App Engine server (https://cloud.google.com/sdk/gcloud/reference/app/versions/list) + +`gcloud app browse`: Open the current app in a web browser (https://cloud.google.com/sdk/gcloud/reference/app/browse) + +`gcloud app create`: Create an App Engine app within your current project (https://cloud.google.com/sdk/gcloud/reference/app/create) + +`gcloud app logs read`: Display the latest App Engine app logs (https://cloud.google.com/sdk/gcloud/reference/app/logs/read) diff --git a/pages/common/gcloud-starting.md b/pages/common/gcloud-starting.md index 44719bd4ca..67fe57a4bc 100644 --- a/pages/common/gcloud-starting.md +++ b/pages/common/gcloud-starting.md @@ -2,3 +2,18 @@ > The official CLI tool for Google Cloud Platform. > More information: . + +Getting started +Get going with the gcloud CLI. + +`gcloud init`: Initialize, authorize, and configure the gcloud CLI (https://cloud.google.com/sdk/gcloud/reference/init) + +`gcloud version`: Display version and installed components (https://cloud.google.com/sdk/gcloud/reference/version) + +`gcloud components install`: Install specific components (https://cloud.google.com/sdk/gcloud/reference/components/install) + +`gcloud components update`: Update your gcloud CLI to the latest version (https://cloud.google.com/sdk/gcloud/reference/components/update) + +`gcloud config set project`: Set a default Google Cloud project to work on (https://cloud.google.com/sdk/gcloud/reference/config/set) + +`gcloud info`: Display current gcloud CLI environment details (https://cloud.google.com/sdk/gcloud/reference/info) From 59f563f6b6c8c90d13e813bab69681445412a776 Mon Sep 17 00:00:00 2001 From: Farhad Koushan Date: Fri, 1 Dec 2023 15:37:18 -0800 Subject: [PATCH 03/18] all gcloud pages updated --- pages/common/gcloud-IAM.md | 27 ++++++++++----- pages/common/gcloud-VM_CE.md | 24 ------------- pages/common/gcloud-app.md | 24 +++++++++++++ pages/common/gcloud-auth.md | 28 +++++++++++++++ pages/common/gcloud-auth_creds.md | 19 ----------- pages/common/gcloud-compute.md | 36 ++++++++++++++++++++ pages/common/gcloud-config.md | 28 +++++++++++++++ pages/common/gcloud-docker.md | 24 +++++++++++++ pages/common/gcloud-docker_GKE.md | 17 --------- pages/common/gcloud-help.md | 15 ++++---- pages/common/gcloud-miscellaneous.md | 19 +++++++---- pages/common/gcloud-personalization.md | 19 ----------- pages/common/gcloud-projects.md | 11 +++--- pages/common/gcloud-serverless_app-engine.md | 17 --------- pages/common/gcloud-starting.md | 27 ++++++++++----- 15 files changed, 203 insertions(+), 132 deletions(-) delete mode 100644 pages/common/gcloud-VM_CE.md create mode 100644 pages/common/gcloud-app.md create mode 100644 pages/common/gcloud-auth.md delete mode 100644 pages/common/gcloud-auth_creds.md create mode 100644 pages/common/gcloud-compute.md create mode 100644 pages/common/gcloud-config.md create mode 100644 pages/common/gcloud-docker.md delete mode 100644 pages/common/gcloud-docker_GKE.md delete mode 100644 pages/common/gcloud-personalization.md delete mode 100644 pages/common/gcloud-serverless_app-engine.md diff --git a/pages/common/gcloud-IAM.md b/pages/common/gcloud-IAM.md index 2ce1127442..51f3a937b8 100644 --- a/pages/common/gcloud-IAM.md +++ b/pages/common/gcloud-IAM.md @@ -1,19 +1,28 @@ # gcloud CLI IAM -> The official CLI tool for Google Cloud Platform. +> Configuring Identity and Access Management (IAM) preferences and service accounts. > More information: . -IAM -Configuring Identity and Access Management (IAM) preferences and service accounts. +- List IAM grantable roles for a resource: -`gcloud iam list-grantable-roles`: List IAM grantable roles for a resource (https://cloud.google.com/sdk/gcloud/reference/iam/list-grantable-roles) +`gcloud iam list-grantable-roles` -`gcloud iam roles create`: Create a custom role for a project or org (https://cloud.google.com/sdk/gcloud/reference/iam/roles/create) +- Create a custom role for a project or org: -`gcloud iam service-accounts create`: Create a service account for a project (https://cloud.google.com/sdk/gcloud/reference/iam/service-accounts/create) +`gcloud iam roles create` -`gcloud iam service-accounts add-iam-policy-binding`: Add an IAM policy binding to a service account (https://cloud.google.com/sdk/gcloud/reference/iam/service-accounts/add-iam-policy-binding) +- Create a service account for a project: -`gcloud iam service-accounts set-iam-policy-binding`: Replace existing IAM policy binding (https://cloud.google.com/sdk/gcloud/reference/iam/service-accounts/set-iam-policy) +`gcloud iam service-accounts create` -`gcloud iam service-accounts keys list`: List a service account's keys (https://cloud.google.com/sdk/gcloud/reference/iam/service-accounts/keys/list) +- Add an IAM policy binding to a service account: + +`gcloud iam service-accounts add-iam-policy-binding` + +- Replace existing IAM policy binding: + +`gcloud iam service-accounts set-iam-policy-binding` + +- List a service account's keys: + +`gcloud iam service-accounts keys list` diff --git a/pages/common/gcloud-VM_CE.md b/pages/common/gcloud-VM_CE.md deleted file mode 100644 index 806d704bea..0000000000 --- a/pages/common/gcloud-VM_CE.md +++ /dev/null @@ -1,24 +0,0 @@ -# gcloud CLI Virtual Machines and Computer Engine - -> The official CLI tool for Google Cloud Platform. -> More information: . - -Virtual Machines & Compute Engine - -Create, run, and manage VMs on Google Cloud infrastructure. - -`gcloud compute zones list`: List Compute Engine zones (https://cloud.google.com/sdk/gcloud/reference/compute/zones/list) - -`gcloud compute instances create`: Create a VM instance (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create) - -`gcloud compute instances describe`: Display a VM instance's details (https://cloud.google.com/sdk/gcloud/reference/compute/instances/describe) - -`gcloud compute instances list`: List all VM instances in a project (https://cloud.google.com/sdk/gcloud/reference/compute/instances/list) - -`gcloud compute disks snapshot`: Create snapshot of persistent disks (https://cloud.google.com/sdk/gcloud/reference/compute/disks/snapshot) - -`gcloud compute snapshots describe`: Display a snapshot's details (https://cloud.google.com/sdk/gcloud/reference/compute/snapshots/describe) - -`gcloud compute snapshots delete`: Delete a snapshot (https://cloud.google.com/sdk/gcloud/reference/compute/snapshots/delete) - -`gcloud compute ssh`: Connect to a VM instance by using SSH (https://cloud.google.com/sdk/gcloud/reference/compute/ssh) diff --git a/pages/common/gcloud-app.md b/pages/common/gcloud-app.md new file mode 100644 index 0000000000..9eaac03de2 --- /dev/null +++ b/pages/common/gcloud-app.md @@ -0,0 +1,24 @@ +# gcloud CLI Serverless and App Engine + +> Build highly scalable applications on a fully managed serverless platform +> More information: + +- Deploy your app's code and configuration to the App Engine server: + +`gcloud app deploy` + +- List all versions of all services deployed to the App Engine server: + +`gcloud app versions list` + +- Open the current app in a web browser: + +`gcloud app browse` + +- Create an App Engine app within your current project: + +`gcloud app create` + +- Display the latest App Engine app logs: + +`gcloud app logs read` diff --git a/pages/common/gcloud-auth.md b/pages/common/gcloud-auth.md new file mode 100644 index 0000000000..fea54ada10 --- /dev/null +++ b/pages/common/gcloud-auth.md @@ -0,0 +1,28 @@ +# gcloud CLI Authorization and Credentials + +> Grant and revoke authorization to the gcloud CLI and manage credentials. +> More information: . + +- Authorize Google Cloud access for the gcloud CLI with Google Cloud user credentials and set the current account as active: + +`gcloud auth login` + +- Authorize Google Cloud access similar to gcloud auth login but with service account credentials: + +`gcloud auth activate-service-account` + +- Manage your Application Default Credentials (ADC) for Cloud Client Libraries: + +`gcloud auth application-default` + +- List all credentialed accounts: + +`gcloud auth list` + +- Display the current account's access token: + +`gcloud auth print-access-token` + +- Remove access credentials for an account: + +`gcloud auth revoke` diff --git a/pages/common/gcloud-auth_creds.md b/pages/common/gcloud-auth_creds.md deleted file mode 100644 index 533af2520b..0000000000 --- a/pages/common/gcloud-auth_creds.md +++ /dev/null @@ -1,19 +0,0 @@ -# gcloud CLI Authorization and Credentials - -> The official CLI tool for Google Cloud Platform. -> More information: . - -Authorization and Credentials -Grant and revoke authorization to the gcloud CLI and manage credentials. - -`gcloud auth login`: Authorize Google Cloud access for the gcloud CLI with Google Cloud user credentials and set the current account as active (https://cloud.google.com/sdk/gcloud/reference/auth/login) - -`gcloud auth activate-service-account`: Authorize Google Cloud access similar to gcloud auth login but with service account credentials (https://cloud.google.com/sdk/gcloud/reference/auth/activate-service-account) - -`gcloud auth application-default`: Manage your Application Default Credentials (ADC) for Cloud Client Libraries (https://cloud.google.com/sdk/gcloud/reference/auth/application-default) - -`gcloud auth list`: List all credentialed accounts (https://cloud.google.com/sdk/gcloud/reference/auth/list) - -`gcloud auth print-access-token`: Display the current account's access token (https://cloud.google.com/sdk/gcloud/reference/auth/print-access-token) - -`gcloud auth revoke`: Remove access credentials for an account (https://cloud.google.com/sdk/gcloud/reference/auth/revoke) diff --git a/pages/common/gcloud-compute.md b/pages/common/gcloud-compute.md new file mode 100644 index 0000000000..15fc0027b1 --- /dev/null +++ b/pages/common/gcloud-compute.md @@ -0,0 +1,36 @@ +# gcloud CLI Virtual Machines and Computer Engine + +> Create, run, and manage VMs on Google Cloud infrastructure. +> More information: . + +- List Compute Engine zones: + +`gcloud compute zones list` + +- Create a VM instance: + +`gcloud compute instances create` + +- Display a VM instance's details: + +`gcloud compute instances describe` + +- List all VM instances in a project: + +`gcloud compute instances list` + +- Create snapshot of persistent disks: + +`gcloud compute disks snapshot` + +- Display a snapshot's details: + +`gcloud compute snapshots describe` + +- Delete a snapshot: + +`gcloud compute snapshots delete` + +- Connect to a VM instance by using SSH: + +`gcloud compute ssh` diff --git a/pages/common/gcloud-config.md b/pages/common/gcloud-config.md new file mode 100644 index 0000000000..962a139142 --- /dev/null +++ b/pages/common/gcloud-config.md @@ -0,0 +1,28 @@ +# gcloud CLI Personalization + +> Make the gcloud CLI your own; personalize your configuration with properties. +> More information: . + +- Define a property (like compute/zone) for the current configuration: + +`gcloud config set` + +- Fetch the value of a gcloud CLI property: + +`gcloud config get` + +- Display all the properties for the current configuration: + +`gcloud config list` + +- Create a new named configuration: + +`gcloud config configurations create` + +- Display a list of all available configurations: + +`gcloud config configurations list` + +- Switch to an existing named configuration: + +`gcloud config configurations activate` diff --git a/pages/common/gcloud-docker.md b/pages/common/gcloud-docker.md new file mode 100644 index 0000000000..2a124e1881 --- /dev/null +++ b/pages/common/gcloud-docker.md @@ -0,0 +1,24 @@ +# gcloud CLI Docker and Google Kubernetes Engine + +> Manage containerized applications on Kubernetes. +> More information: . + +- Register the gcloud CLI as a Docker credential helper: + +`gcloud auth configure-docker` + +- Create a cluster to run GKE containers: + +`gcloud container clusters create` + +- List clusters for running GKE containers: + +`gcloud container clusters list` + +- Update kubeconfig to get kubectl to use a GKE cluster: + +`gcloud container clusters get-credentials` + +- List tag and digest metadata for a container image: + +`gcloud container images list-tags` diff --git a/pages/common/gcloud-docker_GKE.md b/pages/common/gcloud-docker_GKE.md deleted file mode 100644 index ffb19bfe14..0000000000 --- a/pages/common/gcloud-docker_GKE.md +++ /dev/null @@ -1,17 +0,0 @@ -# gcloud CLI Docker and Google Kubernetes Engine - -> The official CLI tool for Google Cloud Platform. -> More information: . - -Docker & Google Kubernetes Engine (GKE) -Manage containerized applications on Kubernetes. - -`gcloud auth configure-docker`: Register the gcloud CLI as a Docker credential helper (https://cloud.google.com/sdk/gcloud/reference/auth/configure-docker) - -`gcloud container clusters create`: Create a cluster to run GKE containers (https://cloud.google.com/sdk/gcloud/reference/container/clusters/create) - -`gcloud container clusters list`: List clusters for running GKE containers (https://cloud.google.com/sdk/gcloud/reference/container/clusters/list) - -`gcloud container clusters get-credentials`: Update kubeconfig to get kubectl to use a GKE cluster (https://cloud.google.com/sdk/gcloud/reference/container/clusters/get-credentials) - -`gcloud container images list-tags`: List tag and digest metadata for a container image (https://cloud.google.com/sdk/gcloud/reference/container/images/list-tags) diff --git a/pages/common/gcloud-help.md b/pages/common/gcloud-help.md index efcec7f4ae..95ddc15242 100644 --- a/pages/common/gcloud-help.md +++ b/pages/common/gcloud-help.md @@ -1,13 +1,16 @@ # gcloud CLI Help -> The official CLI tool for Google Cloud Platform. +> gcloud CLI is happy to help. > More information: . -Help -gcloud CLI is happy to help. +- Search the gcloud CLI reference documents for specific terms: -`gcloud help`: Search the gcloud CLI reference documents for specific terms (https://cloud.google.com/sdk/gcloud/reference/help) +`gcloud help` -`gcloud feedback`: Provide feedback to the gcloud CLI team (https://cloud.google.com/sdk/gcloud/reference/feedback) +- Provide feedback to the gcloud CLI team: -`gcloud topic`: Supplementary help material for non-command topics like accessibility, filtering, and formatting (https://cloud.google.com/sdk/gcloud/reference/topic) +`gcloud feedback` + +- Supplementary help material for non-command topics like accessibility, filtering, and formatting: + +`gcloud topic` diff --git a/pages/common/gcloud-miscellaneous.md b/pages/common/gcloud-miscellaneous.md index 8996fdadb2..855ea0e40a 100644 --- a/pages/common/gcloud-miscellaneous.md +++ b/pages/common/gcloud-miscellaneous.md @@ -1,15 +1,20 @@ # gcloud CLI Miscellaneous Commands -> The official CLI tool for Google Cloud Platform. +> Commands that might come in handy > More information: . -Miscellaneous -Commands that might come in handy +- Decrypt ciphertext (to a plaintext file) using a Cloud Key Management Service key: -`gcloud kms decrypt`: Decrypt ciphertext (to a plaintext file) using a Cloud Key Management Service key (https://cloud.google.com/sdk/gcloud/reference/kms/decrypt) +`gcloud kms decrypt` -`gcloud logging logs list`: List your project's logs (https://cloud.google.com/sdk/gcloud/reference/logging/logs/list) +- List your project's logs: -`gcloud sql backups describe`: Display info about a Cloud SQL instance backup (https://cloud.google.com/sdk/gcloud/reference/sql/backups/describe) +`gcloud logging logs list` -`gcloud sql export sql`: Export data from a Cloud SQL instance to a SQL file (https://cloud.google.com/sdk/gcloud/reference/sql/export/sql) +- Display info about a Cloud SQL instance backup: + +`gcloud sql backups describe` + +- Export data from a Cloud SQL instance to a SQL file: + +`gcloud sql export sql` diff --git a/pages/common/gcloud-personalization.md b/pages/common/gcloud-personalization.md deleted file mode 100644 index 8f7bd204fb..0000000000 --- a/pages/common/gcloud-personalization.md +++ /dev/null @@ -1,19 +0,0 @@ -# gcloud CLI Personalization - -> The official CLI tool for Google Cloud Platform. -> More information: . - -Personalization -Make the gcloud CLI your own; personalize your configuration with properties. - -`gcloud config set`: Define a property (like compute/zone) for the current configuration (https://cloud.google.com/sdk/gcloud/reference/config/set) - -`gcloud config get`: Fetch the value of a gcloud CLI property (https://cloud.google.com/sdk/gcloud/reference/config/get) - -`gcloud config list`: Display all the properties for the current configuration (https://cloud.google.com/sdk/gcloud/reference/config/list) - -`gcloud config configurations create`: Create a new named configuration (https://cloud.google.com/sdk/gcloud/reference/config/configurations/create) - -`gcloud config configurations list`: Display a list of all available configurations (https://cloud.google.com/sdk/gcloud/reference/config/configurations/list) - -`gcloud config configurations activate`: Switch to an existing named configuration (https://cloud.google.com/sdk/gcloud/reference/config/configurations/activate) diff --git a/pages/common/gcloud-projects.md b/pages/common/gcloud-projects.md index b49bc03b17..c0e2944832 100644 --- a/pages/common/gcloud-projects.md +++ b/pages/common/gcloud-projects.md @@ -1,11 +1,12 @@ # gcloud CLI Projects -> The official CLI tool for Google Cloud Platform. +> Manage project access policies. > More information: . -Projects -Manage project access policies. +- Display metadata for a project (including its ID): -`gcloud projects describe`: Display metadata for a project (including its ID) (https://cloud.google.com/sdk/gcloud/reference/projects/describe) +`gcloud projects describe` -`gcloud projects add-iam-policy-binding`: Add an IAM policy binding to a specified project (https://cloud.google.com/sdk/gcloud/reference/projects/add-iam-policy-binding) +- Add an IAM policy binding to a specified project: + +`gcloud projects add-iam-policy-binding` diff --git a/pages/common/gcloud-serverless_app-engine.md b/pages/common/gcloud-serverless_app-engine.md deleted file mode 100644 index 575d740969..0000000000 --- a/pages/common/gcloud-serverless_app-engine.md +++ /dev/null @@ -1,17 +0,0 @@ -# gcloud CLI Serverless and App Engine - -> The official CLI tool for Google Cloud Platform. -> More information: - -Serverless & App Engine -Build highly scalable applications on a fully managed serverless platform - -`gcloud app deploy`: Deploy your app's code and configuration to the App Engine server (https://cloud.google.com/sdk/gcloud/reference/app/deploy) - -`gcloud app versions list`: List all versions of all services deployed to the App Engine server (https://cloud.google.com/sdk/gcloud/reference/app/versions/list) - -`gcloud app browse`: Open the current app in a web browser (https://cloud.google.com/sdk/gcloud/reference/app/browse) - -`gcloud app create`: Create an App Engine app within your current project (https://cloud.google.com/sdk/gcloud/reference/app/create) - -`gcloud app logs read`: Display the latest App Engine app logs (https://cloud.google.com/sdk/gcloud/reference/app/logs/read) diff --git a/pages/common/gcloud-starting.md b/pages/common/gcloud-starting.md index 67fe57a4bc..b5d1ec35f8 100644 --- a/pages/common/gcloud-starting.md +++ b/pages/common/gcloud-starting.md @@ -1,19 +1,28 @@ # gcloud CLI Getting started -> The official CLI tool for Google Cloud Platform. +> Get going with the gcloud CLI. > More information: . -Getting started -Get going with the gcloud CLI. +- Initialize, authorize, and configure the gcloud CLI: -`gcloud init`: Initialize, authorize, and configure the gcloud CLI (https://cloud.google.com/sdk/gcloud/reference/init) +`gcloud init` -`gcloud version`: Display version and installed components (https://cloud.google.com/sdk/gcloud/reference/version) +- Display version and installed components: -`gcloud components install`: Install specific components (https://cloud.google.com/sdk/gcloud/reference/components/install) +`gcloud version` -`gcloud components update`: Update your gcloud CLI to the latest version (https://cloud.google.com/sdk/gcloud/reference/components/update) +- Install specific components: -`gcloud config set project`: Set a default Google Cloud project to work on (https://cloud.google.com/sdk/gcloud/reference/config/set) +`gcloud components install` -`gcloud info`: Display current gcloud CLI environment details (https://cloud.google.com/sdk/gcloud/reference/info) +- Update your gcloud CLI to the latest version: + +`gcloud components update` + +- Set a default Google Cloud project to work on: + +`gcloud config set project` + +- Display current gcloud CLI environment details: + +`gcloud info` From cf857433c9fd94e452b7ece16220659d41729ebc Mon Sep 17 00:00:00 2001 From: Farhad Koushan Date: Sun, 3 Dec 2023 19:18:34 -0800 Subject: [PATCH 04/18] lint removed --- pages/common/gcloud-IAM.md | 2 +- pages/common/gcloud-app.md | 4 ++-- pages/common/gcloud-auth.md | 2 +- pages/common/gcloud-compute.md | 2 +- pages/common/gcloud-config.md | 2 +- pages/common/gcloud-docker.md | 2 +- pages/common/gcloud-help.md | 2 +- pages/common/gcloud-miscellaneous.md | 4 ++-- pages/common/gcloud-projects.md | 2 +- pages/common/gcloud-starting.md | 2 +- 10 files changed, 12 insertions(+), 12 deletions(-) diff --git a/pages/common/gcloud-IAM.md b/pages/common/gcloud-IAM.md index 51f3a937b8..a8961a3aa3 100644 --- a/pages/common/gcloud-IAM.md +++ b/pages/common/gcloud-IAM.md @@ -1,4 +1,4 @@ -# gcloud CLI IAM +# gcloud cli iam > Configuring Identity and Access Management (IAM) preferences and service accounts. > More information: . diff --git a/pages/common/gcloud-app.md b/pages/common/gcloud-app.md index 9eaac03de2..d3739038e0 100644 --- a/pages/common/gcloud-app.md +++ b/pages/common/gcloud-app.md @@ -1,6 +1,6 @@ -# gcloud CLI Serverless and App Engine +# gcloud cli serverless and app engine -> Build highly scalable applications on a fully managed serverless platform +> Build highly scalable applications on a fully managed serverless platform. > More information: - Deploy your app's code and configuration to the App Engine server: diff --git a/pages/common/gcloud-auth.md b/pages/common/gcloud-auth.md index fea54ada10..f340c916b4 100644 --- a/pages/common/gcloud-auth.md +++ b/pages/common/gcloud-auth.md @@ -1,4 +1,4 @@ -# gcloud CLI Authorization and Credentials +# gcloud cli authorization and credentials > Grant and revoke authorization to the gcloud CLI and manage credentials. > More information: . diff --git a/pages/common/gcloud-compute.md b/pages/common/gcloud-compute.md index 15fc0027b1..3a46cf72b9 100644 --- a/pages/common/gcloud-compute.md +++ b/pages/common/gcloud-compute.md @@ -1,4 +1,4 @@ -# gcloud CLI Virtual Machines and Computer Engine +# gcloud cli virtual machines and computer engine > Create, run, and manage VMs on Google Cloud infrastructure. > More information: . diff --git a/pages/common/gcloud-config.md b/pages/common/gcloud-config.md index 962a139142..31b3f6de2a 100644 --- a/pages/common/gcloud-config.md +++ b/pages/common/gcloud-config.md @@ -1,4 +1,4 @@ -# gcloud CLI Personalization +# gcloud cli personalization > Make the gcloud CLI your own; personalize your configuration with properties. > More information: . diff --git a/pages/common/gcloud-docker.md b/pages/common/gcloud-docker.md index 2a124e1881..6b92a4391f 100644 --- a/pages/common/gcloud-docker.md +++ b/pages/common/gcloud-docker.md @@ -1,4 +1,4 @@ -# gcloud CLI Docker and Google Kubernetes Engine +# gcloud cli docker and google kubernetes engine > Manage containerized applications on Kubernetes. > More information: . diff --git a/pages/common/gcloud-help.md b/pages/common/gcloud-help.md index 95ddc15242..6f030fa010 100644 --- a/pages/common/gcloud-help.md +++ b/pages/common/gcloud-help.md @@ -1,4 +1,4 @@ -# gcloud CLI Help +# gcloud cli help > gcloud CLI is happy to help. > More information: . diff --git a/pages/common/gcloud-miscellaneous.md b/pages/common/gcloud-miscellaneous.md index 855ea0e40a..060a6cd13b 100644 --- a/pages/common/gcloud-miscellaneous.md +++ b/pages/common/gcloud-miscellaneous.md @@ -1,6 +1,6 @@ -# gcloud CLI Miscellaneous Commands +# gcloud cli miscellaneous commands -> Commands that might come in handy +> Commands that might come in handy. > More information: . - Decrypt ciphertext (to a plaintext file) using a Cloud Key Management Service key: diff --git a/pages/common/gcloud-projects.md b/pages/common/gcloud-projects.md index c0e2944832..4ef45a028c 100644 --- a/pages/common/gcloud-projects.md +++ b/pages/common/gcloud-projects.md @@ -1,4 +1,4 @@ -# gcloud CLI Projects +# gcloud projects > Manage project access policies. > More information: . diff --git a/pages/common/gcloud-starting.md b/pages/common/gcloud-starting.md index b5d1ec35f8..8b137fd63d 100644 --- a/pages/common/gcloud-starting.md +++ b/pages/common/gcloud-starting.md @@ -1,4 +1,4 @@ -# gcloud CLI Getting started +# gcloud getting started > Get going with the gcloud CLI. > More information: . From f2fb508748c54a6609869cfcea0412f4b6c65bb7 Mon Sep 17 00:00:00 2001 From: Farhad Koushan Date: Sun, 3 Dec 2023 19:24:30 -0800 Subject: [PATCH 05/18] lint removed 2 --- pages/common/gcloud-app.md | 2 +- pages/common/gcloud-help.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pages/common/gcloud-app.md b/pages/common/gcloud-app.md index d3739038e0..894e605647 100644 --- a/pages/common/gcloud-app.md +++ b/pages/common/gcloud-app.md @@ -1,7 +1,7 @@ # gcloud cli serverless and app engine > Build highly scalable applications on a fully managed serverless platform. -> More information: +> More information: . - Deploy your app's code and configuration to the App Engine server: diff --git a/pages/common/gcloud-help.md b/pages/common/gcloud-help.md index 6f030fa010..52554d351c 100644 --- a/pages/common/gcloud-help.md +++ b/pages/common/gcloud-help.md @@ -1,6 +1,6 @@ # gcloud cli help -> gcloud CLI is happy to help. +> Google gcloud CLI is happy to help. > More information: . - Search the gcloud CLI reference documents for specific terms: From 3437d2137b1d70ed33f4cdf034ca17ae58d48e11 Mon Sep 17 00:00:00 2001 From: Farhad Koushan Date: Sun, 3 Dec 2023 19:42:18 -0800 Subject: [PATCH 06/18] lint removed 3 --- pages/common/gcloud-IAM.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/common/gcloud-IAM.md b/pages/common/gcloud-IAM.md index a8961a3aa3..089a7a42f4 100644 --- a/pages/common/gcloud-IAM.md +++ b/pages/common/gcloud-IAM.md @@ -1,4 +1,4 @@ -# gcloud cli iam +# gcloud cli iam > Configuring Identity and Access Management (IAM) preferences and service accounts. > More information: . From 3d6e255a80dc367f5a8b56975236b911f1ed8e64 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Mon, 4 Dec 2023 09:14:02 +0530 Subject: [PATCH 07/18] Update and rename gcloud-IAM.md to gcloud-iam.md --- pages/common/{gcloud-IAM.md => gcloud-iam.md} | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) rename pages/common/{gcloud-IAM.md => gcloud-iam.md} (77%) diff --git a/pages/common/gcloud-IAM.md b/pages/common/gcloud-iam.md similarity index 77% rename from pages/common/gcloud-IAM.md rename to pages/common/gcloud-iam.md index 089a7a42f4..415eef6487 100644 --- a/pages/common/gcloud-IAM.md +++ b/pages/common/gcloud-iam.md @@ -1,13 +1,13 @@ -# gcloud cli iam +# gcloud iam -> Configuring Identity and Access Management (IAM) preferences and service accounts. +> Configure Identity and Access Management (IAM) preferences and service accounts. > More information: . - List IAM grantable roles for a resource: `gcloud iam list-grantable-roles` -- Create a custom role for a project or org: +- Create a custom role for a project or organization: `gcloud iam roles create` From 4eddf78b482c05d1c58de2837ecd3a505c1d8cb8 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Mon, 4 Dec 2023 09:17:08 +0530 Subject: [PATCH 08/18] gcloud-app: update page --- pages/common/gcloud-app.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pages/common/gcloud-app.md b/pages/common/gcloud-app.md index 894e605647..faf8b3f6da 100644 --- a/pages/common/gcloud-app.md +++ b/pages/common/gcloud-app.md @@ -1,6 +1,7 @@ -# gcloud cli serverless and app engine +# gcloud app > Build highly scalable applications on a fully managed serverless platform. +> See also: `gcloud`. > More information: . - Deploy your app's code and configuration to the App Engine server: From 537f59468b181e99d1e48468a1f58c7488383c0b Mon Sep 17 00:00:00 2001 From: Farhad Koushan <100194132+FarhadK2022@users.noreply.github.com> Date: Sun, 3 Dec 2023 20:06:43 -0800 Subject: [PATCH 09/18] Update gcloud-iam.md --- pages/common/gcloud-iam.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/common/gcloud-iam.md b/pages/common/gcloud-iam.md index 415eef6487..a19be7d31c 100644 --- a/pages/common/gcloud-iam.md +++ b/pages/common/gcloud-iam.md @@ -1,4 +1,4 @@ -# gcloud iam +# gcloud iam > Configure Identity and Access Management (IAM) preferences and service accounts. > More information: . From 3de0d4d3535f9e98c495743c53f581ce047501d4 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Mon, 4 Dec 2023 09:47:32 +0530 Subject: [PATCH 10/18] gcloud: update pages Signed-off-by: K.B.Dharun Krishna --- pages/common/gcloud-app.md | 4 ++-- pages/common/gcloud-auth.md | 11 ++++++----- pages/common/gcloud-compute.md | 21 +++++++++++---------- pages/common/gcloud-config.md | 14 +++++++------- pages/common/gcloud-help.md | 2 +- pages/common/gcloud.md | 13 +++++++------ 6 files changed, 34 insertions(+), 31 deletions(-) diff --git a/pages/common/gcloud-app.md b/pages/common/gcloud-app.md index faf8b3f6da..9bb2429562 100644 --- a/pages/common/gcloud-app.md +++ b/pages/common/gcloud-app.md @@ -2,11 +2,11 @@ > Build highly scalable applications on a fully managed serverless platform. > See also: `gcloud`. -> More information: . +> More information: . - Deploy your app's code and configuration to the App Engine server: -`gcloud app deploy` +`gcloud app deploy {{deployables}}` - List all versions of all services deployed to the App Engine server: diff --git a/pages/common/gcloud-auth.md b/pages/common/gcloud-auth.md index f340c916b4..54b0b37ba4 100644 --- a/pages/common/gcloud-auth.md +++ b/pages/common/gcloud-auth.md @@ -1,13 +1,14 @@ -# gcloud cli authorization and credentials +# gcloud auth -> Grant and revoke authorization to the gcloud CLI and manage credentials. -> More information: . +> Grant and revoke authorization to `gcloud` and manage credentials. +> See also: `gcloud`. +> More information: . -- Authorize Google Cloud access for the gcloud CLI with Google Cloud user credentials and set the current account as active: +- Authorize Google Cloud access for the `gcloud` CLI with Google Cloud user credentials and set the current account as active: `gcloud auth login` -- Authorize Google Cloud access similar to gcloud auth login but with service account credentials: +- Authorize Google Cloud access similar to `gcloud auth login` but with service account credentials: `gcloud auth activate-service-account` diff --git a/pages/common/gcloud-compute.md b/pages/common/gcloud-compute.md index 3a46cf72b9..d2f6773991 100644 --- a/pages/common/gcloud-compute.md +++ b/pages/common/gcloud-compute.md @@ -1,7 +1,8 @@ -# gcloud cli virtual machines and computer engine +# gcloud compute > Create, run, and manage VMs on Google Cloud infrastructure. -> More information: . +> See also: `gcloud`. +> More information: . - List Compute Engine zones: @@ -9,28 +10,28 @@ - Create a VM instance: -`gcloud compute instances create` +`gcloud compute instances create {{instance_name}}` - Display a VM instance's details: -`gcloud compute instances describe` +`gcloud compute instances describe {{instance_name}}` - List all VM instances in a project: `gcloud compute instances list` -- Create snapshot of persistent disks: +- Create a snapshot of a persistent disk: -`gcloud compute disks snapshot` +`gcloud compute disks snapshot {{disk_name}} --snapshot-names {{snapshot_name}}` - Display a snapshot's details: -`gcloud compute snapshots describe` +`gcloud compute snapshots describe {{snapshot_name}}` - Delete a snapshot: -`gcloud compute snapshots delete` +`gcloud compute snapshots delete {{snapshot_name}}` -- Connect to a VM instance by using SSH: +- Connect to a VM instance using SSH: -`gcloud compute ssh` +`gcloud compute ssh {{instance_name}}` diff --git a/pages/common/gcloud-config.md b/pages/common/gcloud-config.md index 31b3f6de2a..f5d3239ff5 100644 --- a/pages/common/gcloud-config.md +++ b/pages/common/gcloud-config.md @@ -1,15 +1,15 @@ -# gcloud cli personalization +# gcloud config -> Make the gcloud CLI your own; personalize your configuration with properties. -> More information: . +> Personalize your `gcloud` CLI configuration with properties. +> More information: . - Define a property (like compute/zone) for the current configuration: -`gcloud config set` +`gcloud config set {{property}} {{value}}` - Fetch the value of a gcloud CLI property: -`gcloud config get` +`gcloud config get {{property}}` - Display all the properties for the current configuration: @@ -17,7 +17,7 @@ - Create a new named configuration: -`gcloud config configurations create` +`gcloud config configurations create {{configuration_name}}` - Display a list of all available configurations: @@ -25,4 +25,4 @@ - Switch to an existing named configuration: -`gcloud config configurations activate` +`gcloud config configurations activate {{configuration_name}}` diff --git a/pages/common/gcloud-help.md b/pages/common/gcloud-help.md index 52554d351c..456e077e17 100644 --- a/pages/common/gcloud-help.md +++ b/pages/common/gcloud-help.md @@ -1,6 +1,6 @@ # gcloud cli help -> Google gcloud CLI is happy to help. +> Display help information and support for `gcloud`. > More information: . - Search the gcloud CLI reference documents for specific terms: diff --git a/pages/common/gcloud.md b/pages/common/gcloud.md index 250f9a4b24..02e173569f 100644 --- a/pages/common/gcloud.md +++ b/pages/common/gcloud.md @@ -1,13 +1,14 @@ # gcloud > The official CLI tool for Google Cloud Platform. +> Some subcommands such as `gcloud iam` have their own usage documentation. > More information: . - List all properties in one's active configuration: `gcloud config list` -- Log in to Google account: +- Login to Google account: `gcloud auth login` @@ -17,20 +18,20 @@ - SSH into a virtual machine instance: -`gcloud compute ssh {{user}}@{{instance}} ` +`gcloud compute ssh {{user}}@{{instance}}` -- Display all Google Compute Engine instances in a project. Instances from all zones are listed by default: +- Display all Google Compute Engine instances in a project (Instances from all zones are listed by default): `gcloud compute instances list` -- Update a kubeconfig file with the appropriate credentials to point kubectl to a specific cluster in Google Kubernetes Engine: +- Update a kubeconfig file with the appropriate credentials to point `kubectl` to a specific cluster in Google Kubernetes Engine (GKE): `gcloud container clusters get-credentials {{cluster_name}}` -- Update all gcloud CLI components: +- Update all `gcloud` CLI components: `gcloud components update` -- Show help for a given command: +- Display help for a given command: `gcloud help {{command}}` From f4bd1493ff93b93e51439b8003d7d4f894f6fda0 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Mon, 4 Dec 2023 10:02:48 +0530 Subject: [PATCH 11/18] gcloud-*: update pages Signed-off-by: K.B.Dharun Krishna --- pages/common/gcloud-config.md | 5 +++-- pages/common/gcloud-container.md | 25 +++++++++++++++++++++++++ pages/common/gcloud-docker.md | 24 ------------------------ pages/common/gcloud-feedback.md | 13 +++++++++++++ pages/common/gcloud-help.md | 14 +++++--------- 5 files changed, 46 insertions(+), 35 deletions(-) create mode 100644 pages/common/gcloud-container.md delete mode 100644 pages/common/gcloud-docker.md create mode 100644 pages/common/gcloud-feedback.md diff --git a/pages/common/gcloud-config.md b/pages/common/gcloud-config.md index f5d3239ff5..4d06928efa 100644 --- a/pages/common/gcloud-config.md +++ b/pages/common/gcloud-config.md @@ -1,13 +1,14 @@ # gcloud config -> Personalize your `gcloud` CLI configuration with properties. +> Personalize your `gcloud` configuration with properties. +> See also: `gcloud`. > More information: . - Define a property (like compute/zone) for the current configuration: `gcloud config set {{property}} {{value}}` -- Fetch the value of a gcloud CLI property: +- Fetch the value of a `gcloud` property: `gcloud config get {{property}}` diff --git a/pages/common/gcloud-container.md b/pages/common/gcloud-container.md new file mode 100644 index 0000000000..313001dee0 --- /dev/null +++ b/pages/common/gcloud-container.md @@ -0,0 +1,25 @@ +# gcloud container + +> Manage containerized applications on Kubernetes and clusters. +> See also: `gcloud`. +> More information: . + +- Register `gcloud` as a Docker credential helper: + +`gcloud auth configure-docker` + +- Create a cluster to run GKE containers: + +`gcloud container clusters create {{cluster_name}}` + +- List clusters for running GKE containers: + +`gcloud container clusters list` + +- Update kubeconfig to get `kubectl` to use a GKE cluster: + +`gcloud container clusters get-credentials {{cluster_name}}` + +- List tag and digest metadata for a container image: + +`gcloud container images list-tags {{image}}` diff --git a/pages/common/gcloud-docker.md b/pages/common/gcloud-docker.md deleted file mode 100644 index 6b92a4391f..0000000000 --- a/pages/common/gcloud-docker.md +++ /dev/null @@ -1,24 +0,0 @@ -# gcloud cli docker and google kubernetes engine - -> Manage containerized applications on Kubernetes. -> More information: . - -- Register the gcloud CLI as a Docker credential helper: - -`gcloud auth configure-docker` - -- Create a cluster to run GKE containers: - -`gcloud container clusters create` - -- List clusters for running GKE containers: - -`gcloud container clusters list` - -- Update kubeconfig to get kubectl to use a GKE cluster: - -`gcloud container clusters get-credentials` - -- List tag and digest metadata for a container image: - -`gcloud container images list-tags` diff --git a/pages/common/gcloud-feedback.md b/pages/common/gcloud-feedback.md new file mode 100644 index 0000000000..b09d52ba5a --- /dev/null +++ b/pages/common/gcloud-feedback.md @@ -0,0 +1,13 @@ +# gcloud help + +> Provide feedback to the Google Cloud team. +> See also: `gcloud`. +> More information: . + +- Provide feedback to the `gcloud` team: + +`gcloud feedback` + +- Provide feedback to the `gcloud` team, including a log file: + +`gcloud feedback --log-file {{log_file}}` diff --git a/pages/common/gcloud-help.md b/pages/common/gcloud-help.md index 456e077e17..a9a0fc7d05 100644 --- a/pages/common/gcloud-help.md +++ b/pages/common/gcloud-help.md @@ -1,16 +1,12 @@ -# gcloud cli help +# gcloud help -> Display help information and support for `gcloud`. -> More information: . +> Display help and reference information for `gcloud`. +> More information: . -- Search the gcloud CLI reference documents for specific terms: +- Search the `gcloud` CLI reference documents for specific terms: `gcloud help` -- Provide feedback to the gcloud CLI team: - -`gcloud feedback` - -- Supplementary help material for non-command topics like accessibility, filtering, and formatting: +- View supplementary help material for non-command topics like accessibility, filtering, and formatting: `gcloud topic` From 186d76e4fea67b6937590de6c49c142ec3f30562 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Mon, 4 Dec 2023 10:25:45 +0530 Subject: [PATCH 12/18] gcloud-*: update pages Signed-off-by: K.B.Dharun Krishna --- pages/common/gcloud-iam.md | 17 +++++++++-------- pages/common/gcloud-miscellaneous.md | 20 -------------------- pages/common/gcloud-projects.md | 23 ++++++++++++++++++----- pages/common/gcloud-starting.md | 28 ---------------------------- 4 files changed, 27 insertions(+), 61 deletions(-) delete mode 100644 pages/common/gcloud-miscellaneous.md delete mode 100644 pages/common/gcloud-starting.md diff --git a/pages/common/gcloud-iam.md b/pages/common/gcloud-iam.md index a19be7d31c..3d8c339ec2 100644 --- a/pages/common/gcloud-iam.md +++ b/pages/common/gcloud-iam.md @@ -1,28 +1,29 @@ # gcloud iam > Configure Identity and Access Management (IAM) preferences and service accounts. -> More information: . +> See also: `gcloud`. +> More information: . - List IAM grantable roles for a resource: -`gcloud iam list-grantable-roles` +`gcloud iam list-grantable-roles {{resource}}` -- Create a custom role for a project or organization: +- Create a custom role for a organization or project: -`gcloud iam roles create` +`gcloud iam roles create {{role_name}} --{{organization|project}} {{organization|project_id}} --file {{path/to/role.yaml}}` - Create a service account for a project: -`gcloud iam service-accounts create` +`gcloud iam service-accounts create {{name}}` - Add an IAM policy binding to a service account: -`gcloud iam service-accounts add-iam-policy-binding` +`gcloud iam service-accounts add-iam-policy-binding {{service_account_email}} --member {{member}} --role {{role}}` - Replace existing IAM policy binding: -`gcloud iam service-accounts set-iam-policy-binding` +`gcloud iam service-accounts set-iam-policy {{service_account_email}} {{policy_file}}` - List a service account's keys: -`gcloud iam service-accounts keys list` +`gcloud iam service-accounts keys list --iam-account {{service_account_email}}` diff --git a/pages/common/gcloud-miscellaneous.md b/pages/common/gcloud-miscellaneous.md deleted file mode 100644 index 060a6cd13b..0000000000 --- a/pages/common/gcloud-miscellaneous.md +++ /dev/null @@ -1,20 +0,0 @@ -# gcloud cli miscellaneous commands - -> Commands that might come in handy. -> More information: . - -- Decrypt ciphertext (to a plaintext file) using a Cloud Key Management Service key: - -`gcloud kms decrypt` - -- List your project's logs: - -`gcloud logging logs list` - -- Display info about a Cloud SQL instance backup: - -`gcloud sql backups describe` - -- Export data from a Cloud SQL instance to a SQL file: - -`gcloud sql export sql` diff --git a/pages/common/gcloud-projects.md b/pages/common/gcloud-projects.md index 4ef45a028c..e734dfb55a 100644 --- a/pages/common/gcloud-projects.md +++ b/pages/common/gcloud-projects.md @@ -1,12 +1,25 @@ # gcloud projects -> Manage project access policies. -> More information: . +> Manage project access policies in Google Cloud. +> See also: `gcloud`. +> More information: . -- Display metadata for a project (including its ID): +- Create a new project: -`gcloud projects describe` +`gcloud projects create {{project_id|project_number}}` + +- List all active projects: + +`gcloud projects list` + +- Display metadata for a project: + +`gcloud projects describe {{project_id}}` + +- Delete a project: + +`gcloud projects delete {{project_id|project_number}}` - Add an IAM policy binding to a specified project: -`gcloud projects add-iam-policy-binding` +`gcloud projects add-iam-policy-binding {{project_id}} --member {{principal}} --role {{role}}` diff --git a/pages/common/gcloud-starting.md b/pages/common/gcloud-starting.md deleted file mode 100644 index 8b137fd63d..0000000000 --- a/pages/common/gcloud-starting.md +++ /dev/null @@ -1,28 +0,0 @@ -# gcloud getting started - -> Get going with the gcloud CLI. -> More information: . - -- Initialize, authorize, and configure the gcloud CLI: - -`gcloud init` - -- Display version and installed components: - -`gcloud version` - -- Install specific components: - -`gcloud components install` - -- Update your gcloud CLI to the latest version: - -`gcloud components update` - -- Set a default Google Cloud project to work on: - -`gcloud config set project` - -- Display current gcloud CLI environment details: - -`gcloud info` From fce1dd459609d09319839c02869b1b9ca473fc6e Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Mon, 4 Dec 2023 10:27:23 +0530 Subject: [PATCH 13/18] gcloud: update page Signed-off-by: K.B.Dharun Krishna --- pages/common/gcloud.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/common/gcloud.md b/pages/common/gcloud.md index 02e173569f..87901c4dfa 100644 --- a/pages/common/gcloud.md +++ b/pages/common/gcloud.md @@ -28,7 +28,7 @@ `gcloud container clusters get-credentials {{cluster_name}}` -- Update all `gcloud` CLI components: +- Update all `gcloud` components: `gcloud components update` From ce4fe8526568383eb0a8b0f6baf7b206bb356e71 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Mon, 4 Dec 2023 10:28:05 +0530 Subject: [PATCH 14/18] gcloud-help: reference main page Signed-off-by: K.B.Dharun Krishna --- pages/common/gcloud-help.md | 1 + 1 file changed, 1 insertion(+) diff --git a/pages/common/gcloud-help.md b/pages/common/gcloud-help.md index a9a0fc7d05..d8d695d2d5 100644 --- a/pages/common/gcloud-help.md +++ b/pages/common/gcloud-help.md @@ -1,6 +1,7 @@ # gcloud help > Display help and reference information for `gcloud`. +> See also: `gcloud`. > More information: . - Search the `gcloud` CLI reference documents for specific terms: From a87e90e0ca27ed32ff0dee45f71ea9f7a6703d15 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Mon, 4 Dec 2023 10:45:15 +0530 Subject: [PATCH 15/18] gcloud-*: update pages Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> --- pages/common/gcloud-feedback.md | 2 +- pages/common/gcloud-help.md | 2 +- pages/common/gcloud.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/pages/common/gcloud-feedback.md b/pages/common/gcloud-feedback.md index b09d52ba5a..81be8b0d55 100644 --- a/pages/common/gcloud-feedback.md +++ b/pages/common/gcloud-feedback.md @@ -1,4 +1,4 @@ -# gcloud help +# gcloud feedback > Provide feedback to the Google Cloud team. > See also: `gcloud`. diff --git a/pages/common/gcloud-help.md b/pages/common/gcloud-help.md index d8d695d2d5..f85b3a9cc6 100644 --- a/pages/common/gcloud-help.md +++ b/pages/common/gcloud-help.md @@ -9,5 +9,5 @@ `gcloud help` - View supplementary help material for non-command topics like accessibility, filtering, and formatting: - +`gcloud topic {{topic_name}}` `gcloud topic` diff --git a/pages/common/gcloud.md b/pages/common/gcloud.md index 87901c4dfa..dbadb622ac 100644 --- a/pages/common/gcloud.md +++ b/pages/common/gcloud.md @@ -20,7 +20,7 @@ `gcloud compute ssh {{user}}@{{instance}}` -- Display all Google Compute Engine instances in a project (Instances from all zones are listed by default): +- Display all Google Compute Engine instances in a project (by default instances from all zones are listed): `gcloud compute instances list` From 3f272d5c5917da7076309b6840f2226785ecc345 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Mon, 4 Dec 2023 10:45:46 +0530 Subject: [PATCH 16/18] gcloud-help: fix page --- pages/common/gcloud-help.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/common/gcloud-help.md b/pages/common/gcloud-help.md index f85b3a9cc6..edda92cc9b 100644 --- a/pages/common/gcloud-help.md +++ b/pages/common/gcloud-help.md @@ -9,5 +9,5 @@ `gcloud help` - View supplementary help material for non-command topics like accessibility, filtering, and formatting: + `gcloud topic {{topic_name}}` -`gcloud topic` From edc1a17313445b152263741abb895e74a6fa26ec Mon Sep 17 00:00:00 2001 From: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> Date: Mon, 4 Dec 2023 07:10:44 +0100 Subject: [PATCH 17/18] gcloud-topic: add page --- pages/common/gcloud-topic.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 pages/common/gcloud-topic.md diff --git a/pages/common/gcloud-topic.md b/pages/common/gcloud-topic.md new file mode 100644 index 0000000000..39a131392d --- /dev/null +++ b/pages/common/gcloud-topic.md @@ -0,0 +1,13 @@ +# gcloud topic + +> Provides supplementary help for topics not directly associated with individual commands. See also `gcloud`. +> For general help, please take a look at `tldr gcloud help`. +> More information: . + +- View supplementary help material for non-command topics like accessibility, filtering, and formatting: + +`gcloud topic {{topic_name}}` + +- List all available topics: + +`gcloud topic --help` From 1fa450a5b41e60dd798787efe73bc900499a8667 Mon Sep 17 00:00:00 2001 From: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> Date: Mon, 4 Dec 2023 07:12:21 +0100 Subject: [PATCH 18/18] gcloud-help: refer to gcloud-topic --- pages/common/gcloud-help.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/pages/common/gcloud-help.md b/pages/common/gcloud-help.md index edda92cc9b..21c8740d06 100644 --- a/pages/common/gcloud-help.md +++ b/pages/common/gcloud-help.md @@ -1,13 +1,9 @@ # gcloud help > Display help and reference information for `gcloud`. -> See also: `gcloud`. +> For supplementary help for topics not directly associated with individual commands, please take a look at `tldr gcloud topic`. > More information: . - Search the `gcloud` CLI reference documents for specific terms: `gcloud help` - -- View supplementary help material for non-command topics like accessibility, filtering, and formatting: - -`gcloud topic {{topic_name}}`