Skip to content

Harbor Config Schema

Note

This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.

Return to the root config schema

https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/harbor

Configuration options for Harbor.

Harbor is a container registry that deployed for the application developers to use when deploying their applications.

Note

See upstream documentation for reference. All config variables that exists in harbor are not exposed via our config.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Forbidden none config/schemas/config.yaml*

TYPE:

object (Harbor Config)

PROPERTIES:

Property Type Required Nullable Defined by
enabled boolean Optional cannot be null Welkin Apps Config
alerts object Optional cannot be null Welkin Apps Config
backup object Optional cannot be null Welkin Apps Config
core object Optional cannot be null Welkin Apps Config
database object Optional cannot be null Welkin Apps Config
gc object Optional cannot be null Welkin Apps Config
ingress object Optional cannot be null Welkin Apps Config
jobservice object Optional cannot be null Welkin Apps Config
nodeSelector object Optional cannot be null Welkin Apps Config
notary object Optional cannot be null Welkin Apps Config
notarySigner object Optional cannot be null Welkin Apps Config
oidc object Optional cannot be null Welkin Apps Config
persistence object Optional cannot be null Welkin Apps Config
portal object Optional cannot be null Welkin Apps Config
redis object Optional cannot be null Welkin Apps Config
registry object Optional cannot be null Welkin Apps Config
s3 object Optional cannot be null Welkin Apps Config
subdomain string Optional cannot be null Welkin Apps Config
tolerations array Optional cannot be null Welkin Apps Config
trivy object Optional cannot be null Welkin Apps Config
exporter object Optional cannot be null Welkin Apps Config

enabled

enabled

TYPE:

boolean (Enable Harbor)

DEFAULTS:

The default value is:

true

alerts

Configuration options for Harbor Alerts.

alerts

TYPE:

object (Alert Config)

backup

Configuration options for Backup Job.

backup

TYPE:

object (Backup Job Config)

core

Configuration options for Core.

core

TYPE:

object (Core Config)

database

Configuration options for Database used by Harbor

Set type to define which type of redis Harbor should use.

Only external or internal database can be enabled at the same time.

External: Defines an external postgres that harbor will use. For more details how to configure harbor to use an external database check the README

Internal: Use the internal database that is packaged with harbor.

database

TYPE:

object (Database Config)

gc

Configuration options for GC (Garbage Collection).

gc

TYPE:

object (GC (Garbage Collection) Config)

ingress

Configuration options for Ingress.

ingress

TYPE:

object (Ingress Config)

jobservice

Configuration options for Jobservice.

jobservice

TYPE:

object (Jobservice Config)

nodeSelector

Kubernetes node selector

Kubernetes assign pod node

nodeSelector

TYPE:

object (Kubernetes Node Selector)

EXAMPLES:

kubernetes.io/os: linux

notary

Configuration options for Notary.

notary

TYPE:

object (Notary Config)

notarySigner

Configuration options for Notary signer.

notarySigner

TYPE:

object (NotarySigner Config)

oidc

Configuration options for OIDC.

oidc

TYPE:

object (OIDC (OpenID Connector) Config)

persistence

Configuration options for Persistence.

persistence

TYPE:

object (Persistence Config)

portal

Configuration options for Portal.

portal

TYPE:

object (Portal Config)

redis

Configuration options for Redis used by Harbor

Set type to define which type of redis Harbor should use.

Only external or internal redis can be enabled at the same time.

External: Defines an external redis that harbor will use. For more details how to configure harbor to use an external redis check the README

Internal: Use the internal redis that is packaged with harbor.

redis

TYPE:

object (Redis Config)

registry

Registry configuration

registry

TYPE:

object (Registry config)

s3

Configuration options for S3.

Storage Driver S3

s3

TYPE:

object (Storage Driver S3 Config)

subdomain

subdomain

TYPE:

string (Sub Domain)

DEFAULTS:

The default value is:

"harbor"

tolerations

Kubernetes Tolerations

Kubernetes taint and toleration

tolerations

TYPE:

an array of merged types (Details)

trivy

Configuration options for Trivy.

trivy

TYPE:

object (Trivy Config)

exporter

Configuration options for Exporter.

exporter

TYPE:

object (Exporter Config)

Return to the root config schema

Generated Sun Nov 17 03:51:36 UTC 2024 from elastisys/compliantkubernetes-apps@main