Harbor Configuration

• 1: Harbor
• 2: Harbor use cases
• 3: v2.5.0
• 4: v2.5.1
• 5: v2.7.1
• 6: v2.10.2
• 7: v2.11.1

1 - Harbor

If you have not already done so, make sure your cluster meets the package prerequisites. Be sure to refer to the troubleshooting guide in the event of a problem.

Install

1. Set the KUBECONFIG environment variable to use the config of the management cluster

   export KUBECONFIG=<path to management cluster kubeconfig>
   

2. Generate the package configuration

   eksctl anywhere generate package harbor --cluster <cluster-name> > harbor.yaml
   

3. Add the desired configuration to harbor.yaml

   Please see complete configuration options for all configuration options and their default values.

   Important

   • All configuration options are listed in dot notations (e.g., expose.tls.enabled) in the doc, but they have to be transformed to hierachical structures when specified in the config section in the YAML spec.
   • Harbor web portal is exposed through NodePort by default, and its default port number is 30003 with TLS enabled and 30002 with TLS disabled.
   • TLS is enabled by default for connections to Harbor web portal, and a secret resource named harbor-tls-secret is required for that purpose. It can be provisioned through cert-manager or manually with the following command using self-signed certificate:

     kubectl create secret tls harbor-tls-secret --cert=[path to certificate file] --key=[path to key file] -n eksa-packages
     

   • secretKey has to be set as a string of 16 characters for encryption.

   TLS example with auto certificate generation

   apiVersion: packages.eks.amazonaws.com/v1alpha1
   kind: Package
   metadata:
      name: my-harbor
      namespace: eksa-packages-<cluster-name>
   spec:
      packageName: harbor
      config: |-
         secretKey: "use-a-secret-key"
         externalURL: https://harbor.eksa.demo:30003
         expose:
            tls:
               certSource: auto
               auto:
                  commonName: "harbor.eksa.demo"      
   

   Non-TLS example

   apiVersion: packages.eks.amazonaws.com/v1alpha1
   kind: Package
   metadata:
      name: my-harbor
      namespace: eksa-packages-<cluster-name>
   spec:
      packageName: harbor
      config: |-
         secretKey: "use-a-secret-key"
         externalURL: http://harbor.eksa.demo:30002
         expose:
            tls:
               enabled: false      
   

4. Install Harbor

   eksctl anywhere create packages -f harbor.yaml
   

5. Check Harbor

   eksctl anywhere get packages --cluster <cluster-name>
   

   Example command output

   NAME        PACKAGE   AGE     STATE       CURRENTVERSION             TARGETVERSION        DETAIL
   my-harbor   harbor    5m34s   installed   v2.5.1                     v2.5.1 (latest)
   

   Harbor web portal is accessible at whatever externalURL is set to. See complete configuration options for all default values.

   

Update

To update package configuration, update harbor.yaml file, and run the following command:

eksctl anywhere apply package -f harbor.yaml

Upgrade

1. Verify a new bundle is available

   eksctl anywhere get packagebundle
   

   Example command output

   NAME         VERSION   STATE
   v1.25-120    1.25      active (upgrade available)
   v1.26-120    1.26      inactive
   

2. Upgrade Harbor

   eksctl anywhere upgrade packages --bundle-version v1.26-120
   

3. Check Harbor

   eksctl anywhere get packages --cluster <cluster-name>
   

   Example command output

   NAME        PACKAGE   AGE     STATE       CURRENTVERSION             TARGETVERSION        DETAIL
   my-harbor   Harbor    14m     installed   v2.7.1                     v2.7.1 (latest)
   

Uninstall

1. Uninstall Harbor

   Important

   • By default, PVCs created for jobservice and registry are not removed during a package delete operation, which can be changed by leaving persistence.resourcePolicy empty.

   eksctl anywhere delete package --cluster <cluster-name> my-harbor
   

2 - Harbor use cases

Proxy a public Amazon Elastic Container Registry (ECR) repository

This use case is to use Harbor to proxy and cache images from a public ECR repository, which helps limit the amount of requests made to a public ECR repository, avoiding consuming too much bandwidth or being throttled by the registry server.

1. Login

   Log in to the Harbor web portal with the default credential as shown below

   admin
   Harbor12345
   

   

2. Create a registry proxy

   Navigate to Registries on the left panel, and then click on NEW ENDPOINT button. Choose Docker Registry as the Provider, and enter public-ecr as the Name, and enter https://public.ecr.aws/ as the Endpoint URL. Save it by clicking on OK.

   

3. Create a proxy project

   Navigate to Projects on the left panel and click on the NEW PROJECT button. Enter proxy-project as the Project Name, check Public access level, and turn on Proxy Cache and choose public-ecr from the pull-down list. Save the configuration by clicking on OK.

   

4. Pull images

   Note

   • harbor.eksa.demo:30003 should be replaced with whatever externalURL is set to in the Harbor package YAML file.

   docker pull harbor.eksa.demo:30003/proxy-project/cloudwatch-agent/cloudwatch-agent:latest
   

Proxy a private Amazon Elastic Container Registry (ECR) repository

This use case is to use Harbor to proxy and cache images from a private ECR repository, which helps limit the amount of requests made to a private ECR repository, avoiding consuming too much bandwidth or being throttled by the registry server.

1. Login

   Log in to the Harbor web portal with the default credential as shown below

   admin
   Harbor12345
   

   

2. Create a registry proxy

   In order for Harbor to proxy a remote private ECR registry, an IAM credential with necessary permissions need to be created. Usually, it follows three steps:

   1. Policy

      This is where you specify all necessary permissions. Please refer to private repository policies , IAM permissions for pushing an image and ECR policy examples to figure out the minimal set of required permissions.

      For simplicity, the build-in policy AdministratorAccess is used here.

      

   2. User group

      This is an easy way to manage a pool of users who share the same set of permissions by attaching the policy to the group.

      

   3. User

      Create a user and add it to the user group. In addition, please navigate to Security credentials to generate an access key. Access keys consists of two parts: an access key ID and a secret access key. Please save both as they are used in the next step.

      

   Navigate to Registries on the left panel, and then click on NEW ENDPOINT button. Choose Aws ECR as Provider, and enter private-ecr as Name, https://[ACCOUNT NUMBER].dkr.ecr.us-west-2.amazonaws.com/ as Endpoint URL, use the access key ID part of the generated access key as Access ID, and use the secret access key part of the generated access key as Access Secret. Save it by click on OK.

   

3. Create a proxy project

   Navigate to Projects on the left panel and click on NEW PROJECT button. Enter proxy-private-project as Project Name, check Public access level, and turn on Proxy Cache and choose private-ecr from the pull-down list. Save the configuration by clicking on OK.

   

4. Pull images

   Create a repository in the target private ECR registry

   

   Push an image to the created repository

   docker pull alpine
   docker tag alpine [ACCOUNT NUMBER].dkr.ecr.us-west-2.amazonaws.com/alpine:latest
   docker push [ACCOUNT NUMBER].dkr.ecr.us-west-2.amazonaws.com/alpine:latest
   

   Note

   • harbor.eksa.demo:30003 should be replaced with whatever externalURL is set to in the Harbor package YAML file.

   docker pull harbor.eksa.demo:30003/proxy-private-project/alpine:latest
   

Repository replication from Harbor to a private Amazon Elastic Container Registry (ECR) repository

This use case is to use Harbor to replicate local images and charts to a private ECR repository in push mode. When a replication rule is set, all resources that match the defined filter patterns are replicated to the destination registry when the triggering condition is met.

1. Login

   Log in to the Harbor web portal with the default credential as shown below

   admin
   Harbor12345
   

   

2. Create a nonproxy project

   

3. Create a registry proxy

   In order for Harbor to proxy a remote private ECR registry, an IAM credential with necessary permissions need to be created. Usually, it follows three steps:

   1. Policy

      This is where you specify all necessary permissions. Please refer to private repository policies , IAM permissions for pushing an image and ECR policy examples to figure out the minimal set of required permissions.

      For simplicity, the build-in policy AdministratorAccess is used here.

      

   2. User group

      This is an easy way to manage a pool of users who share the same set of permissions by attaching the policy to the group.

      

   3. User

      Create a user and add it to the user group. In addition, please navigate to Security credentials to generate an access key. Access keys consists of two parts: an access key ID and a secret access key. Please save both as they are used in the next step.

      

   Navigate to Registries on the left panel, and then click on the NEW ENDPOINT button. Choose Aws ECR as the Provider, and enter private-ecr as the Name, https://[ACCOUNT NUMBER].dkr.ecr.us-west-2.amazonaws.com/ as the Endpoint URL, use the access key ID part of the generated access key as Access ID, and use the secret access key part of the generated access key as Access Secret. Save it by clicking on OK.

   

4. Create a replication rule

   

5. Prepare an image

   Note

   • harbor.eksa.demo:30003 should be replaced with whatever externalURL is set to in the Harbor package YAML file.

   docker pull alpine
   docker tag alpine:latest harbor.eksa.demo:30003/nonproxy-project/alpine:latest
   

6. Authenticate with Harbor with the default credential as shown below

   admin
   Harbor12345
   

   Note

   • harbor.eksa.demo:30003 should be replaced with whatever externalURL is set to in the Harbor package YAML file.

   docker logout
   docker login harbor.eksa.demo:30003
   

7. Push images

   Create a repository in the target private ECR registry

   

   Note

   • harbor.eksa.demo:30003 should be replaced with whatever externalURL is set to in the Harbor package YAML file.

   docker push harbor.eksa.demo:30003/nonproxy-project/alpine:latest
   

   The image should appear in the target ECR repository shortly.

   

Set up trivy image scanner in an air-gapped environment

This use case is to manually import vulnerability database to Harbor trivy when Harbor is running in an air-gapped environment. All the following commands are assuming Harbor is running in the default namespace.

1. Configure trivy

   TLS example with auto certificate generation

   apiVersion: packages.eks.amazonaws.com/v1alpha1
   kind: Package
   metadata:
      name: my-harbor
      namespace: eksa-packages
   spec:
      packageName: harbor
      config: |-
        secretKey: "use-a-secret-key"
        externalURL: https://harbor.eksa.demo:30003
        expose:
          tls:
            certSource: auto
            auto:
              commonName: "harbor.eksa.demo"
          trivy:
            skipUpdate: true
            offlineScan: true     
   

   Non-TLS example

   apiVersion: packages.eks.amazonaws.com/v1alpha1
   kind: Package
   metadata:
      name: my-harbor
      namespace: eksa-packages
   spec:
      packageName: harbor
      config: |-
        secretKey: "use-a-secret-key"
        externalURL: http://harbor.eksa.demo:30002
        expose:
          tls:
            enabled: false
        trivy:
          skipUpdate: true
          offlineScan: true     
   

   If Harbor is already running without the above trivy configurations, run the following command to update both skipUpdate and offlineScan

   kubectl edit statefulsets/harbor-helm-trivy
   

2. Download the vulnerability database to your local host

   Please follow oras installation instruction .

   oras pull ghcr.io/aquasecurity/trivy-db:2 -a
   

3. Upload database to trivy pod from your local host

   kubectl cp db.tar.gz harbor-helm-trivy-0:/home/scanner/.cache/trivy -c trivy
   

4. Set up database on Harbor trivy pod

   kubectl exec -it harbor-helm-trivy-0 -c trivy bash
   cd /home/scanner/.cache/trivy
   mkdir db
   mv db.tar.gz db
   cd db
   tar zxvf db.tar.gz
   

3 - v2.5.0

Configuring Harbor in EKS Anywhere package spec

The following table lists the configurable parameters of the Harbor package spec and the default values.

4 - v2.5.1

Configuring Harbor in EKS Anywhere package spec

The following table lists the configurable parameters of the Harbor package spec and the default values.

5 - v2.7.1

Configuring Harbor in EKS Anywhere package spec

The following table lists the configurable parameters of the Harbor package spec and the default values.

6 - v2.10.2

Configuring Harbor in EKS Anywhere package spec

The following table lists the configurable parameters of the Harbor package spec and the default values.

7 - v2.11.1

Configuring Harbor in EKS Anywhere package spec

The following table lists the configurable parameters of the Harbor package spec and the default values.