Added 'docker login' to fix pull rate limit issue (#197)

Added 'docker login' to fix pull rate limit issue

Co-authored-by: Stefan Botez <[email protected]>
Co-authored-by: Carl Zogheib <[email protected]>

Author: 3 people

aws-lambda-java-runtime-interface-client/README.md

@@ -120,6 +120,18 @@ This command invokes the function running in the container image and returns a r
 
 *Alternately, you can also include RIE as a part of your base image. See the AWS documentation on how to [Build RIE into your base image](https://docs.aws.amazon.com/lambda/latest/dg/images-test.html#images-test-alternative).*
 
+### Troubleshooting
+
+While running integration tests, you might encounter the Docker Hub rate limit error with the following body:
+```
+You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limits
+```
+To fix the above issue, consider authenticating to a Docker Hub account by setting the Docker Hub credentials as below CodeBuild environment variables.
+```shell script
+DOCKERHUB_USERNAME=<dockerhub username>
+DOCKERHUB_PASSWORD=<dockerhub password>
+```
+Recommended way is to set the Docker Hub credentials in CodeBuild job by retrieving them from AWS Secrets Manager.
 
 ## Security
 

aws-lambda-java-runtime-interface-client/test/integration/codebuild/buildspec.os.alpine.yml

@@ -22,6 +22,16 @@ batch:
           RUNTIME_VERSION:
             - "corretto11"
 phases:
+  install:
+    commands:
+      - >
+        if [[ -z "${DOCKERHUB_USERNAME}" && -z "${DOCKERHUB_PASSWORD}" ]];
+        then
+            echo "DockerHub credentials not set as CodeBuild environment variables. Continuing without docker login."
+        else
+            echo "Performing DockerHub login . . ."
+            docker login -u $DOCKERHUB_USERNAME -p $DOCKERHUB_PASSWORD
+        fi
   pre_build:
     commands:
       - (cd aws-lambda-java-serialization && mvn install)

aws-lambda-java-runtime-interface-client/test/integration/codebuild/buildspec.os.amazoncorretto.yml

@@ -20,6 +20,16 @@ batch:
             - "8"
             - "11"
 phases:
+  install:
+    commands:
+      - >
+        if [[ -z "${DOCKERHUB_USERNAME}" && -z "${DOCKERHUB_PASSWORD}" ]];
+        then
+            echo "DockerHub credentials not set as CodeBuild environment variables. Continuing without docker login."
+        else
+            echo "Performing DockerHub login . . ."
+            docker login -u $DOCKERHUB_USERNAME -p $DOCKERHUB_PASSWORD
+        fi
   pre_build:
     commands:
       - (cd aws-lambda-java-serialization && mvn install)

aws-lambda-java-runtime-interface-client/test/integration/codebuild/buildspec.os.amazonlinux.yml

@@ -20,6 +20,16 @@ batch:
           RUNTIME_VERSION:
             - "openjdk8"
 phases:
+  install:
+    commands:
+      - >
+        if [[ -z "${DOCKERHUB_USERNAME}" && -z "${DOCKERHUB_PASSWORD}" ]];
+        then
+            echo "DockerHub credentials not set as CodeBuild environment variables. Continuing without docker login."
+        else
+            echo "Performing DockerHub login . . ."
+            docker login -u $DOCKERHUB_USERNAME -p $DOCKERHUB_PASSWORD
+        fi
   pre_build:
     commands:
       - (cd aws-lambda-java-serialization && mvn install)

aws-lambda-java-runtime-interface-client/test/integration/codebuild/buildspec.os.centos.yml

@@ -20,6 +20,16 @@ batch:
           RUNTIME_VERSION:
             - "corretto11"
 phases:
+  install:
+    commands:
+      - >
+        if [[ -z "${DOCKERHUB_USERNAME}" && -z "${DOCKERHUB_PASSWORD}" ]];
+        then
+            echo "DockerHub credentials not set as CodeBuild environment variables. Continuing without docker login."
+        else
+            echo "Performing DockerHub login . . ."
+            docker login -u $DOCKERHUB_USERNAME -p $DOCKERHUB_PASSWORD
+        fi
   pre_build:
     commands:
       - (cd aws-lambda-java-serialization && mvn install)

aws-lambda-java-runtime-interface-client/test/integration/codebuild/buildspec.os.debian.yml

@@ -19,6 +19,16 @@ batch:
           RUNTIME_VERSION:
             - "corretto11"
 phases:
+  install:
+    commands:
+      - >
+        if [[ -z "${DOCKERHUB_USERNAME}" && -z "${DOCKERHUB_PASSWORD}" ]];
+        then
+            echo "DockerHub credentials not set as CodeBuild environment variables. Continuing without docker login."
+        else
+            echo "Performing DockerHub login . . ."
+            docker login -u $DOCKERHUB_USERNAME -p $DOCKERHUB_PASSWORD
+        fi
   pre_build:
     commands:
       - (cd aws-lambda-java-serialization && mvn install)

aws-lambda-java-runtime-interface-client/test/integration/codebuild/buildspec.os.ubuntu.yml

@@ -21,6 +21,16 @@ batch:
           RUNTIME_VERSION:
             - "corretto11"
 phases:
+  install:
+    commands:
+      - >
+        if [[ -z "${DOCKERHUB_USERNAME}" && -z "${DOCKERHUB_PASSWORD}" ]];
+        then
+            echo "DockerHub credentials not set as CodeBuild environment variables. Continuing without docker login."
+        else
+            echo "Performing DockerHub login . . ."
+            docker login -u $DOCKERHUB_USERNAME -p $DOCKERHUB_PASSWORD
+        fi
   pre_build:
     commands:
       - (cd aws-lambda-java-serialization && mvn install)