C.J. Collier | 37141e4 | 2020-02-13 13:49:49 -0800 | [diff] [blame] | 1 | # Copyright 2016 Google LLC |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 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 | """Environment variables used by :mod:`google.auth`.""" |
| 16 | |
| 17 | |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 18 | PROJECT = "GOOGLE_CLOUD_PROJECT" |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 19 | """Environment variable defining default project. |
| 20 | |
| 21 | This used by :func:`google.auth.default` to explicitly set a project ID. This |
| 22 | environment variable is also used by the Google Cloud Python Library. |
| 23 | """ |
| 24 | |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 25 | LEGACY_PROJECT = "GCLOUD_PROJECT" |
Jon Wayne Parrott | ce37cba | 2016-11-07 16:41:42 -0800 | [diff] [blame] | 26 | """Previously used environment variable defining the default project. |
| 27 | |
| 28 | This environment variable is used instead of the current one in some |
| 29 | situations (such as Google App Engine). |
| 30 | """ |
| 31 | |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 32 | CREDENTIALS = "GOOGLE_APPLICATION_CREDENTIALS" |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 33 | """Environment variable defining the location of Google application default |
| 34 | credentials.""" |
| 35 | |
| 36 | # The environment variable name which can replace ~/.config if set. |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 37 | CLOUD_SDK_CONFIG_DIR = "CLOUDSDK_CONFIG" |
Jon Wayne Parrott | aadb3de | 2016-10-19 09:34:05 -0700 | [diff] [blame] | 38 | """Environment variable defines the location of Google Cloud SDK's config |
| 39 | files.""" |
Craig Citro | b33b802 | 2017-03-24 15:36:04 -0700 | [diff] [blame] | 40 | |
| 41 | # These two variables allow for customization of the addresses used when |
| 42 | # contacting the GCE metadata service. |
chenyumic | 8ffb4d3 | 2020-06-04 10:14:05 -0700 | [diff] [blame^] | 43 | GCE_METADATA_HOST = "GCE_METADATA_HOST" |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 44 | GCE_METADATA_ROOT = "GCE_METADATA_ROOT" |
Craig Citro | b33b802 | 2017-03-24 15:36:04 -0700 | [diff] [blame] | 45 | """Environment variable providing an alternate hostname or host:port to be |
chenyumic | 8ffb4d3 | 2020-06-04 10:14:05 -0700 | [diff] [blame^] | 46 | used for GCE metadata requests. |
| 47 | |
| 48 | This environment variable is originally named GCE_METADATA_ROOT. System will |
| 49 | check the new variable first; should there be no value present, |
| 50 | the system falls back to the old variable. |
| 51 | """ |
Craig Citro | b33b802 | 2017-03-24 15:36:04 -0700 | [diff] [blame] | 52 | |
Bu Sun Kim | 9eec091 | 2019-10-21 17:04:21 -0700 | [diff] [blame] | 53 | GCE_METADATA_IP = "GCE_METADATA_IP" |
Craig Citro | b33b802 | 2017-03-24 15:36:04 -0700 | [diff] [blame] | 54 | """Environment variable providing an alternate ip:port to be used for ip-only |
| 55 | GCE metadata requests.""" |