sitespeedio/sitespeed.io

S3 access via IAM instance profile

Open

#3,331 opened on Apr 1, 2021

View on GitHub
 (13 comments) (1 reaction) (0 assignees)JavaScript (573 forks)batch import
documentationgood first issues3

Repository metrics

Stars
 (4,434 stars)
PR merge metrics
 (Avg merge 6h 3m) (35 merged PRs in 30d)

Description

For the moment there is no ability to use IAM instance profile for access to s3 bucket as it is not described in documentation Could you add this ability, please? It will increase security and secret key and access key will be not be used in this integration, only IAM Instance profile attached to EC2 instance where sitespeed.io is running.

Contributor guide

Research direction
Start by examining the existing S3 output plugin in the 'plugins' directory. Review how AWS credentials are currently configured and used. Look for any configuration schema that specifies accessKeyId and secretAccessKey. To support IAM instance profiles, you may need to make those optional and rely on the AWS SDK's default credential provider chain. Check the AWS SDK documentation for Node.js on how to use credentials from the environment or EC2 instance metadata. Additionally, review the tests for the S3 plugin to understand how they mock credentials, and update accordingly. Finally, update the documentation to describe the new feature.
Tech stack
javascriptnodejsaws
Domain
cloudbackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptNode.jsAWS S3
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40