Docker image for ASK and AWS CLI

The purpose of this container is to be able to use the Amazon ASK CLI and Amazon AWS CLI in a Docker container in DevOps pipelines.

NOTE: This is a fork from martindsouza image with these changes:

1. Image base is the latest LTS version instead of the current version of Node.js.
2. Added ASK_CLI_VERSION build argument in order to be able to work with different ASK CLI versions.
3. Added git and zip packages that ASK CLI will use in its commands.
4. Added Bespoken.
5. Added jq and expect cli commands.
6. Remove volumes. I think it is not necessary in a simple docker image that I will use in my DevOps pipelines. In addition, you can use '-v' argument in docker run command whenever you want.

ASK Config

You have to take into account that you have to have an Alexa Developer account to be able to work with this container.

ask configure

Running ask configure in v2 and ask init in v1 in the container will ask you a set of questions to create the Alexa credentials. Follow all the steps explained in the official documentation.

In either case ensure that you pass in -v $(pwd)/ask-config:/home/node/.ask \ (where $(pwd)/ask-config is a location on your host machine) as an option when running the container to preserve the ASK configuration.

Setting credentials using environment variables

You can store Alexa credentials in environment variables instead of the Alexa credentials file. If the Alexa environment variables exist, ASK CLI uses them instead of the values in the Alexa credentials file. ASK CLI searches for the following Alexa environment variables:

You can use the ASK CLI environment variables in conjunction with or in addition to the ASK CLI configuration file. The following list describes the ASK CLI environment variables.

• ASK_DEFAULT_PROFILE: Use this environment variable in conjunction with the ASK CLI configuration file. When you set the value of this environment variable to one of the profiles in the configuration file, ASK CLI uses the credentials in that profile.
• ASK_ACCESS_TOKEN: Use this environment variable to store an Amazon developer access token. When this environment variable exists, ASK CLI uses it instead of the credentials in the configuration file.
• ASK_REFRESH_TOKEN: Use this environment variable to store an Amazon developer refresh token. When this environment variable exists, ASK CLI uses it instead of the credentials in the configuration file. When this environment variable and ASK_ACCESS_TOKEN both exist, ASK CLI uses this one.
• ASK_VENDOR_ID: Use this environment variable to store an Amazon developer vendor ID. When this environment variable exists, ASK CLI uses it instead of the one it the configuration file.
• ASK_CLI_PROXY: Use this environment variable to specify an HTTP proxy for requests made with the ASK CLI.

If you want to know how to get the ASK_REFRESH_TOKEN and ASK_ACCESS_TOKEN, see this page in the Alexa documentation.

If you want to know how to get the ASK_VENDOR_ID, you only have to enter to this page.

If you are using Alexa environment variable you have to add a new profile called __ENVIRONMENT_ASK_PROFILE__ in your .ask/config file

AWS Config

If you plan to use AWS Lambda you'll need to configure the AWS CLI. To simplify. You can configure it multiple ways.

In either case ensure that you pass in -v $(pwd)/aws-config:/home/node/.aws \ (where $(pwd)/aws-config is a location on your host machine) as an option when running the container to preserve the AWS configuration.

aws configure

For general use, the aws configure command is the fastest way to set up your AWS CLI installation. When you enter this command, the AWS CLI prompts you for four pieces of information (access key, secret access key, AWS Region, and output format)

Setting credentials using environment variables

You can store AWS credentials in environment variables instead of the AWS credentials file. If the AWS environment variables exist, ASK CLI uses them instead of the values in the AWS credentials file. ASK CLI searches for the following AWS environment variables:

• AWS_ACCESS_KEY_ID
• AWS_SECRET_ACCESS_KEY

For more information about the AWS environment variables, see Environment Variables in the AWS documentation.

Usage

Get the latest version of the container:

  # Get image
  docker pull xavidop/alexa-ask-aws-cli:2.0

They're two ways to use the ask cli for this container described below.

Run ASK CLI Commands

This is an example that shows up how to execute an ask command. After this command is executed, the container will stop.

docker run -it --rm \
  -v $(pwd)/ask-config:/home/node/.ask \
  -v $(pwd)/ask-config:/home/node/.aws \
  -v $(pwd)/ask-config:/home/node/.bst \
  -v $(pwd)/hello-world:/home/node/app \
  xavidop/alexa-ask-aws-cli:2.0 \
  ask init -l

Run ASK CLI Commands interactively

In this example, the container will start directly with the bash console and then you can execute there all the ASK CLI commands you want.

docker run -it --rm \
  -v $(pwd)/ask-config:/home/node/.ask \
  -v $(pwd)/ask-config:/home/node/.aws \
  -v $(pwd)/ask-config:/home/node/.bst \
  -v $(pwd)/app/HelloWorld:/home/node/app \
  xavidop/alexa-ask-aws-cli:2.0 \
  bash

Build and push the image

For ASK CLI v1:

docker build --build-arg ASK_CLI_VERSION=1.7.23 -t xavidop/alexa-ask-aws-cli:1.0 .

# Pushing to Docker Hub
# Note: not required since I have a build hook linked to the repo
docker login
docker push xavidop/alexa-ask-aws-cli:1.0

For ASK CLI v2:

docker build --build-arg ASK_CLI_VERSION=2.15.0 -t xavidop/alexa-ask-aws-cli:2.0 .

# Pushing to Docker Hub
# Note: not required since I have a build hook linked to the repo
docker login
docker push xavidop/alexa-ask-aws-cli:2.0

Versions

Currently there are the versions available:

• 1.0: this image is running the latest version of ASK CLI v1 (1.7.23)
• 2.0: this image is running the latest version of ASK CLI v2 (2.21.0)
  • 2.12.0: this image is running the 2.12.0 version of ASK CLI
  • 2.13.0: this image is running the 2.13.0 version of ASK CLI
  • 2.15.0: this image is running the 2.15.0 version of ASK CLI
  • 2.21.0: this image is running the 2.21.0 version of ASK CLI
• latest: this image is running the latest version of ASK CLI (2.21.0)

These versions are available in my DockerHub profile

GitHub Action

With the above Docker image a GitHub Action has been created in order to run ASK CLI Commands:

This GitHub Action is available in the gitHub Actions Marketplace](https://github.com/marketplace/actions/alexa-ask-aws-cli-action)

You can use the following example as a way to start:

  - name: Alexa ASK AWS CLI Action
    uses: xavidop/alexa-ask-aws-cli-docker@v1.0.6
    id: command
    with:
      command: 'ask --version'
    env: # Or as an environment variable
      ASK_ACCESS_TOKEN: ${{ secrets.ASK_ACCESS_TOKEN }}
      ASK_REFRESH_TOKEN: ${{ secrets.ASK_REFRESH_TOKEN }}
      ASK_VENDOR_ID: ${{ secrets.ASK_VENDOR_ID }}
      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
      SKILL_ID: ${{ secrets.SKILL_ID }}
  # Use the output from the `hello` step
  - name: Get the output
    run: echo "The result was ${{ steps.command.outputs.result }}"

Or for example using it in a workflow:

  on: [push]

  jobs:
    test-action:
      runs-on: ubuntu-latest
      name: Test Action
      steps:
        # To use this repository's private action,
        # you must check out the repository
        - name: Checkout
          uses: actions/checkout@v2
        - name: Test action step
          uses: xavidop/alexa-ask-aws-cli-docker@v1.0.6
          id: ask
          with:
            command: 'ask --version'
          env: # Or as an environment variable
            ASK_ACCESS_TOKEN: ${{ secrets.ASK_ACCESS_TOKEN }}
            ASK_REFRESH_TOKEN: ${{ secrets.ASK_REFRESH_TOKEN }}
            ASK_VENDOR_ID: ${{ secrets.ASK_VENDOR_ID }}
            AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
            AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
            SKILL_ID: ${{ secrets.SKILL_ID }}
        # Use the output from the `hello` step
        - name: Get the output
          run: echo "The result was ${{ steps.ask.outputs.result }}"

It is important to add that the GiHub Action are using the latest version of the ASK CLI.

Links:

• ASK CLI Quickstart
• ASK CLI Full Doc