google-cloud-os_config-v1alpha 0.7.0 → 0.8.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/os_config/v1alpha/os_config_zonal_service/client.rb +32 -8
- data/lib/google/cloud/os_config/v1alpha/os_config_zonal_service/operations.rb +28 -6
- data/lib/google/cloud/os_config/v1alpha/os_config_zonal_service/rest/client.rb +34 -7
- data/lib/google/cloud/os_config/v1alpha/os_config_zonal_service/rest/operations.rb +33 -8
- data/lib/google/cloud/os_config/v1alpha/os_config_zonal_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/os_config/v1alpha/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/cloud/osconfig/v1alpha/config_common.rb +6 -0
- data/proto_docs/google/cloud/osconfig/v1alpha/instance_os_policies_compliance.rb +5 -0
- data/proto_docs/google/cloud/osconfig/v1alpha/os_policy.rb +1 -0
- data/proto_docs/google/cloud/osconfig/v1alpha/os_policy_assignments.rb +1 -0
- data/proto_docs/google/cloud/osconfig/v1alpha/vulnerability.rb +2 -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: b1daf79029a979802f615568ac2da153adf0718ff06e439c31246ef65b36650f
|
|
4
|
+
data.tar.gz: 4a11830f7239f43d3026eda70ab9e1bfdc3de2c73288b87032947db717053747
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e880881ca0db20e7469785eb55d6cd12a77a398693e61dd7caa840da6aaaaa713fb75fa13be47a7c5baf73c0bbed0f7c187e38a73c2de0b6eee9e9721e6f1832
|
|
7
|
+
data.tar.gz: 80c6cfef3d3355dbb159283bb3a7a4ae6844e9f2da62a7840c87ddd55df45259e43351c1d79831cf2867c123dcc0a9a766f35aeb78deb0e2715a666e6960710d
|
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-os_config-v1alpha 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-os_config-v1alpha 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-os_config-v1alpha 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::OsConfig::V1alpha::OsConfigZonalService::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/os_config/v1alpha"
|
|
77
|
-
|
|
78
|
-
ENV["OS_CONFIG_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/os_config/v1alpha"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::OsConfig::V1alpha::OsConfigZonalService::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/os_config/v1alpha"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::OsConfig::V1alpha::OsConfigZonalService::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::OsConfig::V1alpha::OsConfigZonalService::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-os_config-v1alpha
|
|
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/os_config/v1alpha"
|
|
124
100
|
|
|
125
|
-
|
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
127
|
-
connect to most services with google-cloud-os_config-v1alpha.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
128
102
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::OsConfig::V1alpha::OsConfigZonalService::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).
|
|
@@ -33,6 +33,9 @@ module Google
|
|
|
33
33
|
# manage package installations and patch jobs for Compute Engine VM 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_zonal_service_stub.universe_domain
|
|
111
|
+
end
|
|
112
|
+
|
|
101
113
|
##
|
|
102
114
|
# Create a new OsConfigZonalService 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
|
|
135
|
-
|
|
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)
|
|
@@ -145,12 +158,15 @@ module Google
|
|
|
145
158
|
config.credentials = credentials
|
|
146
159
|
config.quota_project = @quota_project_id
|
|
147
160
|
config.endpoint = @config.endpoint
|
|
161
|
+
config.universe_domain = @config.universe_domain
|
|
148
162
|
end
|
|
149
163
|
|
|
150
164
|
@os_config_zonal_service_stub = ::Gapic::ServiceStub.new(
|
|
151
165
|
::Google::Cloud::OsConfig::V1alpha::OsConfigZonalService::Stub,
|
|
152
|
-
credentials:
|
|
153
|
-
endpoint:
|
|
166
|
+
credentials: credentials,
|
|
167
|
+
endpoint: @config.endpoint,
|
|
168
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
169
|
+
universe_domain: @config.universe_domain,
|
|
154
170
|
channel_args: @config.channel_args,
|
|
155
171
|
interceptors: @config.interceptors,
|
|
156
172
|
channel_pool_config: @config.channel_pool
|
|
@@ -1617,9 +1633,9 @@ module Google
|
|
|
1617
1633
|
# end
|
|
1618
1634
|
#
|
|
1619
1635
|
# @!attribute [rw] endpoint
|
|
1620
|
-
#
|
|
1621
|
-
#
|
|
1622
|
-
# @return [::String]
|
|
1636
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1637
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1638
|
+
# @return [::String,nil]
|
|
1623
1639
|
# @!attribute [rw] credentials
|
|
1624
1640
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1625
1641
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1665,13 +1681,20 @@ module Google
|
|
|
1665
1681
|
# @!attribute [rw] quota_project
|
|
1666
1682
|
# A separate project against which to charge quota.
|
|
1667
1683
|
# @return [::String]
|
|
1684
|
+
# @!attribute [rw] universe_domain
|
|
1685
|
+
# The universe domain within which to make requests. This determines the
|
|
1686
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1687
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1688
|
+
# @return [::String,nil]
|
|
1668
1689
|
#
|
|
1669
1690
|
class Configuration
|
|
1670
1691
|
extend ::Gapic::Config
|
|
1671
1692
|
|
|
1693
|
+
# @private
|
|
1694
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1672
1695
|
DEFAULT_ENDPOINT = "osconfig.googleapis.com"
|
|
1673
1696
|
|
|
1674
|
-
config_attr :endpoint,
|
|
1697
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1675
1698
|
config_attr :credentials, nil do |value|
|
|
1676
1699
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1677
1700
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -1686,6 +1709,7 @@ module Google
|
|
|
1686
1709
|
config_attr :metadata, nil, ::Hash, nil
|
|
1687
1710
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1688
1711
|
config_attr :quota_project, nil, ::String, nil
|
|
1712
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1689
1713
|
|
|
1690
1714
|
# @private
|
|
1691
1715
|
def initialize parent_config = nil
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module OsConfigZonalService
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "osconfig.$UNIVERSE_DOMAIN$"
|
|
31
|
+
|
|
29
32
|
# @private
|
|
30
33
|
attr_reader :operations_stub
|
|
31
34
|
|
|
@@ -60,6 +63,15 @@ module Google
|
|
|
60
63
|
@config
|
|
61
64
|
end
|
|
62
65
|
|
|
66
|
+
##
|
|
67
|
+
# The effective universe domain
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
#
|
|
71
|
+
def universe_domain
|
|
72
|
+
@operations_stub.universe_domain
|
|
73
|
+
end
|
|
74
|
+
|
|
63
75
|
##
|
|
64
76
|
# Create a new Operations client object.
|
|
65
77
|
#
|
|
@@ -90,8 +102,10 @@ module Google
|
|
|
90
102
|
|
|
91
103
|
@operations_stub = ::Gapic::ServiceStub.new(
|
|
92
104
|
::Google::Longrunning::Operations::Stub,
|
|
93
|
-
credentials:
|
|
94
|
-
endpoint:
|
|
105
|
+
credentials: credentials,
|
|
106
|
+
endpoint: @config.endpoint,
|
|
107
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
108
|
+
universe_domain: @config.universe_domain,
|
|
95
109
|
channel_args: @config.channel_args,
|
|
96
110
|
interceptors: @config.interceptors,
|
|
97
111
|
channel_pool_config: @config.channel_pool
|
|
@@ -613,9 +627,9 @@ module Google
|
|
|
613
627
|
# end
|
|
614
628
|
#
|
|
615
629
|
# @!attribute [rw] endpoint
|
|
616
|
-
#
|
|
617
|
-
#
|
|
618
|
-
# @return [::String]
|
|
630
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
631
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
632
|
+
# @return [::String,nil]
|
|
619
633
|
# @!attribute [rw] credentials
|
|
620
634
|
# Credentials to send with calls. You may provide any of the following types:
|
|
621
635
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -661,13 +675,20 @@ module Google
|
|
|
661
675
|
# @!attribute [rw] quota_project
|
|
662
676
|
# A separate project against which to charge quota.
|
|
663
677
|
# @return [::String]
|
|
678
|
+
# @!attribute [rw] universe_domain
|
|
679
|
+
# The universe domain within which to make requests. This determines the
|
|
680
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
681
|
+
# universe (usually the default "googleapis.com" universe).
|
|
682
|
+
# @return [::String,nil]
|
|
664
683
|
#
|
|
665
684
|
class Configuration
|
|
666
685
|
extend ::Gapic::Config
|
|
667
686
|
|
|
687
|
+
# @private
|
|
688
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
668
689
|
DEFAULT_ENDPOINT = "osconfig.googleapis.com"
|
|
669
690
|
|
|
670
|
-
config_attr :endpoint,
|
|
691
|
+
config_attr :endpoint, nil, ::String, nil
|
|
671
692
|
config_attr :credentials, nil do |value|
|
|
672
693
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
673
694
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -682,6 +703,7 @@ module Google
|
|
|
682
703
|
config_attr :metadata, nil, ::Hash, nil
|
|
683
704
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
684
705
|
config_attr :quota_project, nil, ::String, nil
|
|
706
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
685
707
|
|
|
686
708
|
# @private
|
|
687
709
|
def initialize parent_config = nil
|
|
@@ -35,6 +35,9 @@ module Google
|
|
|
35
35
|
# manage package installations and patch jobs for Compute Engine VM instances.
|
|
36
36
|
#
|
|
37
37
|
class Client
|
|
38
|
+
# @private
|
|
39
|
+
DEFAULT_ENDPOINT_TEMPLATE = "osconfig.$UNIVERSE_DOMAIN$"
|
|
40
|
+
|
|
38
41
|
include Paths
|
|
39
42
|
|
|
40
43
|
# @private
|
|
@@ -100,6 +103,15 @@ module Google
|
|
|
100
103
|
@config
|
|
101
104
|
end
|
|
102
105
|
|
|
106
|
+
##
|
|
107
|
+
# The effective universe domain
|
|
108
|
+
#
|
|
109
|
+
# @return [String]
|
|
110
|
+
#
|
|
111
|
+
def universe_domain
|
|
112
|
+
@os_config_zonal_service_stub.universe_domain
|
|
113
|
+
end
|
|
114
|
+
|
|
103
115
|
##
|
|
104
116
|
# Create a new OsConfigZonalService REST client object.
|
|
105
117
|
#
|
|
@@ -127,8 +139,9 @@ module Google
|
|
|
127
139
|
credentials = @config.credentials
|
|
128
140
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
129
141
|
# but only if the default endpoint does not have a region prefix.
|
|
130
|
-
enable_self_signed_jwt = @config.endpoint
|
|
131
|
-
|
|
142
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
143
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
144
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
132
145
|
credentials ||= Credentials.default scope: @config.scope,
|
|
133
146
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
134
147
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -142,9 +155,15 @@ module Google
|
|
|
142
155
|
config.credentials = credentials
|
|
143
156
|
config.quota_project = @quota_project_id
|
|
144
157
|
config.endpoint = @config.endpoint
|
|
158
|
+
config.universe_domain = @config.universe_domain
|
|
145
159
|
end
|
|
146
160
|
|
|
147
|
-
@os_config_zonal_service_stub = ::Google::Cloud::OsConfig::V1alpha::OsConfigZonalService::Rest::ServiceStub.new
|
|
161
|
+
@os_config_zonal_service_stub = ::Google::Cloud::OsConfig::V1alpha::OsConfigZonalService::Rest::ServiceStub.new(
|
|
162
|
+
endpoint: @config.endpoint,
|
|
163
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
164
|
+
universe_domain: @config.universe_domain,
|
|
165
|
+
credentials: credentials
|
|
166
|
+
)
|
|
148
167
|
end
|
|
149
168
|
|
|
150
169
|
##
|
|
@@ -1505,9 +1524,9 @@ module Google
|
|
|
1505
1524
|
# end
|
|
1506
1525
|
#
|
|
1507
1526
|
# @!attribute [rw] endpoint
|
|
1508
|
-
#
|
|
1509
|
-
#
|
|
1510
|
-
# @return [::String]
|
|
1527
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1528
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1529
|
+
# @return [::String,nil]
|
|
1511
1530
|
# @!attribute [rw] credentials
|
|
1512
1531
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1513
1532
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1544,13 +1563,20 @@ module Google
|
|
|
1544
1563
|
# @!attribute [rw] quota_project
|
|
1545
1564
|
# A separate project against which to charge quota.
|
|
1546
1565
|
# @return [::String]
|
|
1566
|
+
# @!attribute [rw] universe_domain
|
|
1567
|
+
# The universe domain within which to make requests. This determines the
|
|
1568
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1569
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1570
|
+
# @return [::String,nil]
|
|
1547
1571
|
#
|
|
1548
1572
|
class Configuration
|
|
1549
1573
|
extend ::Gapic::Config
|
|
1550
1574
|
|
|
1575
|
+
# @private
|
|
1576
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1551
1577
|
DEFAULT_ENDPOINT = "osconfig.googleapis.com"
|
|
1552
1578
|
|
|
1553
|
-
config_attr :endpoint,
|
|
1579
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1554
1580
|
config_attr :credentials, nil do |value|
|
|
1555
1581
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1556
1582
|
allowed.any? { |klass| klass === value }
|
|
@@ -1562,6 +1588,7 @@ module Google
|
|
|
1562
1588
|
config_attr :metadata, nil, ::Hash, nil
|
|
1563
1589
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1564
1590
|
config_attr :quota_project, nil, ::String, nil
|
|
1591
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1565
1592
|
|
|
1566
1593
|
# @private
|
|
1567
1594
|
def initialize parent_config = nil
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module Rest
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "osconfig.$UNIVERSE_DOMAIN$"
|
|
31
|
+
|
|
29
32
|
# @private
|
|
30
33
|
attr_reader :operations_stub
|
|
31
34
|
|
|
@@ -60,6 +63,15 @@ module Google
|
|
|
60
63
|
@config
|
|
61
64
|
end
|
|
62
65
|
|
|
66
|
+
##
|
|
67
|
+
# The effective universe domain
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
#
|
|
71
|
+
def universe_domain
|
|
72
|
+
@operations_stub.universe_domain
|
|
73
|
+
end
|
|
74
|
+
|
|
63
75
|
##
|
|
64
76
|
# Create a new Operations client object.
|
|
65
77
|
#
|
|
@@ -84,8 +96,10 @@ module Google
|
|
|
84
96
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
85
97
|
|
|
86
98
|
@operations_stub = OperationsServiceStub.new(
|
|
87
|
-
endpoint:
|
|
88
|
-
|
|
99
|
+
endpoint: @config.endpoint,
|
|
100
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
101
|
+
universe_domain: @config.universe_domain,
|
|
102
|
+
credentials: credentials
|
|
89
103
|
)
|
|
90
104
|
|
|
91
105
|
# Used by an LRO wrapper for some methods of this service
|
|
@@ -478,9 +492,9 @@ module Google
|
|
|
478
492
|
# end
|
|
479
493
|
#
|
|
480
494
|
# @!attribute [rw] endpoint
|
|
481
|
-
#
|
|
482
|
-
#
|
|
483
|
-
# @return [::String]
|
|
495
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
496
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
497
|
+
# @return [::String,nil]
|
|
484
498
|
# @!attribute [rw] credentials
|
|
485
499
|
# Credentials to send with calls. You may provide any of the following types:
|
|
486
500
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -517,13 +531,20 @@ module Google
|
|
|
517
531
|
# @!attribute [rw] quota_project
|
|
518
532
|
# A separate project against which to charge quota.
|
|
519
533
|
# @return [::String]
|
|
534
|
+
# @!attribute [rw] universe_domain
|
|
535
|
+
# The universe domain within which to make requests. This determines the
|
|
536
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
537
|
+
# universe (usually the default "googleapis.com" universe).
|
|
538
|
+
# @return [::String,nil]
|
|
520
539
|
#
|
|
521
540
|
class Configuration
|
|
522
541
|
extend ::Gapic::Config
|
|
523
542
|
|
|
543
|
+
# @private
|
|
544
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
524
545
|
DEFAULT_ENDPOINT = "osconfig.googleapis.com"
|
|
525
546
|
|
|
526
|
-
config_attr :endpoint,
|
|
547
|
+
config_attr :endpoint, nil, ::String, nil
|
|
527
548
|
config_attr :credentials, nil do |value|
|
|
528
549
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
529
550
|
allowed.any? { |klass| klass === value }
|
|
@@ -535,6 +556,7 @@ module Google
|
|
|
535
556
|
config_attr :metadata, nil, ::Hash, nil
|
|
536
557
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
537
558
|
config_attr :quota_project, nil, ::String, nil
|
|
559
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
538
560
|
|
|
539
561
|
# @private
|
|
540
562
|
def initialize parent_config = nil
|
|
@@ -617,12 +639,15 @@ module Google
|
|
|
617
639
|
# Service stub contains baseline method implementations
|
|
618
640
|
# including transcoding, making the REST call, and deserialing the response.
|
|
619
641
|
class OperationsServiceStub
|
|
620
|
-
def initialize endpoint:, credentials:
|
|
642
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
621
643
|
# These require statements are intentionally placed here to initialize
|
|
622
644
|
# the REST modules only when it's required.
|
|
623
645
|
require "gapic/rest"
|
|
624
646
|
|
|
625
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
647
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
648
|
+
endpoint_template: endpoint_template,
|
|
649
|
+
universe_domain: universe_domain,
|
|
650
|
+
credentials: credentials
|
|
626
651
|
end
|
|
627
652
|
|
|
628
653
|
##
|
|
@@ -30,16 +30,28 @@ module Google
|
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
|
31
31
|
#
|
|
32
32
|
class ServiceStub
|
|
33
|
-
def initialize endpoint:, credentials:
|
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
34
34
|
# These require statements are intentionally placed here to initialize
|
|
35
35
|
# the REST modules only when it's required.
|
|
36
36
|
require "gapic/rest"
|
|
37
37
|
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
endpoint_template: endpoint_template,
|
|
40
|
+
universe_domain: universe_domain,
|
|
41
|
+
credentials: credentials,
|
|
39
42
|
numeric_enums: true,
|
|
40
43
|
raise_faraday_errors: false
|
|
41
44
|
end
|
|
42
45
|
|
|
46
|
+
##
|
|
47
|
+
# The effective universe domain
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
#
|
|
51
|
+
def universe_domain
|
|
52
|
+
@client_stub.universe_domain
|
|
53
|
+
end
|
|
54
|
+
|
|
43
55
|
##
|
|
44
56
|
# Baseline implementation for the create_os_policy_assignment REST call
|
|
45
57
|
#
|
|
@@ -21,6 +21,7 @@ module Google
|
|
|
21
21
|
module Api
|
|
22
22
|
# Required information for every language.
|
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
24
25
|
# @return [::String]
|
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
|
@@ -304,6 +305,19 @@ module Google
|
|
|
304
305
|
# seconds: 360 # 6 minutes
|
|
305
306
|
# total_poll_timeout:
|
|
306
307
|
# seconds: 54000 # 90 minutes
|
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
|
309
|
+
# @return [::Array<::String>]
|
|
310
|
+
# List of top-level fields of the request message, that should be
|
|
311
|
+
# automatically populated by the client libraries based on their
|
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
|
313
|
+
#
|
|
314
|
+
# Example of a YAML configuration:
|
|
315
|
+
#
|
|
316
|
+
# publishing:
|
|
317
|
+
# method_settings:
|
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
|
319
|
+
# auto_populated_fields:
|
|
320
|
+
# - request_id
|
|
307
321
|
class MethodSettings
|
|
308
322
|
include ::Google::Protobuf::MessageExts
|
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -23,6 +23,7 @@ module Google
|
|
|
23
23
|
module V1alpha
|
|
24
24
|
# Step performed by the OS Config agent for configuring an `OSPolicyResource`
|
|
25
25
|
# to its desired state.
|
|
26
|
+
# @deprecated This message is deprecated and may be removed in the next major version update.
|
|
26
27
|
# @!attribute [rw] type
|
|
27
28
|
# @return [::Google::Cloud::OsConfig::V1alpha::OSPolicyResourceConfigStep::Type]
|
|
28
29
|
# Configuration step type.
|
|
@@ -38,6 +39,7 @@ module Google
|
|
|
38
39
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
39
40
|
|
|
40
41
|
# Supported configuration step types
|
|
42
|
+
# @deprecated This enum is deprecated and may be removed in the next major version update.
|
|
41
43
|
module Type
|
|
42
44
|
# Default value. This value is unused.
|
|
43
45
|
TYPE_UNSPECIFIED = 0
|
|
@@ -62,6 +64,7 @@ module Google
|
|
|
62
64
|
end
|
|
63
65
|
|
|
64
66
|
# Supported outcomes for a configuration step.
|
|
67
|
+
# @deprecated This enum is deprecated and may be removed in the next major version update.
|
|
65
68
|
module Outcome
|
|
66
69
|
# Default value. This value is unused.
|
|
67
70
|
OUTCOME_UNSPECIFIED = 0
|
|
@@ -75,6 +78,7 @@ module Google
|
|
|
75
78
|
end
|
|
76
79
|
|
|
77
80
|
# Compliance data for an OS policy resource.
|
|
81
|
+
# @deprecated This message is deprecated and may be removed in the next major version update.
|
|
78
82
|
# @!attribute [rw] os_policy_resource_id
|
|
79
83
|
# @return [::String]
|
|
80
84
|
# The id of the OS policy resource.
|
|
@@ -93,6 +97,7 @@ module Google
|
|
|
93
97
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
94
98
|
|
|
95
99
|
# ExecResource specific output.
|
|
100
|
+
# @deprecated This message is deprecated and may be removed in the next major version update.
|
|
96
101
|
# @!attribute [rw] enforcement_output
|
|
97
102
|
# @return [::String]
|
|
98
103
|
# Output from Enforcement phase output file (if run).
|
|
@@ -104,6 +109,7 @@ module Google
|
|
|
104
109
|
end
|
|
105
110
|
|
|
106
111
|
# Supported OSPolicy compliance states.
|
|
112
|
+
# @deprecated This enum is deprecated and may be removed in the next major version update.
|
|
107
113
|
module OSPolicyComplianceState
|
|
108
114
|
# Default value. This value is unused.
|
|
109
115
|
OS_POLICY_COMPLIANCE_STATE_UNSPECIFIED = 0
|
|
@@ -33,6 +33,7 @@ module Google
|
|
|
33
33
|
#
|
|
34
34
|
# For more information, see [View
|
|
35
35
|
# compliance](https://cloud.google.com/compute/docs/os-configuration-management/view-compliance).
|
|
36
|
+
# @deprecated This message is deprecated and may be removed in the next major version update.
|
|
36
37
|
# @!attribute [r] name
|
|
37
38
|
# @return [::String]
|
|
38
39
|
# Output only. The `InstanceOSPoliciesCompliance` API resource name.
|
|
@@ -80,6 +81,7 @@ module Google
|
|
|
80
81
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
81
82
|
|
|
82
83
|
# Compliance data for an OS policy
|
|
84
|
+
# @deprecated This message is deprecated and may be removed in the next major version update.
|
|
83
85
|
# @!attribute [rw] os_policy_id
|
|
84
86
|
# @return [::String]
|
|
85
87
|
# The OS policy id
|
|
@@ -105,6 +107,7 @@ module Google
|
|
|
105
107
|
|
|
106
108
|
# A request message for getting OS policies compliance data for the given
|
|
107
109
|
# Compute Engine VM instance.
|
|
110
|
+
# @deprecated This message is deprecated and may be removed in the next major version update.
|
|
108
111
|
# @!attribute [rw] name
|
|
109
112
|
# @return [::String]
|
|
110
113
|
# Required. API resource name for instance OS policies compliance resource.
|
|
@@ -123,6 +126,7 @@ module Google
|
|
|
123
126
|
|
|
124
127
|
# A request message for listing OS policies compliance data for all Compute
|
|
125
128
|
# Engine VMs in the given location.
|
|
129
|
+
# @deprecated This message is deprecated and may be removed in the next major version update.
|
|
126
130
|
# @!attribute [rw] parent
|
|
127
131
|
# @return [::String]
|
|
128
132
|
# Required. The parent resource name.
|
|
@@ -150,6 +154,7 @@ module Google
|
|
|
150
154
|
|
|
151
155
|
# A response message for listing OS policies compliance data for all Compute
|
|
152
156
|
# Engine VMs in the given location.
|
|
157
|
+
# @deprecated This message is deprecated and may be removed in the next major version update.
|
|
153
158
|
# @!attribute [rw] instance_os_policies_compliances
|
|
154
159
|
# @return [::Array<::Google::Cloud::OsConfig::V1alpha::InstanceOSPoliciesCompliance>]
|
|
155
160
|
# List of instance OS policies compliance objects.
|
|
@@ -570,6 +570,7 @@ module Google
|
|
|
570
570
|
# group within the OS policy is selected based on the `OSFilter` specified
|
|
571
571
|
# within the resource group.
|
|
572
572
|
# @!attribute [rw] os_filter
|
|
573
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
573
574
|
# @return [::Google::Cloud::OsConfig::V1alpha::OSPolicy::OSFilter]
|
|
574
575
|
# Deprecated. Use the `inventory_filters` field instead.
|
|
575
576
|
# Used to specify the OS filter for a resource group
|
|
@@ -135,6 +135,7 @@ module Google
|
|
|
135
135
|
# Target all VMs in the project. If true, no other criteria is
|
|
136
136
|
# permitted.
|
|
137
137
|
# @!attribute [rw] os_short_names
|
|
138
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
138
139
|
# @return [::Array<::String>]
|
|
139
140
|
# Deprecated. Use the `inventories` field instead.
|
|
140
141
|
# A VM is selected if it's OS short name matches with any of the
|
|
@@ -49,6 +49,7 @@ module Google
|
|
|
49
49
|
# Contains metadata as per the upstream feed of the operating system and
|
|
50
50
|
# NVD.
|
|
51
51
|
# @!attribute [rw] installed_inventory_item_ids
|
|
52
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
52
53
|
# @return [::Array<::String>]
|
|
53
54
|
# Corresponds to the `INSTALLED_PACKAGE` inventory item on the VM.
|
|
54
55
|
# This field displays the inventory items affected by this vulnerability.
|
|
@@ -56,6 +57,7 @@ module Google
|
|
|
56
57
|
# update, these values might not display in VM inventory. For some distros,
|
|
57
58
|
# this field may be empty.
|
|
58
59
|
# @!attribute [rw] available_inventory_item_ids
|
|
60
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
59
61
|
# @return [::Array<::String>]
|
|
60
62
|
# Corresponds to the `AVAILABLE_PACKAGE` inventory item on the VM.
|
|
61
63
|
# If the vulnerability report was not updated after the VM inventory
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-os_config-v1alpha
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.8.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:
|
|
11
|
+
date: 2024-01-11 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
@@ -16,7 +16,7 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - ">="
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: 0.
|
|
19
|
+
version: 0.21.1
|
|
20
20
|
- - "<"
|
|
21
21
|
- !ruby/object:Gem::Version
|
|
22
22
|
version: 2.a
|
|
@@ -26,7 +26,7 @@ dependencies:
|
|
|
26
26
|
requirements:
|
|
27
27
|
- - ">="
|
|
28
28
|
- !ruby/object:Gem::Version
|
|
29
|
-
version: 0.
|
|
29
|
+
version: 0.21.1
|
|
30
30
|
- - "<"
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: 2.a
|
|
@@ -233,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
233
233
|
- !ruby/object:Gem::Version
|
|
234
234
|
version: '0'
|
|
235
235
|
requirements: []
|
|
236
|
-
rubygems_version: 3.
|
|
236
|
+
rubygems_version: 3.5.3
|
|
237
237
|
signing_key:
|
|
238
238
|
specification_version: 4
|
|
239
239
|
summary: OS management tools that can be used for patch management, patch compliance,
|