aosan/redis-stack

A Redis server with additional database capabilities powered by Redis modules.

redis-stack

This repository builds redis, and downloads various components (modules, RedisInsight) in order to build redis-stack packages for it's CI process.

Homebrew Recipe | Helm Charts | Docker images | Other downloads

---

Quick start

Start a docker docker run redis/redis-stack:latest

Start a docker with the custom password foo docker run -e REDIS_ARGS="--requirepass foo" redis/redis-stack:latest

Start a docker with both custom redis arguments and a search configuration docker run -e REDIS_ARGS="--requirepass foo" -e REDISEARCH_ARGS="MAXSEARCHRESULTS 5" redis/redis-stack:latest

From a locally installed package: start a redis stack with custom search results and passwords

REDISEARCH_ARGS="MAXSEARCHRESULTS 5" redis-stack-server --requirepass foo

---

Code contributions

Please see the CONTRIBUTING.md file in this source distribution for more information. For security bugs and vulnerabilities, please see SECURITY.md.

---

Development Requirements

• Python > 3.10 (for this toolkit) and poetry
• Ruby > 2.7 (for fpm)
• Docker (to build a docker)
• zip/apt/deb/tar depending on your target outputs.

Building

1. Create a virtualenv and install dependencies poetry install

2. Install the fpm gem: gem install fpm

   • Based on your Linux distribution you may need to install a debian tools package (i.e something providing dpkg), something to provide zip, tar, and rpm package tools.

3. Clone redis if you're developing changes to the redis builds.

4. Use invoke -l to list, and then execute the various tasks you need (below, an example on packaging).

To build a focal package

invoke package -o Linux -p redis-stack-server -s ubuntu20.04 -t deb -d focal

To build a xenial package

invoke package -o Linux -p redis-stack-server -s ubuntu16.04 -t deb -d xenial

To build a macos (x86_64) zip, prior to homebrew

invoke package -o macos -p redis-stack-server -s catalina -t zip -d catalina

To build a macos (m1) zip, prior to homebrew

invoke package -o macos -p redis-stack-server -s monterey -t zip -d monterey -a arm64

For more examples, see github workflows for how CI reuses invoke.

Packaging

Invoke wraps fpm, in order to provide a unified packaging interface on top of fpm. The script assemble.py provides support for building each target package. To do so, you will need to execute packaging on the target operating system.

While it's possible to build all Linux packages on Arch or Ubuntu, OSX packages must be built on a Mac.

Testing

Tests are run via pytest. Linux tests create and destroy dockers, validating their contents. In order to validate the individual packages (i.e foo.rpm), packages be built, via invoke, then copied to a folder called redis-stack and renamed, so as not to include the version number.

For example to test redis-stack-server-99.99.99-1.x86_64.rpm:

mkdir redis-stack
cp *redis-stack-server-99.99.99-1.x86_64.deb* redis-stack/redis-stack-server.deb
pytest tests/smoketest/test_debs.py::TestXenial

For the various pytest markers, see the pyproject.toml

---

Releasing

1. To make a release, use the GitHub release drafter. By creating a tag, in the release drafter, a release is made. Versions are taken from the config.yaml.

   The process of releasing copies existing built artifacts (dockers, rpms, snaps, etc) from the snapshot directories, and re-uploading them to the root s3 folder (s3://redismodules/redis-stack/). No compilation or testing of releases occur, as that has already happened as part of the continuous integration process. As of this writing, this repository releases the dockers as well.

The following steps only apply to non-prerelease, releases. As of this writing only a single package version can be released for the following installation methods.

2. Tag the rpm repository and wait for the publish action to complete.
   1. This repository cannot release multiple versions simultaneously. This means that each release must wait for the outcome of the previous release's output tasks.
3. Tag the debian repository and wait for and wait for the publish action to complete.
4. Update homebrew with the latest version of redis-stack
   1. Note that if RedisInsight is being upgraded, it too needs to be edited in that pull request,
   2. Merge to master. There are no tags for this repository.
5. Update the helm charts with the latest version of redis-stack
   1. After the pull request, create a release, using the release drafter.

---

Modifying service initializations

Today, to modify the way a service starts, the following files all need editing:

• entrypoint.sh (for dockers)
• snapcraft.j2 (for ubuntu snaps)
• etc/services/ (for systemd services on Linux)

Changing package versions and sources

Versions for all packages are defined in the config.yaml file, and within a function named generate_url for each source type. In the case where you need to test a package that has been built to a custom location, set a variable named -url-override in the config file at the top level. For example, to override the rejson package location create a variable named rejson-url-override. In the case of RedisInsight, all packages would derive from redisinsight-url-override.

Do not commit this change to a mainline branch.

---

Signed Binaries

The following redis-stack builds are currently signed using the Redis GPG key. The public key can be downloaded from here.

1. Debian archives (deb files) - The indivial packages themselves are signed, as is the debian archive respository. Repository signing can be found in the debian tagging repository. Adding the apt repository includes importing, and validating the GPG key.

2. RedHat packages (rpm files) - The indivial packages themselves are signed. Adding the rpm repository includes importing, and validating the GPG key.

3. All binaries within OSX zip files are code-signed using Redis' code-signing certificates. Validation is handled by the operating system.

4. Tarballs generated by redis-stack, are GPG signed.