This section contains a full list of supported environment variables for your Docker and Kubernetes agent installations.
Default environment variables are included and prefilled in the auto-generated command created when you add an agent for your private location. For Docker agent installation, the command can be used as is. For Kubernetes agent installation, you'll need to replace and update some of the variables with your own configuration.
Optional environment variables enable you to further configure your instance for specific use cases, for example, when your private location is hidden behind a corporate proxy, or if you want to use CA certificates for agent installation.
Docker Environment Variables
Environment Variable | Type | Description |
AUTH_TOKEN | String | The agent auth token |
HARBOR_ID | String | The ID of the private location (aka harbor) with which the agent is associated |
SHIP_ID | String | The ID of the agent |
| AWS_CA_BUNDLE | String | This value is always /etc/ssl/certs/ca-certificates.crt. Denotes the location of the certificate bundle. |
| CONTAINER_MANAGER_TYPE | String | Valid values: DOCKER, KUBERNETES Default: DOCKER |
| HTTP_PROXY | String | URL of the HTTP proxy server to be used for all HTTP requests sent by the agent to A_ENVIRONMENT. Also passed to other components |
| HTTPS_PROXY | String | URL of HTTPS proxy server to be used for all HTTPS requests sent by agent to A_ENVIRONMENT. Also passed to the other components. |
| INHERIT_RUNNING_USER_AND_GROUP | Boolean | If true, it indicates that containers launched should use the same UID:GID as the Crane itself. Default: false |
| NO_PROXY | String | URL that should be excluded from proxying (on servers that should be contacted directly. See more info here) |
| PREFERRED_INTERFACE | String | Uses a specific network interface to gather the machine's IP address. If the interface is unavailable, it falls back to use the first available interface (not in blacklist, see default). Default: none; Uses first interface available not in list: docker0, lo |
| REQUESTS_CA_BUNDLE | String | This value is always /etc/ssl/certs/ca-certificates.crt. Denotes the location of the certificate bundle. |
| VERIFY_SSL | Boolean | If set to false, will send insecure requests to HTTPS addresses. If true a CA bundle may be required if something other than BlazeMeter requires HTTPS connections. Default: true |
| AUTO_UPDATE | Boolean | Whether new (Dockerized) auto-updates should be enabled. Default: true |
| DOCKER_REGISTRY | String | The address of your private Docker registry. For example: localhost:5000 |
| DOCKER_REGISTRY_EMAIL | String | The user name of your private Docker registry |
| DOCKER_REGISTRY_PASSWORD | String | The password of your private Docker registry |
| DOCKER_REGISTRY_USERNAME | String | The user name of your private Docker registry |
| HOSTNAME_OVERRIDE | String | The hostname you are going to use for transactional mock services and BlazeVSEs created on the agent. |
| TLS_CERT | String | The public certificate for the domain used in HOSTNAME_OVERRIDE. |
| TLS_KEY | String | The private key for the domain used in HOSTNAME_OVERRIDE. |
Kubernetes Environment Variables
Environment Variable | Type | Description |
AUTH_TOKEN | String | The agent auth token |
| HARBOR_ID | String | The ID of the private location (aka harbor) with which the agent is associated |
SHIP_ID | String | The ID of the agent |
AWS_CA_BUNDLE | String | This value is always /etc/ssl/certs/ca-certificates.crt. Denotes the location of the certificate bundle. |
CONTAINER_MANAGER_TYPE | String | Valid values: DOCKER, KUBERNETES Default: DOCKER |
HTTP_PROXY | String | URL of the HTTP proxy server to be used for all HTTP requests sent by the agent to A_ENVIRONMENT. Also passed to other components |
HTTPS_PROXY | String | URL of HTTPS proxy server to be used for all HTTPS requests sent by agent to A_ENVIRONMENT. Also passed to the other components. |
INHERIT_RUNNING_USER_AND_GROUP | Boolean | If true, it indicates that containers launched should use the same UID:GID as the Crane itself. Default: false |
NO_PROXY | String | URL that should be excluded from proxying (on servers that should be contacted directly. See more info here) |
PREFERRED_INTERFACE | String | Uses a specific network interface to gather the machine's IP address. If the interface is unavailable, it falls back to use the first available interface (not in blacklist, see default). Default: none; Uses first interface available not in list: docker0, lo |
REQUESTS_CA_BUNDLE | String | This value is always /etc/ssl/certs/ca-certificates.crt. Denotes the location of the certificate bundle. |
VERIFY_SSL | Boolean | If set to false, will send insecure requests to HTTPS addresses. If true a CA bundle may be required if something other than BlazeMeter requires HTTPS connections. Default: true |
AUTO_KUBERNETES_UPDATE | Boolean | If true, activate Kubernetes auto updater. Default: false |
DOCKER_REGISTRY | String | The address of your private Docker registry. For example: gcr.io/verdant-bulwark-278 |
IMAGE_OVERRIDES | JSON Encoded String | Allows the override of the default image received from BZA for the container to run. Key should be the original value (Example: apm-image:latest). The value should be the new repository name with a tag. MUST BE JSON ENCODED. Must be of the following regex: 'blabla/blabla/.../blabla/<image_name:latest>:<version_number>' For example: '{"torero:latest":"gcr.io/verdant-bulwark-278/blazemeter/torero:2.2.3-812"}' The version number can be extracted from 'admin/ship-stats' |
KUBERNETES_USE_PRE_PULLING | Boolean | Allows the K8S cluster to pre-pull images when updates occur to BlazeMeter components. Default: false |
KUBERNETES_SERVICE_USE_TYPE | String | Allows the K8S cluster to use ClusterIP services over the default NodePort service for Mock Services. Can be NODEPORT or CLUSTERIP. Default: NODEPORT |
KUBERNETES_WEB_EXPOSE_TYPE | String | This indicates the type of web interface to be used. The values can be INGRESS or CONTOUR or ISTIO. |
KUBERNETES_WEB_EXPOSE_SUB_DOMAIN | String | The subdomain to be used when creating transactional mock services. Example Value: blazevse.user.net |
KUBERNETES_ISTIO_GATEWAY_NAME | String | This value denotes the name of the Istio Gateway to be used. If left empty or not present, an Istio Gateway will be created by default (if KUBERNETES_WEB_EXPOSE_TYPE is set to ISTIO). |
KUBERNETES_WEB_EXPOSE_TLS_SECRET_NAME | String | The TLS secret name that contains the TLS key and TLS secret for the domain provided in KUBERNETES_WEB_EXPOSE_SUB_DOMAIN. |
KUBERNETES_SERVICES_BLOCKING_GET | Boolean | This needs to be set to true when creating numerous transactional mock services to avoid potential issues with K8S provisioning of pods. |
KUBERNETES_USE_APIPA | Boolean | Crane uses kubernetes node information to discover the IP Address of the endpoint. By default, this is disabled and "127.0.0.1" is used as the Automatic Private IP Address (APIPA) for all endpoints. To use kubernetes node IP address then set this flag to False. Default: true |
KUBERNETES_LIMITS_EPHEMERAL_STORAGE | Integer | Integer value in megabytes. Set to control the ephemeral storage limits of the Taurus pod (optional). Default: None. Example: name: KUBERNETES_LIMITS_EPHEMERAL_STORAGE |
KUBERNETES_REQUESTS_EPHEMERAL_STORAGE | Integer | Integer value in megabytes. Set to control the ephemeral storage requests of the Taurus pod (optional). Default:`100`(Mi). Example: name: KUBERNETES_REQUESTS_EPHEMERAL_STORAGE |
0 Comments