Values for Helm James template
Helm James has many visible values to configure before being able to use
it correctly. Values are injected into the deployment template as
environment variables. An example with default values can be found in
the values.yaml
file.
This document presents a quick description of each value field.
DNS values
Field | Default value | Description |
---|---|---|
emailDomain |
mail.example.com |
The domain name for your tenant’s email addresses |
jmapUrl |
jmap.example.com |
The url for the ingress jmap endpoint |
adminUrl |
admin.example.com |
The url for the ingress admin endpoint |
smtpHostname |
smtp.example.com |
The SMTP Ehlo hostname |
James values
Field | Default value | Description |
---|---|---|
replicaJmapInstanceCount |
1 |
The number of pods we deploy for James JMAP instance in the cluster |
replicaImapSmtpInstanceCount |
1 |
The number of pods we deploy for James IMAP/SMTP instance in the cluster |
image |
apache/james:distributed-3.7.4 |
The James image used for deployment (Cassandra - RabbitMQ - LDAP distributed James flavor) |
James environment values
Field | Default value | Description |
---|---|---|
jamesCassandraKeyspace |
sandbox_james |
The keyspace used for Cassandra James data |
jamesCassandraCacheKeyspace |
sandbox_james_cache |
The keyspace used for the Cassandra cache |
jamesEsMailboxIndex |
mailbox_v1 |
The index used for mailbox in OpenSearch. The default value should be enough, but in case you had issues and needed to create a new index, this will allow you to point James to it |
jamesEsClusterName |
change-me |
Name of the cluster |
jamesEsHostScheme |
http |
Only http or https are accepted |
jamesEsSslValidationStrategy |
ignore |
Choosing the SSL check strategy
when using https scheme: |
jamesEsHostNameVerifier |
default |
Configure OpenSearch rest client
to use host name verifier during SSL handshake: |
jamesRabbitHost |
change-me |
The host url for RabbitMQ used by James for mail processing |
jamesMessageSize |
25M |
The default maximum size for each email is 25MB, Must be a positive integer, optionally with a unit: B, K, M, G. |
jamesDkimSignSmtp |
dkimselector |
SMTP signature for DKIM, also called DKIM Selector |
jamesDkimSignDomain |
mail.example.com |
Domain signature for DKIM |
cassandraReplicationFactor |
3 |
The replication factor for Cassandra configuration |
jamesHELOMessage |
change-me |
The SMTP Ehlo message |
jvmOpts |
-Xms4g -Xmx4g |
Add the JVM_OPTIONS flag for the JVM resource allocation when starting James |
jamesResources.limits.cpu |
2000m |
Limit of cpu allowed to James pod |
jamesResources.limits.memory |
6Gi |
Limit of memory allowed to James pod |
jamesResources.requests.cpu |
1000m |
Request of cpu allowed to James pod |
jamesResources.requests.memory |
3Gi |
Request of memory allowed to James pod |
glowroot.enabled |
true |
Enabling or disabling Glowroot usage with James. It’s better to disable it for prod environments |
ingress.enabled |
false |
Enabling or disabling Nginx Ingress. We are using it to expose JMAP and attach our SSL certificates for SMTP/IMAP/JMAP. Default is false |
james.tls.secretName |
the-name-of-a-secret |
The name of the secret created separately contenting the SSL certificate for JMAP, IMAPS and SMTPS |
Cassandra values
There is two ways to deploy Cassandra in our Helm packages, defined by
the deploy
field.
as-pod
Cassandra can be deployed as pods in the cluster. Parameters for this mode are:
Field | Default value | Description |
---|---|---|
replicaCount |
1 |
The number of Cassandra pods |
namespace |
change-me |
Namespace of Cassandra deployment |
Pod name must match template format: cassandra-01.namespace:9042,cassandra-02.namespace:9042
|
OpenSearch values
There is two ways to deploy OpenSearch in our Helm packages, defined
by the deploy
field.
as-pod
OpenSearch has been deployed as pods in the cluster. Parameters for this mode are:
Field | Default value | Description |
---|---|---|
replicaCount |
1 |
The number of OpenSearch pods |
namespace |
change-me |
Namespace of OpenSearch deployment |
Pod name must match template format: opensearch-01.namespace:9200,opensearch-02.namespace:9200
|