Skip to content
FME Server helm chart for deployment in Kubernetes clusters
Smarty Shell
Branch: master
Clone or download
Jenkins CI
Latest commit 71ff14f Aug 28, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
chart-source Release Helm chart for branch 2020.0 Aug 27, 2019
ci Only build and publish charts for 2019.0 May 31, 2019
docs Release Helm chart for branch 2020.0 Aug 27, 2019
.gitignore Introduce PodDisruptionBudget for core Mar 19, 2019
LICENSE Intial working fmeserver chart Apr 12, 2018
README.md Update README for 2019.1.0 beta. Jun 18, 2019

README.md

Official Safe Software Helm Charts

Prerequisites

To add the Safe Software charts repository:
helm repo add safesoftware https://safesoftware.github.io/helm-charts/

Installing the Chart

To walk you through the helm installation process, a quick-start script for all supported FME Server versions has been created and can be found here.

FME Server 2019.1.0 BETA

Configuration

The following table lists the configurable parameters of the FME Server 2019.1.0 BETA chart and their default values.

Parameter Description Default
fmeserver.image.tag The docker image tag to use. Nil You must provide a tag. You can find available tags here.
fmeserver.image.pullPolicy Image pull policy IfNotPresent
fmeserver.image.registry Docker registry quay.io This parameter should not be changed.
fmeserver.image.namespace Docker registry namespace safesoftware This parameter should not be changed.
deployment.hostname FME Server hostname localhost
deployment.proxyReadTimeout Default proxy read timeout (in seconds) 60
deployment.proxyBodySize Default maximum allowed size of the request body 0
deployment.tlsSecretName Custom TLS certificate, see documentation for more details Nil
deployment.certManager.issuerName Cert Manager issuer name, see documentation for more details Nil
deployment.certManager.issuerType Can be cluster or namespace, ignored if no issuerName is provided. See documentation for more details cluster
deployment.numCores Number of cores to launch. Multi-core only works in a multi-host cluster with ReadWriteMany storage 1
deployment.startAsRoot Starts core container as root and grants the fmeserver user access to the file system. false
deployment.useHostnameIngress Configures the ingress to route traffic to FME Server only if the request matches the value of deployment.hostname. Setting this to false will route all traffic on the ingress to FME Server. true
deployment.deployPostgresql Deploy a Postgresql Database for FME Server to use. Set this to false if you have an existing database you would like FME Server to connect to. true
resources.core Core CPU/Memory resource requests/limits Memory: 1.5Gi, CPU: 200m
resources.web Web CPU/Memory resource requests/limits Memory: 1Gi, CPU: 200m
resources.engine Engine CPU/Memory resource requests/limits Memory: 512Mi, CPU: 200m
resources.queue Queue CPU/Memory resource requests/limits Memory: 128Mi, CPU: 100m
resources.websocket Websocket CPU/Memory resource requests/limits Memory: 256Mi, CPU: 100m
storage.reclaimPolicy Volume Reclaim Policy Delete
storage.useHostDir Allows to map data and database volumes to a directory on a node. Requires path parameters. false
storage.postgresql.class Storage class for PostgreSQL data. Ignored if host dir mapping is used. Nil
storage.postgresql.size PostgreSQL volume size 1Gi
storage.postgresql.path Absolute path where database data should be stored on host. Only required if useHostDir is enabled. Nil
storage.fmeserver.accessMode Access mode for FME Server data storage class. ReadWriteOnce
storage.fmeserver.class Storage class for FME Server data. Ignored if host dir mapping is used. Nil
storage.fmeserver.size FME Server data volume size 10Gi
storage.fmeserver.path Absolute path where FME Server data should be stored on host. Only required if useHostDir is enabled. Nil
fmeserver.engines An array of engine deployments. Each deployment defines a name, queues to join, number of replicas, and scheduling information.
fmeserver.engines[].name The name of this group of engines. default
fmeserver.engines[].engines The number of engines to deploy in this engine deployment. 2
fmeserver.engines[].queues The queues that the engines in this deployment should join. This is a comma delimited list of queues and optionally priorities for those queues of the form <QueueName>[:<QueuePriority>],<QueueName>[:<QueuePriority>],.... The default priority is 100. For example: Queue1:100,Queue2:200,Queue3:1 or Queue1,Queue4,Queue5 Default
fmeserver.engines[].affinity Affinity labels for pod assignment for this engine deployment {}
fmeserver.engines[].nodeSelector Map of nodeselector annotations to add to this engine deployment {}
fmeserver.engines[].tolerations Toleration labels for pod assignment for this engine deployment []
fmeserver.database.host The hostname of the Postgres database to use. Only set this if you are not using the included Postgres database The service DNS of the Postgresql database deployed with this chart
fmeserver.database.port The port of the Postgres database to use. 5432
fmeserver.database.name The database name for FME Server to use for its schema. fmeserver
fmeserver.database.user The database user for FME Server to use/create. fmeserver
fmeserver.database.password The database password for the fmeserver user. 4fmmsgrz09
fmeserver.database.passwordSecret Instead of specifying a database password in plaintext, specify an existing secret that contains the password to use.
fmeserver.database.passwordSecretKey The key in the above specified secret that contains the fmeserver database password. fmeserver-db-password
fmeserver.database.adminUser The admin database user for FME Server to use to create its schema in the database. postgres
fmeserver.database.adminPasswordSecret The name of the secret that contains the password of the admin user specified in fmeserver.database.adminUser Secret generated by the Postgresql chart
fmeserver.database.adminPasswordSecretKey The key in the specified fmeserver.database.adminPasswordSecret that contains the password for the admin user specified in fmeserver.database.adminUser postgresql-password
fmeserver.webserver.maxThreads Max threads the Tomcat webserver can use (more info here) 200
fmeserver.webserver.experimentalJavaFlags Enable Java support for Docker memory limits false
scheduling.core.affinity Affinity labels for pod assignment for Core pod {}
scheduling.core.nodeselector Map of nodeselector annotations to add to the Core pod {}
scheduling.core.tolerations Toleration labels for pod assignment for Core pod []
scheduling.queue.affinity Affinity labels for pod assignment for Queue pod {}
scheduling.queue.nodeselector Map of nodeselector annotations to add to the Queue pod {}
scheduling.queue.tolerations Toleration labels for pod assignment for Queue pod []
scheduling.websocket.affinity Affinity labels for pod assignment for Websocket pod {}
scheduling.websocket.nodeselector Map of nodeselector annotations to add to the Websocket pod {}
scheduling.websocket.tolerations Toleration labels for pod assignment for Websocket pod []
annotations.core.statefulset Annotations for the core statefulset {}
annotations.core.template Annotations for the core pod template {}
annotations.engine.deployment Annotations for the engine deployment {}
annotations.engine.template Annotations for the engine pod template {}
annotations.queue.statefulset Annotations for the queue statefulset {}
annotations.queue.template Annotations for the queue pod template {}
annotations.websocket.statefulset Annotations for the websocket statefulset {}
annotations.websocket.template Annotations for the websocket pod template {}

FME Server 2019.0.0

Configuration

The following table lists the configurable parameters of the FME Server 2019.0.0 chart and their default values.

Parameter Description Default
fmeserver.image.tag The docker image tag to use. Nil You must provide a tag. You can find available tags here.
fmeserver.image.pullPolicy Image pull policy IfNotPresent
fmeserver.image.registry Docker registry quay.io This parameter should not be changed.
fmeserver.image.namespace Docker registry namespace safesoftware This parameter should not be changed.
deployment.hostname FME Server hostname localhost
deployment.proxyReadTimeout Default proxy read timeout (in seconds) 60
deployment.proxyBodySize Default maximum allowed size of the request body 0
deployment.tlsSecretName Custom TLS certificate, see documentation for more details Nil
deployment.certManager.issuerName Cert Manager issuer name, see documentation for more details Nil
deployment.certManager.issuerType Can be cluster or namespace, ignored if no issuerName is provided. See documentation for more details cluster
deployment.numCores Number of cores to launch. Multi-core only works in a multi-host cluster with ReadWriteMany storage 1
deployment.numEngine Number of engines to launch. 2
deployment.startAsRoot Starts core container as root and grants the fmeserver user access to the file system. false
deployment.useHostnameIngress Configures the ingress to route traffic to FME Server only if the request matches the value of deployment.hostname. Setting this to false will route all traffic on the ingress to FME Server. true
deployment.deployPostgresql Deploy a Postgresql Database for FME Server to use. Set this to false if you have an existing database you would like FME Server to connect to. true
resources.core Core CPU/Memory resource requests/limits Memory: 1.5Gi, CPU: 200m
resources.web Web CPU/Memory resource requests/limits Memory: 1Gi, CPU: 200m
resources.engine Engine CPU/Memory resource requests/limits Memory: 512Mi, CPU: 200m
resources.queue Queue CPU/Memory resource requests/limits Memory: 128Mi, CPU: 100m
resources.websocket Websocket CPU/Memory resource requests/limits Memory: 256Mi, CPU: 100m
storage.reclaimPolicy Volume Reclaim Policy Delete
storage.useHostDir Allows to map data and database volumes to a directory on a node. Requires path parameters. false
storage.postgresql.class Storage class for PostgreSQL data. Ignored if host dir mapping is used. Nil
storage.postgresql.size PostgreSQL volume size 1Gi
storage.postgresql.path Absolute path where database data should be stored on host. Only required if useHostDir is enabled. Nil
storage.fmeserver.accessMode Access mode for FME Server data storage class. ReadWriteOnce
storage.fmeserver.class Storage class for FME Server data. Ignored if host dir mapping is used. Nil
storage.fmeserver.size FME Server data volume size 10Gi
storage.fmeserver.path Absolute path where FME Server data should be stored on host. Only required if useHostDir is enabled. Nil
fmeserver.database.host The hostname of the Postgres database to use. Only set this if you are not using the included Postgres database The service DNS of the Postgresql database deployed with this chart
fmeserver.database.port The port of the Postgres database to use. 5432
fmeserver.database.name The database name for FME Server to use for its schema. fmeserver
fmeserver.database.user The database user for FME Server to use/create. fmeserver
fmeserver.database.password The database password for the fmeserver user. 4fmmsgrz09
fmeserver.database.passwordSecret Instead of specifying a database password in plaintext, specify an existing secret that contains the password to use.
fmeserver.database.passwordSecretKey The key in the above specified secret that contains the fmeserver database password. fmeserver-db-password
fmeserver.database.adminUser The admin database user for FME Server to use to create its schema in the database. postgres
fmeserver.database.adminPasswordSecret The name of the secret that contains the password of the admin user specified in fmeserver.database.adminUser Secret generated by the Postgresql chart
fmeserver.database.adminPasswordSecretKey The key in the specified fmeserver.database.adminPasswordSecret that contains the password for the admin user specified in fmeserver.database.adminUser postgresql-password
fmeserver.webserver.maxThreads Max threads the Tomcat webserver can use (more info here) 200
fmeserver.webserver.experimentalJavaFlags Enable Java support for Docker memory limits false

Development

Run unit tests

  1. helm plugin install https://github.com/lrills/helm-unittest
  2. helm unittest <path/to/chart/source>
You can’t perform that action at this time.