Snorkel Flow Configuration Reference
Snorkel Flow installation has many configuration options that can be set in your bootstrapping file.
After generating a config file in Generate a Snorkel Flow config, these additional features can be configured before moving to Install Snorkel Flow to meet the requirements of your environment.
| Key | Required | Value Type | Description |
|---|---|---|---|
| version | Yes | string | Snorkel Flow version (e.g. 0.52.20-cuda) |
| project_name | Yes | string | Name of the docker-compose project (use "snorkelflow") |
| domain | No | string | Kubernetes only: The top-level domain for Kubernetes ingress generation, sub-domains will be generated following the convention {project_name}-{service}.{domain}. |
| send_metrics_to_remote | No | boolean | If enabled, telemetry data will be sent to Grafana cloud as well as InfluxDB in the local cluster. When enabled, Snorkel engineers will be more able to observe your installation and debug problems remotely. |
| pagerduty_key | No | string | string If set, this is the API integration key that Grafana will use as its default notification channel. This can be used to respond quickly to issues that might be occurring in Snorkel Flow. |
| host_ip | Yes | string | IP address or host name where Snorkel Flow will be served from (e.g. 10.1.0.21 or snorkel.example.com) |
| work_directory | Yes | string | Absolute path of the work directory where configuration files will be stored. |
| mount_directory | Yes | string | Absolute path of the mount directory. Data in this directory can be ingested directly by the platform. |
| platform | No | string | Container platform. Options: "docker", "podman", "k8s" |
| podman | No | map | Additional options for Podman. Optional keys: "infra_image" (name of the desired infra image) |
| image_name_suffix | No | string | Suffix to append to all image names |
| docker_groups | No | list | Supplementary groups to run the container processes as. Snorkel Flow will be able to access files for which these groups have permissions. See https://docs.docker.com/engine/reference/run/#additional-groups |
| ui_ingress_port | No | int | Ingress port for the web UI |
| tdm_api_ingress_port | No | int | Ingress port for the TDM API |
| engine_notebook_port | No | int | Ingress port for the in-platform Notebook server |
| minio_ingress_port | No | int | Ingress port for the MinIO web UI |
| banner_text | No | string | Custom text to display in the banner on all pages of the web UI |
| set_memory_limits | No | boolean | Whether to set automatically-calculated memory limits based on the host machine. Only applicable if platform is set to "docker" or "podman". Consult with Snorkel support before enabling. |
| tls | No | map | Configuration options for TLS. See “TLS Configuration Options” table below for options. |
TLS Configuration Options
| Key | Required | Value Type | Description |
|---|---|---|---|
| key_pem_path | No | string | A path to a file containing a private key that will be used to secure connections to the Snorkel platform. All services included in the Snorkel platform will be proxied by an Envoy instance using this key on different ports. Defaults to a key and Snorkel-issued self-signed certificate. |
| cert_pem_path | No | string | A path to a file containing a certificate that will be presented to clients connecting the Snorkel platform. All services included in the Snorkel platform will use this certificate on different ports. Defaults to a Snorkel-issued self-signed certificate. Note: it is strongly recommended that you issue and configure your own certificate that matches any hostname you set up for Snorkel Flow to ensure a secure connection. |