Skip to content

Commit 0a9862e

Browse files
authored
Document additional PaaSTA-provided env vars (+ sort list) (#4034)
I was recently chatting with jrchu about default env vars and I realized that there's a couple that we didn't document.
1 parent 8863176 commit 0a9862e

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

docs/source/yelpsoa_configs.rst

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,22 +60,25 @@ specify the following options:
6060
* ``env``: A dictionary of environment variables that will be made available
6161
to the container. PaaSTA additionally will inject the following variables automatically (keep in mind all environment variables are strings in a shell):
6262

63-
* ``PAASTA_SERVICE``: The service name
64-
* ``PAASTA_INSTANCE``: The instance name
63+
* ``MESH_REGISTRATIONS`` (optional): space-separated list of registrations for a given Pod if the PaaSTA instance is mesh-routable - absent otherwise.
6564
* ``PAASTA_CLUSTER``: The cluster name
66-
* ``PAASTA_HOST``: The hostname of the actual server the container is runnig on
67-
* ``PAASTA_PORT``: The configured port the service should listen on
65+
* ``PAASTA_DEPLOY_GROUP``: The `deploy group <deploy_group.html>`_ specified
6866
* ``PAASTA_DOCKER_IMAGE``: The docker image name
6967
* ``PAASTA_GIT_SHA``: The short git sha of the code the container has
70-
* ``PAASTA_DEPLOY_GROUP``: The `deploy group <deploy_group.html>`_ specified
68+
* ``PAASTA_HOST``: The hostname of the actual server the container is running on
69+
* ``PAASTA_IMAGE_VERSION`` (optional) : The version of the docker image - only present for instances using automated redeploys or manually deployed using --image-version
70+
* ``PAASTA_INSTANCE_TYPE``: The instance type of the service (e.g: tron, kubernetes, eks, etc)
71+
* ``PAASTA_INSTANCE``: The instance name
72+
* ``PAASTA_LAUNCHED_BY`` (optional): May not be present. If present, will have the username of the user who launched the PaaSTA container
7173
* ``PAASTA_MONITORING_TEAM``: The team that is configured to get alerts.
72-
* ``PAASTA_LAUNCHED_BY``: May not be present. If present, will have the username of the user who launched the PaaSTA container
74+
* ``PAASTA_POD_IP``: The IP of the Pod running the PaaSTA container - may not always be a routable IP
75+
* ``PAASTA_PORT``: The configured port the service should listen on
7376
* ``PAASTA_RESOURCE_CPUS``: Number of cpus allocated to a container
74-
* ``PAASTA_RESOURCE_MEM``: Amount of ram in MB allocated to a container
7577
* ``PAASTA_RESOURCE_DISK``: Amount of disk space in MB allocated to a container
7678
* ``PAASTA_RESOURCE_GPUS``: Number of GPUS (if requested) allocated to a container
77-
* ``PAASTA_IMAGE_VERSION``: The version of the docker image
78-
* ``PAASTA_INSTANCE_TYPE``: The instance type of the service (e.g: tron, kubernetes, eks, etc)
79+
* ``PAASTA_RESOURCE_MEM``: Amount of ram in MB allocated to a container
80+
* ``PAASTA_SERVICE``: The service name
81+
* ``POD_NAME``: The Pod name as generated by Kubernetes.
7982

8083

8184
* ``extra_volumes``: An array of dictionaries specifying extra bind-mounts

0 commit comments

Comments
 (0)