Squirro Minimal Container Image

Squirro Minimal Container Image#

Squirro Minimal is, as the name suggests, a minimal container image you can use for testing, development purposes, and very minimal production deployments. Its main objective is to provide a quick and easy way to get started with Squirro in a containerized environment. It also serves as a test bed for us to test and develop our container images and get customer feedback. The image is based on Amazon Linux 2023, a hardened and secure base image.

Get the Image#

Navigate to the Squirro Container Registry and click the List Tags button for squirro/minimal. It shows you the available tags for the image and instructions on how to pull the image.

Currently, only selected customers and partners have access to the registry. To request access, create a Squirro ID, and then contact Squirro Support using a technical support request.

Supported Architectures#

Squirro currently provides the image for the following architectures:

  • amd64/x86_64 (Intel/AMD)

  • arm64/aarch64 (like Apple Silicon or AWS Graviton)

Note that the arm64/aarch64 image is currently considered experimental.

Requirements#

The image is only tested with Docker and Docker Compose. Plans are in place to support Kubernetes and other container orchestration tools in the near future.

The following other images are required to run Squirro Minimal:

  • Elasticsearch (see further below)

  • Redis

  • PostgreSQL

In cloud deployments, Squirro recommends using managed services for Redis and PostgreSQL.

The Compose file on the Squirro Container Registry website contains the necessary configuration to run Squirro Minimal with the required services.

Secrets and Configuration#

The system requires a few secrets and configuration values as environment variables or secret files for the Squirro Minimal image.

See Container Reference for a list of all the environment variables and secrets required.

Deploying Squirro Minimal using Docker Compose#

For the latest and most up-to-date instructions, each tag listed on the Squirro Container Registry website contains a link to the Compose file you can use to run Squirro Minimal.

The Compose file contains the necessary configuration to run Squirro Minimal with the required services and randomly generated secrets. Squirro strongly recommends changing them to your own unique and secure values.

The Squirro Elasticsearch Image#

Squirro provides a minimal Elasticsearch image you can use in conjunction with the Squirro minimal image.

The Elasticsearch image is based on the official Elasticsearch image but with some modifications to make it work better with the Squirro platform.

  • The image is based on Amazon Linux 2023.

  • The image is configured to run as a non-privileged user with user ID 44040.

  • The image is configured to run in read-only mode.

  • The image is preconfigured with the necessary plugins for the Squirro platform.

While we recommend using the Squirro Elasticsearch image, you can also use the official Elasticsearch image. However, you need to modify the configuration to make it work with the Squirro platform.

Known Issues and Missing Features#

  • Automated Integration Tests

  • SSL/TLS support for Elasticsearch

  • SSL/TLS support for PostgreSQL

  • SSL/TLS support for Redis

  • Support for MariaDB

  • Practical guidelines and examples for running in development and production

  • Support for automatic bootstrapping with passwords and API tokens

  • Support for automatic bootstrapping with project templates

  • Automated Build Process for arm64/aarch64

  • Support for Kubernetes, AWS ECS, EKS, and Fargate

  • And much more, stay tuned for updates

Contents