Skip to content

Refactor to Consolidated Docker File

Paul Tomasula requested to merge refactor into main

Background

The PR represents the conclusion of a refactoring effort to increase the useability of the builder repository and improve documentation. Additional details are captured in the issues under milestone 1.

High Level Summary of Changes

  • Consolidate separate docker files into a single file with multi-stage/partial building support.
  • Adds docker caching support (enabled by default) to avoid a full rebuild when changing something later in the build stack (e.g. configuration files).
  • Adds support for overriding image pygeoapi configuration yml file at runtime.
  • Updates the CI/CD pipeline to use new consolidated docker file approach.
  • Consolidates and cross references the documentation.
  • Updates sections of the documentation for added clarity.
    • Adds instructions on docker partial builds.
    • Adds explanation of container environment variables.
    • Documents a set of common user and developer workflows.

Review Requests

@asnyder and @ahopkins1, I'm requesting that you review the README documentation for this refactored version of the builder. You are both end users of this repository, so I want to make sure the documentation is intuitive to you and that we did not blind spots in the documentation based on my familiarity with the repository.

cc: @dblodgett @aaufdenkampe_limno.com @kbartels_limno.com @sjordan_limno.com

Merge request reports

Loading