google-cloud-os_config-v1 0.13.0 → 0.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 225aed013ae0f215d256ad32a39a6d2e206b6d1bebb3f83dca5a606422bd8ae8
4
- data.tar.gz: 181bbd650bb8b779b186e7e24607a55a2a87c289d849c71e94043cded1f50c08
3
+ metadata.gz: 03ee2c782ba3c1e7952287f1c53c75aa118fdd7b68c2996c6f254b12981b2fef
4
+ data.tar.gz: db41db85137f8ded65b4f10a8fdec34e7d79f9c0c7c809222838eb43d2993a03
5
5
  SHA512:
6
- metadata.gz: 9b7bbc5c74fcc8209fe404e8f3df9a9419fea97ab7c6c953dd9f2fe464417f4b3f8dd9737ea1bb5c2e90e5126cc5866271fc828849850c1bc75dde31f8f6686f
7
- data.tar.gz: 36dccc76c76f08142bce862f9bf1fc2e719944fe70d709e6b6fc8c92a5c80c8390bcbc758dfbd2dd8f41a9a1224c1d4eb37921a828b5b326d8721b380379b009
6
+ metadata.gz: 721b7d49e270a04a99a001ee28cab3ee02ecca6bd7af80cff769faf49f4754b02191bc512820bb2cbf10b1317ca9b9da0ba75aab69a42258edc97ad4571ea485
7
+ data.tar.gz: 9dc995605e28eb42871fe2e3e89db2ad07b9394859ec3cbb1bbd97dce3d8fbaa6cd20e17bcdc1201e868f9d5bb3346d1ec871c989ad6a4eced83efc095aeaaa6
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-os_config-v1 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-os_config-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
- 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 OS_CONFIG_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/os_config/v1"
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::OsConfig::V1::OsConfigService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-os_config-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
- 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-os_config-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
- The environment variables that google-cloud-os_config-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::OsConfig::V1::OsConfigService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `OS_CONFIG_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `OS_CONFIG_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- * `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)
74
41
 
75
- ```ruby
76
- require "google/cloud/os_config/v1"
77
-
78
- ENV["OS_CONFIG_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::OsConfig::V1::OsConfigService::Client.new
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
- ### 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.
84
53
 
85
- The path to the **Credentials JSON** file can be configured instead of storing
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/os_config/v1"
90
58
 
91
59
  client = ::Google::Cloud::OsConfig::V1::OsConfigService::Client.new do |config|
92
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
97
65
 
98
66
  ```ruby
99
67
  require "google/cloud/os_config/v1"
100
68
 
101
69
  ::Google::Cloud::OsConfig::V1::OsConfigService::Client.configure do |config|
102
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
103
71
  end
104
72
 
105
73
  client = ::Google::Cloud::OsConfig::V1::OsConfigService::Client.new
106
74
  ```
107
75
 
108
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- 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.
113
82
 
114
- 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).
115
87
 
116
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
- 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-os_config-v1
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *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
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/os_config/v1"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
126
- connect to the APIs. You will use the **JSON key file** to
127
- connect to most services with google-cloud-os_config-v1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
128
102
 
129
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = ::Google::Cloud::OsConfig::V1::OsConfigService::Client.new
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
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
- *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.
139
111
 
140
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
142
- Find the "Create credentials" drop down near the top of the page, and select
143
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
146
- new key file. Just select the account you wish to re-use, click the pencil
147
- tool on the right side to edit the service account, select the **Keys** tab,
148
- 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.
149
120
 
150
- The key file you download will be used by this library to authenticate API
151
- 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).
@@ -33,6 +33,9 @@ module Google
33
33
  # manage package installations and patch jobs for virtual machine instances.
34
34
  #
35
35
  class Client
36
+ # @private
37
+ DEFAULT_ENDPOINT_TEMPLATE = "osconfig.$UNIVERSE_DOMAIN$"
38
+
36
39
  include Paths
37
40
 
38
41
  # @private
@@ -98,6 +101,15 @@ module Google
98
101
  @config
99
102
  end
100
103
 
104
+ ##
105
+ # The effective universe domain
106
+ #
107
+ # @return [String]
108
+ #
109
+ def universe_domain
110
+ @os_config_service_stub.universe_domain
111
+ end
112
+
101
113
  ##
102
114
  # Create a new OsConfigService client object.
103
115
  #
@@ -131,8 +143,9 @@ module Google
131
143
  credentials = @config.credentials
132
144
  # Use self-signed JWT if the endpoint is unchanged from default,
133
145
  # but only if the default endpoint does not have a region prefix.
134
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
135
- !@config.endpoint.split(".").first.include?("-")
146
+ enable_self_signed_jwt = @config.endpoint.nil? ||
147
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
148
+ !@config.endpoint.split(".").first.include?("-"))
136
149
  credentials ||= Credentials.default scope: @config.scope,
137
150
  enable_self_signed_jwt: enable_self_signed_jwt
138
151
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -143,10 +156,13 @@ module Google
143
156
 
144
157
  @os_config_service_stub = ::Gapic::ServiceStub.new(
145
158
  ::Google::Cloud::OsConfig::V1::OsConfigService::Stub,
146
- credentials: credentials,
147
- endpoint: @config.endpoint,
159
+ credentials: credentials,
160
+ endpoint: @config.endpoint,
161
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
162
+ universe_domain: @config.universe_domain,
148
163
  channel_args: @config.channel_args,
149
- interceptors: @config.interceptors
164
+ interceptors: @config.interceptors,
165
+ channel_pool_config: @config.channel_pool
150
166
  )
151
167
  end
152
168
 
@@ -1284,9 +1300,9 @@ module Google
1284
1300
  # end
1285
1301
  #
1286
1302
  # @!attribute [rw] endpoint
1287
- # The hostname or hostname:port of the service endpoint.
1288
- # Defaults to `"osconfig.googleapis.com"`.
1289
- # @return [::String]
1303
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1304
+ # nil, indicating to use the default endpoint in the current universe domain.
1305
+ # @return [::String,nil]
1290
1306
  # @!attribute [rw] credentials
1291
1307
  # Credentials to send with calls. You may provide any of the following types:
1292
1308
  # * (`String`) The path to a service account key file in JSON format
@@ -1332,13 +1348,20 @@ module Google
1332
1348
  # @!attribute [rw] quota_project
1333
1349
  # A separate project against which to charge quota.
1334
1350
  # @return [::String]
1351
+ # @!attribute [rw] universe_domain
1352
+ # The universe domain within which to make requests. This determines the
1353
+ # default endpoint URL. The default value of nil uses the environment
1354
+ # universe (usually the default "googleapis.com" universe).
1355
+ # @return [::String,nil]
1335
1356
  #
1336
1357
  class Configuration
1337
1358
  extend ::Gapic::Config
1338
1359
 
1360
+ # @private
1361
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1339
1362
  DEFAULT_ENDPOINT = "osconfig.googleapis.com"
1340
1363
 
1341
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1364
+ config_attr :endpoint, nil, ::String, nil
1342
1365
  config_attr :credentials, nil do |value|
1343
1366
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1344
1367
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1353,6 +1376,7 @@ module Google
1353
1376
  config_attr :metadata, nil, ::Hash, nil
1354
1377
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1355
1378
  config_attr :quota_project, nil, ::String, nil
1379
+ config_attr :universe_domain, nil, ::String, nil
1356
1380
 
1357
1381
  # @private
1358
1382
  def initialize parent_config = nil
@@ -1373,6 +1397,14 @@ module Google
1373
1397
  end
1374
1398
  end
1375
1399
 
1400
+ ##
1401
+ # Configuration for the channel pool
1402
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
1403
+ #
1404
+ def channel_pool
1405
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
1406
+ end
1407
+
1376
1408
  ##
1377
1409
  # Configuration RPC class for the OsConfigService API.
1378
1410
  #