Aptible Metadata Variables
Aptible injects the following metadata keys as environment variables:
-
APTIBLE_PROCESS_TYPE
-
Represents the name of the Service this container belongs to. For example, if the Procfile defines services like
web
andworker
. -
Then, the containers for the web Service will run with
APTIBLE_PROCESS_TYPE=web
, and the containers for the worker Service will run withAPTIBLE_PROCESS_TYPE=worker
. -
If there is no Procfile and users choose to use an Implicit Service instead, the variable is set to
APTIBLE_PROCESS_TYPE=cmd
.
-
-
APTIBLE_PROCESS_INDEX
-
APTIBLE_PROCESS_CONTAINER_COUNT
- This variable is a companion to
APTIBLE_PROCESS_INDEX
, and represents the total count of containers on the service. Note that this will only be present in app service containers (not in pre_release, ephemeral/ssh, or database containers).
- This variable is a companion to
-
APTIBLE_CONTAINER_CPU_SHARE
- Provides the vCPU share for the container, matching the ratios in our documentation for container profiles. Format will be provided in the following format: 0.125, 0.5, 1.0, etc.
-
APTIBLE_CONTAINER_PROFILE
-
APTIBLE_CONTAINER_SIZE
- This variable represents the memory limit in MB of the Container. See Memory Limits for more information.
-
APTIBLE_LAYER
-
APTIBLE_GIT_REF
-
APTIBLE_ORGANIZATION_HREF
- Aptible API URL representing the Organization this container belongs to.
-
APTIBLE_APP_HREF
- Aptible API URL representing the App this container belongs to, if any.
-
APTIBLE_DATABASE_HREF
- Aptible API URL representing the Database this container belongs to, if any.
-
APTIBLE_SERVICE_HREF
- Aptible API URL representing the Service this container belongs to, if any.
-
APTIBLE_RELEASE_HREF
- Aptible API URL representing the Release this container belongs to, if any.
-
APTIBLE_EPHEMERAL_SESSION_HREF
- Aptible API URL representing the current Ephemeral SSH Sessions this container belongs to, if any.
-
APTIBLE_USER_DOCUMENT
- Aptible injects an expired JWT object with user information.
- The information available is id, email, name, etc.
decode_base64_url() { local len=$((${#1} % 4)) local result="$1" if [ $len -eq 2 ]; then result="$1"'==' elif [ $len -eq 3 ]; then result="$1"'=' fi echo "$result" | tr '_-' '/+' | openssl enc -d -base64 } decode_jwt(){ decode_base64_url $(echo -n $2 | cut -d "." -f $1) | sed 's/{/\n&\n/g;s/}/\n&\n/g;s/,/\n&\n/g' | sed 's/^ */ /' } # Decode JWT header alias jwth="decode_jwt 1" # Decode JWT Payload alias jwtp="decode_jwt 2"
You can use the above script to decode the expired JWT object using
jwtp $APTIBLE_USER_DOCUMENT
- Aptible injects an expired JWT object with user information.
-
APTIBLE_RESOURCE_HREF
- Aptible uses this variable internally. Do not depend on this value.
-
APTIBLE_ALLOCATION
- Aptible uses this variable internally. Do not depend on this value.
Was this page helpful?