airgapper 0.2.0

Helper to download packages/images for airgapped applications.

Airgapper

Taking the shet pain out of air-gapped environments.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About Airgapper

Taking the shet pain out of airgapped environment.

(back to top)

Feature Matrix

Packages / Hosted Repositories	Nexus	Harbor
Python Package (pypi)
Maven Java Packages
Docker Image
Helm Chart
Bitnami Helm Charts

Getting Started

Just download package from pypi repository. Its that easy!

pip install airgapper

The package will use existing tools (docker, mvn etc.) to automate the downloading and uploading of library packages.

Prerequisites

The following are the prerequisites when working with different libraries

Python

• Python 3.7+
• Requests Library

Docker

• Docker Engine

Bitnami Helm

• Docker Engine
• Bitnami Helm Distribution Tool

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git
   

3. Install NPM packages

   npm install
   

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';
   

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

Maven

Download

1. Search for maven/gradle plugin package at Maven Repository

2. Select version and copy xml snippet into pom.xml

   pom.xml example

   ```xml pom.xml

    <project>
        <modelVersion>4.0.0</modelVersion>
        <groupId>com.example</groupId>
        <artifactId>sample-project</artifactId>
        <version>1.0-SNAPSHOT</version>
        <name>Sample Project</name>
   
        <dependencies>
            <!-- Gson Library for JSON processing -->
            <dependency>
                <groupId>com.google.code.gson</groupId>
                <artifactId>gson</artifactId>
                <version>2.8.9</version>
            </dependency>
        </dependencies>
    </project>
    ```
   

3. Download

   airgapper maven download pom.xml -o ./output-directory
   

Upload

1. Inject required environment variables.
2. Upload

   airgapper maven upload ./output-directory \
       "-a",
       "nexus", # Application
       "-r",
       "http://nexus.local.arpa:8080", # Application URL 
       "--repo",
       "maven-hosted", # Repository Name
   

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Add Maven support
  • Add gradle plugins support
• Add generic Helm chart support
  • Handle recursive subdependencies

See the open issues for a full list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)