Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ehsaniara/maven-repository-aws-s3
Make AWS S3 Bucket as your private maven repository
https://github.com/ehsaniara/maven-repository-aws-s3
aws aws-s3 iam-users java java11 maven-plugin maven-repository oss plugin s3
Last synced: 2 days ago
JSON representation
Make AWS S3 Bucket as your private maven repository
- Host: GitHub
- URL: https://github.com/ehsaniara/maven-repository-aws-s3
- Owner: ehsaniara
- License: apache-2.0
- Created: 2020-03-30T22:08:39.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-07-17T02:34:21.000Z (about 2 years ago)
- Last Synced: 2024-04-23T14:18:12.355Z (5 months ago)
- Topics: aws, aws-s3, iam-users, java, java11, maven-plugin, maven-repository, oss, plugin, s3
- Language: Java
- Homepage:
- Size: 318 KB
- Stars: 13
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# maven-repository-aws-s3
[](https://opensource.org/licenses/Apache-2.0)
[](https://search.maven.org/search?q=g:%22com.github.ehsaniara%22%20AND%20a:%22maven-repository-aws-s3%22)
[](https://travis-ci.org/ehsaniara/maven-repository-aws-s3.svg?branch=master)
[](https://maven-badges.herokuapp.com/maven-central/com.github.ehsaniara/maven-repository-aws-s3)
**Introduction**
With the help of this maven-plugin you can create your own private Maven Repository with the essential features. There are many commercial products out there, for example: [Nexus](https://help.sonatype.com/repomanager3/formats/maven-repositories), [JFrog](https://jfrog.com/artifactory/) and ets.., but the drawback is they required more resources (Compute and storage) and some are costly. Where you can simply setup in your AWS cloud with much much less cost.
**Start Here**
* [Configure AWS Pre-Req](#Configure-AWS-Pre-Req)
* [Configure By AWS CLI (No ready yet)](#Configure-By-AWS-CLI)
* [Configure By AWS Console](#Configure-By-AWS-Console)
* [Create S3 Bucket](#Create-S3-Bucket)
* [Create Policy](#Create-Policy)
* [Create IAM USER](#Create-IAM-USER)
* [Local PC Setup](#Local-PC-Setup)
* [CI/CD Pipeline Setup](#CI-CD-Pipeline-Setup)
* [Reference](#Reference)
[](https://opensource.org/licenses/Apache-2.0)
[](https://maven-badges.herokuapp.com/maven-central/com.github.ehsaniara/maven-repository-aws-s3)
[](https://travis-ci.org/ehsaniara/maven-repository-aws-s3.svg?branch=master)
[](https://search.maven.org/search?q=g:%22com.github.ehsaniara%22%20AND%20a:%22maven-repository-aws-s3%22)
## Configure AWS Pre-Req
Create IAM User, -Rule and -Policy.
You can use both AWS-CLI or Web Console (browser: https://aws.amazon.com/)
##### NOTE: Java 1.8 and 11 supporteds
> Note: make sure that you have latest AWS CLI installed in your PC.
> Note: make sure that you are in your project root directory and have permission to create a file.
```shell script
curl -s https://raw.githubusercontent.com/ehsaniara/maven-repository-aws-s3/master/aws-s3-setup.sh | bash /dev/stdin bucket_name username
```
###### Note: Currently AWS CLI script is not completed, Please try AWS Console one
## Configure By AWS Console
(browser: https://aws.amazon.com/)
Create a AWS S3 bucket, try to have unique name from you domain, for example: ```my-project-com-maven-repository```
###### Note: Block all public access on the bucket
and also create 2 folder of ```release``` and ```snapshot``` in it.
### Create Policy
Create policy with the following json (select json tab):
##### Note: dont forget to replace ```YOUR_BUCKET_NAME``` by your bucket name, for example: ```my-project-com-maven-repository```
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"s3:PutObject",
"s3:GetObject",
"s3:CreateBucket",
"s3:ListBucket",
"s3:DeleteObject"
],
"Resource": "arn:aws:s3:::YOUR_BUCKET_NAME/*"
}
]
}
```
then give name to this policy. something similar to your bucket name, for example: ```my-project-com-maven-repository-policy``` and then create the policy.
### Create IAM USER
on Add user, select a User name and make sure you have select the "Programmatic access"
then select "Attach existing policies directly", and in ```Filter policies``` box search for your the policy name you have just created.
then tag,review and create the user.
> Important: Make sure that you have download the .csv file and store it in the secure place. the credentials in this file is required to user in your ```~/.m2/setting.xml``` file
create a user with (Programmatic access).
* create separate user to access your S3 bucket, for the security reason you should not give admin permission. this user should have enough access to read and write in the bucket and no more than that.
##### Note: you can have as many user (per team member) or single user just for repo access.
## Local PC Setup
[](https://opensource.org/licenses/Apache-2.0)
[](https://search.maven.org/search?q=g:%22com.github.ehsaniara%22%20AND%20a:%22maven-repository-aws-s3%22)
[](https://maven-badges.herokuapp.com/maven-central/com.github.ehsaniara/maven-repository-aws-s3)
If you plane to deploy you project jar from your local machine you need to follow the following steps.
* on your local maven setup directory ```.m2``` add the following XML snaps in ```setting.xml```.
you basically gave permission to maven to access the S3 bucket, to be able to push or pull the files. one for **snapshot** and one for **release**.
##### Note: create ```setting.xml``` if it's not exist in ```.m2``` directory
```xml
...
...
YOUR_BUCKET_NAME-snapshot
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
AWS_REGION
false
YOUR_BUCKET_NAME-release
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
AWS_REGION
false
....
....
```
* on your project ```pom.xml``` add the following xml to let maven **DOWNLOAD** your project artifactory from the maven-repo
```xml
YOUR_BUCKET_NAME-snapshot
s3://YOUR_BUCKET_NAME/snapshot
YOUR_BUCKET_NAME-release
s3://YOUR_BUCKET_NAME/release
```
##### Note: make sure that```YOUR_BUCKET_NAME-snapshot``` and ```YOUR_BUCKET_NAME-release``` should be identical with your ```.m2/setting.xml``` ids
* The following xml is required if you want ,user be able to upload into maven repo., from its terminal or idea
on your project ```pom.xml``` add the following xml to let maven **UPLOAD** your project artifactory into the maven-repo
```xml
YOUR_BUCKET_NAME-snapshot
s3://YOUR_BUCKET_NAME/snapshot
YOUR_BUCKET_NAME-release
s3://YOUR_BUCKET_NAME/release
```
And the most important one, add the following xml in your project ```pom.xml``` with in the `````` tag
[](https://maven-badges.herokuapp.com/maven-central/com.github.ehsaniara/maven-repository-aws-s3)
```xml
...
com.github.ehsaniara
maven-repository-aws-s3
1.2.11
...
```
for Example:
[](https://maven-badges.herokuapp.com/maven-central/com.github.ehsaniara/maven-repository-aws-s3)
```xml
org.springframework.boot
spring-boot-maven-plugin
build-info
org.apache.maven.plugins
maven-compiler-plugin
3.8.1
11
com.github.ehsaniara
maven-repository-aws-s3
1.2.11
```
once you have setup your pom.xml file in your project you can run the following line:
```shell script
# to clean your target directory
mvn clean
# deploy your artifactory into you maven-repo (AWS S3 Bucket)
mvn deploy
```
## CI/CD Pipeline Setup
[updating soon..]
Apache wagon: http://maven.apache.org/wagon/