Skip to content

Latest commit

 

History

History
110 lines (77 loc) · 5.1 KB

README.md

File metadata and controls

110 lines (77 loc) · 5.1 KB
Raw

Black Duck Image Management Script

Overview

This script automates the process of pulling, saving, and archiving Docker images for various versions of Black Duck. It supports pulling both standard and UBI (hardened) images, as well as optional Black Duck Binary Analysis (DBA) and Reversing Labs containers. It also checks for commands and Python libraries that it needs. The script can help install Python packages if necessary but not command-line tools.

Prerequisites

  • Python 3.x
  • Docker installed and running
  • Required Python packages: none extra beyond the default install of Python
  • Required command-line tools: docker, curl, tar, 7z

Setup

  1. Clone the repository:

    git clone https://github.com/snps-steve/Offline-Image-Creator.git

  2. Change into the directory with the cloned code.

    cd Offline-Image-Creator

  3. The script will check for Docker (and that docker is running), Curl, tar, and 7z and Python packages beyond the defaults. It won't help you install docker, Curl, tar, or 7z but if you're on a system that uses pip, it can help you install the missing Python packages.

If you don't currently have the non-Python-related dependencies installed, you'll need to go do that before executing the script.

  1. The script downloads the specified version of Black Duck Hub and enumerates the container image names and version numbers. It will prompt you and ask if you need any "extra" containers you might need. Some customers are licensed for and need to run BDBA Integrated and Reversing Labs. We also have Federal customers that need hardened Iron Bank images.

Usage

Run the script and it will prompt you at each stage of the process:

python oic.py

The script will guide you through the following steps:

  1. Checking for required packages and tools: The script checks for necessary Python packages and command-line tools.

  2. Cleaning up: The script deletes any existing hub directory and images files to ensure a clean environment.

  3. Selecting Black Duck version: You will be prompted to select a Black Duck version from a list of supported versions. The default version is 2024.7.0.

  4. Obtaining image names and versions: The script clones the specified version of the Black Duck repository to obtain the necessary image names and versions.

  5. Asking about 'extra' images required:

    • Whether you need Black Duck Binary Analysis (BDBA) containers (default: no).
    • Whether you need Reversing Labs containers (default: no).
    • Whether you need Iron Bank UBI (hardened) images (default: no). Please note: currently, the script can't download the hardened Iron Bank images. I'm working on trying to fix that.

  6. Authentication to Iron Bank registry: If Iron Bank hardened UBI images are required, you will be prompted to enter your Iron Bank username and CLI secret to authenticate (you won't be able to see the CLI secret). The script then creates a 'docker-config.json' file that contains the username, CLI secret, and the base64 encoded username:cli secret. The script pulls the information it needs from here to successfully authenticate to the Iron Bank repository.

  7. Pulling images: The script pulls the required images from Docker Hub or Iron Bank registry based on your selections.

  8. Saving images to tar files: The pulled images are saved as tar files.

  9. Creating archive: The tar files are archived using tar.

  10. Providing user notes: Instructions are provided for transferring and loading the images on the target server.

Important Notes

  • Moving the tarball: Move the tarball (images.tar.gz) to the target server using a jump box.
  • Untarring the tarball: On the target server, untar the tarball using: 
    tar xvf images.tar.gz
  • Loading images: You do not need to untar the individual images as Docker can load them as tar archives. Load the images with the command: 
    for i in $(ls *.tar); do docker load -i $i; done

Example Usage

python oic.py
  1. Checking for required Python packages.
  2. Checking for required command-line tools.
  3. Obtaining image names and versions based on your selection of Black Duck v2024.7.0.
  4. Asking about 'extra' images required:
    • Do you need the BDBA container? (yes/no) (default is no):
    • Do you need the Reversing Labs container? (yes/no) (default is no):
    • Do you need UBI images? (yes/no) (default is no):
    • Enter your Iron Bank username:
    • Enter your Iron Bank CLI secret:
  5. Creating images archive.
  6. Providing user notes:
    • Note: Move the tarball (images.tar.gz) to the target server using a jump box.
    • Once on the target server, untar the tarball using: 
      tar xvf images.tar.gz
    • You do not need to untar the individual images as Docker can load them as tar archives. Load the images with the command: 
      for i in $(ls *.tar); do docker load -i $i; done

Contributing

Feel free to open issues or submit pull requests for any improvements.

License

This project is licensed under the MIT License.