code-kern-ai/refinery-submodule-s3

S3 related AWS and Minio logic.

refinery-submodule-s3

S3 related AWS and Minio logic.

Caution! This is only meant as a submodule not as a library

If you like what we're working on, please leave a ⭐ for refinery!

Usage

Implement by using: git submodule add https://github.com/code-kern-ai/refinery-submodule-s3.git submodules/s3

This means the requirements of the project need to include:

boto3
minio

Also some os variables are required to access minio:

• S3_ENDPOINT --> adress to access (e.g. http://$HOST_IP:7053 -- usually for aws)
• S3_ENDPOINT_LOCAL --> local adress to access (e.g. object-storage:9000 -- usually for minio)
• S3_ACCESS_KEY --> S3 User name
• S3_SECRET_KEY --> S3 Password

Also some os variables are required to access aws:

They are stored in a different set of os variables to be able to migration from minio to aws

• S3_TARGET --> set to AWS if AWS should be used other value or no value at all defaults to minio
• S3_AWS_ENDPOINT --> adress to access
• S3_AWS_REGION --> region e.g. eu-west-1
• S3_AWS_ACCESS_KEY --> AWS User name
• S3_AWS_SECRET_KEY --> AWS Password
• STS_ENDPOINT --> Security Token Service (STS)

Common submodule logic applies

git submodules

Submodules can be a bit irritating - key insights:

1. Paths need to be relative inside the module (e.g. from . import constants )
2. They are their own repositories so they need to be handled as such (committing etc. for changes inside their own branch)
3. Cloning needs to be done recursively to get the files
4. Adding submodules without changing the folder will result in errors because the import of paths with - doesn't work
5. Drone builds appear to work fine
6. Drone builds need to include the "collection" of the submodules data so another step needs to be introduces to the .yml file:

- name: submodules
  image: alpine/git
  commands:
    - git submodule init
    - 'git config --global url."https://github.com/".insteadOf git@github.com:'
    - "git submodule update --recursive"

"remember" to pull / push for the submodules!!

Example Commands for submodules

Clone reposity with submodules

git clone <git@github ...> --recursive Example git clone git@github.com:code-kern-ai/refinery-gateway.git --recursive

(if you missed the --recursive part or switch to a branch with a new submodule): git submodule update --init

Add submodule

(no path specified -> the repository will be a new folder on the top level - DON'T DO THIS)

git submodule add <git@github ...> snipmate-snippets/snippets/

(path specified -> this one we usually want since repository names might have some issues)

git submodule add <git@github ...> submodules/<repo_name_with_underscores>

Working with submodules after initial setup

• Either navigate to the submodule folder and use it like every other git:
  • cd submodules/<repo_name_with_underscores>
  • git pull
  • git add .
  • git commit ....
  • git push
• Or use submodule command like:
  • git submodule foreach git pull
  • git submodule foreach git add .
  • git submodule foreach git commit -m '<message>'
  • git submodule foreach git push