google-cloud-gke_multi_cloud 0.3.0 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -99
  3. data/README.md +2 -2
  4. data/lib/google/cloud/gke_multi_cloud/version.rb +1 -1
  5. data/lib/google/cloud/gke_multi_cloud.rb +5 -4
  6. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ef4692c5c2b050d2c3e203d2cd859e9634a7d16e5d866641c3e90a0b853df40f
4
- data.tar.gz: cf5d68ce12d8a1a8dafef6ce7c4e327a6fef9d1fa173f2e506612ef87ade182b
3
+ metadata.gz: 5c825ba4de10d55f332f871c6e77f65e3144a14f921e0fb7f4a3cb8394415d2e
4
+ data.tar.gz: 7f30d8533c96db8168136f3a79f5661b9921e267da9de474fe7c2cdc50bb544a
5
5
  SHA512:
6
- metadata.gz: bd386357a7293f1e28f5f8a939438961e5d6c581d14b2558e941a10dd40200ac52587b438a18a23bcbb51adea1b58e9dd6e046d80c6adaa9b4a05d1e7cf8d360
7
- data.tar.gz: 10fa9570a88582987f9be5f620371b8229d12940024efd331a890b29c7ec8d013a9b190f7fd0b05416470402b6988f3df6d42e232a6b3d3cbedac21ff72e8345
6
+ metadata.gz: 06c4671461fb211eaa7a7cf3727789a9ac4daa99f907b37efb122c5ca2e63c8d156782702fa4fbe44c69d3d00307242c0bcc35adee025405f4fdffe81610b7c8
7
+ data.tar.gz: 7750982e7b62feeb974e249cb38e29d6bf87f45891f31bdfd9b95093556c55c51b74501fa6b1696702a5a44e6ff405085ca6f06143f4fc7125bf8856175cb4f0
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-gke_multi_cloud library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
6
- [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
- credentials will be discovered automatically. When running on other
8
- environments, the Service Account credentials can be specified by providing the
9
- path to the
10
- [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
- for the account (or the JSON itself) in
12
- [environment variables](#environment-variables). Additionally, Cloud SDK
13
- credentials can also be discovered automatically, but this is only recommended
14
- during development.
3
+ The recommended way to authenticate to the google-cloud-gke_multi_cloud library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
15
6
 
16
7
  ## Quickstart
17
8
 
18
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export GOOGLE_CLOUD_CREDENTIALS=path/to/keyfile.json
23
- ```
24
-
25
- 3. Initialize the client.
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
26
14
 
27
- ```ruby
28
- require "google/cloud/gke_multi_cloud"
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
29
17
 
30
- client = Google::Cloud::GkeMultiCloud.attached_clusters
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-gke_multi_cloud library aims to make authentication
36
- as simple as possible, and provides several mechanisms to configure your system
37
- without requiring **Service Account Credentials** directly in code.
38
-
39
- **Credentials** are discovered in the following order:
40
-
41
- 1. Specify credentials in method arguments
42
- 2. Specify credentials in configuration
43
- 3. Discover credentials path in environment variables
44
- 4. Discover credentials JSON in environment variables
45
- 5. Discover credentials file in the Cloud SDK's path
46
- 6. Discover GCP credentials
47
-
48
- ### Google Cloud Platform environments
22
+ 3. Write code as if already authenticated.
49
23
 
50
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
- Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
- Code should be written as if already authenticated.
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
54
26
 
55
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
61
- **Credentials JSON** file can be stored in the environment variable, or the
62
- **Credentials JSON** itself can be stored for environments such as Docker
63
- containers where writing files is difficult or not encouraged.
29
+ The google-cloud-gke_multi_cloud library provides several mechanisms to configure your system.
30
+ Generally, using Application Default Credentials to facilitate automatic
31
+ credentials discovery is the easist method. But if you need to explicitly specify
32
+ credentials, there are several methods available to you.
64
33
 
65
- The environment variables that google-cloud-gke_multi_cloud
66
- checks for credentials are configured on the service Credentials class (such as
67
- `::Google::Cloud::GkeMultiCloud::V1::AttachedClusters::Credentials`):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
72
41
 
73
- ```ruby
74
- require "google/cloud/gke_multi_cloud"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = Google::Cloud::GkeMultiCloud.attached_clusters
79
- ```
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
80
49
 
81
- ### Configuration
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
82
53
 
83
- The path to the **Credentials JSON** file can be configured instead of storing
84
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
85
55
 
86
56
  ```ruby
87
57
  require "google/cloud/gke_multi_cloud"
88
58
 
89
59
  client = Google::Cloud::GkeMultiCloud.attached_clusters do |config|
90
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
91
61
  end
92
62
  ```
93
63
 
94
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
95
65
 
96
66
  ```ruby
97
67
  require "google/cloud/gke_multi_cloud"
98
68
 
99
69
  Google::Cloud::GkeMultiCloud.configure do |config|
100
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
101
71
  end
102
72
 
103
73
  client = Google::Cloud::GkeMultiCloud.attached_clusters
104
74
  ```
105
75
 
106
- ### Cloud SDK
76
+ ### Environment Variables
107
77
 
108
- This option allows for an easy way to authenticate during development. If
109
- credentials are not provided in code or in environment variables, then Cloud SDK
110
- credentials are discovered.
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
111
82
 
112
- To configure your system for this, simply:
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
113
87
 
114
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
115
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
116
- 3. Write code as if already authenticated.
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-gke_multi_cloud
93
+ checks for credentials are:
117
94
 
118
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
120
97
 
121
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/gke_multi_cloud"
122
100
 
123
- Google Cloud requires **Service Account Credentials** to
124
- connect to the APIs. You will use the **JSON key file** to
125
- connect to most services with google-cloud-gke_multi_cloud.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
126
102
 
127
- If you are not running this client within
128
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
129
- need a Google Developers service account.
103
+ client = Google::Cloud::GkeMultiCloud.attached_clusters
104
+ ```
130
105
 
131
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
132
- 2. Create a new project or click on an existing project.
133
- 3. Activate the menu in the upper left and select **APIs & Services**. From
134
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
135
107
 
136
- *Note: You may need to enable billing in order to use these services.*
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
137
111
 
138
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
139
113
 
140
- Find the "Create credentials" drop down near the top of the page, and select
141
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
142
115
 
143
- If you want to re-use an existing service account, you can easily generate a
144
- new key file. Just select the account you wish to re-use, click the pencil
145
- tool on the right side to edit the service account, select the **Keys** tab,
146
- and then select **Add Key**.
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
147
120
 
148
- The key file you download will be used by this library to authenticate API
149
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
data/README.md CHANGED
@@ -16,7 +16,7 @@ for this library, google-cloud-gke_multi_cloud, to see the convenience methods f
16
16
  constructing client objects. Reference documentation for the client objects
17
17
  themselves can be found in the client library documentation for the versioned
18
18
  client gems:
19
- [google-cloud-gke_multi_cloud-v1](https://googleapis.dev/ruby/google-cloud-gke_multi_cloud-v1/latest).
19
+ [google-cloud-gke_multi_cloud-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/latest).
20
20
 
21
21
  See also the [Product Documentation](https://cloud.google.com/anthos/clusters/docs/multi-cloud)
22
22
  for more usage information.
@@ -38,7 +38,7 @@ In order to use this library, you first need to go through the following steps:
38
38
 
39
39
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
40
40
  The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
41
- or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
41
+ or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
42
42
  that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
43
43
  and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
44
44
 
data/lib/google/cloud/gke_multi_cloud/version.rb CHANGED
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Cloud
22
22
  module GkeMultiCloud
23
- VERSION = "0.3.0"
23
+ VERSION = "1.1.0"
24
24
  end
25
25
  end
26
26
  end
data/lib/google/cloud/gke_multi_cloud.rb CHANGED
@@ -29,7 +29,7 @@ require "google/cloud/config"
29
29
 
30
30
  # Set the default configuration
31
31
  ::Google::Cloud.configure.add_config! :gke_multi_cloud do |config|
32
- config.add_field! :endpoint, "gkemulticloud.googleapis.com", match: ::String
32
+ config.add_field! :endpoint, nil, match: ::String
33
33
  config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
34
34
  config.add_field! :scope, nil, match: [::Array, ::String]
35
35
  config.add_field! :lib_name, nil, match: ::String
@@ -39,6 +39,7 @@ require "google/cloud/config"
39
39
  config.add_field! :metadata, nil, match: ::Hash
40
40
  config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
41
41
  config.add_field! :quota_project, nil, match: ::String
42
+ config.add_field! :universe_domain, nil, match: ::String
42
43
  end
43
44
 
44
45
  module Google
@@ -48,7 +49,7 @@ module Google
48
49
  # Create a new client object for AttachedClusters.
49
50
  #
50
51
  # By default, this returns an instance of
51
- # [Google::Cloud::GkeMultiCloud::V1::AttachedClusters::Client](https://googleapis.dev/ruby/google-cloud-gke_multi_cloud-v1/latest/Google/Cloud/GkeMultiCloud/V1/AttachedClusters/Client.html)
52
+ # [Google::Cloud::GkeMultiCloud::V1::AttachedClusters::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/latest/Google-Cloud-GkeMultiCloud-V1-AttachedClusters-Client)
52
53
  # for a gRPC client for version V1 of the API.
53
54
  # However, you can specify a different API version by passing it in the
54
55
  # `version` parameter. If the AttachedClusters service is
@@ -80,7 +81,7 @@ module Google
80
81
  # Create a new client object for AwsClusters.
81
82
  #
82
83
  # By default, this returns an instance of
83
- # [Google::Cloud::GkeMultiCloud::V1::AwsClusters::Client](https://googleapis.dev/ruby/google-cloud-gke_multi_cloud-v1/latest/Google/Cloud/GkeMultiCloud/V1/AwsClusters/Client.html)
84
+ # [Google::Cloud::GkeMultiCloud::V1::AwsClusters::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/latest/Google-Cloud-GkeMultiCloud-V1-AwsClusters-Client)
84
85
  # for a gRPC client for version V1 of the API.
85
86
  # However, you can specify a different API version by passing it in the
86
87
  # `version` parameter. If the AwsClusters service is
@@ -111,7 +112,7 @@ module Google
111
112
  # Create a new client object for AzureClusters.
112
113
  #
113
114
  # By default, this returns an instance of
114
- # [Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client](https://googleapis.dev/ruby/google-cloud-gke_multi_cloud-v1/latest/Google/Cloud/GkeMultiCloud/V1/AzureClusters/Client.html)
115
+ # [Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/latest/Google-Cloud-GkeMultiCloud-V1-AzureClusters-Client)
115
116
  # for a gRPC client for version V1 of the API.
116
117
  # However, you can specify a different API version by passing it in the
117
118
  # `version` parameter. If the AzureClusters service is
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-gke_multi_cloud
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-02-14 00:00:00.000000000 Z
11
+ date: 2024-01-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-cloud-core
@@ -30,7 +30,7 @@ dependencies:
30
30
  requirements:
31
31
  - - ">="
32
32
  - !ruby/object:Gem::Version
33
- version: '0.4'
33
+ version: '0.8'
34
34
  - - "<"
35
35
  - !ruby/object:Gem::Version
36
36
  version: 2.a
@@ -40,7 +40,7 @@ dependencies:
40
40
  requirements:
41
41
  - - ">="
42
42
  - !ruby/object:Gem::Version
43
- version: '0.4'
43
+ version: '0.8'
44
44
  - - "<"
45
45
  - !ruby/object:Gem::Version
46
46
  version: 2.a
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
191
191
  - !ruby/object:Gem::Version
192
192
  version: '0'
193
193
  requirements: []
194
- rubygems_version: 3.4.2
194
+ rubygems_version: 3.5.3
195
195
  signing_key:
196
196
  specification_version: 4
197
197
  summary: API Client library for the Anthos Multi-Cloud API