Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 1.9 KB

configuration.md

File metadata and controls

33 lines (26 loc) · 1.9 KB

Immudb Configuration

After deploying the operator, you can create a Immudb resource to create a database (example Immudb resource).

Immudb Spec

The following spec values can be updated.

Name Type Default value Description
image string "codenotary/immudb:latest" The Immudb image.
imagePullPolicy string "IfNotPresent" ImagePullPolicy of immudb image.
replicas int 1 Number of replicas of immudb image. The value can only be 1 at the moment. The immudb team is working hard in adding replication in the future.
volume.storageClassName string Name of the default storageClass of the cluster. StorageClassName of the database.
volume.size string No default value, mandatory to set. Size of the database, e.g., 5Mi, 10Gi.
ingress.enabled bool No default value, mandatory to set. Enabling of ingress resource.
ingress.ingressClassName string "nginx" Ingress class name.
ingress.TLS []knetworkingv1.IngressTLS nil TLS for the ingress.
ingress.Host string "" Host of the ingress.
serviceMonitor.enabled bool No default value, mandatory to set. Enabling of the service monitor.
serviceMonitor.Labels map[string]string nil Labels of the service monitor. It should be configured so that the service monitor is selected by Prometheus.

Immudb Status

The status field of the Immudb resource is updated by the immudb operator. It gives real-time status of the database.

Name Type Description
ready bool The database can be used when the value is true.
readyReplicas int Number of immudb replicas in a ready state.
hosts.GRPC string Host to access database with GRPC.
hosts.HTTP string Host to access database with HTTP.
hosts.Metrics string Host to access database metrics for Prometheus.