Skip to content

Latest commit

 

History

History
94 lines (62 loc) · 3.91 KB

README.md

File metadata and controls

94 lines (62 loc) · 3.91 KB
Raw

Motion S3 Connector

The Motion S3 Connector showcases a bridge between the Amazon S3 client libraries and Motion. By leveraging this connector, users can seamlessly store and fetch data through Motion, an API layer crafted to facilitate Filecoin storage layer integration. This connector utilizes a Zenko CloudServer - an Amazon S3-compatible storage server - and integrates a tailored Motion client. This client is responsible for converting S3 requests to Motion requests and vice versa.

Demos

This repository contains two demo setups:

  1. local: local storage without Filecoin interaction.
  2. local-devnet: full end-to-end S3 <-> Filecoin SP interaction using a local Boost Devnet.

To run the demos, see README within each corresponding directory.

Setting Up Zenko CloudServer with Motion Storage Backend

Prerequisites

  • Docker for deploying via docker-compose.
  • AWS CLI to communicate with the CloudServer.
  • AWS test credentials provided in .env are required for CloudServer authentication. For alternative methods, refer to AWS CLI Configuration.
  • one or more FileCoin Storage provider address specified as comma separated list under MOTION_STORAGE_PROVIDERS environment variable.
  • Filecoin wallet key with sufficient FileCoin funds specified as hex encoded string under MOTION_WALLET_KEY environment variable.

Launching Motion and CloudServer

Initiate both the Motion API server and the CloudServer with:

docker compose up

This starts the Motion HTTP API at http://localhost:40080 and the CloudServer at https://localhost:8000.

Configuring AWS CLI with Test Credentials

To set up the AWS CLI with the designated test credentials, execute:

export AWS_ACCESS_KEY_ID=accessKey1
export AWS_SECRET_ACCESS_KEY=verySecretKey1
export AWS_DEFAULT_REGION=location-motion-v1

These credentials correspond to a test user on our local CloudServer. The predefined region location-motion-v1 directs CloudServer to employ the Motion storage backend.

See Overriding Default AWS Credentials for instructions on how to override the default credentials accepted by the server side.

Bucket Operations

  1. Creating a Bucket
    After starting the servers, generate a bucket using:

    aws --endpoint-url http://localhost:8000 s3 mb s3://mybucket

  2. Uploading Objects
    Transfer a file to the new bucket:

    aws --endpoint-url http://localhost:8000 s3 cp README.md s3://mybucket

    Alternatively, utilize:

    aws --endpoint-url http://localhost:8000 s3api put-object --bucket mybucket --key README.md --body README.md

  3. Listing Objects
    To view the contents of your bucket:

    aws --endpoint-url http://localhost:8000 s3 ls s3://mybucket

  4. Downloading Objects
    Retrieve an uploaded object with:

    aws --endpoint-url http://localhost:8000 s3 cp s3://mybucket/README.md README.md

    Or, use:

    aws --endpoint-url http://localhost:8000 s3api get-object --bucket mybucket --key README.md README.md

Overriding Default AWS Credentials

In scenarios where you wish to use different credentials than the default ones, the Motion S3 Connector allows users to override the default AWS credentials. This can be particularly useful for more advanced use-cases, testing, or specific security measures.

How to Override Credentials

To update the AWS credentials, edit the authdata.json file with your preferred access credentials. After making the changes, restart Docker Compose to apply the updated credentials on the server.