Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seporaitis/yum-s3-iam
Yum package manager plugin for private S3 repositories. Uses Amazon IAM & EC2 Roles.
https://github.com/seporaitis/yum-s3-iam
Last synced: about 2 months ago
JSON representation
Yum package manager plugin for private S3 repositories. Uses Amazon IAM & EC2 Roles.
- Host: GitHub
- URL: https://github.com/seporaitis/yum-s3-iam
- Owner: seporaitis
- License: apache-2.0
- Created: 2012-08-08T09:20:12.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2024-03-01T19:25:50.000Z (7 months ago)
- Last Synced: 2024-07-27T17:58:15.077Z (about 2 months ago)
- Language: Python
- Size: 81.1 KB
- Stars: 162
- Watchers: 11
- Forks: 99
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# yum-s3-iam
This is a [yum](http://yum.baseurl.org/) plugin that allows for
private AWS S3 buckets to be used as package repositories. The plugin
utilizes AWS [Identity and Access Management](http://aws.amazon.com/iam/)
(IAM) roles for authorization, removing any requirement for an access or
secret key pair to be defined anywhere in your repository configuration.
## What is an IAM Role?
IAM Roles are used to control access to AWS services and resources.
For further details, take a look at the AWS-provided documentation:
[docs](http://aws.amazon.com/documentation/iam/).
Why it's useful: when you assign an IAM role to an EC2 instance,
credentials to access the instance are automatically provided by AWS.
This removes the need to store them, change and/or rotate
them, while also providing fine-grain controls over what actions can
be performed when using the credentials.
This particular plug-in makes use of the IAM credentials when accessing
S3 buckets backing a yum repository.
## How to set it up?
There is a great blog post by Jeremy Carroll which explains in depth how to
use this plugin:
[S3 Yum Repos With IAM Authorization](https://web.archive.org/web/20160708032958/https://carrollops.com/blog/2012/09/11/s3-yum-repos-with-iam-authorization/) (via Wayback Machine).
## Notes on S3 buckets and URLs
There are 2 types of S3 URLs:
- virtual-hosted–style URL:
- `https://.s3.amazonaws.com/` if region is US East (us-east-1)
- `https://.s3-.amazonaws.com/` in other regions
- path-style URLs:
- `https://s3.amazonaws.com//` if region is US East (us-east-1)
- `https://s3-.amazonaws.com//` in other regions
When using HTTP/S and a bucket name containing a dot (`.`) you need to
use the path-style URL syntax.
## Use outside of EC2
Some use-cases (Continuous Integration, Docker) involve S3-hosted yum
repositories being accessed from outside EC2. For those cases two
options are available:
- Use AWS API keys in AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY (and
optionally AWS_SESSION_TOKEN) environment variables. Those will be
used as a fallback if IAM role credentials can not be accessed.
- Defining the environment DISABLE_YUM_S3_IAM to 1 will disable the
use of the yum-s3-iam plugin. This should be used with S3 bucket IP
white-listing.
## Limitations
Currently the plugin does not support:
- Proxy server configuration
- Multi-valued baseurl or mirrorlist
## Testing
Use `make test` to run some simple tests.
### Testing with docker compose:
```
docker-compose -f docker-compose.tests.yml run yum-s3-iam test
docker-compose -f docker-compose.tests.yml down --volumes --rmi all
```
## License
Apache 2.0 license. See LICENSE.
## Maintainers
- Mathias Brossard
- Mischa Spiegelmock
- Sean Edge
## Author(s)
- Julius Seporaitis
- [Robert Melas' code](https://github.com/rmela/yum-s3-plugin/) was
used as a reference. See NOTICE.