docker-aptdownloader

If you are beginning your journey with Senzing, please start with Senzing Quick Start guides.

You are in the Senzing Garage where projects are "tinkered" on. Although this GitHub repository may help you understand an approach to using Senzing, it's not considered to be "production ready" and is not considered to be part of the Senzing product. Heck, it may not even be appropriate for your application of Senzing!

Synopsis

A Docker wrapper over the apt-get command tuned to download the .deb file.

Overview

A thin wrapper over apt-get install --download-only.

The Docker container downloads the latest senzingapi-M.m.p-xxxxx.x86_64.deb and senzingdata-v3-M.m.p-xxxxx.x86_64.deb files.

Contents

1. Preamble
   1. Legend
2. Related artifacts
3. Expectations
4. Demonstrate using Docker
   1. Prerequisites for Docker
   2. Run Docker container
5. Develop
   1. Prerequisites for development
   2. Clone repository
   3. Build Docker image
6. Examples
   1. Examples of Docker
7. Advanced
   1. Configuration
8. Errors
9. References

Preamble

At Senzing, we strive to create GitHub documentation in a "don't make me think" style. For the most part, instructions are copy and paste. Whenever thinking is needed, it's marked with a "thinking" icon 🤔. Whenever customization is needed, it's marked with a "pencil" icon ✏️. If the instructions are not clear, please let us know by opening a new Documentation issue describing where we can improve. Now on with the show...

Legend

1. 🤔 - A "thinker" icon means that a little extra thinking may be required. Perhaps there are some choices to be made. Perhaps it's an optional step.
2. ✏️ - A "pencil" icon means that the instructions may need modification before performing.
3. ⚠️ - A "warning" icon means that something tricky is happening, so pay attention.

Related artifacts

1. DockerHub

Expectations

• Space: This repository and demonstration require 6 GB free disk space.
• Time: Budget 30 minutes to get the demonstration up-and-running, depending on CPU and network speeds.
• Background knowledge: This repository assumes a working knowledge of:
  • Docker

Demonstrate using Docker

Prerequisites for Docker

🤔 The following tasks need to be complete before proceeding. These are "one-time tasks" which may already have been completed.

1. The following software programs need to be installed:
   1. docker

Run Docker container

1. ✏️ Set environment variables. Example:

   export SENZING_DEB_DIR=~/Downloads

2. Run Docker container. Example:

   sudo docker run \
     --rm \
     --volume ${SENZING_DEB_DIR}:/download \
     senzing/aptdownloader

3. For more examples of use, see Examples of Docker.

Develop

The following instructions are used when modifying and building the Docker image.

Prerequisites for development

🤔 The following tasks need to be complete before proceeding. These are "one-time tasks" which may already have been completed.

1. The following software programs need to be installed:
   1. git
   2. make
   3. docker

Clone repository

For more information on environment variables, see Environment Variables.

1. Set these environment variable values:

   export GIT_ACCOUNT=senzing
   export GIT_REPOSITORY=docker-aptdownloader
   export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git
   export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}"

2. Using the environment variables values just set, follow steps in clone-repository to install the Git repository.

Build Docker image

1. Option #1: Using docker command and GitHub.

   sudo docker build \
     --tag senzing/aptdownloader \
     https://github.com/senzing-garage/docker-aptdownloader.git#main

2. Option #2: Using docker command and local repository.

   cd ${GIT_REPOSITORY_DIR}
   sudo docker build --tag senzing/aptdownloader .

3. Option #3: Using make command.

   cd ${GIT_REPOSITORY_DIR}
   sudo make docker-build

   Note: sudo make docker-build-development-cache can be used to create cached Docker layers.

Examples

Examples of Docker

The following examples require initialization described in Demonstrate using Docker.

Advanced

Configuration

Configuration values specified by environment variable or command line parameter.

• SENZING_DEB_DIR

Errors

1. See docs/errors.md.

References