Aerospike docs were significantly out of date #2575
+246
−100
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yosifkit
reviewed
May 22, 2025
Comment on lines
+9
to
+32
| - [Getting Started](#getting-started) | ||
| - [Version Tags](#version-tags) | ||
| - [Running an Aerospike Server node](#running-an-aerospike-server-node) | ||
| - [Enterprise Edition](#enterprise-edition) | ||
| - [Community Edition](#community-edition) | ||
| - [Connecting to your Aerospike Container](#connecting-to-your-aerospike-container) | ||
| - [Using aql](#using-aql) | ||
| - [Using asadm](#using-asadm) | ||
| - [Customizing the Default Developer nvironment](#customizing-the-default-developer-template) | ||
| - [List of template variables](#list-of-template-variables) | ||
| - [Preconfigured namespace](#preconfigured-namespace) | ||
| - [Advanced Configuration](#advanced-configuration) | ||
| - [Persistent data directory](#persistent-data-directory) | ||
| - [Block storage](#block-storage) | ||
| - [Persistent Lua cache](#persistent-lua-cache) | ||
| - [A note about security](#a-note-about-security) | ||
| - [Networking](#networking) | ||
| - [Configuring the node's access address](#configuring-the-nodes-access-address) | ||
| - [Mesh clustering](#mesh-clustering) | ||
| - [Sending telemetry data to Aerospike](#sending-telemetry-data-to-aerospike) | ||
| - [Image Versions](#image-versions) | ||
| - [Reporting Issues](#reporting-issues) | ||
| - [License](#license) | ||
|
|
There was a problem hiding this comment.
These links to headers are unfortunately not supported by Docker Hub, which is what this documentation is created for. If they were supported, we'd want to be able to generate a table of contents in README.md for every image, rather than it being a one off.
| FEATKEY=$(base64 ~/Desktop/evaluation-features.conf) | ||
| docker run -d -e "FEATURES=$FEATKEY" -e "FEATURE_KEY_FILE=env-b64:FEATURES" --name aerospike -p 3000-3002:3000-3002 %%IMAGE%%:ee-[version] | ||
| docker run -d -e "FEATURES=$FEATKEY" -e "FEATURE_KEY_FILE=env-b64:FEATURES" --name aerospike -p 3000-3002:3000-3002 aerospike:ee-[version] |
There was a problem hiding this comment.
Suggested change
| docker run -d -e "FEATURES=$FEATKEY" -e "FEATURE_KEY_FILE=env-b64:FEATURES" --name aerospike -p 3000-3002:3000-3002 aerospike:ee-[version] | |
| docker run -d -e "FEATURES=$FEATKEY" -e "FEATURE_KEY_FILE=env-b64:FEATURES" --name aerospike -p 3000-3002:3000-3002 %%IMAGE%%:ee-[version] |
Anywhere that is referring to the Docker Hub image name should use %%IMAGE%% so that on the view on an arch-specific page will correctly refer to [arch]/aerospike (like arm64v8/aerospike).
|
|
||
| ### Running a node with a feature key file in an environment variable | ||
| ```sh | ||
| docker run -d -v DIR:/opt/aerospike/etc/ -e "FEATURE_KEY_FILE=/opt/aerospike/etc/features.conf" --name aerospike -p 3000-3002:3000-3002 aerospike:ee-[version] |
There was a problem hiding this comment.
Suggested change
| docker run -d -v DIR:/opt/aerospike/etc/ -e "FEATURE_KEY_FILE=/opt/aerospike/etc/features.conf" --name aerospike -p 3000-3002:3000-3002 aerospike:ee-[version] | |
| docker run -d -v DIR:/opt/aerospike/etc/ -e "FEATURE_KEY_FILE=/opt/aerospike/etc/features.conf" --name aerospike -p 3000-3002:3000-3002 %%IMAGE%%:ee-[version] |
| Running Aerospike Community Edition: | ||
|
|
||
| ```sh | ||
| docker run -d --name aerospike -p 3000-3002:3000-3002 aerospike:ce-[version] |
There was a problem hiding this comment.
Suggested change
| docker run -d --name aerospike -p 3000-3002:3000-3002 aerospike:ce-[version] | |
| docker run -d --name aerospike -p 3000-3002:3000-3002 %%IMAGE%%:ce-[version] |
|
|
||
| The Aerospike Docker image has a default configuration file template that can be populated with individual configuration parameters, as we did before with `FEATURE_KEY_FILE`. Alternatively, it can be replaced with a custom configuration file. | ||
| ```sh | ||
| docker run -ti aerospike/aerospike-tools:latest asadm -h $(docker inspect -f '{{.NetworkSettings.IPAddress }}' aerospike) |
There was a problem hiding this comment.
asadm is in the regular image though, so it could us that instead of the tools image?
Suggested change
| docker run -ti aerospike/aerospike-tools:latest asadm -h $(docker inspect -f '{{.NetworkSettings.IPAddress }}' aerospike) | |
| docker run -ti %%IMAGE%%:ce-[version] asadm -h $(docker inspect -f '{{.NetworkSettings.IPAddress }}' aerospike) |
| ```console | ||
| docker run -d -v /opt/aerospike/data:/opt/aerospike/data -v /opt/aerospike/etc:/opt/aerospike/etc/ --name aerospike -p 3000-3002:3000-3002 -e "FEATURE_KEY_FILE=/opt/aerospike/etc/features.conf" %%IMAGE%%:ee-[version] | ||
| ```sh | ||
| docker run -d -v /opt/aerospike/data:/opt/aerospike/data -v /opt/aerospike/etc:/opt/aerospike/etc/ --name aerospike -p 3000-3002:3000-3002 -e "FEATURE_KEY_FILE=/opt/aerospike/etc/features.conf" aerospike/aerospike-server-enterprise |
There was a problem hiding this comment.
Suggested change
| docker run -d -v /opt/aerospike/data:/opt/aerospike/data -v /opt/aerospike/etc:/opt/aerospike/etc/ --name aerospike -p 3000-3002:3000-3002 -e "FEATURE_KEY_FILE=/opt/aerospike/etc/features.conf" aerospike/aerospike-server-enterprise | |
| docker run -d -v /opt/aerospike/data:/opt/aerospike/data -v /opt/aerospike/etc:/opt/aerospike/etc/ --name aerospike -p 3000-3002:3000-3002 -e "FEATURE_KEY_FILE=/opt/aerospike/etc/features.conf" %%IMAGE%%:ee-[version] |
I'm not sure why these are changing. Is there something about the aerospike/aerospike-server-enterprise image that isn't available in the aerospike:ee-[version] image?
| ```console | ||
| docker run -d -v /opt/aerospike/data:/opt/aerospike/data -v /opt/aerospike/etc/:/opt/aerospike/etc/ --name aerospike -p 3000-3002:3000-3002 %%IMAGE%%:ee-[version] --config-file /opt/aerospike/etc/aerospike.conf | ||
| ```sh | ||
| docker run -d -v /opt/aerospike/data:/opt/aerospike/data -v /opt/aerospike/etc/:/opt/aerospike/etc/ --name aerospike -p 3000-3002:3000-3002 --config-file /opt/aerospike/etc/aerospike.conf aerospike/aerospike-server-enterprise |
There was a problem hiding this comment.
Suggested change
| docker run -d -v /opt/aerospike/data:/opt/aerospike/data -v /opt/aerospike/etc/:/opt/aerospike/etc/ --name aerospike -p 3000-3002:3000-3002 --config-file /opt/aerospike/etc/aerospike.conf aerospike/aerospike-server-enterprise | |
| docker run -d -v /opt/aerospike/data:/opt/aerospike/data -v /opt/aerospike/etc/:/opt/aerospike/etc/ --name aerospike -p 3000-3002:3000-3002 %%IMAGE%%:ee-[version] --config-file /opt/aerospike/etc/aerospike.conf |
| ```console | ||
| docker run -d --device '/dev/sdc:/dev/xvdc' -v /opt/aerospike/etc/:/opt/aerospike/etc/ --name aerospike -p 3000-3002:3000-3002 %%IMAGE%%:ee-[version] --config-file /opt/aerospike/etc/aerospike.conf | ||
| ```sh | ||
| docker run -d --device '/dev/sdc:/dev/xvdc' -v /opt/aerospike/etc/:/opt/aerospike/etc/ --name aerospike -p 3000-3002:3000-3002 --config-file /opt/aerospike/etc/aerospike.conf aerospike/aerospike-server-enterprise |
There was a problem hiding this comment.
Suggested change
| docker run -d --device '/dev/sdc:/dev/xvdc' -v /opt/aerospike/etc/:/opt/aerospike/etc/ --name aerospike -p 3000-3002:3000-3002 --config-file /opt/aerospike/etc/aerospike.conf aerospike/aerospike-server-enterprise | |
| docker run -d --device '/dev/sdc:/dev/xvdc' -v /opt/aerospike/etc/:/opt/aerospike/etc/ --name aerospike -p 3000-3002:3000-3002 %%IMAGE%%:ee-[version] --config-file /opt/aerospike/etc/aerospike.conf |
|
|
||
| ```sh | ||
| docker run -d -v /opt/aerospike/lua:/opt/aerospike/usr/udf/lua -v /opt/aerospike/data:/opt/aerospike/data --name aerospike -p 3000-3002:3000-3002 -e "FEATURE_KEY_FILE=/opt/etc/aerospike/features.conf" %%IMAGE%%:ee-[version] | ||
| docker run -d -v /opt/aerospike/lua:/opt/aerospike/usr/udf/lua -v /opt/aerospike/data:/opt/aerospike/data --name aerospike -p 3000-3002:3000-3002 --config-file /opt/aerospike/etc/aerospike.conf aerospike/aerospike-server-enterprise |
There was a problem hiding this comment.
Suggested change
| docker run -d -v /opt/aerospike/lua:/opt/aerospike/usr/udf/lua -v /opt/aerospike/data:/opt/aerospike/data --name aerospike -p 3000-3002:3000-3002 --config-file /opt/aerospike/etc/aerospike.conf aerospike/aerospike-server-enterprise | |
| docker run -d -v /opt/aerospike/lua:/opt/aerospike/usr/udf/lua -v /opt/aerospike/data:/opt/aerospike/data --name aerospike -p 3000-3002:3000-3002 %%IMAGE%%:ee-[version] --config-file /opt/aerospike/etc/aerospike.conf |
|
|
||
| These tags are for Aerospike CE images, and do not require a feature key file to start. As mentioned above, the developer API for both is the same, but the editions differ in operational features. | ||
| These images are based on [debian:*-slim](https://hub.docker.com/_/debian). |
There was a problem hiding this comment.
Both ce-* and ee-* use Ubuntu 24.04 as the base.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.