Harbor

https://goharbor.io/docs/2.15.0/
Admin
Harbor is an open-source trusted cloud native registry that stores, signs, and scans container...
Tokens:83,294
Snippets:722
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Harbor with Trivy (sudo ./install.sh --with-trivy)

Source: https://goharbor.io/docs/2.15.0/install-config/run-installer-script

Run the installer with the --with-trivy parameter to include the Trivy vulnerability scanner. The default installation does not include Trivy.

```shell
sudo ./install.sh --with-trivy


```

--------------------------------

### Install an OCI Helm chart

Source: https://goharbor.io/docs/2.15.0/working-with-projects/working-with-oci/working-with-helm-oci-charts

Installs a chart from an OCI registry. Login first if the project is private. Example: helm install MyRelease oci://demo.goharbor.io/oci/demo --version 0.1.0

```bash
helm install <release_name> oci://<harbor_address>/<project>/<chart_name> --version <version>

```

```bash
helm install MyRelease oci://demo.goharbor.io/oci/demo --version 0.1.0

```

--------------------------------

### GPG Verification Output Example

Source: https://goharbor.io/docs/2.15.0/install-config/download-installer

Example output showing a successful signature verification for the Harbor installer.

```text
gpg: armor header: Version: GnuPG v1
gpg: assuming signed data in 'harbor-online-installer-v2.0.2.tgz'
gpg: Signature made Tue Jul 28 09:49:20 2020 UTC
gpg:                using RSA key 644FF454C0B4115C
gpg: using pgp trust model
gpg: Good signature from "Harbor-sign (The key for signing Harbor build) <jiangd@vmware.com>" [unknown]
gpg: WARNING: This key is not certified with a trusted signature!
gpg:          There is no indication that the signature belongs to the owner.
Primary key fingerprint: 7722 D168 DAEC 4578 06C9  6FF9 644F F454 C0B4 115C
gpg: binary signature, digest algorithm SHA1, key algorithm rsa4096
```

--------------------------------

### Build and install with official Golang image

Source: https://goharbor.io/docs/2.15.0/build-customize-contribute/compile-guide

Builds, installs, and brings up Harbor using the official Golang image. Use this approach if you don't have a local Golang environment.

```bash
make install COMPILETAG=compile_golangimage

```

--------------------------------

### Install Harbor without Trivy (sudo ./install.sh)

Source: https://goharbor.io/docs/2.15.0/install-config/run-installer-script

Run the default Harbor installer script. This does not include the Trivy service. Installation may take time while images are downloaded from Docker Hub. After success, visit http://reg.yourdomain.com (replace with your configured hostname) and log in with default admin credentials if changeless (admin / Harbor12345).

```shell
sudo ./install.sh


```

--------------------------------

### Start Harbor with Docker Compose

Source: https://goharbor.io/docs/2.15.0/install-config/customize-token-service

Starts Harbor using Docker Compose after replacing the key and certificate. Run this command from the make directory.

```bash
docker compose up -d
```

--------------------------------

### Build and install with local Golang environment

Source: https://goharbor.io/docs/2.15.0/build-customize-contribute/compile-guide

Builds, installs, and runs Harbor using your own Golang environment. Requires the source code to be in $GOPATH.

```bash
cd $GOPATH/src/github.com/goharbor/harbor
$ make install

```

--------------------------------

### Install Harbor with Helm 3

Source: https://goharbor.io/docs/2.15.0/install-config/harbor-ha-helm

Installs the Harbor chart with release name 'my-release' using Helm 3.

```bash
helm install my-release harbor/

```

--------------------------------

### Verify installation success message

Source: https://goharbor.io/docs/2.15.0/build-customize-contribute/compile-guide

Expected output after a successful installation. If everything works, you will see this message.

```text
...
Start complete. You can visit harbor now.

```

--------------------------------

### Install Notation CLI

Source: https://goharbor.io/docs/2.15.0/working-with-projects/working-with-images/sign-images

Install the latest version of the Notation CLI on Linux using Homebrew.

```bash
brew install notation
```

--------------------------------

### Install Harbor with Helm 2

Source: https://goharbor.io/docs/2.15.0/install-config/harbor-ha-helm

Installs the Harbor chart with release name 'my-release' using Helm 2.

```bash
helm install --name my-release harbor/

```

--------------------------------

### Start Harbor frontend development server

Source: https://goharbor.io/docs/2.15.0/build-customize-contribute/ui-contribution-get-started

Serve Harbor locally. After running this command, visit https://localhost:4200.

```bash
npm run start

```

--------------------------------

### Build and run Harbor from source code

Source: https://goharbor.io/docs/2.15.0/build-customize-contribute/use-make

Builds Harbor from source code and starts the instance. This target compiles binaries, builds images, prepares the specific version of the compose file, and starts the Harbor instance.

```bash
make install
```

--------------------------------

### Install npm dependencies

Source: https://goharbor.io/docs/2.15.0/build-customize-contribute/ui-contribution-get-started

Install npm packages and 3rd-party dependencies for the Harbor frontend.

```bash
npm install

```

--------------------------------

### Restart Harbor service with install.sh

Source: https://goharbor.io/docs/2.15.0/administration/upgrade/roll-back-upgrade

If the previous version was installed by a release build, run these commands to restart the Harbor service.

```bash
cd harbor
./install.sh

```

--------------------------------

### Load migration tool from offline package

Source: https://goharbor.io/docs/2.15.0/administration/upgrade

Extract the offline installer package and load the Harbor image tarball to get the migration tool.

```bash
tar zxf <offline package>
docker image load -i harbor/harbor.[version].tar.gz

```

--------------------------------

### Configure Docker Daemon for HTTP Harbor (daemon.json)

Source: https://goharbor.io/docs/2.15.0/install-config/run-installer-script

For HTTP-based Harbor installations, add the --insecure-registry option to your Docker daemon. The example adds example.com and 0.0.0.0 as insecure registries in daemon.json. After updating the file, restart Docker Engine and Harbor.

```json
{
"insecure-registries" : ["_myregistrydomain.com_:5000", "0.0.0.0"]
}


```

--------------------------------

### Package offline installer

Source: https://goharbor.io/docs/2.15.0/build-customize-contribute/use-make

Prepares the offline install package for Harbor. This target creates the offline installer package.

```bash
make package_offline
```

--------------------------------

### Extract Offline Installer

Source: https://goharbor.io/docs/2.15.0/install-config/download-installer

Use the tar command to extract the offline installer package.

```bash
bash $ tar xzvf harbor-offline-installer-version.tgz
```

--------------------------------

### Build and tag a test image

Source: https://goharbor.io/docs/2.15.0/install-config/demo-server

Build an image from the Dockerfile and tag it with the demo server and your project name.

```bash
docker build -t demo.goharbor.io/your-project/test-image .

```

--------------------------------

### Extract Online Installer

Source: https://goharbor.io/docs/2.15.0/install-config/download-installer

Use the tar command to extract the online installer package.

```bash
bash $ tar xzvf harbor-online-installer-version.tgz
```

--------------------------------

### Verify Offline Installer Signature

Source: https://goharbor.io/docs/2.15.0/install-config/download-installer

Verify the authenticity of the offline installer package using the downloaded .asc file.

```bash
gpg -v --keyserver hkps://keyserver.ubuntu.com --verify harbor-offline-installer-version.tgz.asc
```

--------------------------------

### Verify Online Installer Signature

Source: https://goharbor.io/docs/2.15.0/install-config/download-installer

Verify the authenticity of the online installer package using the downloaded .asc file.

```bash
gpg -v --keyserver hkps://keyserver.ubuntu.com --verify harbor-online-installer-version.tgz.asc
```

--------------------------------

### Create a simple Dockerfile

Source: https://goharbor.io/docs/2.15.0/install-config/demo-server

Create a minimal Dockerfile based on busybox:latest to build a test image.

```dockerfile
FROM busybox:latest

```

--------------------------------

### Verify Harbor Installation with Docker Login and Push

Source: https://goharbor.io/docs/2.15.0/install-config/run-installer-script

After creating a project (e.g., myproject) in the Harbor portal, use Docker to log in to your Harbor registry and push an image. Replace reg.yourdomain.com with your configured hostname.

```shell
docker login reg.yourdomain.com
docker push reg.yourdomain.com/myproject/myrepo:mytag


```

--------------------------------

### Push the test image to Harbor

Source: https://goharbor.io/docs/2.15.0/install-config/demo-server

Push the built image to your project in the Harbor demo server.

```bash
docker push demo.goharbor.io/your-project/test-image

```

--------------------------------

### Run the migration tool

Source: https://goharbor.io/docs/2.15.0/administration/upgrade

Run the migration tool to upgrade the harbor.yml file. Replace [tag] with the new Harbor version and ${path to harbor.yml} with the actual path.

```bash
docker run -it --rm -v /:/hostfs goharbor/prepare:[tag] migrate -i ${path to harbor.yml}

```

--------------------------------

### Docker login to demo.goharbor.io

Source: https://goharbor.io/docs/2.15.0/install-config/demo-server

Log in to the Harbor demo server using Docker with the credentials created earlier.

```bash
docker login demo.goharbor.io

```
Tokens:
Raw