AWS p2 Repository

Web application to host p2 repositories backed by AWS S3.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

• Maven 3.5.x
• Java 1.8+

Installing

Package the self-contained JAR:

$ mvn clean package

Run the JAR:

$ java -jar aws-p2-repository-webapp/target/aws-p2-repository-webapp-<version>.jar

To view, open a web browser and navigate to localhost:<port>/browse.

Building the Docker Image

$ docker build --tag aws-p2-repository .

Running the tests

To execute all unit tests and perform code coverage analysis, run the following from the root of the project:

$ mvn clean verify

Deployment

The JAR produced in /aws-p2-repository-webapp/target is self-contained, and can be deployed as a stand-alone JAR file. Alternatively, it can be deployed via a Docker container.

Required Environment Variables

• AWS_ACCESS_KEY_ID - See Working with AWS Credentials
• AWS_SECRET_KEY - See Working with AWS Credentials
• AWS_S3_BUCKET_NAME - The name of the AWS S3 bucket where the p2 repositories are stored
• AWS_P2_REPO_WEBAPP_BRAND_NAME - Custom website name branding
• AWS_P2_REPO_WEBAPP_BRAND_ICON - URL of the branding icon to use
• AWS_P2_REPO_WEBAPP_BRAND_FAVICON - URL of the branding favicon to use
• AWS_P2_REPO_WEBAPP_CUSTOM_DOMAIN - The welcome message to display on the dashboard
• PORT - The port number that the embedded server will use
• P2_INSPECTOR_BASE_URL - The base URL of the p2 Inspector to retrieve p2 repository metadata

Docker

Due to the number of required environment variables, you can use a config file containing the environment variables.

$ docker run --rm -d -p 8081:8081 --env-file ./env.list aws-p2-repository

Example env.list file:

AWS_ACCESS_KEY_ID=FAKENOTREAL123
AWS_SECRET_KEY=FAKENOTREAL123
AWS_S3_BUCKET_NAME=p2.example.com
AWS_P2_REPO_WEBAPP_BRAND_NAME=p2.example.com
AWS_P2_REPO_WEBAPP_BRAND_ICON=https://www.example.com/icon.png
AWS_P2_REPO_WEBAPP_BRAND_FAVICON=https://www.example.com/favicon.png
AWS_P2_REPO_WEBAPP_CUSTOM_DOMAIN=p2.example.com
P2_INSPECTOR_BASE_URL=https://inspector.example.com
PORT=8081

S3 Bucket Content

The application expects that bucket content follows the following layout in the root of the bucket:

{project_name}/{snapshots|releases}/{version}/

For example:

+ foo-project
    + snapshots
    |   + 1.0.0-SNAPSHOT
    |   |   + features
    |   |   |   + ...
    |   |   + plugins
    |   |   |   + ...
    |   |   + artifacts.jar
    |   |   + artifacts.xml.xz
    |   |   + content.jar
    |   |   + content.xml.xz
    |   |   + p2.index
    |   + 1.1.0-SNAPSHOT
    |       + ...
    + releases
        + 1.0.0
        + ...

Built With

• Spring Boot - The web application framework
• Maven - Dependency Management
• Docker - Containerized deployment

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE file for details