Squirro Minimal Container Image

Squirro Minimal Container Image#

Squirro minmial is, as the name suggests, a minimal container image that can be used for testing and development purposes as well for very minimal production deployments.

Its main purpose 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 to get feedback from our customers.

The image is based on Amazon Linux 2023 which is a hardened and secure base image.

Get the Image#

Head over to the Squirro Container Registry at. You will need a login on id.squirro.com to access the registry.

At the time of writing, we only provide access to the registry to selected customers and partners. If you are interested in getting access, please contact us at support@squirro.com.

Once you have access to the registry, click the ‘List Tags’ button for squirro/minimal. It will show you the available tags for the image and instructions on how to pull the image.

Supported Architectures#

We currently provide the image for the following architectures:

  • amd64/x86_64 (Intel/AMD)

  • arm64/aarch64 (Apple Sillcon, AWS Graviton, etc.)

Please consider the arm64/aarch64 image as experimental at this point, as we are still working on putting the automated build process in place.

Requirements#

At the time of writing, the image is only tested with Docker and Docker Compose. We will support Kubernetes and other container orchestration tools in the very near future.

The following other images are required to run Squirro Minimal:

  • Elasticsearch (see further below)

  • Redis

  • PostgreSQL

In cloud deployments, we recommend using managed services for Redis and PostgeSQL.

The docker-compose file provided on the Squirro Container Registry contains the necessary configuration to run Squirro Minimal with the required services.

Secrets and Configuration#

The Squirro Minimal image requires a few secrets and configuration values to be provided as environment variables/secret files.

See Container Reference for a list of all 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 contains a link to the docker-compose file that can be used to run Squirro Minimal.

The docker-compose file contains the necessary configuration to run Squirro Minimal with the required services. It will also contain randomly generated secrets. We do not retain these secrets in any way, yet we recommend changing them to your own unique secrets.

The Squirro Elasticsearch image#

We also provide a minimal Elasticsearch image that can be used 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 Squirro.

  • 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 Squirro

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

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