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
-
is optional
-
Type:
boolean(Enable Harbor) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
boolean (Enable Harbor)
DEFAULTS:
The default value is:
true
alerts¶
Configuration options for Harbor Alerts.
alerts
-
is optional
-
Type:
object(Alert Config) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Alert Config)
backup¶
Configuration options for Backup Job.
backup
-
is optional
-
Type:
object(Backup Job Config) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Backup Job Config)
core¶
Configuration options for Core.
core
-
is optional
-
Type:
object(Core Config) -
cannot be null
-
defined in: Welkin Apps Config
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
-
is optional
-
Type:
object(Database Config) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Database Config)
gc¶
Configuration options for GC (Garbage Collection).
gc
-
is optional
-
Type:
object(GC (Garbage Collection) Config) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (GC (Garbage Collection) Config)
ingress¶
Configuration options for Ingress.
ingress
-
is optional
-
Type:
object(Ingress Config) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Ingress Config)
jobservice¶
Configuration options for Jobservice.
jobservice
-
is optional
-
Type:
object(Jobservice Config) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Jobservice Config)
nodeSelector¶
Kubernetes node selector
nodeSelector
-
is optional
-
Type:
object(Kubernetes Node Selector) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Kubernetes Node Selector)
EXAMPLES:
kubernetes.io/os: linux
notary¶
Configuration options for Notary.
notary
-
is optional
-
Type:
object(Notary Config) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Notary Config)
notarySigner¶
Configuration options for Notary signer.
notarySigner
-
is optional
-
Type:
object(NotarySigner Config) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (NotarySigner Config)
oidc¶
Configuration options for OIDC.
oidc
-
is optional
-
Type:
object(OIDC (OpenID Connector) Config) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (OIDC (OpenID Connector) Config)
persistence¶
Configuration options for Persistence.
persistence
-
is optional
-
Type:
object(Persistence Config) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Persistence Config)
portal¶
Configuration options for Portal.
portal
-
is optional
-
Type:
object(Portal Config) -
cannot be null
-
defined in: Welkin Apps Config
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
-
is optional
-
Type:
object(Redis Config) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Redis Config)
registry¶
Registry configuration
registry
-
is optional
-
Type:
object(Registry config) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Registry config)
s3¶
Configuration options for S3.
s3
-
is optional
-
Type:
object(Storage Driver S3 Config) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Storage Driver S3 Config)
subdomain¶
subdomain
-
is optional
-
Type:
string(Sub Domain) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string (Sub Domain)
DEFAULTS:
The default value is:
"harbor"
tolerations¶
Kubernetes Tolerations
Kubernetes taint and toleration
tolerations
-
is optional
-
Type: an array of merged types (Details)
-
cannot be null
-
defined in: Welkin Apps Config
TYPE:
an array of merged types (Details)
trivy¶
Configuration options for Trivy.
trivy
-
is optional
-
Type:
object(Trivy Config) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Trivy Config)
exporter¶
Configuration options for Exporter.
exporter
-
is optional
-
Type:
object(Exporter Config) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Exporter Config)
Return to the root config schema
Generated Thu Dec 19 03:51:01 UTC 2024 from elastisys/compliantkubernetes-apps@main