openstack-helm-images/mini-mirror
Gage Hugo e9b2ff0c74 Remove OSH Authors copyright
The current copyright refers to a non-existent group
"openstack helm authors" with often out-of-date references that
are confusing when adding a new file to the repo.

This change removes all references to this copyright by the
non-existent group and any blank lines underneath.

Change-Id: Ic78d29883364378cc14b11402f16d99dcec1fc96
2020-05-07 02:11:23 +00:00
..
etc Modify mini-mirror to build from yaml 2020-01-10 14:34:24 -06:00
tools Fix source publishing and publish logic 2020-02-06 13:16:03 -06:00
Dockerfile.ubuntu_bionic Add base image overrides to mini-mirror image 2020-03-26 12:40:06 -05:00
Dockerfile.ubuntu_xenial Add base image overrides to mini-mirror image 2020-03-26 12:40:06 -05:00
README.rst Modify mini-mirror to build from yaml 2020-01-10 14:34:24 -06:00
build.sh Remove OSH Authors copyright 2020-05-07 02:11:23 +00:00
mini-mirror-sources.yaml Modify mini-mirror to build from yaml 2020-01-10 14:34:24 -06:00

README.rst

Mini-mirror Image Build

Mini-mirror is a service that mirrors existing Debian/Ubuntu repositories and can be used as an APT source for OpenStack-Helm deployments with no internet connectivity.

Build Requirements

Add mirror sources

Mini-mirror requires a YAML file at build-time that contains the repositories and packages that will be mirrored as different YAML documents.

*Optional

To specify the location of your sources YAML file, export the following environment variable:

export MIRROR_SOURCE_FILE=/path/to/sources.yaml

Generate a signing key

Warning

The demo image published in the OpenStack-Helm-Addons repository is not signed. It should NOT be used in production and signing should be enabled in the Aptly config file.

Mini-mirror signs the release file during the image build process. Supply a path to a valid GPG key using the RELEASE_SIGN_KEY environment variable.

export RELEASE_SIGN_KEY_PATH=key.gpg

Additionally, supply your GPG key passphrase with the RELEASE_SIGN_KEY_PASSPHRASE environment variable:

export RELEASE_SIGN_KEY_PASSPHRASE=passphrase

Create an Aptly config file (optional)

Specify the location of your Aptly config file using the APTLY_CONFIG_PATH environment variable:

export APTLY_CONFIG_PATH=aptly.conf

Note

Mini-mirror can be configured on a per-repo basis by adding an Aptly config file to the .aptly_config key in the YAML document. This overrides the Aptly config file taken from APTLY_CONFIG_PATH.

Proxy

If building the mini-mirror image behind a proxy server, define the standard HTTP_PROXY, HTTPS_PROXY, and NO_PROXY environment variables. They will be passed as build-args.

Build

To build the mini-mirror image, execute the following:

export DISTRO=ubuntu
./build.sh