harbor-cli

habor-cli

A cli for Harbor to interfact during CI/CD jobs. We use it to force scan and check vulnerabilities report during CI before to start CD. We also use it to delete artifact (docker image) from Harbor when volatile environment is destroyed on PR steps.

It's work for API v2.

CLI

Global options

The following parameters are available for all commands line :

• --debug: Enable the debug mode
• --help: Display help for the current command
• --url (required): The Harbor url with suffixe API version (https://harbor.company.com/api/v2.0)
• --username (required): The username to connect on Harbor API
• --password (required): The password to connect on Harbor API
• --timeout: Wait time before exit on error. Default to 60s.
• --self-signed-certificat: To not check validity of Harbor certificate. Default to false.
• --no-color: To not display logs with color. Default to false.

You can set also this parameters on yaml file (one or all) and use the parameters --config with the path of your Yaml file.

---
url: https://harbor.company.com/api/v2.0
username: admin
password: admin
self-signed-certificat: true
timeout: 180s

Check vulnerabilities

It permit to get vulnerabilities from Harbor on docker image and check the severity. It also display the report as output like trivy. If severity is biggest that the provided, it return with exit code 1.

We use it on Jenkins CI step just after build docker image with Kaniko.

Sample of command:

harbor-cli --url https://harbor.company.com/api/v2.0 --username admin --password admin --timeout "180s" check-vulnerabilities --project team1 --repository harbor --artifact build-PR-1 --force-scan --severity CRITICAL

You need to set following parameter:

• --project: The project name
• --registry: The registry name
• --artifact: The artifact name.
• --severity: The maximum severity before to exit with error (LOW, MEDIUM, HIGH or CRITICAL). Default it not check severity.
• --force-scan: To launch new scan and wait before to access on vulnerabilities reports. Default to false.

It return the following code:

• 0: all work fine and severity is not to bad
• 1: some internale errors or severity is to bad.

Delete artifact (docker image)

It permit to delete a specific artifact (docker image) or a tag. If you not provide the tag, it will delete the artifact. If you povide the tag:

• it will delete the artifact if the tag provided is the only tag of the artifact
• else it only delete the tag

We use it on Jenkins CI step just after destroy volatile environment for user tests on PR pipeline.

Sample of command:

harbor-cli --url https://harbor.company.com/api/v2.0 --username admin --password admin delete-artifact --project team1 --repository harbor --artifact build-PR-1

You need to set following parameter:

• --project: The project name
• --registry: The registry name
• --artifact: The artifact name.
• --tag (optionnal): The tag name.

It return the following code:

• 0: all work fine
• 1: some internale errors

Promote artifact (docker image)

It permit to promote artifact from existing tag to new tag. If will add the new tag on artifact and delete the old tag. If target tag already in use, it will first remove the tag or artfiact (if only on tag).

We use it on Jenkins just before to start CD to deploy a unique tag

Sample of command:

harbor-cli --url https://harbor.company.com/api/v2.0 --username admin --password admin promote-artifact --project team1 --repository harbor --artifact build-PR-1 --source-tag build-PR-1 --target-tags v1.0.0 --target-tags latest

You need to set following parameter:

• --project: The project name
• --repository: The repository name
• --artifact: The artifact name.
• --source-tag : The source tag name.
• --target-tags: the list of target tags to add

It return the following code:

• 0: all work fine
• 1: some internale errors

Contributing

You PR are always welcome. Please use the main branch as PR target. Don't forget to add test if you add some functionalities.

To build, you can use the following command line:

make build

To lauch golang test, you can use the folowing command line:

make test

Dev notes

Generate mocks

go install github.com/golang/mock/mockgen@v1.6.0
mockgen -destination=harbor/mocks/mock_api.go -package=mocks github.com/disaster37/harbor-cli/harbor/api API,ArtifactAPI