| /* |
| * |
| * Copyright 2020 gRPC authors. |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| * |
| */ |
| |
| // Package env acts a single source of definition for all environment variables |
| // related to the xDS implementation in gRPC. |
| package env |
| |
| import ( |
| "os" |
| "strings" |
| ) |
| |
| const ( |
| // BootstrapFileNameEnv is the env variable to set bootstrap file name. |
| // Do not use this and read from env directly. Its value is read and kept in |
| // variable BootstrapFileName. |
| // |
| // When both bootstrap FileName and FileContent are set, FileName is used. |
| BootstrapFileNameEnv = "GRPC_XDS_BOOTSTRAP" |
| // BootstrapFileContentEnv is the env variable to set bootstrapp file |
| // content. Do not use this and read from env directly. Its value is read |
| // and kept in variable BootstrapFileName. |
| // |
| // When both bootstrap FileName and FileContent are set, FileName is used. |
| BootstrapFileContentEnv = "GRPC_XDS_BOOTSTRAP_CONFIG" |
| |
| ringHashSupportEnv = "GRPC_XDS_EXPERIMENTAL_ENABLE_RING_HASH" |
| clientSideSecuritySupportEnv = "GRPC_XDS_EXPERIMENTAL_SECURITY_SUPPORT" |
| aggregateAndDNSSupportEnv = "GRPC_XDS_EXPERIMENTAL_ENABLE_AGGREGATE_AND_LOGICAL_DNS_CLUSTER" |
| retrySupportEnv = "GRPC_XDS_EXPERIMENTAL_ENABLE_RETRY" |
| rbacSupportEnv = "GRPC_XDS_EXPERIMENTAL_RBAC" |
| |
| c2pResolverSupportEnv = "GRPC_EXPERIMENTAL_GOOGLE_C2P_RESOLVER" |
| c2pResolverTestOnlyTrafficDirectorURIEnv = "GRPC_TEST_ONLY_GOOGLE_C2P_RESOLVER_TRAFFIC_DIRECTOR_URI" |
| ) |
| |
| var ( |
| // BootstrapFileName holds the name of the file which contains xDS bootstrap |
| // configuration. Users can specify the location of the bootstrap file by |
| // setting the environment variable "GRPC_XDS_BOOTSTRAP". |
| // |
| // When both bootstrap FileName and FileContent are set, FileName is used. |
| BootstrapFileName = os.Getenv(BootstrapFileNameEnv) |
| // BootstrapFileContent holds the content of the xDS bootstrap |
| // configuration. Users can specify the bootstrap config by |
| // setting the environment variable "GRPC_XDS_BOOTSTRAP_CONFIG". |
| // |
| // When both bootstrap FileName and FileContent are set, FileName is used. |
| BootstrapFileContent = os.Getenv(BootstrapFileContentEnv) |
| // RingHashSupport indicates whether ring hash support is enabled, which can |
| // be disabled by setting the environment variable |
| // "GRPC_XDS_EXPERIMENTAL_ENABLE_RING_HASH" to "false". |
| RingHashSupport = !strings.EqualFold(os.Getenv(ringHashSupportEnv), "false") |
| // ClientSideSecuritySupport is used to control processing of security |
| // configuration on the client-side. |
| // |
| // Note that there is no env var protection for the server-side because we |
| // have a brand new API on the server-side and users explicitly need to use |
| // the new API to get security integration on the server. |
| ClientSideSecuritySupport = !strings.EqualFold(os.Getenv(clientSideSecuritySupportEnv), "false") |
| // AggregateAndDNSSupportEnv indicates whether processing of aggregated |
| // cluster and DNS cluster is enabled, which can be enabled by setting the |
| // environment variable |
| // "GRPC_XDS_EXPERIMENTAL_ENABLE_AGGREGATE_AND_LOGICAL_DNS_CLUSTER" to |
| // "true". |
| AggregateAndDNSSupportEnv = strings.EqualFold(os.Getenv(aggregateAndDNSSupportEnv), "true") |
| |
| // RetrySupport indicates whether xDS retry is enabled. |
| RetrySupport = !strings.EqualFold(os.Getenv(retrySupportEnv), "false") |
| |
| // RBACSupport indicates whether xDS configured RBAC HTTP Filter is enabled, |
| // which can be disabled by setting the environment variable |
| // "GRPC_XDS_EXPERIMENTAL_RBAC" to "false". |
| RBACSupport = !strings.EqualFold(os.Getenv(rbacSupportEnv), "false") |
| |
| // C2PResolverSupport indicates whether support for C2P resolver is enabled. |
| // This can be enabled by setting the environment variable |
| // "GRPC_EXPERIMENTAL_GOOGLE_C2P_RESOLVER" to "true". |
| C2PResolverSupport = strings.EqualFold(os.Getenv(c2pResolverSupportEnv), "true") |
| // C2PResolverTestOnlyTrafficDirectorURI is the TD URI for testing. |
| C2PResolverTestOnlyTrafficDirectorURI = os.Getenv(c2pResolverTestOnlyTrafficDirectorURIEnv) |
| ) |