google-cloud-env 1.0.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 +7 -0
- data/.yardopts +7 -0
- data/LICENSE +201 -0
- data/README.md +32 -0
- data/lib/google-cloud-env.rb +17 -0
- data/lib/google/cloud/env.rb +366 -0
- data/lib/google/cloud/env/version.rb +22 -0
- metadata +193 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA1:
|
|
3
|
+
metadata.gz: 0a69ed77d834f3ae04f4b17e6b14211bcb1d011c
|
|
4
|
+
data.tar.gz: 2793cde8a808b4bfc3bee78956b7560b130a455b
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 0404159a03422d4d6dbcf1bf21d4ae091deb857910634eb9ef68f1bf585bd14b88a0dc03a002751cbfc45b153dadae247b66c73b34c1500832e50a7d50b1a603
|
|
7
|
+
data.tar.gz: 31467ed9c20e79c7fc2a33704d5046c16004de52cda504a51ac3a67c88c8b70fcacafedfc6172b34f79ad77455f17d59f0bdd90f3668d5444ac0e61367550869
|
data/.yardopts
ADDED
data/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# google-cloud-env
|
|
2
|
+
|
|
3
|
+
This library provides information on the application hosting environment for apps running on Google Cloud Platform.
|
|
4
|
+
|
|
5
|
+
- [google-cloud-env API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-env/latest)
|
|
6
|
+
|
|
7
|
+
## Supported Ruby Versions
|
|
8
|
+
|
|
9
|
+
This library is supported on Ruby 2.0+.
|
|
10
|
+
|
|
11
|
+
## Versioning
|
|
12
|
+
|
|
13
|
+
This library follows [Semantic Versioning](http://semver.org/).
|
|
14
|
+
|
|
15
|
+
It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable.
|
|
16
|
+
|
|
17
|
+
## Contributing
|
|
18
|
+
|
|
19
|
+
Contributions to this library are always welcome and highly encouraged.
|
|
20
|
+
|
|
21
|
+
See the [Contributing Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/contributing) for more information on how to get started.
|
|
22
|
+
|
|
23
|
+
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct](../CODE_OF_CONDUCT.md) for more information.
|
|
24
|
+
|
|
25
|
+
## License
|
|
26
|
+
|
|
27
|
+
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).
|
|
28
|
+
|
|
29
|
+
## Support
|
|
30
|
+
|
|
31
|
+
Please [report bugs at the project on Github](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues).
|
|
32
|
+
Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby) about the client or APIs on [StackOverflow](http://stackoverflow.com).
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Copyright 2017 Google Inc. All rights reserved.
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
require "google/cloud/env"
|
|
17
|
+
require "google/cloud/env/version"
|
|
@@ -0,0 +1,366 @@
|
|
|
1
|
+
# Copyright 2017 Google Inc. All rights reserved.
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
require "faraday"
|
|
17
|
+
require "json"
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Cloud
|
|
22
|
+
##
|
|
23
|
+
# # Google Cloud hosting environment
|
|
24
|
+
#
|
|
25
|
+
# This library provides access to information about the application's
|
|
26
|
+
# hosting environment if it is running on Google Cloud Platform. You may
|
|
27
|
+
# use this library to determine which Google Cloud product is hosting your
|
|
28
|
+
# application (e.g. app engine, container engine), information about the
|
|
29
|
+
# Google Cloud project hosting the application, information about the
|
|
30
|
+
# virtual machine instance, authentication information, and so forth.
|
|
31
|
+
#
|
|
32
|
+
# ## Usage
|
|
33
|
+
#
|
|
34
|
+
# Obtain an instance of the environment info with:
|
|
35
|
+
#
|
|
36
|
+
# require "google/cloud/env"
|
|
37
|
+
# env = Google::Cloud.env
|
|
38
|
+
#
|
|
39
|
+
# Then you can interrogate any fields using methods on the object.
|
|
40
|
+
#
|
|
41
|
+
# if env.app_engine?
|
|
42
|
+
# # App engine specific logic
|
|
43
|
+
# end
|
|
44
|
+
#
|
|
45
|
+
# Any item that does not apply to the current environment will return nil.
|
|
46
|
+
# For example:
|
|
47
|
+
#
|
|
48
|
+
# unless env.app_engine?
|
|
49
|
+
# service = env.app_engine_service_id # => nil
|
|
50
|
+
# end
|
|
51
|
+
#
|
|
52
|
+
class Env
|
|
53
|
+
# @private Base (host) URL for the metadata server.
|
|
54
|
+
METADATA_HOST = "http://169.254.169.254".freeze
|
|
55
|
+
|
|
56
|
+
# @private URL path for v1 of the metadata service.
|
|
57
|
+
METADATA_PATH_BASE = "/computeMetadata/v1".freeze
|
|
58
|
+
|
|
59
|
+
# @private URL path for metadata server root.
|
|
60
|
+
METADATA_ROOT_PATH = "/".freeze
|
|
61
|
+
|
|
62
|
+
##
|
|
63
|
+
# Create a new instance of the environment information.
|
|
64
|
+
# Most client should not need to call this directly. Obtain a singleton
|
|
65
|
+
# instance of the information from `Google::Cloud.env`. This constructor
|
|
66
|
+
# is provided for internal testing and allows mocking of the data.
|
|
67
|
+
#
|
|
68
|
+
# @param [Hash] env Mock environment variables.
|
|
69
|
+
# @param [Faraday::Connection] connection Faraday connection to use.
|
|
70
|
+
#
|
|
71
|
+
def initialize env: nil, connection: nil
|
|
72
|
+
@metadata_cache = {}
|
|
73
|
+
@env = env || ::ENV
|
|
74
|
+
@connection = connection ||
|
|
75
|
+
::Faraday.new(url: METADATA_HOST,
|
|
76
|
+
request: { timeout: 0.1 })
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
##
|
|
80
|
+
# Determine whether the application is running on Google App Engine.
|
|
81
|
+
#
|
|
82
|
+
# @return [Boolean]
|
|
83
|
+
#
|
|
84
|
+
def app_engine?
|
|
85
|
+
env["GAE_INSTANCE"] ? true : false
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
##
|
|
89
|
+
# Determine whether the application is running on Google Container Engine.
|
|
90
|
+
#
|
|
91
|
+
# @return [Boolean]
|
|
92
|
+
#
|
|
93
|
+
def container_engine?
|
|
94
|
+
container_engine_cluster_name ? true : false
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
##
|
|
98
|
+
# Determine whether the application is running on Google Cloud Shell.
|
|
99
|
+
#
|
|
100
|
+
# @return [Boolean]
|
|
101
|
+
#
|
|
102
|
+
def cloud_shell?
|
|
103
|
+
env["DEVSHELL_GCLOUD_CONFIG"] ? true : false
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
##
|
|
107
|
+
# Determine whether the application is running on Google Compute Engine.
|
|
108
|
+
#
|
|
109
|
+
# Note that most other products (e.g. App Engine, Container Engine,
|
|
110
|
+
# Cloud Shell) themselves use Compute Engine under the hood, so this
|
|
111
|
+
# method will return true for all the above products. If you want to
|
|
112
|
+
# determine whether the application is running on a "raw" Compute Engine
|
|
113
|
+
# VM without using a higher level hosting product, use
|
|
114
|
+
# {Env#raw_compute_engine?}.
|
|
115
|
+
#
|
|
116
|
+
# @return [Boolean]
|
|
117
|
+
#
|
|
118
|
+
def compute_engine?
|
|
119
|
+
metadata?
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
##
|
|
123
|
+
# Determine whether the application is running on "raw" Google Compute
|
|
124
|
+
# Engine without using a higher level hosting product such as App
|
|
125
|
+
# Engine or Container Engine.
|
|
126
|
+
#
|
|
127
|
+
# @return [Boolean]
|
|
128
|
+
#
|
|
129
|
+
def raw_compute_engine?
|
|
130
|
+
!app_engine? && !cloud_shell? && metadata? && !container_engine?
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
##
|
|
134
|
+
# Returns the unique string ID of the project hosting the application,
|
|
135
|
+
# or `nil` if the application is not running on Google Cloud.
|
|
136
|
+
#
|
|
137
|
+
# @return [String,nil]
|
|
138
|
+
#
|
|
139
|
+
def project_id
|
|
140
|
+
env["GCLOUD_PROJECT"] || env["DEVSHELL_PROJECT_ID"] ||
|
|
141
|
+
lookup_metadata("project", "project-id")
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
##
|
|
145
|
+
# Returns the unique numeric ID of the project hosting the application,
|
|
146
|
+
# or `nil` if the application is not running on Google Cloud.
|
|
147
|
+
#
|
|
148
|
+
# Caveat: this method does not work and returns `nil` on CloudShell.
|
|
149
|
+
#
|
|
150
|
+
# @return [Integer,nil]
|
|
151
|
+
#
|
|
152
|
+
def numeric_project_id
|
|
153
|
+
# CloudShell's metadata server seems to run in a dummy project.
|
|
154
|
+
# We can get the user's normal project ID via environment variables,
|
|
155
|
+
# but the numeric ID from the metadata service is not correct. So
|
|
156
|
+
# disable this for CloudShell to avoid confusion.
|
|
157
|
+
return nil if cloud_shell?
|
|
158
|
+
|
|
159
|
+
result = lookup_metadata "project", "numeric-project-id"
|
|
160
|
+
result.nil? ? nil : result.to_i
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
##
|
|
164
|
+
# Returns the name of the VM instance hosting the application, or `nil`
|
|
165
|
+
# if the application is not running on Google Cloud.
|
|
166
|
+
#
|
|
167
|
+
# @return [String,nil]
|
|
168
|
+
#
|
|
169
|
+
def instance_name
|
|
170
|
+
env["GAE_INSTANCE"] || lookup_metadata("instance", "name")
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
##
|
|
174
|
+
# Returns the description field (which may be the empty string) of the
|
|
175
|
+
# VM instance hosting the application, or `nil` if the application is
|
|
176
|
+
# not running on Google Cloud.
|
|
177
|
+
#
|
|
178
|
+
# @return [String,nil]
|
|
179
|
+
#
|
|
180
|
+
def instance_description
|
|
181
|
+
lookup_metadata "instance", "description"
|
|
182
|
+
end
|
|
183
|
+
|
|
184
|
+
##
|
|
185
|
+
# Returns the zone (for example "`us-central1-c`") in which the instance
|
|
186
|
+
# hosting the application lives. Returns `nil` if the application is
|
|
187
|
+
# not running on Google Cloud.
|
|
188
|
+
#
|
|
189
|
+
# @return [String,nil]
|
|
190
|
+
#
|
|
191
|
+
def instance_zone
|
|
192
|
+
result = lookup_metadata "instance", "zone"
|
|
193
|
+
result.nil? ? nil : result.split("/").last
|
|
194
|
+
end
|
|
195
|
+
|
|
196
|
+
##
|
|
197
|
+
# Returns the machine type of the VM instance hosting the application,
|
|
198
|
+
# or `nil` if the application is not running on Google Cloud.
|
|
199
|
+
#
|
|
200
|
+
# @return [String,nil]
|
|
201
|
+
#
|
|
202
|
+
def instance_machine_type
|
|
203
|
+
result = lookup_metadata "instance", "machine-type"
|
|
204
|
+
result.nil? ? nil : result.split("/").last
|
|
205
|
+
end
|
|
206
|
+
|
|
207
|
+
##
|
|
208
|
+
# Returns an array (which may be empty) of all tags set on the VM
|
|
209
|
+
# instance hosting the application, or `nil` if the application is not
|
|
210
|
+
# running on Google Cloud.
|
|
211
|
+
#
|
|
212
|
+
# @return [Array<String>,nil]
|
|
213
|
+
#
|
|
214
|
+
def instance_tags
|
|
215
|
+
result = lookup_metadata "instance", "tags"
|
|
216
|
+
result.nil? ? nil : JSON.parse(result)
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
##
|
|
220
|
+
# Returns an array (which may be empty) of all attribute keys present
|
|
221
|
+
# for the VM instance hosting the application, or `nil` if the
|
|
222
|
+
# application is not running on Google Cloud.
|
|
223
|
+
#
|
|
224
|
+
# @return [Array<String>,nil]
|
|
225
|
+
#
|
|
226
|
+
def instance_attribute_keys
|
|
227
|
+
result = lookup_metadata "instance", "attributes/"
|
|
228
|
+
result.nil? ? nil : result.split
|
|
229
|
+
end
|
|
230
|
+
|
|
231
|
+
##
|
|
232
|
+
# Returns the value of the given instance attribute for the VM instance
|
|
233
|
+
# hosting the application, or `nil` if the given key does not exist or
|
|
234
|
+
# application is not running on Google Cloud.
|
|
235
|
+
#
|
|
236
|
+
# @param [String] key Attribute key to look up.
|
|
237
|
+
# @return [String,nil]
|
|
238
|
+
#
|
|
239
|
+
def instance_attribute key
|
|
240
|
+
lookup_metadata "instance", "attributes/#{key}"
|
|
241
|
+
end
|
|
242
|
+
|
|
243
|
+
##
|
|
244
|
+
# Returns the name of the running App Engine service, or `nil` if the
|
|
245
|
+
# current code is not running in App Engine.
|
|
246
|
+
#
|
|
247
|
+
# @return [String,nil]
|
|
248
|
+
#
|
|
249
|
+
def app_engine_service_id
|
|
250
|
+
env["GAE_SERVICE"]
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
##
|
|
254
|
+
# Returns the version of the running App Engine service, or `nil` if the
|
|
255
|
+
# current code is not running in App Engine.
|
|
256
|
+
#
|
|
257
|
+
# @return [String,nil]
|
|
258
|
+
#
|
|
259
|
+
def app_engine_service_version
|
|
260
|
+
env["GAE_VERSION"]
|
|
261
|
+
end
|
|
262
|
+
|
|
263
|
+
##
|
|
264
|
+
# Returns the amount of memory reserved for the current App Engine
|
|
265
|
+
# instance, or `nil` if the current code is not running in App Engine.
|
|
266
|
+
#
|
|
267
|
+
# @return [Integer,nil]
|
|
268
|
+
#
|
|
269
|
+
def app_engine_memory_mb
|
|
270
|
+
result = env["GAE_MEMORY_MB"]
|
|
271
|
+
result.nil? ? nil : result.to_i
|
|
272
|
+
end
|
|
273
|
+
|
|
274
|
+
##
|
|
275
|
+
# Returns the name of the Container Engine cluster hosting the
|
|
276
|
+
# application, or `nil` if the current code is not running in
|
|
277
|
+
# Container Engine.
|
|
278
|
+
#
|
|
279
|
+
# @return [String,nil]
|
|
280
|
+
#
|
|
281
|
+
def container_engine_cluster_name
|
|
282
|
+
instance_attribute "cluster-name"
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
##
|
|
286
|
+
# Returns the name of the Container Engine namespace hosting the
|
|
287
|
+
# application, or `nil` if the current code is not running in
|
|
288
|
+
# Container Engine.
|
|
289
|
+
#
|
|
290
|
+
# @return [String,nil]
|
|
291
|
+
#
|
|
292
|
+
def container_engine_namespace_id
|
|
293
|
+
env["GKE_NAMESPACE_ID"]
|
|
294
|
+
end
|
|
295
|
+
|
|
296
|
+
##
|
|
297
|
+
# Determine whether the Google Compute Engine Metadata Service is running.
|
|
298
|
+
#
|
|
299
|
+
# @return [Boolean]
|
|
300
|
+
#
|
|
301
|
+
def metadata?
|
|
302
|
+
unless metadata_cache.include?(METADATA_ROOT_PATH)
|
|
303
|
+
begin
|
|
304
|
+
resp = connection.get METADATA_ROOT_PATH
|
|
305
|
+
metadata_cache[METADATA_ROOT_PATH] = \
|
|
306
|
+
resp.status == 200 && resp.headers["Metadata-Flavor"] == "Google"
|
|
307
|
+
rescue ::Faraday::TimeoutError, ::Faraday::ConnectionFailed
|
|
308
|
+
metadata_cache[METADATA_ROOT_PATH] = false
|
|
309
|
+
end
|
|
310
|
+
end
|
|
311
|
+
metadata_cache[METADATA_ROOT_PATH]
|
|
312
|
+
end
|
|
313
|
+
|
|
314
|
+
##
|
|
315
|
+
# Retrieve info from the Google Compute Engine Metadata Service.
|
|
316
|
+
# Returns `nil` if the Metadata Service is not running or the given
|
|
317
|
+
# data is not present.
|
|
318
|
+
#
|
|
319
|
+
# @param [String] type Type of metadata to look up. Currently supported
|
|
320
|
+
# values are "project" and "instance".
|
|
321
|
+
# @param [String] entry Metadata entry path to look up.
|
|
322
|
+
# @return [String,nil]
|
|
323
|
+
#
|
|
324
|
+
def lookup_metadata type, entry
|
|
325
|
+
path = "#{METADATA_PATH_BASE}/#{type}/#{entry}"
|
|
326
|
+
if !metadata_cache.include?(path) && metadata?
|
|
327
|
+
begin
|
|
328
|
+
resp = connection.get path do |req|
|
|
329
|
+
req.headers = { "Metadata-Flavor" => "Google" }
|
|
330
|
+
end
|
|
331
|
+
metadata_cache[path] = resp.status == 200 ? resp.body.strip : nil
|
|
332
|
+
rescue ::Faraday::TimeoutError, ::Faraday::ConnectionFailed
|
|
333
|
+
metadata_cache[path] = nil
|
|
334
|
+
end
|
|
335
|
+
end
|
|
336
|
+
metadata_cache[path]
|
|
337
|
+
end
|
|
338
|
+
|
|
339
|
+
##
|
|
340
|
+
# Returns the global instance of {Google::Cloud::Env}.
|
|
341
|
+
#
|
|
342
|
+
# @return [Google::Cloud::Env]
|
|
343
|
+
#
|
|
344
|
+
def self.get
|
|
345
|
+
::Google::Cloud.env
|
|
346
|
+
end
|
|
347
|
+
|
|
348
|
+
private
|
|
349
|
+
|
|
350
|
+
attr_reader :connection
|
|
351
|
+
attr_reader :env
|
|
352
|
+
attr_reader :metadata_cache
|
|
353
|
+
end
|
|
354
|
+
|
|
355
|
+
@env = Env.new
|
|
356
|
+
|
|
357
|
+
##
|
|
358
|
+
# Returns the global instance of {Google::Cloud::Env}.
|
|
359
|
+
#
|
|
360
|
+
# @return [Google::Cloud::Env]
|
|
361
|
+
#
|
|
362
|
+
def self.env
|
|
363
|
+
@env
|
|
364
|
+
end
|
|
365
|
+
end
|
|
366
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Copyright 2017 Google Inc. All rights reserved.
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
module Google
|
|
17
|
+
module Cloud
|
|
18
|
+
class Env
|
|
19
|
+
VERSION = "1.0.0".freeze
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: google-cloud-env
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Daniel Azuma
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: bin
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2017-04-01 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: faraday
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - "~>"
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '0.11'
|
|
20
|
+
type: :runtime
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - "~>"
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '0.11'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: minitest
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - "~>"
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '5.10'
|
|
34
|
+
type: :development
|
|
35
|
+
prerelease: false
|
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - "~>"
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: '5.10'
|
|
41
|
+
- !ruby/object:Gem::Dependency
|
|
42
|
+
name: minitest-autotest
|
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
|
44
|
+
requirements:
|
|
45
|
+
- - "~>"
|
|
46
|
+
- !ruby/object:Gem::Version
|
|
47
|
+
version: '1.0'
|
|
48
|
+
type: :development
|
|
49
|
+
prerelease: false
|
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
51
|
+
requirements:
|
|
52
|
+
- - "~>"
|
|
53
|
+
- !ruby/object:Gem::Version
|
|
54
|
+
version: '1.0'
|
|
55
|
+
- !ruby/object:Gem::Dependency
|
|
56
|
+
name: minitest-focus
|
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
|
58
|
+
requirements:
|
|
59
|
+
- - "~>"
|
|
60
|
+
- !ruby/object:Gem::Version
|
|
61
|
+
version: '1.1'
|
|
62
|
+
type: :development
|
|
63
|
+
prerelease: false
|
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
65
|
+
requirements:
|
|
66
|
+
- - "~>"
|
|
67
|
+
- !ruby/object:Gem::Version
|
|
68
|
+
version: '1.1'
|
|
69
|
+
- !ruby/object:Gem::Dependency
|
|
70
|
+
name: minitest-rg
|
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
|
72
|
+
requirements:
|
|
73
|
+
- - "~>"
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: '5.2'
|
|
76
|
+
type: :development
|
|
77
|
+
prerelease: false
|
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
79
|
+
requirements:
|
|
80
|
+
- - "~>"
|
|
81
|
+
- !ruby/object:Gem::Version
|
|
82
|
+
version: '5.2'
|
|
83
|
+
- !ruby/object:Gem::Dependency
|
|
84
|
+
name: autotest-suffix
|
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
|
86
|
+
requirements:
|
|
87
|
+
- - "~>"
|
|
88
|
+
- !ruby/object:Gem::Version
|
|
89
|
+
version: '1.1'
|
|
90
|
+
type: :development
|
|
91
|
+
prerelease: false
|
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
93
|
+
requirements:
|
|
94
|
+
- - "~>"
|
|
95
|
+
- !ruby/object:Gem::Version
|
|
96
|
+
version: '1.1'
|
|
97
|
+
- !ruby/object:Gem::Dependency
|
|
98
|
+
name: rubocop
|
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
|
100
|
+
requirements:
|
|
101
|
+
- - "<="
|
|
102
|
+
- !ruby/object:Gem::Version
|
|
103
|
+
version: 0.35.1
|
|
104
|
+
type: :development
|
|
105
|
+
prerelease: false
|
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
107
|
+
requirements:
|
|
108
|
+
- - "<="
|
|
109
|
+
- !ruby/object:Gem::Version
|
|
110
|
+
version: 0.35.1
|
|
111
|
+
- !ruby/object:Gem::Dependency
|
|
112
|
+
name: simplecov
|
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
|
114
|
+
requirements:
|
|
115
|
+
- - "~>"
|
|
116
|
+
- !ruby/object:Gem::Version
|
|
117
|
+
version: '0.9'
|
|
118
|
+
type: :development
|
|
119
|
+
prerelease: false
|
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
121
|
+
requirements:
|
|
122
|
+
- - "~>"
|
|
123
|
+
- !ruby/object:Gem::Version
|
|
124
|
+
version: '0.9'
|
|
125
|
+
- !ruby/object:Gem::Dependency
|
|
126
|
+
name: yard
|
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
|
128
|
+
requirements:
|
|
129
|
+
- - "~>"
|
|
130
|
+
- !ruby/object:Gem::Version
|
|
131
|
+
version: '0.9'
|
|
132
|
+
type: :development
|
|
133
|
+
prerelease: false
|
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
135
|
+
requirements:
|
|
136
|
+
- - "~>"
|
|
137
|
+
- !ruby/object:Gem::Version
|
|
138
|
+
version: '0.9'
|
|
139
|
+
- !ruby/object:Gem::Dependency
|
|
140
|
+
name: yard-doctest
|
|
141
|
+
requirement: !ruby/object:Gem::Requirement
|
|
142
|
+
requirements:
|
|
143
|
+
- - "<="
|
|
144
|
+
- !ruby/object:Gem::Version
|
|
145
|
+
version: 0.1.8
|
|
146
|
+
type: :development
|
|
147
|
+
prerelease: false
|
|
148
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
149
|
+
requirements:
|
|
150
|
+
- - "<="
|
|
151
|
+
- !ruby/object:Gem::Version
|
|
152
|
+
version: 0.1.8
|
|
153
|
+
description: google-cloud-env provides information on the Google Cloud Platform hosting
|
|
154
|
+
environment. Applications can use this library to determine hosting context information
|
|
155
|
+
such as the project ID, whether App Engine is running, what tags are set on the
|
|
156
|
+
VM instance, and much more.
|
|
157
|
+
email:
|
|
158
|
+
- dazuma@google.com
|
|
159
|
+
executables: []
|
|
160
|
+
extensions: []
|
|
161
|
+
extra_rdoc_files: []
|
|
162
|
+
files:
|
|
163
|
+
- ".yardopts"
|
|
164
|
+
- LICENSE
|
|
165
|
+
- README.md
|
|
166
|
+
- lib/google-cloud-env.rb
|
|
167
|
+
- lib/google/cloud/env.rb
|
|
168
|
+
- lib/google/cloud/env/version.rb
|
|
169
|
+
homepage: http://googlecloudplatform.github.io/google-cloud-ruby/
|
|
170
|
+
licenses:
|
|
171
|
+
- Apache-2.0
|
|
172
|
+
metadata: {}
|
|
173
|
+
post_install_message:
|
|
174
|
+
rdoc_options: []
|
|
175
|
+
require_paths:
|
|
176
|
+
- lib
|
|
177
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
178
|
+
requirements:
|
|
179
|
+
- - ">="
|
|
180
|
+
- !ruby/object:Gem::Version
|
|
181
|
+
version: 2.0.0
|
|
182
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
183
|
+
requirements:
|
|
184
|
+
- - ">="
|
|
185
|
+
- !ruby/object:Gem::Version
|
|
186
|
+
version: '0'
|
|
187
|
+
requirements: []
|
|
188
|
+
rubyforge_project:
|
|
189
|
+
rubygems_version: 2.6.11
|
|
190
|
+
signing_key:
|
|
191
|
+
specification_version: 4
|
|
192
|
+
summary: Google Cloud Platform hosting environment information.
|
|
193
|
+
test_files: []
|