Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add S3 File Downloader to catalog #38

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ocihangir
Copy link

Use this PR to list your component in the aws-greengrass-software-catalog repository. Update README file with your component details and provide other information as requested below.

PR checklist

  • Review the guidelines for contributing to this repository.
  • Check your code additions and commit messages don't fail the automated CI validation.
  • Fill in the requested information in all the following sections.

Description

This component downloads files from an Amazon S3 bucket by using Amazon S3 Transfer Manager. It can download files in parallel and pause/resume downloads. It is especially designed to work in unreliable network conditions.

Link to the component repository

https://github.com/awslabs/aws-greengrass-labs-s3-file-downloader

Motivation and context

This component was created based on a real world use case where large files need to be downloaded in unreliable network conditions. It receives download tasks from an MQTT topic it subscribes to. When a download task starts, it sends download status feedback to AWS IoT Core MQTT broker.

QA Detail - Instructions to verify component functionality

Please see building and testing instructions in the README file.
Unit test scripts run during the build.

Acceptance criteria

Make sure your component home contains:

  • Requirements - AWS and non-AWS resources required on device and in customer's AWS account.
  • Instructions for installation of component, preferably "one-click or one-line".
  • Instructions around what settings can be configured along with examples of workable defaults.
  • Threat Modeling - List any potential security vulnerabilities for this component and how you've attempted to mitigate risks.
  • Troubleshooting guide to help resolve customer issues.
  • Instructions about how customers can report issues related to component and get them addressed.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants