Kubernetes
Prerequisites
Kubernetes
- Kubernetes 1.14+
- Helm 3.1.0+
- (optional: sealed secrets)
Container Image Access
Because the images used in this chart are from a private container registry you need to have
- access to the container
registry registry.jadice.com
- OR access to a proxy
registry registry.jadice.com
Since the used Helm charts come from a private container registry, they also require
- access to the helm registry
artifacts.jadice.com
Installing the Chart
On this page we showcase how to install the jadice web viewer via its corresponding Helm Chart.
Download Helm Chart
There is the option to download a Helm Chart with the command:
$ helm pull levigo/jadice-web-viewer
Install from jadice helm repository
In this case our release name will be my-release
:
$ helm repo add levigo https://artifacts.jadice.com/repository/helm-charts/ --username <username>
Password: <enter your password>
$ helm install my-release levigo/jadice-web-viewer
Configuration
Image pull secrets
To access the container registry you have the following three options:
-
Provide the name of an existing Kubernetes registry-secret via
global.imagePullSecrets
.For instructions on how to create a Kubernetes docker-registry secret check out the Documentation or the output of
kubectl create secret docker-registry --help
-
Provide the credentials to the registry via the following parameters:
Parameter Description Default secrets.imageRegistry.server
Server of the container registry registry.jadice.com
secrets.imageRegistry.username
Username for the container registry nil
secrets.imageRegistry.password
Password for the container registry nil
-
For sealed secrets, you can encrypt the content of a ~/.docker/config.json file as a String and provide this as the value for the parameter
secrets.imageRegistry.dockerconfigjson
.To create this String you could run the following command
kubectl create secret docker-registry registry-secret \
--docker-username=<user> \
--docker-password=<password> \
--docker-server=registry.jadice.com \
--dry-run=client -o json | jq -r '.data[".dockerconfigjson"]' | base64 -d | kubeseal --raw --from-file=/dev/stdin --namespace <namespace> --name registry-secretNote:
- Requires
jq
andkubeseal
- Replace
<user>
,<password>
,<namespace>
with the respective values.
- Requires
Application settings
The base configuration of jadice web viewer includes all necessary configuration setting to run as is. If you like to customize your deployment the following configuration settings can be used:
Parameter | Description | Default |
---|---|---|
secrets.licenseInformation.license | The license field contains the necessary license information | |
secrets.licenseInformation.fingerprint | The unique fingerprint associated with your license |