install-harbor

  

Install VMWare Harbor tile pipeline

This pipeline installs the VMWare Harbor Container Registry tile on top of an existing PCF Ops Manager deployment.

The parameters file of this pipeline implements the concept of "externalized tile parameters", where all the available tile configuration options are fed to the pipeline tasks as a YAML object containing the parameter names expected by Ops Manager for the tile.

For example:

properties: |

  ######## General
  ### The FQDN (not IP) of Harbor instance. Its domain must match the wildcard domain used for generating Harbor certificate.
  .properties.hostname:
    value: ((harbor_hostname))

This approach allows for the configure-tile task of this pipeline to be generic and tile-agnostic, by delegating the tile configuration options to the content of the main three parameters networks, properties and resources.

---

How to use this pipeline

1. Update harbor_params.yml by following the instructions in the file.
   The order of tile parameters in that file follows the same order as parameters are presented in Ops Manager and in the tile documentation.

   If you use Vault or CredHub for credentials management, you can use the provided script harbor_vault_params.sh to automatically create the pipeline secrets in those systems.

   Also, note that the pipeline can automatically generate certificates for the Harbor server. See more details in comments for parameter .properties.server_cert_key in harbor_params.yml.

2. Update pcf_params.yml by following the instructions in the file.

   This parameter file contains information about the PCF foundation (e.g. Ops Manager and Director) to which the tile will be deployed to.

   This parameters file is separate from the others for reuse purposes, since any other PCF tile install or upgrade pipeline will use the same properties. If you already have this type of file created for another PCF tile pipeline, you can reuse it here.

3. Update global_params.yml by following the instructions in the file.

This parameter file contains information about global properties that typically apply to any PCF pipeline (e.g. Pivotal Network token).

This parameters file is separate from the others for reuse purposes, since any other PCF tile install or upgrade pipeline will use the same properties. If you already have this type of file created for another PCF tile pipeline, you can reuse it here.

4. Create the pipeline in Concourse:

   fly -t <target> set-pipeline -p install-harbor -c pipeline.yml -l global_params.yml -l pcf_params.yml -l harbor_params.yml

5. Un-pause and run pipeline install-harbor

---

Post-Install Configuration Tasks for the Harbor Tile

After the Harbor tile is successfully deployed to Ops Manager, make sure that the configured Harbor API endpoint is routable, so container images can be pull or pushed to the registry.

For VMWare environments with NSX-V Load Balancer, a sample load balancer setup pipeline is available here.

Once the Harbor API endpoint is routable, then follow the Harbor tile documentation on how to use and manage the Harbor container registry.