From 48dce36b879ab618a58c82e6c3a7c430486f73b8 Mon Sep 17 00:00:00 2001 From: Frank Natividad Date: Thu, 29 Aug 2024 16:10:14 -0700 Subject: [PATCH 1/5] docs(storage): update docs on gRPC availability --- storage/doc.go | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/storage/doc.go b/storage/doc.go index d9cde1a46ec1..d472d4210d2d 100644 --- a/storage/doc.go +++ b/storage/doc.go @@ -331,14 +331,11 @@ to add a [custom audit logging] header: // Use client as usual with the context and the additional headers will be sent. client.Bucket("my-bucket").Attrs(ctx) -# Experimental gRPC API +# gRPC API -This package includes support for the Cloud Storage gRPC API, which is currently -in preview. This implementation uses gRPC rather than the current JSON & XML -APIs to make requests to Cloud Storage. Kindly contact the Google Cloud Storage gRPC -team at gcs-grpc-contact@google.com with a list of GCS buckets you would like to -allowlist to access this API. The Go Storage gRPC library is not yet generally -available, so it may be subject to breaking changes. +This package includes support for the Cloud Storage gRPC API. This implementation uses gRPC rather than the current JSON & XML +APIs to make requests to Cloud Storage. +The Go Storage gRPC library is not yet generally available, so it may be subject to breaking changes. To create a client which will use gRPC, use the alternate constructor: @@ -349,11 +346,9 @@ To create a client which will use gRPC, use the alternate constructor: } // Use client as usual. -Using the gRPC API inside GCP with a bucket in the same region can allow for -Direct Google Access (enabling requests to skip some proxy steps and reducing -response latency). A warning is emmitted if gRPC is not used within GCP to -warn that Direct Google Access could not be initialized. Direct Google Access -is not required to access the gRPC API. +Using the gRPC API inside GCP with a bucket in the same region can allow direct +connectivity (enabling requests to skip Google Front Ends (GFEs) and reducing +response latency) from compute to GCS. For more information see docs on [direct connectivity] A warning is emmitted if gRPC is not used within GCP to warn that direct connectivity could not be initialized. Direct connectivity is not required to access the gRPC API. Dependencies for the gRPC API may slightly increase the size of binaries for applications depending on this package. If you are not using gRPC, you can use @@ -409,5 +404,6 @@ client, which is available as a subpackage in this module. See package docs at [custom audit logging]: https://cloud.google.com/storage/docs/audit-logging#add-custom-metadata [Storage Control API]: https://cloud.google.com/storage/docs/reference/rpc/google.storage.control.v2 [metric explorer]: https://console.cloud.google.com/projectselector/monitoring/metrics-explorer +[direct connectivity]: https://cloud.google.com/vpc-service-controls/docs/set-up-private-connectivity#direct-connectivity */ package storage // import "cloud.google.com/go/storage" From 2cfa05571484422590363888e301524849cddb64 Mon Sep 17 00:00:00 2001 From: Frank Natividad Date: Thu, 12 Sep 2024 15:51:03 -0700 Subject: [PATCH 2/5] clean up long lines --- storage/doc.go | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/storage/doc.go b/storage/doc.go index d472d4210d2d..9ca1c20e24ab 100644 --- a/storage/doc.go +++ b/storage/doc.go @@ -333,9 +333,11 @@ to add a [custom audit logging] header: # gRPC API -This package includes support for the Cloud Storage gRPC API. This implementation uses gRPC rather than the current JSON & XML -APIs to make requests to Cloud Storage. -The Go Storage gRPC library is not yet generally available, so it may be subject to breaking changes. +This package includes support for the Cloud Storage gRPC API. The +implementation uses gRPC rather than the current +JSON & XML APIs to make requests to Cloud Storage. +The Go Storage gRPC library is not yet generally available, so it may be +subject to breaking changes. To create a client which will use gRPC, use the alternate constructor: @@ -348,7 +350,10 @@ To create a client which will use gRPC, use the alternate constructor: Using the gRPC API inside GCP with a bucket in the same region can allow direct connectivity (enabling requests to skip Google Front Ends (GFEs) and reducing -response latency) from compute to GCS. For more information see docs on [direct connectivity] A warning is emmitted if gRPC is not used within GCP to warn that direct connectivity could not be initialized. Direct connectivity is not required to access the gRPC API. +response latency) from compute to GCS. For more information see docs on [direct connectivity]. +A warning is emmitted if gRPC is not used within GCP to warn that direct +connectivity could not be initialized. Direct connectivity is not required +to access the gRPC API. Dependencies for the gRPC API may slightly increase the size of binaries for applications depending on this package. If you are not using gRPC, you can use From a272d4a80c7ba7604cc21beb8f2e4cb4d337cc2b Mon Sep 17 00:00:00 2001 From: Frank Natividad Date: Thu, 12 Sep 2024 15:51:59 -0700 Subject: [PATCH 3/5] update to GA --- storage/doc.go | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/storage/doc.go b/storage/doc.go index 9ca1c20e24ab..002f318c741a 100644 --- a/storage/doc.go +++ b/storage/doc.go @@ -336,8 +336,7 @@ to add a [custom audit logging] header: This package includes support for the Cloud Storage gRPC API. The implementation uses gRPC rather than the current JSON & XML APIs to make requests to Cloud Storage. -The Go Storage gRPC library is not yet generally available, so it may be -subject to breaking changes. +The Go Storage gRPC library is generally available. To create a client which will use gRPC, use the alternate constructor: From 8d33b706f39384cda65e04eaf9edaced19157c5c Mon Sep 17 00:00:00 2001 From: Frank Natividad Date: Fri, 13 Sep 2024 10:16:58 -0700 Subject: [PATCH 4/5] address comments --- storage/doc.go | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/storage/doc.go b/storage/doc.go index 002f318c741a..b582e3d3ddb8 100644 --- a/storage/doc.go +++ b/storage/doc.go @@ -334,9 +334,9 @@ to add a [custom audit logging] header: # gRPC API This package includes support for the Cloud Storage gRPC API. The -implementation uses gRPC rather than the current +implementation uses gRPC rather than the Default JSON & XML APIs to make requests to Cloud Storage. -The Go Storage gRPC library is generally available. +The Go Storage gRPC client is generally available. To create a client which will use gRPC, use the alternate constructor: @@ -347,12 +347,11 @@ To create a client which will use gRPC, use the alternate constructor: } // Use client as usual. -Using the gRPC API inside GCP with a bucket in the same region can allow direct -connectivity (enabling requests to skip Google Front Ends (GFEs) and reducing -response latency) from compute to GCS. For more information see docs on [direct connectivity]. -A warning is emmitted if gRPC is not used within GCP to warn that direct -connectivity could not be initialized. Direct connectivity is not required -to access the gRPC API. +Using the gRPC API inside GCP with a bucket in the same region can allow for +[Direct Connectivity] (enabling requests to skip some proxy steps and reducing +response latency). A warning is emmitted if gRPC is not used within GCP to +warn that Direct Connectivity could not be initialized. Direct Connectivity +is not required to access the gRPC API. Dependencies for the gRPC API may slightly increase the size of binaries for applications depending on this package. If you are not using gRPC, you can use @@ -408,6 +407,6 @@ client, which is available as a subpackage in this module. See package docs at [custom audit logging]: https://cloud.google.com/storage/docs/audit-logging#add-custom-metadata [Storage Control API]: https://cloud.google.com/storage/docs/reference/rpc/google.storage.control.v2 [metric explorer]: https://console.cloud.google.com/projectselector/monitoring/metrics-explorer -[direct connectivity]: https://cloud.google.com/vpc-service-controls/docs/set-up-private-connectivity#direct-connectivity +[Direct Connectivity]: https://cloud.google.com/vpc-service-controls/docs/set-up-private-connectivity#direct-connectivity */ package storage // import "cloud.google.com/go/storage" From 0b0172f841a13c67d00a68404de38116eded9930 Mon Sep 17 00:00:00 2001 From: Frank Natividad Date: Mon, 23 Sep 2024 16:46:09 -0700 Subject: [PATCH 5/5] gofmt doc.go --- storage/doc.go | 1 - 1 file changed, 1 deletion(-) diff --git a/storage/doc.go b/storage/doc.go index 1863b31e97a1..4fcfb7326487 100644 --- a/storage/doc.go +++ b/storage/doc.go @@ -333,7 +333,6 @@ to add a [custom audit logging] header: # gRPC API - This package includes support for the Cloud Storage gRPC API. The implementation uses gRPC rather than the Default JSON & XML APIs to make requests to Cloud Storage.