在 localstack 上自动创建 S3 Buckets

Question

Using localstack in my docker-compose mainly to mimic S3.

I know I can create buckets, that's not the issue. What I would like to do is automatically create the buckets when I run a docker-compose up.

Is there something built in already for localstack?

Answer 1

A change that came in with this commit since version 0.10.0 .

When a container is started for the first time, it will execute files with extensions .sh that are found in /docker-entrypoint-initaws.d . Files will be executed in alphabetical order. You can easily create aws resources on localstack using awslocal (or aws) cli tool in the initialization scripts.

version: '3.7'
services:
  localstack:
    image: localstack/localstack
    environment:
      - SERVICES=s3
    ports:
      - "4566:4566"
      # - "4572:4572" Old S3 port
    volumes:
      - ./aws:/docker-entrypoint-initaws.d

With a script in directory ./aws/buckets.sh :

#!/usr/bin/env bash
set -x
awslocal s3 mb s3://bucket
set +x

Note: the set [-/+] x is purely there to turn on and off outputting of the commands being executed.

Will produce this output:

...
localstack_1  | Starting mock S3 (http port 4572)...
localstack_1  | Waiting for all LocalStack services to be ready
localstack_1  | Ready.
localstack_1  | /usr/local/bin/docker-entrypoint.sh: running /docker-entrypoint-initaws.d/buckets.sh
localstack_1  | ++ awslocal s3 mb s3://bucket
localstack_1  | make_bucket: bucket
localstack_1  | ++ set +x
localstack_1  |

Answer 2

I was been able to achieve this with Localstack with kind of "workaround":

1. Start Localstack

2. Create expected buckets, eg:

    aws --endpoint-url=http://localhost:4572 s3 mb s3://test1

3. Above line will update the s3_api_calls.json file in the Localstack directory (by default on Linux it's /tmp/localstack/data
4. Backup the file
5. Put the copied file in the Localstack directory ( /tmp/localstack/data by default) before starting the stack again
6. You should be able to see something like 2019-03-21T08:38:28:INFO:localstack.utils.persistence: Restored 2 API calls from persistent file: /tmp/localstack/data/s3_api_calls.json the in startup log after you start Localstack again and the bucket should be available: aws --endpoint-url=http://localhost:4572 s3 ls s3://test1

Answer 3

Important notice for users of LocalStack v1.1.3 and above

Since the 1st of December 2022, LocalStack has announced the deprecation of legacy init scripts ( /docker-entrypoint-initaws.d ) with the release of v1.3.0 . The replacement - plugggable initialisation hooks - was introduced in v1.1.0.

They will be fully removed in v2.0.0, posing a risk for anyone that would be using /docker-entrypoint-initaws.d with the latest version of LocalStack.

This would be a breaking change.

For future-proofing, the accepted answer is still valid but I would recommend replacing /docker-entrypoint-initaws.d with /etc/localstack/init/ready.d .

This would mimic the previous intended behaviour, as it would be hooking into the READY stage where LocalStack can actually create your S3 buckets, while making sure you can still continue to update LocalStack.

This would be the best current Dockerfile :

version: '3.8'
services:
  localstack:
    image: localstack/localstack:latest
    environment:
      - SERVICES=s3
    ports:
      - "4566:4566"
    volumes:
      - ./aws:/etc/localstack/init/ready.d

Answer 4

DATA_DIR：用于保存持久数据的本地目录（目前仅支持这些服务：Kinesis、DynamoDB、Elasticsearch、S3）