google-cloud-container-v1 0.31.0 → 0.33.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/container/v1/cluster_manager/client.rb +31 -8
- data/lib/google/cloud/container/v1/version.rb +1 -1
- data/lib/google/container/v1/cluster_service_pb.rb +2 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/container/v1/cluster_service.rb +132 -0
- metadata +5 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c62881bb561e3304b9eded0bbf957c4577264b313aefca1f387cd1f59eccf72b
|
|
4
|
+
data.tar.gz: 5e81e9a9952a8b45201b2f02d52b16affe361e91f17f360ed2f4ef7d797f99a9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: adbc2401153d980611cc9b34ecf8ca585f23d958bff026c41740109f89360e027c3e508f404d19efcd35e6896a21c02bbf0697ec25f5dd48f66f578b060cb6e4
|
|
7
|
+
data.tar.gz: af1641f38e9a423c73fcce5d28a4380eda04e5a5ddc3c8c94c65c4372fb8b57db6d9aebeb3718925b05c990bab2027ffc6173615e9cf2de251c4362081d4c55d
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,151 +1,122 @@
|
|
|
1
1
|
# Authentication
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[
|
|
5
|
-
|
|
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-container-v1 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
|
-
|
|
19
|
-
|
|
9
|
+
The following example shows how to set up authentication for a local development
|
|
10
|
+
environment with your user credentials.
|
|
20
11
|
|
|
21
|
-
|
|
22
|
-
|
|
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
|
-
|
|
28
|
-
|
|
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
|
-
|
|
18
|
+
```sh
|
|
19
|
+
gcloud auth application-default login
|
|
31
20
|
```
|
|
32
21
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
The google-cloud-container-v1 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
|
-
|
|
51
|
-
|
|
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
|
-
|
|
27
|
+
## Credential Lookup
|
|
56
28
|
|
|
57
|
-
The
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
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-container-v1 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
|
-
|
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
|
67
|
-
{::Google::Cloud::Container::V1::ClusterManager::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
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)
|
|
74
41
|
|
|
75
|
-
|
|
76
|
-
require "google/cloud/container/v1"
|
|
77
|
-
|
|
78
|
-
ENV["CONTAINER_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
79
43
|
|
|
80
|
-
client
|
|
81
|
-
|
|
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).
|
|
82
49
|
|
|
83
|
-
|
|
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.
|
|
84
53
|
|
|
85
|
-
|
|
86
|
-
it in an environment variable. Either on an individual client initialization:
|
|
54
|
+
To configure a credentials file for an individual client initialization:
|
|
87
55
|
|
|
88
56
|
```ruby
|
|
89
57
|
require "google/cloud/container/v1"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::Container::V1::ClusterManager::Client.new do |config|
|
|
92
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
93
61
|
end
|
|
94
62
|
```
|
|
95
63
|
|
|
96
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
97
65
|
|
|
98
66
|
```ruby
|
|
99
67
|
require "google/cloud/container/v1"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::Container::V1::ClusterManager::Client.configure do |config|
|
|
102
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
103
71
|
end
|
|
104
72
|
|
|
105
73
|
client = ::Google::Cloud::Container::V1::ClusterManager::Client.new
|
|
106
74
|
```
|
|
107
75
|
|
|
108
|
-
###
|
|
76
|
+
### Environment Variables
|
|
109
77
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
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.
|
|
113
82
|
|
|
114
|
-
|
|
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).
|
|
115
87
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
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-container-v1
|
|
93
|
+
checks for credentials are:
|
|
119
94
|
|
|
120
|
-
|
|
121
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
122
97
|
|
|
123
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/container/v1"
|
|
124
100
|
|
|
125
|
-
|
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
127
|
-
connect to most services with google-cloud-container-v1.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
128
102
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::Container::V1::ClusterManager::Client.new
|
|
104
|
+
```
|
|
132
105
|
|
|
133
|
-
|
|
134
|
-
2. Create a new project or click on an existing project.
|
|
135
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
|
136
|
-
here, you will enable the APIs that your application requires.
|
|
106
|
+
### Local ADC file
|
|
137
107
|
|
|
138
|
-
|
|
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.
|
|
139
111
|
|
|
140
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
141
113
|
|
|
142
|
-
|
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
144
115
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
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.
|
|
149
120
|
|
|
150
|
-
|
|
151
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -30,6 +30,9 @@ module Google
|
|
|
30
30
|
# Google Kubernetes Engine Cluster Manager v1
|
|
31
31
|
#
|
|
32
32
|
class Client
|
|
33
|
+
# @private
|
|
34
|
+
DEFAULT_ENDPOINT_TEMPLATE = "container.$UNIVERSE_DOMAIN$"
|
|
35
|
+
|
|
33
36
|
include Paths
|
|
34
37
|
|
|
35
38
|
# @private
|
|
@@ -177,6 +180,15 @@ module Google
|
|
|
177
180
|
@config
|
|
178
181
|
end
|
|
179
182
|
|
|
183
|
+
##
|
|
184
|
+
# The effective universe domain
|
|
185
|
+
#
|
|
186
|
+
# @return [String]
|
|
187
|
+
#
|
|
188
|
+
def universe_domain
|
|
189
|
+
@cluster_manager_stub.universe_domain
|
|
190
|
+
end
|
|
191
|
+
|
|
180
192
|
##
|
|
181
193
|
# Create a new ClusterManager client object.
|
|
182
194
|
#
|
|
@@ -210,8 +222,9 @@ module Google
|
|
|
210
222
|
credentials = @config.credentials
|
|
211
223
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
212
224
|
# but only if the default endpoint does not have a region prefix.
|
|
213
|
-
enable_self_signed_jwt = @config.endpoint
|
|
214
|
-
|
|
225
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
226
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
227
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
215
228
|
credentials ||= Credentials.default scope: @config.scope,
|
|
216
229
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
217
230
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -222,8 +235,10 @@ module Google
|
|
|
222
235
|
|
|
223
236
|
@cluster_manager_stub = ::Gapic::ServiceStub.new(
|
|
224
237
|
::Google::Cloud::Container::V1::ClusterManager::Stub,
|
|
225
|
-
credentials:
|
|
226
|
-
endpoint:
|
|
238
|
+
credentials: credentials,
|
|
239
|
+
endpoint: @config.endpoint,
|
|
240
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
241
|
+
universe_domain: @config.universe_domain,
|
|
227
242
|
channel_args: @config.channel_args,
|
|
228
243
|
interceptors: @config.interceptors,
|
|
229
244
|
channel_pool_config: @config.channel_pool
|
|
@@ -3786,9 +3801,9 @@ module Google
|
|
|
3786
3801
|
# end
|
|
3787
3802
|
#
|
|
3788
3803
|
# @!attribute [rw] endpoint
|
|
3789
|
-
#
|
|
3790
|
-
#
|
|
3791
|
-
# @return [::String]
|
|
3804
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
3805
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
3806
|
+
# @return [::String,nil]
|
|
3792
3807
|
# @!attribute [rw] credentials
|
|
3793
3808
|
# Credentials to send with calls. You may provide any of the following types:
|
|
3794
3809
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -3834,13 +3849,20 @@ module Google
|
|
|
3834
3849
|
# @!attribute [rw] quota_project
|
|
3835
3850
|
# A separate project against which to charge quota.
|
|
3836
3851
|
# @return [::String]
|
|
3852
|
+
# @!attribute [rw] universe_domain
|
|
3853
|
+
# The universe domain within which to make requests. This determines the
|
|
3854
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
3855
|
+
# universe (usually the default "googleapis.com" universe).
|
|
3856
|
+
# @return [::String,nil]
|
|
3837
3857
|
#
|
|
3838
3858
|
class Configuration
|
|
3839
3859
|
extend ::Gapic::Config
|
|
3840
3860
|
|
|
3861
|
+
# @private
|
|
3862
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
3841
3863
|
DEFAULT_ENDPOINT = "container.googleapis.com"
|
|
3842
3864
|
|
|
3843
|
-
config_attr :endpoint,
|
|
3865
|
+
config_attr :endpoint, nil, ::String, nil
|
|
3844
3866
|
config_attr :credentials, nil do |value|
|
|
3845
3867
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
3846
3868
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -3855,6 +3877,7 @@ module Google
|
|
|
3855
3877
|
config_attr :metadata, nil, ::Hash, nil
|
|
3856
3878
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
3857
3879
|
config_attr :quota_project, nil, ::String, nil
|
|
3880
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
3858
3881
|
|
|
3859
3882
|
# @private
|
|
3860
3883
|
def initialize parent_config = nil
|