s3provider

README

Summary

This package provides a ConfigMapProvider implementation for Amazon S3 (s3provider) that allows the Collector the ability to load configuration by fetching and reading config objects stored in Amazon S3.

How it works

• It will be called by ConfigMapResolver to load configuration for the Collector.
• By giving a config URI starting with prefix s3://, this s3provider will be used to download config objects from the given S3 URIs, and then use the downloaded configuration during Collector initialization.

Expected URI format:

• s3://[BUCKET].s3.[REGION].amazonaws.com/[KEY]

Prerequistes:

• Need to setup access keys from IAM console (aws_access_key_id and aws_secret_access_key) with permission to access Amazon S3
• For details, can take a look at https://aws.github.io/aws-sdk-go-v2/docs/configuring-sdk/

Documentation

Index

• func New() confmap.Provider
• func NewFactory() confmap.ProviderFactory

Functions

func New

func New() confmap.Provider

New returns a new confmap.Provider that reads the configuration from a file.

This Provider supports "s3" scheme, and can be called with a "uri" that follows:

s3-uri : s3://[BUCKET].s3.[REGION].amazonaws.com/[KEY]

One example for s3-uri be like: s3://doc-example-bucket.s3.us-west-2.amazonaws.com/photos/puppy.jpg References: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html

Examples: `s3://DOC-EXAMPLE-BUCKET.s3.us-west-2.amazonaws.com/photos/puppy.jpg` - (unix, windows)

Deprecated: [v0.100.0] Use NewFactory() instead.

func NewFactory

func NewFactory() confmap.ProviderFactory

NewFactory returns a new confmap.ProviderFactory that creates a confmap.Provider which reads configuration from a file obtained from an s3 bucket.

This Provider supports "s3" scheme, and can be called with a "uri" that follows:

s3-uri : s3://[BUCKET].s3.[REGION].amazonaws.com/[KEY]

One example for s3-uri be like: s3://doc-example-bucket.s3.us-west-2.amazonaws.com/photos/puppy.jpg References: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html

Examples: `s3://DOC-EXAMPLE-BUCKET.s3.us-west-2.amazonaws.com/photos/puppy.jpg` - (unix, windows)