warricksothr
/
pinned-package-updater
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
5 Commits
1 Branch
0 Tags
4.1 MiB
 
 
Tree: d6efb30f4a
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'd6efb30f4a'
${ noResults }
Drew Short d6efb30f4a
Removed committed binary and added gitignore 		3 years ago
cmd Added logging library, config and scaffold for dockerfile parser 3 years ago
distribution Added additional starting documentation 3 years ago
documentation Added placeholder documentation files 3 years ago
internal/parser Added logging library, config and scaffold for dockerfile parser 3 years ago
.gitignore Removed committed binary and added gitignore 3 years ago
LICENSE Initial commit for the project 3 years ago
README.md Added additional starting documentation 3 years ago
go.mod Added logging library, config and scaffold for dockerfile parser 3 years ago
go.sum Added logging library, config and scaffold for dockerfile parser 3 years ago
main.go Added logging library, config and scaffold for dockerfile parser 3 years ago

README.md

Pinned Package Updater

Pinned Package Updater (PPU) is a tool for managing pinned packages installed with package managers in a Dockerfile manifest. The goal of this tool is to reduce the administrative burden of keeping packages up to date with upstream security releases by offering an automatic mechanism for checking for new security releases and patching the existing Dockerfile manifest with those new versions.

The integration into the CI/CD is left up to the user, but can be as simple as committing the changes and opening an MR.

Table Of Contents

  1. Usage
  2. Features
  3. Building
  4. Contributing
  5. License

Usage

Standalone Usage

The default behavior for the tool is to operate in a standalone mode. In this mode the tool is responsible for parsing the Dockerfile, fetching the upstream package manager resources, identifying the upgrades available, and applying those upgrades. An alternative distributed mode is available to remove the upstream package resource caching and version upgrade determination logic.

pinned-package-updater check
pinned-package-updater update

Distributed Usage

In distributed mode the tool relies on an external deployment of PPU that is running in serve mode pinned-package-updater serve. To cache the upstream package manager resources and handle the upgrade check logic. In this mode much of the work can be cached between requests and the overhead of checking for pinned version updates is significantly reduced.

The tool running in this mode will revert to standalone mode if the upstream service is unavailable.

pinned-package-updater --remote <address of the upstream service> check
pinned-package-updater --remote <address of the upstream service> update

Features

  • Supported base images
    • Alpine Linux
      • (3.11, 3.12, 3.13, 3.14) are recognized by default, other versions may need additional configuration
    • Debian
      • (jessie, stretch, buster, bullseye) are recognized by default, other versions may need additional configuration
    • Ubuntu
      • (16.04, 18.04, 20.04) are recognized by default, other versions may need additional configuration
    • Red Hat Enterprise Linux
      • (8, 9) are recognized by default, other versions may need additional configurations
    • Others with explicit configuration of package manager and default upstream repositories
  • Resolve pinned packages in Dockerfiles
    • Support for Alpine based images (apk)
    • Support for Debian based images (apt, apt-get)
    • Support for Red Hat Enterprise Linux based images (yum, dnf)
  • Interrogate upstream package systems for package and version information
    • Support for Alpine based package repositories
    • Support for Debian based package repositories
    • Support for Red Hat Enterprise Linux based package repositories
  • Patch Dockerfiles in place with the recommended version upgrades

Building

To build pinned-package-updater, run go build

Contributing

I am not currently accepting outside contributions.

License

Copyright © 2021 Drew Short warricks@sothr.com

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

A copy of the license can also be viewed at LICENSE