Skip to content
This repository has been archived by the owner on Feb 16, 2023. It is now read-only.

Remove GCP BETA notice and some minor comment changes #198

Merged
merged 3 commits into from
Jul 3, 2020
Merged

Remove GCP BETA notice and some minor comment changes #198

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ac3f9ef
Remove GCP beta notices
jpcoenen Jul 3, 2020
975b892
Fix typo
jpcoenen Jul 3, 2020
d2966b1
Remove non-functioning example and clarify on-GCP requirement
jpcoenen Jul 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions pkg/secrethub/credentials/gcp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ import (
// If used on GCP (e.g. from a Compute Engine instance), this extra configuration is not required and the correct
// configuration should be auto-detected by the GCP client.
//
// Note: this functionality currently is in private beta. It will only work on selected namespaces.
// Access to the GCP metadata server is required for this function to work. In practice, this means that it can
// only be run on GCP.
//
// Usage:
// credentials.UseGCPServiceAccount()
// credentials.UseGCPServiceAccount(option.WithAPIKey("a-custom-api-key"))
func UseGCPServiceAccount(gcpOptions ...option.ClientOption) Provider {
return providerFunc(func(httpClient *http.Client) (auth.Authenticator, Decrypter, error) {
decrypter, err := gcp.NewKMSDecrypter(gcpOptions...)
Expand All @@ -35,9 +35,7 @@ func UseGCPServiceAccount(gcpOptions ...option.ClientOption) Provider {
// The kmsResourceID is the Resource ID of the key in KMS that is used to encrypt the account key.
// The service account should have decryption permission on the provided KMS key.
// gcpOptions can be used to optionally configure the used GCP client. For example to set a custom API key.
// The KMS key id and service account emaail are returned in the credentials metadata.
//
// Note: this functionality currently is in private beta. It will only work on selected namespaces.
// The KMS key id and service account email are returned in the credentials metadata.
func CreateGCPServiceAccount(serviceAccountEmail string, keyResourceID string, gcpOptions ...option.ClientOption) Creator {
return &gcpServiceAccountCreator{
keyResourceID: keyResourceID,
Expand Down