Skip to content

Latest commit

 

History

History
72 lines (46 loc) · 3.04 KB

README.md

File metadata and controls

72 lines (46 loc) · 3.04 KB
Raw

Artifact Hub

Artifact Hub is a web-based application that enables finding, installing, and publishing Kubernetes packages.

Introduction

This chart bootstraps an Artifact Hub deployment on a Kubernetes cluster using the Helm package manager.

Installing the Chart

To install the chart with the release name hub run:

$ helm repo add artifact-hub https://artifacthub.github.io/hub/chart
$ helm install hub artifact-hub/artifact-hub

The command deploys Artifact Hub on the Kubernetes cluster using the default configuration. The configuration section lists the parameters that can be configured during installation.

As soon as all pods are up and running, you can access the Artifact Hub by visiting the address specified in your Ingress object in your browser (http://192.168.64.18 in the case shown below).

$ kubectl get ingress
NAME   HOSTS   ADDRESS         PORTS   AGE
hub    *       192.168.64.18   80      6s

When the parameter dbMigrator.loadSampleData is set to true (default) a demo user and a couple of sample repositories are registered automatically. The credentials for the demo user are: demo@artifacthub.io / changeme. You can change the password from the control panel once you log in.

Populating packages

The chart installs one cronjob in charge of launching periodically (every 30m) the tracker, which indexes packages from the registered repositories. Some sample repositories are added by default when dbMigrator.loadSampleData is set to true. If you don't want to wait until the job is triggered by the cronjob, you can create one manually using the following command:

$ kubectl create job initial-tracker-job --from=cronjob/tracker

Packages security reports

The chart installs another cronjob in charge of launching periodically (every hour) the scanner, which scans packages' images for security vulnerabilities, generating security reports for them. If you don't want to wait until the job is triggered by the cronjob, you can create one manually using the following command:

$ kubectl create job initial-scanner-job --from=cronjob/scanner

Uninstalling the Chart

To uninstall the hub deployment run:

$ helm uninstall hub

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

Please see the values schema reference documentation in Artifact Hub for a list of the configurable parameters of the chart and their default values.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install hub \
  --set dbMigrator.loadSampleData=false \
  artifact-hub/artifact-hub

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install hub -f values.yaml artifact-hub/artifact-hub