190 lines
8.6 KiB
Markdown
190 lines
8.6 KiB
Markdown
# Harbor Adapter Clair packaged by Bitnami
|
|
|
|
## What is Harbor Adapter Clair?
|
|
|
|
> Harbor Adapter for Clair translates the Harbor API into Clair API calls and allows Harbor to use Clair for providing vulnerability reports on images as part of its vulnerability scan.
|
|
|
|
[Overview of Harbor Adapter Clair](https://github.com/goharbor/harbor-scanner-clair/releases)
|
|
|
|
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
|
|
|
|
## TL;DR
|
|
|
|
This container is part of the [Harbor solution](https://github.com/bitnami/charts/tree/master/bitnami/harbor) that is primarily intended to be deployed in Kubernetes. You can deploy Harbor solution and then enable this specific container with the command below:
|
|
|
|
```console
|
|
$ curl -LO https://raw.githubusercontent.com/bitnami/bitnami-docker-harbor-portal/master/docker-compose.yml
|
|
$ curl -L https://github.com/bitnami/bitnami-docker-harbor-portal/archive/master.tar.gz | tar xz --strip=1 --wildcards '*-master/config'
|
|
$ docker-compose up
|
|
```
|
|
|
|
## Why use Bitnami Images?
|
|
|
|
* Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
|
|
* With Bitnami images the latest bug fixes and features are available as soon as possible.
|
|
* Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
|
|
* All our images are based on [minideb](https://github.com/bitnami/minideb) a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading Linux distribution.
|
|
* All Bitnami images available in Docker Hub are signed with [Docker Content Trust (DCT)](https://docs.docker.com/engine/security/trust/content_trust/). You can use `DOCKER_CONTENT_TRUST=1` to verify the integrity of the images.
|
|
* Bitnami container images are released daily with the latest distribution packages available.
|
|
|
|
## Why use a non-root container?
|
|
|
|
Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers [in our docs](https://docs.bitnami.com/tutorials/work-with-non-root-containers/).
|
|
|
|
## Supported tags and respective `Dockerfile` links
|
|
|
|
Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://docs.bitnami.com/tutorials/understand-rolling-tags-containers/).
|
|
|
|
|
|
* [`2`, `2-debian-10`, `2.5.0`, `2.5.0-debian-10-r41`, `latest` (2/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-harbor-adapter-clair/blob/2.5.0-debian-10-r41/2/debian-10/Dockerfile)
|
|
|
|
Subscribe to project updates by watching the [bitnami/harbor-adapter-clair GitHub repo](https://github.com/bitnami/bitnami-docker-harbor-adapter-clair).
|
|
|
|
## Get this image
|
|
|
|
The recommended way to get the Bitnami Harbor-Adapter-Clair Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/harbor-adapter-clair).
|
|
|
|
```console
|
|
$ docker pull bitnami/harbor-adapter-clair:latest
|
|
```
|
|
|
|
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/harbor-adapter-clair/tags/) in the Docker Hub Registry.
|
|
|
|
```console
|
|
$ docker pull bitnami/harbor-adapter-clair:[TAG]
|
|
```
|
|
|
|
If you wish, you can also build the image yourself.
|
|
|
|
```console
|
|
$ docker build -t bitnami/harbor-adapter-clair:latest 'https://github.com/bitnami/bitnami-docker-harbor-adapter-clair.git#master:2/debian-10'
|
|
```
|
|
|
|
## Persisting your application
|
|
|
|
If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.
|
|
|
|
For persistence you should mount a directory at the `/bitnami` path. If the mounted directory is empty, it will be initialized on the first run.
|
|
|
|
```console
|
|
$ docker run \
|
|
-v /path/to/harbor-adapter-clair-persistence:/bitnami \
|
|
bitnami/harbor-adapter-clair:latest
|
|
```
|
|
|
|
You can also do this with a minor change to the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-harbor-adapter-clair/blob/master/docker-compose.yml) file present in this repository:
|
|
|
|
```yaml
|
|
harbor-adapter-clair:
|
|
...
|
|
volumes:
|
|
- /path/to/harbor-adapter-clair-persistence:/bitnami
|
|
...
|
|
```
|
|
|
|
## Connecting to other containers
|
|
|
|
Using [Docker container networking](https://docs.docker.com/engine/userguide/networking/), a different server running inside a container can easily be accessed by your application containers and vice-versa.
|
|
|
|
Containers attached to the same network can communicate with each other using the container name as the hostname.
|
|
|
|
### Using the Command Line
|
|
|
|
#### Step 1: Create a network
|
|
|
|
```console
|
|
$ docker network create harbor-adapter-clair-network --driver bridge
|
|
```
|
|
|
|
#### Step 2: Launch the Harbor-Adapter-Clair container within your network
|
|
|
|
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `harbor-adapter-clair-network` network.
|
|
|
|
```console
|
|
$ docker run --name harbor-adapter-clair-node1 --network harbor-adapter-clair-network bitnami/harbor-adapter-clair:latest
|
|
```
|
|
|
|
#### Step 3: Run another containers
|
|
|
|
We can launch another containers using the same flag (`--network NETWORK`) in the `docker run` command. If you also set a name to your container, you will be able to use it as hostname in your network.
|
|
|
|
## Configuration
|
|
|
|
Harbor Adapter Clair is a component of the Harbor application. In order to get the Harbor application running on Kubernetes we encourage you to check the [bitnami/harbor Helm chart](https://github.com/bitnami/charts/tree/master/bitnami/harbor) and configure it using the options exposed in the values.yaml file.
|
|
|
|
For further information about the specific component itself, please refer to the [source repository documentation](https://github.com/goharbor/harbor-scanner-clair/blob/master/README.md).
|
|
|
|
## Logging
|
|
|
|
The Bitnami Harbor-Adapter-Clair Docker image sends the container logs to `stdout`. To view the logs:
|
|
|
|
```console
|
|
$ docker logs harbor-adapter-clair
|
|
```
|
|
|
|
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
|
|
|
|
## Maintenance
|
|
|
|
### Upgrade this image
|
|
|
|
Bitnami provides up-to-date versions of Harbor-Adapter-Clair, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container.
|
|
|
|
#### Step 1: Get the updated image
|
|
|
|
```console
|
|
$ docker pull bitnami/harbor-adapter-clair:latest
|
|
```
|
|
|
|
#### Step 2: Stop the running container
|
|
|
|
Stop the currently running container using the command
|
|
|
|
```console
|
|
$ docker stop harbor-adapter-clair
|
|
```
|
|
|
|
#### Step 3: Remove the currently running container
|
|
|
|
```console
|
|
$ docker rm -v harbor-adapter-clair
|
|
```
|
|
|
|
#### Step 4: Run the new image
|
|
|
|
Re-create your container from the new image.
|
|
|
|
```console
|
|
$ docker run --name harbor-adapter-clair bitnami/harbor-adapter-clair:latest
|
|
```
|
|
|
|
## Contributing
|
|
|
|
We'd love for you to contribute to this container. You can request new features by creating an [issue](https://github.com/bitnami/bitnami-docker-harbor-adapter-clair/issues), or submit a [pull request](https://github.com/bitnami/bitnami-docker-harbor-adapter-clair/pulls) with your contribution.
|
|
|
|
## Issues
|
|
|
|
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/bitnami-docker-harbor-adapter-clair/issues/new). For us to provide better support, be sure to include the following information in your issue:
|
|
|
|
- Host OS and version
|
|
- Docker version (`docker version`)
|
|
- Output of `docker info`
|
|
- Version of this container
|
|
- The command you used to run the container, and any relevant output you saw (masking any sensitive information)
|
|
|
|
## License
|
|
|
|
Copyright © 2022 Bitnami
|
|
|
|
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.
|