chore: replace HOSTNAME with AWS_ROLE_SESSION_NAME

Author: shawnhankim

common/docker-entrypoint.d/00-check-for-required-env.sh

@@ -52,10 +52,13 @@ elif curl --output /dev/null --silent --head --fail --connect-timeout 2 --max-ti
 #    Example: We are running inside an EKS cluster with IAM roles for service accounts enabled.
 elif [[ -v AWS_WEB_IDENTITY_TOKEN_FILE ]]; then
   echo "Running inside EKS with IAM roles for service accounts"
-  if [[ ! -v HOSTNAME ]]; then
-    # This environment value is used for Role Session Name. The default value is
-    # set as a nginx-s3-gateway unless the value is defined.
-    HOSTNAME="nginx-s3-gateway"
+  if [[ -v HOSTNAME ]]; then
+    echo "Depreciated the HOSTNAME! Use the environment variable of AWS_ROLE_SESSION_NAME instead"  
+    failed=1
+  fi
+  if [[ ! -v AWS_ROLE_SESSION_NAME ]]; then
+    # The default value is set as a nginx-s3-gateway unless the value is defined.
+    AWS_ROLE_SESSION_NAME="nginx-s3-gateway"
   fi
 
 elif [[ -v S3_ACCESS_KEY_ID ]]; then

common/etc/nginx/include/awscredentials.js

@@ -362,14 +362,14 @@ async function _fetchEC2RoleCredentials() {
 
 /**
  * Get the credentials by assuming calling AssumeRoleWithWebIdentity with the environment variable
- * values ROLE_ARN, AWS_WEB_IDENTITY_TOKEN_FILE and HOSTNAME
+ * values ROLE_ARN, AWS_WEB_IDENTITY_TOKEN_FILE and AWS_ROLE_SESSION_NAME
  *
  * @returns {Promise<{accessKeyId: (string), secretAccessKey: (string), sessionToken: (string), expiration: (string)}>}
  * @private
  */
 async function _fetchWebIdentityCredentials(r) {
     const arn = process.env['AWS_ROLE_ARN'];
-    const name = process.env['HOSTNAME'];
+    const name = process.env['AWS_ROLE_SESSION_NAME'];
 
     let sts_endpoint = process.env['STS_ENDPOINT'];
     if (!sts_endpoint) {

docs/getting_started.md

@@ -51,7 +51,7 @@ file.
 
 There are few optional environment variables that can be used.
 
-* `HOSTNAME` - (optional) The value will be used for Role Session Name. The default value is nginx-s3-gateway.
+* `AWS_ROLE_SESSION_NAME` - (optional) The value will be used for Role Session Name. The default value is nginx-s3-gateway.
 * `STS_ENDPOINT` - (optional) Overrides the STS endpoint to be used in applicable setups. This is not required when running on EKS. See the EKS portion of the guide below for more details.
 * `AWS_STS_REGIONAL_ENDPOINTS` - (optional) Allows for a regional STS endpoint to be
   selected. When the regional model is selected then the STS endpoint generated will