Sign inSign up

hylandsoftware/tagd

By hylandsoftware

•Updated almost 7 years ago

Tag Cleanup Daemon for VMWare Harbor

Image
1

5M+

hylandsoftware/tagd repository overview

⁠Tag Cleanup Daemon for VMware Harbor⁠

Build Status Coverage Status

tagd automates the process of cleaning up old tags from your Harbor container registries. You can override the default policy to be more or less specific for projects and repositories if needed.

⁠Building

You need version 2.0 or later of the dotnet core SDK. macOS and Linux also require mono to be installed to run the build script, but the project could be built manually.

Invoke the cake build script:

Windows:

./build.ps1 -t Dist

macOS / Linux:

./build.sh -t Dist

This will create a dist folder in the current directory containing a published copy of the application. Invoke with dotnet ./dist/Harbor.Tagd.dll. You can also build a docker container by executing the Docker target for cake instead of the Dist target.

⁠Running

The easiest way to get up and running is to use the Docker Container:

docker run -it --rm -v config.yml:/config.yml hylandsoftware/tagd \
    --config-file /config.yml \
    --endpoint <your harbor server> \
    --user <service user> \
    --password <service user password>

This will perform a dry run using the rules specified in config.yml. To actually delete tags, invoke with --destructive.

⁠Usage
Usage: Harbor.Tagd [ -h|--help ] [ --version ] --endpoint  -u|--user U -p|--password P [ --destructive ] [ --notify-slack  ] [ -v|--verbosity V ] [ --config-file  ] [ --config-server  ] [
--config-user  ] [ --config-password  ]

 Tag Cleanup daemon for VMware Harbor Registries

Required Arguments:
 --endpoint         The harbor registry to connect to
 -p, --password     The password for the user connecting to harbor
 -u, --user         The user to connect to harbor as

Optional Arguments:
 --destructive      Actually delete tags instead of generating a report
 --notify-slack     Post results to this slack-compatible webhook
 --config-file      The config file to parse
 --config-server    The springboot config server to get configuration from
 --config-user      The user to login to the springboot config server as
 --config-password  The password for the springboot config server user
 -h, --help         Display this help document.
 -v, --verbosity    How verbose should logging output be
 --version          Displays the version of the current executable.

If no value is provided for --password you will be prompted to enter a masked password:

$ dotnet .\dist\Harbor.Tagd.dll --config-server https://config.mydomain.net --verbosity verbose --endpoint https://hcr.io --user harboradmin --password
Input a value for --password:
[17:17:26 INF] Fetching config from server at: https://config.mydomain.net
[17:17:27 INF] Located environment: tagd, ["Production"], null, 05ba9ab0fe7b8846da1863cac3b4eebaa260c54b
[17:17:27 INF] Loading rules using Harbor.Tagd.Rules.ConfigServerRuleProvider
[17:17:27 INF] Connecting to https://hcr.io as harboradmin
⁠Configuration

You can use a configuration file or connect to a Spring CloudConfig Server⁠ by specifying --config-server instead of --config-file. If your configuration server requires authentication, provide --config-user and --config-password.

The backing file for the configuration server has the same format as --config-file:

# Projects, Repositories, and Tags to globally ignore. Must match exactly
ignoreGlobally:
  projects: []
  repos: []
  tags: ['latest']
# The default rule to process if no other rules match
defaultRule:
  project: '.*'      # A regular expression matching a project
  repo: '.*'         # A regular Expression matching a repository
  tag: '.*'          # A regular Expression matching a tag
  ignore: ['latest'] # Tags to always keep. Must match exactly
  keep: 10           # The number of tags matching this rule to keep, sorted by creation date
# Additional Rules to process
rules:
- project: '.*'
  repo: '.*'
  tag: '.*'
  ignore: ['latest']
  keep: 10

You can validate your rule config using the check verb:

$ dotnet .\dist\Harbor.Tagd.dll check --config-file rules.yml --verbosity verbose
⁠Usage
Usage: Harbor.Tagd check [ -h|--help ] [ --version ] [ -v|--verbosity V ] [ --config-file  ] [ --config-server  ] [ --config-user  ] [ --config-password  ]

 Load and validate rules

Optional Arguments:
 --config-file      The config file to parse
 --config-server    The springboot config server to get configuration from
 --config-user      The user to login to the springboot config server as
 --config-password  The password for the springboot config server user
 -h, --help         Display this help document.
 -v, --verbosity    How verbose should logging output be
 --version          Displays the version of the current executable.

⁠License

tagd is licensed under the MIT License. See LICENSE⁠ for details.

tagd makes use of nuget⁠ for package management. Packages restored by nuget have their own license which may differ from the terms of the MIT license that we use.

Tag summary

Content type

Image

Digest

Size

92.1 MB

Last updated

almost 7 years ago

docker pull hylandsoftware/tagd