From 66ebe5739d3d9d2160e6af021e531d3ba0035f55 Mon Sep 17 00:00:00 2001 From: Kevin Porter Date: Tue, 3 Jan 2023 14:23:08 -0800 Subject: [PATCH 01/10] Update aerospike readme. --- aerospike/README-short.txt | 3 +- aerospike/content.md | 416 ++++++++++++++++++++++++++++--------- aerospike/github-repo | 2 +- aerospike/issues.md | 3 +- aerospike/license.md | 14 +- 5 files changed, 333 insertions(+), 105 deletions(-) diff --git a/aerospike/README-short.txt b/aerospike/README-short.txt index acf36bac8fd1..51a651a07810 100644 --- a/aerospike/README-short.txt +++ b/aerospike/README-short.txt @@ -1 +1,2 @@ -Aerospike – the reliable, high performance, distributed database optimized for flash and RAM. +Aerospike – the reliable, high performance, distributed database optimized for +flash and RAM. diff --git a/aerospike/content.md b/aerospike/content.md index 35650ff23744..f13246a39940 100644 --- a/aerospike/content.md +++ b/aerospike/content.md @@ -2,174 +2,389 @@ ## What is Aerospike? -[Aerospike](http://aerospike.com) is a distributed NoSQL database purposefully designed for high performance web scale applications. Aerospike supports key-value and document data models, and has multiple data types including List, Map, HyperLogLog, GeoJSON, and Blob. Aerospike's patented hybrid memory architecture delivers predictable high performance at scale and high data density per node. +[Aerospike](http://aerospike.com) is a distributed NoSQL database purposefully +designed for high performance applications. Aerospike supports key-value and +document data models, and has multiple data types including List, Map, +HyperLogLog, GeoJSON, and Blob. Aerospike's patented hybrid memory architecture +delivers predictable high performance at scale and high data density per node. %%LOGO%% +* [Getting Started](#getting-started) + * [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 Environment](#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) +* [Sending Performance Data to Aerospike](#sending-performance-data-to-aerospike) + * [Mesh clustering](#mesh-clustering) +* [Image Versions](#image-versions) + * [ee-[version]](#ee-version) + * [ce-[version]](#ce-verions) +* [Reporting Issues](#reporting-issues) +* [License](#license) + ## Getting Started -Aerospike Enterprise Edition requires a feature key file to start and to ungate certain features in the database, such as compression. Enterprise customers can use their production or development keys. +Aerospike Database Community Edition (CE) supports the same developer APIs as +Aerospike Database Enterprise Edition (EE), except for durable deletes. They +differ in ease of operation and [enterprise features](https://aerospike.com/products/features-and-editions/) +, such as compression. -Anyone can [sign up](https://www.aerospike.com/lp/try-now/) to get an evaluation feature key file for a full-featured, single-node Aerospike Enterprise Edition. +Since server version 6.1, Aerospike EE starts in a single-node cluster +evaluation mode, with all its enterprise features available. -Aerospike Community Edition supports the same developer APIs as Aerospike Enterprise Edition, and differs in ease of operation and enterprise features. See the [product matrix](https://www.aerospike.com/products/product-matrix/) for more. +### Running an Aerospike Server node -### Running an Aerospike EE node with a feature key file in a mapped directory +#### Enterprise Edition -```console -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] +By using Aerospike Enterprise Edition you agree to the [ENTERPRISE_LICENSE](enterprise/ENTERPRISE_LICENSE). + +```sh +docker run -d --name aerospike -p 3000-3002:3000-3002 %%IMAGE%%:ee-[version] ``` -Above, *DIR* is a directory on your machine where you drop your feature key file. Make sure Docker Desktop has file sharing permission to bind mount it into Docker containers. +Running Enterprise Edition with a feature key file in a mapped directory: + +```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 %%IMAGE%%:ee-[version] +``` -### Running an Aerospike EE node with a feature key file in a mapped directory +Running Enterprise Edition with a feature key file in an environment variable: -```console -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] +```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 %%IMAGE%%:ee-[version] ``` -### Running an Aerospike CE node +Above, _DIR_ is a directory on your machine where you drop your feature +key file. Make sure Docker Desktop has file sharing permission to bind mount it +into Docker containers. + +#### Community Edition + +By using Aerospike Community Edition you agree to the [COMMUNITY_LICENSE](community/COMMUNITY_LICENSE). -```console +Running Aerospike Community Edition: + +```sh docker run -d --name aerospike -p 3000-3002:3000-3002 %%IMAGE%%:ce-[version] ``` -## Advanced Configuration +## Connecting to your Aerospike Container -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. +You can use the latest aerospike-tools image to connect to your Aerospike +container. -The following sections describe both advanced options. +### Using aql -### Injecting configuration parameters +```sh +docker run -ti aerospike/aerospike-tools:latest aql -h $(docker inspect -f '{{.NetworkSettings.IPAddress }}' aerospike) + +Seed: 172.17.0.2 +User: None +Config File: /etc/aerospike/astools.conf /root/.aerospike/astools.conf +Aerospike Query Client +Version 7.0.4 +C Client Version 6.0.0 +Copyright 2012-2021 Aerospike. All rights reserved. +aql> show namespaces ++------------+ +| namespaces | ++------------+ +| "test" | ++------------+ +[172.17.0.2:3000] 1 row in set (0.002 secs) + +OK + +aql> +``` + +### Using asadm + +```sh +docker run -ti aerospike/aerospike-tools:latest asadm -h $(docker inspect -f '{{.NetworkSettings.IPAddress }}' aerospike) + +Seed: [('172.17.0.2', 3000, None)] +Config_file: /root/.aerospike/astools.conf, /etc/aerospike/astools.conf +Aerospike Interactive Shell, version 2.10.0 + +Found 1 nodes +Online: 172.17.0.2:3000 + +Admin> info +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~Network Information (2022-11-01 00:48:05 UTC)~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Node| Node ID| IP| Build|Migrations|~~~~~~~~~~~~~~~~~~Cluster~~~~~~~~~~~~~~~~~~|Client| Uptime + | | | | |Size| Key|Integrity| Principal| Conns| +172.17.0.2:3000|*BB9020011AC4202|172.17.0.2:3000|E-6.1.0.3| 0.000 | 1|19E628721D9A|True |BB9020011AC4202| 8|00:02:09 +Number of rows: 1 + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~Namespace Usage Information (2022-11-01 00:48:05 UTC)~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Namespace| Node| Total|Expirations|Evictions| Stop|~~~~~~~~~~Device~~~~~~~~~~|~~~~~~~~~~Memory~~~~~~~~~|~Primary~ + | |Records| | |Writes| Used|Used%|HWM%|Avail%| Used|Used%|HWM%|Stop%|~~Index~~ + | | | | | | | | | | | | | | Type +test |172.17.0.2:3000|0.000 | 0.000 | 0.000 |False |0.000 B | 0.0| 0| 99|0.000 B | 0.0| 0| 90|shmem +test | |0.000 | 0.000 | 0.000 | |0.000 B | 0.0| | |0.000 B | 0.0| | | +Number of rows: 1 + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~Namespace Object Information (2022-11-01 00:48:05 UTC)~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Namespace| Node|Rack| Repl| Total|~~~~~~~~~~Objects~~~~~~~~~~|~~~~~~~~~Tombstones~~~~~~~~|~~~~Pending~~~~ + | | ID|Factor|Records| Master| Prole|Non-Replica| Master| Prole|Non-Replica|~~~~Migrates~~~ + | | | | | | | | | | | Tx| Rx +test |172.17.0.2:3000| 0| 1|0.000 |0.000 |0.000 | 0.000 |0.000 |0.000 | 0.000 |0.000 |0.000 +test | | | |0.000 |0.000 |0.000 | 0.000 |0.000 |0.000 | 0.000 |0.000 |0.000 +Number of rows: 1 + +Admin> +``` + +## Customizing the Default Developer Environment + +The Aerospike Docker image comes with a default configuration file, which sets +up a single node, single namespace developer environment. Alternatively, you can +provide your own configuration file (see below). -You can inject parameters into the configuration template using container-side environment variables with the `-e` flag. +You can inject parameters into the default configuration template using +container-side environment variables with the `-e` flag. -For example, to set the default [namespace](https://www.aerospike.com/docs/architecture/data-model.html) name to *demo*: +For example, to set the default [namespace](https://docs.aerospike.com/server/architecture/data-model) +name to _demo_: -```console +```sh docker run -d --name aerospike -e "NAMESPACE=demo" -p 3000-3002:3000-3002 -v /my/dir:/opt/aerospike/etc/ -e "FEATURE_KEY_FILE=/opt/aerospike/etc/features.conf" %%IMAGE%%:ee-[version] ``` -Injecting configuration parameters into the configuration template isn't compatible with using a custom configuration file. You can use one or the other. +Injecting configuration parameters into the configuration template isn't +compatible with providing a configuration file. You can use one or the other. + +### List of template variables + +#### `FEATURE_KEY_FILE` + +The [`feature_key_file`](https://docs.aerospike.com/server/operations/configure/feature-key). +of the `service` context which is only applicable and to Enterprise editions and +must be set to the empty string when running the Community edition. +Default: _/etc/aerospike/features.conf_. + +#### `LOGFILE` + +The [`file`](https://docs.aerospike.com/reference/configuration#file) param of +the `logging` context. Default: _""_, do not log to file. The container will +also log to `stdout`` regardless of what is configured here. + +#### `SERVICE_ADDRESS` -#### List of template variables +The bind [`address`](https://docs.aerospike.com/reference/configuration#address) +of the `networking.service` subcontext. Default: _any_ -- `FEATURE_KEY_FILE` - the [`feature_key_file`](https://www.aerospike.com/docs/reference/configuration/index.html#feature-key-file) is only required for the EE image. Default: /etc/aerospike/features.conf -- `SERVICE_THREADS` - the [`service_threads`](https://www.aerospike.com/docs/reference/configuration/index.html#service-threads). Default: Number of vCPUs -- `LOGFILE` - the [`file`](https://www.aerospike.com/docs/reference/configuration/index.html#file) param of the `logging` context. Default: /dev/null, do not log to file, log to stdout -- `SERVICE_ADDRESS` - the bind [`address`](https://www.aerospike.com/docs/reference/configuration/index.html#address) of the `networking.service` subcontext. Default: any -- `SERVICE_PORT` - the [`port`](https://www.aerospike.com/docs/reference/configuration/index.html#port) of the `networking.service` subcontext. Default: 3000 -- `HB_ADDRESS` - the `networking.heartbeat` [`address`](https://www.aerospike.com/docs/reference/configuration/index.html#address) for cross cluster mesh. Default: any -- `HB_PORT` - the [`port`](https://www.aerospike.com/docs/reference/configuration/index.html#port) for `networking.heartbeat` communications. Default: 3002 -- `FABRIC_ADDRESS` - the [`address`](https://www.aerospike.com/docs/reference/configuration/index.html#address) of the `networking.fabric` subcontext. Default: any -- `FABRIC_PORT` - the [`port`](https://www.aerospike.com/docs/reference/configuration/index.html#port) of the `networking.fabric` subcontext. Default: 3001 +#### `SERVICE_PORT` -The single preconfigured namespace is [in-memory with filesystem persistence](https://www.aerospike.com/docs/operations/configure/namespace/storage/#recipe-for-a-hdd-storage-engine-with-data-in-index-engine) +The [`port`](https://docs.aerospike.com/reference/configuration#port) of the +`networking.service` subcontext. Default: _3000_ -- `NAMESPACE` - the name of the namespace. Default: test -- `REPL_FACTOR` - the namespace [`replication-factor`](https://www.aerospike.com/docs/reference/configuration/index.html#replication-factor). Default: 2 -- `MEM_GB` - the namespace [`memory-size`](https://www.aerospike.com/docs/reference/configuration/index.html#memory-size). Default: 1, the unit is always `G` (GB) -- `DEFAULT_TTL` - the namespace [`default-ttl`](https://www.aerospike.com/docs/reference/configuration/index.html#default-ttl). Default: 30d -- `STORAGE_GB` - the namespace persistence `file` size. Default: 4, the unit is always `G` (GB) -- `NSUP_PERIOD` - the namespace [`nsup-period`](https://www.aerospike.com/docs/reference/configuration/index.html#nsup-period). Default: 120 , nsup-period in seconds +### Preconfigured namespace -### Using a custom configuration file +The single preconfigured namespace has the following variables: -You can override the use of the configuration file template by providing your own aerospike.conf, as described in [Configuring Aerospike Database](https://www.aerospike.com/docs/operations/configure/index.html). +#### `NAMESPACE` -You should first `-v` map a local directory, which Docker will bind mount. Next, drop your aerospike.conf file into this directory. Finally, use the `--config-file` option to tell Aerospike where in the container the configuration file is (the default path is /etc/aerospike/aerospike.conf). Remember that the feature key file is required, so use `feature-key-file` in your config file to point to a mounted path (such as /opt/aerospike/etc/feature.conf). +The name of the namespace. Default: _test_ + +#### `DATA_IN_MEMORY` + +The storage-engine [`data-in-memory`](https://docs.aerospike.com/reference/configuration#data-in-memory) setting. +If _false_ (default), the namespace only stores the index in memory, and all +reads and writes are served +[from the filesystem](https://docs.aerospike.com/server/operations/configure/namespace/storage#recipe-for-a-persistent-memory-storage-engine). +If _true_ the namespace storage is +[in-memory with filesystem persistence](https://docs.aerospike.com/server/operations/configure/namespace/storage#recipe-for-an-hdd-storage-engine-with-data-in-memory), +meaning that reads and writes happen from a full in-memory copy, and a +synchronous write persists to disk. + +#### `DEFAULT_TTL` + +The namespace [`default-ttl`](https://docs.aerospike.com/reference/configuration#default-ttl). +Default: _30d_ + +#### `MEM_GB` + +The namespace [`memory-size`](https://docs.aerospike.com/reference/configuration#memory-size). +Default: _1_, the unit is always `G` (GB) + +#### `NSUP_PERIOD` + +The namespace [`nsup-period`](https://docs.aerospike.com/reference/configuration#nsup-period). +Default: _120_ , nsup-period in seconds + +#### `STORAGE_GB` + +The namespace persistence `file` size. Default: _4_, the unit is always `G` (GB) + +## Advanced Configuration + +You can override the default configuration file by providing your own +aerospike.conf, as described in +[Configuring Aerospike Database](https://docs.aerospike.com/server/operations/configure). + +You should first `-v` map a local directory, which Docker will bind mount. +Next, drop your aerospike.conf file into this directory. Finally, use the +`--config-file` option to tell Aerospike where in the container the +configuration file is (the default path is _/etc/aerospike/aerospike.conf_). +Remember that the feature key file is required, so use `feature-key-file` in +your config file to point to a mounted path (such as +_/opt/aerospike/etc/feature.conf_). For example: -```console -docker run -d -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/etc/:/opt/aerospike/etc/ --name aerospike -p 3000-3002:3000-3002 %%IMAGE%%:ee-[version] --config-file /opt/aerospike/etc/aerospike.conf ``` -### Persistent Data Directory +### Persistent data directory -With Docker, the files within the container are not persisted past the life of the container. To persist data, you will want to mount a directory from the host to the container's /opt/aerospike/data using the `-v` option: +With Docker, the files within the container are not persisted past the life of +the container. To persist data, you will want to mount a directory from the host +to the container's _/opt/aerospike/data_ using the `-v` option: For example: -```console +```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" %%IMAGE%%:ee-[version] ``` -The example above uses the configuration template, where the single defined namespace is in-memory with file-based persistence. Just mounting the predefined /opt/aerospike/data directory enables the data to be persisted on the host. - -Alternatively, a custom configuration file is used with the parameter `file` set to be a file in the mounted /opt/aerospike/data, such as in the following config snippet: - - namespace test { - # : - storage-engine device { - file /opt/aerospike/data/test.dat - filesize 4G - data-in-memory true - } - } +The example above uses the configuration template, where the single defined +namespace is in-memory with file-based persistence. Just mounting the predefined +_/opt/aerospike/data_ directory enables the data to be persisted on the host. + +Alternatively, your custom configuration file is used with the parameter `file` +set to be a file in the mounted _/opt/aerospike/data_, such as in the following +config snippet: + +```plaintext +namespace test { + # : + storage-engine device { + file /opt/aerospike/data/test.dat + filesize 4G + data-in-memory true + } +} +``` -In this example we also mount the data directory in a similar way, using a custom configuration file. +In this example we also mount the data directory in a similar way, using a +custom configuration file -```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 %%IMAGE%%:ee-[version] ``` -### Block Storage +### Block storage -Docker provides an ability to expose a host's block devices to a running container. The `--device` option can be used to map a host block device within a container. +Docker provides an ability to expose a host's block devices to a running +container. The `--device` option can be used to map a host block device within a +container. -Update the `storage-engine device` section of the namespace in the custom aerospike configuration file. +Update the `storage-engine device` section of the namespace in the custom +Aerospike configuration file. - namespace test { - # : - storage-engine device { - device /dev/xvdc - write-block-size 128k - } - } +```plaintext +namespace test { + # : + storage-engine device { + device /dev/xvdc + write-block-size 128k + } +} +``` Now to map a host drive /dev/sdc to /dev/xvdc on a container -```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 %%IMAGE%%:ee-[version] ``` -### Persistent Lua Cache +### Persistent Lua cache -Upon restart, your lua cache will become emptied. To persist the cache, you will want to mount a directory from the host to the container's `/opt/aerospike/usr/udf/lua` using the `-v` option: +Upon restart, your Lua cache will become emptied. To persist the cache, you will +want to mount a directory from the host to the container's +_/opt/aerospike/usr/udf/lua_ using the `-v` option: ```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 %%IMAGE%%:ee-[version] ``` -## Clustering +### A note about security -Developers using the Aerospike EE single-node evaluation, and most others using Docker Desktop on their machine for development, will not need to configure the node for clustering. If you're interested in using clustering and have a feature key file without a single node limit, read the following sections. +For convenience, this image does not have security turned on by default, but it +is a core Aerospike Enterprise Edition feature. The knowledge base +article +[How To secure Aerospike database servers](https://discuss.aerospike.com/t/how-to-secure-aerospike-database-servers/7804) +covers the topic well. -### Configuring the node's access address +[And Now for a Security Reminder](https://www.aerospike.com/blog/and-now-for-a-security-reminder/) +that bad things can happen to good people. -In order for the Aerospike node to properly broadcast its address to the cluster and applications, the [`access-address`](https://www.aerospike.com/docs/reference/configuration/index.html#access-address) configuration parameter needs to be set in the configuration file. If it is not set, then the IP address within the container will be used, which is not accessible to other nodes. +Also see the knowledge base article +[How To secure Aerospike database servers](https://discuss.aerospike.com/t/how-to-secure-aerospike-database-servers/7804). - network { - service { - address any # Listening IP Address - port 3000 # Listening Port - access-address 192.168.1.100 # IP Address used by cluster nodes and applications - } +### Networking -### Mesh Clustering +Developers using the Aerospike Enterprise Edition single-node evaluation, and +most others using Docker Desktop on their machine for development, will not need +to configure the node for clustering. If you're interested in using clustering +and have a feature key file without a single node limit or you are using the +Community Edition, read the following sections. -Mesh networking requires setting up links between each node in the cluster. This can be achieved in two ways: +#### Configuring the node's access address -1. Add a configuration for each node in the cluster, as defined in [Network Heartbeat Configuration](http://www.aerospike.com/docs/operations/configure/network/heartbeat/#mesh-unicast-heartbeat). -2. Use `asinfo` to send the `tip` command, to make the node aware of another node, as defined in [tip command in asinfo](http://www.aerospike.com/docs/tools/asinfo/#tip). +In order for the Aerospike node to properly broadcast its address to the cluster +and applications, the [`access-address`](https://docs.aerospike.com/reference/configuration#access-address) +configuration parameter needs to be set in the configuration file. If it is not +set, then the IP address within the container will be used, which is not +accessible to other nodes. -For more, see [How do I get a 2 nodes Aerospike cluster running quickly in Docker without editing a single file?](https://medium.com/aerospike-developer-blog/how-do-i-get-a-2-node-aerospike-cluster-running-quickly-in-docker-without-editing-a-single-file-1c2a94564a99?source=friends_link&sk=4ff6a22f0106596c42aa4b77d6cdc3a5) +```plaintext + network { + service { + address any # Listening IP Address + port 3000 # Listening Port + access-address 192.168.1.100 # IP Address used by cluster nodes and applications + } + + ... + } +``` + +#### Mesh clustering + +See [How do I get a 2 nodes Aerospike cluster running quickly in Docker without editing a single file?](https://medium.com/aerospike-developer-blog/how-do-i-get-a-2-node-aerospike-cluster-running-quickly-in-docker-without-editing-a-single-file-1c2a94564a99?source=friends_link&sk=4ff6a22f0106596c42aa4b77d6cdc3a5) + +## Sending Performance Data to Aerospike + +Aerospike Telemetry is a feature that allows us to collect certain anonymized +use data – not the database data – on your Aerospike Community Edition server +use. We’d like to know when clusters are created and destroyed, cluster size, +cluster workload, how often queries are run, whether instances are deployed +purely in-memory or with Flash. Aerospike Telemetry collects information from +running Community Edition server instances every 10 minutes. The data helps us +to understand how the product is being used, identify issues, and create a +better experience for the end user. +[More Info](http://www.aerospike.com/aerospike-telemetry/) ## Image Versions -These images are based on [debian:strech-slim](https://hub.docker.com/_/debian). +These images are based on [debian:bullseye-slim](https://hub.docker.com/_/debian). ### ee-[version] @@ -181,10 +396,15 @@ These tags are for Aerospike CE images, and do not require a feature key file to ## Reporting Issues -If you have any problems with or questions about this image, please post on the [Aerospike discussion forum](https://discuss.aerospike.com). - -Enterprise customers are welcome to participate in the community forum, but can also report issues through the enterprise support system. +Aerospike Enterprise evaluation users, if you have any problems with or +questions about this image, please post on the +[Aerospike discussion forum](https://discuss.aerospike.com) or open an issue in +[aerospike/aerospike-server-enterprise.docker](https://github.com/aerospike/aerospike-server-enterprise.docker/issues). -Aerospike EE evaluation users can open an issue in [aerospike/aerospike-server-enterprise.docker](https://github.com/aerospike/aerospike-server-enterprise.docker/issues). +Enterprise customers are welcome to participate in the community forum, but can +also report issues through the +[enterprise support system](https://support.aerospike.com/). -Aerospike CE users can open an issue in [aerospike/aerospike-server.docker](https://github.com/aerospike/aerospike-server.docker/issues). +Community Edition users may report problems or ask questions about this image +on the [Aerospike Forums](https://discuss.aerospike.com/) or open an issue in +[aerospike/aerospike-server.docker](https://github.com/aerospike/aerospike-server.docker/issues). diff --git a/aerospike/github-repo b/aerospike/github-repo index bfe29fcaf8f4..91cf2ac3e131 100644 --- a/aerospike/github-repo +++ b/aerospike/github-repo @@ -1 +1 @@ -https://github.com/aerospike/aerospike-server-enterprise.docker +https://github.com/aerospike/aerospike-server.docker diff --git a/aerospike/issues.md b/aerospike/issues.md index 7f7f5a133956..87f65dea2416 100644 --- a/aerospike/issues.md +++ b/aerospike/issues.md @@ -1 +1,2 @@ -[the Aerospike Forums](https://discuss.aerospike.com) or [GitHub](%%GITHUB-REPO%%/issues) +[The Aerospike Forum](https://discuss.aerospike.com) or +[GitHub](%%GITHUB-REPO%%/issues) diff --git a/aerospike/license.md b/aerospike/license.md index f7db53b12ae0..a6be36c54457 100644 --- a/aerospike/license.md +++ b/aerospike/license.md @@ -1,7 +1,13 @@ -Copyright 2019-2021 Aerospike, Inc. +Copyright 2019-2023 Aerospike, Inc. -If you are using a feature key file you received as part of your commercial enterprise license, you are operating under the [Aerospike Master License Agreement](https://www.aerospike.com/forms/master-license-agreement/). +If you are using a feature key file you received as part of your commercial +enterprise license, you are operating under the +[Aerospike Master License Agreement](https://www.aerospike.com/forms/master-license-agreement/). -If you are using the Aerospike Database EE evaluation feature key file, you are operating under the [Aerospike Evaluation License Agreement](https://www.aerospike.com/forms/evaluation-license-agreement/). +If you are using the Aerospike Database EE evaluation feature key file, you are +operating under the +[Aerospike Evaluation License Agreement](https://www.aerospike.com/forms/evaluation-license-agreement/). -If you are using Aerospike Database CE refer to the license information in the [aerospike/aerospike-server](https://github.com/aerospike/aerospike-server) repository. +If you are using Aerospike Database CE refer to the license information in the +[aerospike/aerospike-server](https://github.com/aerospike/aerospike-server) +repository. From 169ace4642fcec66829dd6d75791b07b69f6c247 Mon Sep 17 00:00:00 2001 From: Kevin Porter Date: Tue, 3 Jan 2023 14:34:36 -0800 Subject: [PATCH 02/10] Fix 'ce-[version]' link. --- aerospike/content.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aerospike/content.md b/aerospike/content.md index f13246a39940..6600dd7ccf19 100644 --- a/aerospike/content.md +++ b/aerospike/content.md @@ -31,7 +31,7 @@ delivers predictable high performance at scale and high data density per node. * [Mesh clustering](#mesh-clustering) * [Image Versions](#image-versions) * [ee-[version]](#ee-version) - * [ce-[version]](#ce-verions) + * [ce-[version]](#ce-version) * [Reporting Issues](#reporting-issues) * [License](#license) From 3ae8f04c1bb4c5b981797fd1b4b0de511b885f00 Mon Sep 17 00:00:00 2001 From: Kevin Porter Date: Tue, 3 Jan 2023 14:46:14 -0800 Subject: [PATCH 03/10] README-short can only be one line. --- aerospike/README-short.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/aerospike/README-short.txt b/aerospike/README-short.txt index 51a651a07810..acf36bac8fd1 100644 --- a/aerospike/README-short.txt +++ b/aerospike/README-short.txt @@ -1,2 +1 @@ -Aerospike – the reliable, high performance, distributed database optimized for -flash and RAM. +Aerospike – the reliable, high performance, distributed database optimized for flash and RAM. From a6e20e7fb51de66743d01eebe2e75ac32de43721 Mon Sep 17 00:00:00 2001 From: Kevin Porter Date: Tue, 3 Jan 2023 14:58:49 -0800 Subject: [PATCH 04/10] Dockerhub's markdownfmt require 1 line per paragraph. --- aerospike/content.md | 147 +++++++++++-------------------------------- 1 file changed, 35 insertions(+), 112 deletions(-) diff --git a/aerospike/content.md b/aerospike/content.md index 6600dd7ccf19..bbcbd13fd9e9 100644 --- a/aerospike/content.md +++ b/aerospike/content.md @@ -37,13 +37,9 @@ delivers predictable high performance at scale and high data density per node. ## Getting Started -Aerospike Database Community Edition (CE) supports the same developer APIs as -Aerospike Database Enterprise Edition (EE), except for durable deletes. They -differ in ease of operation and [enterprise features](https://aerospike.com/products/features-and-editions/) -, such as compression. +Aerospike Database Community Edition (CE) supports the same developer APIs as Aerospike Database Enterprise Edition (EE), except for durable deletes. They differ in ease of operation and [enterprise features](https://aerospike.com/products/features-and-editions/), such as compression. -Since server version 6.1, Aerospike EE starts in a single-node cluster -evaluation mode, with all its enterprise features available. +Since server version 6.1, Aerospike EE starts in a single-node cluster evaluation mode, with all its enterprise features available. ### Running an Aerospike Server node @@ -67,9 +63,7 @@ Running Enterprise Edition with a feature key file in an environment variable: 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] ``` -Above, _DIR_ is a directory on your machine where you drop your feature -key file. Make sure Docker Desktop has file sharing permission to bind mount it -into Docker containers. +Above, _DIR_ is a directory on your machine where you drop your feature key file. Make sure Docker Desktop has file sharing permission to bind mount it into Docker containers. #### Community Edition @@ -83,8 +77,7 @@ docker run -d --name aerospike -p 3000-3002:3000-3002 %%IMAGE%%:ce-[version] ## Connecting to your Aerospike Container -You can use the latest aerospike-tools image to connect to your Aerospike -container. +You can use the latest aerospike-tools image to connect to your Aerospike container. ### Using aql @@ -151,47 +144,35 @@ Admin> ## Customizing the Default Developer Environment -The Aerospike Docker image comes with a default configuration file, which sets -up a single node, single namespace developer environment. Alternatively, you can -provide your own configuration file (see below). +The Aerospike Docker image comes with a default configuration file, which sets up a single node, single namespace developer environment. Alternatively, you can provide your own configuration file (see below). -You can inject parameters into the default configuration template using -container-side environment variables with the `-e` flag. +You can inject parameters into the default configuration template using container-side environment variables with the `-e` flag. -For example, to set the default [namespace](https://docs.aerospike.com/server/architecture/data-model) -name to _demo_: +For example, to set the default [namespace](https://docs.aerospike.com/server/architecture/data-model) name to _demo_: ```sh docker run -d --name aerospike -e "NAMESPACE=demo" -p 3000-3002:3000-3002 -v /my/dir:/opt/aerospike/etc/ -e "FEATURE_KEY_FILE=/opt/aerospike/etc/features.conf" %%IMAGE%%:ee-[version] ``` -Injecting configuration parameters into the configuration template isn't -compatible with providing a configuration file. You can use one or the other. +Injecting configuration parameters into the configuration template isn't compatible with providing a configuration file. You can use one or the other. ### List of template variables #### `FEATURE_KEY_FILE` -The [`feature_key_file`](https://docs.aerospike.com/server/operations/configure/feature-key). -of the `service` context which is only applicable and to Enterprise editions and -must be set to the empty string when running the Community edition. -Default: _/etc/aerospike/features.conf_. +The [`feature_key_file`](https://docs.aerospike.com/server/operations/configure/feature-key). of the `service` context which is only applicable and to Enterprise editions and must be set to the empty string when running the Community edition. Default: _/etc/aerospike/features.conf_. #### `LOGFILE` -The [`file`](https://docs.aerospike.com/reference/configuration#file) param of -the `logging` context. Default: _""_, do not log to file. The container will -also log to `stdout`` regardless of what is configured here. +The [`file`](https://docs.aerospike.com/reference/configuration#file) param of the `logging` context. Default: _""_, do not log to file. The container will also log to `stdout`` regardless of what is configured here. #### `SERVICE_ADDRESS` -The bind [`address`](https://docs.aerospike.com/reference/configuration#address) -of the `networking.service` subcontext. Default: _any_ +The bind [`address`](https://docs.aerospike.com/reference/configuration#address) of the `networking.service` subcontext. Default: _any_ #### `SERVICE_PORT` -The [`port`](https://docs.aerospike.com/reference/configuration#port) of the -`networking.service` subcontext. Default: _3000_ +The [`port`](https://docs.aerospike.com/reference/configuration#port) of the `networking.service` subcontext. Default: _3000_ ### Preconfigured namespace @@ -203,29 +184,20 @@ The name of the namespace. Default: _test_ #### `DATA_IN_MEMORY` -The storage-engine [`data-in-memory`](https://docs.aerospike.com/reference/configuration#data-in-memory) setting. -If _false_ (default), the namespace only stores the index in memory, and all -reads and writes are served -[from the filesystem](https://docs.aerospike.com/server/operations/configure/namespace/storage#recipe-for-a-persistent-memory-storage-engine). -If _true_ the namespace storage is -[in-memory with filesystem persistence](https://docs.aerospike.com/server/operations/configure/namespace/storage#recipe-for-an-hdd-storage-engine-with-data-in-memory), -meaning that reads and writes happen from a full in-memory copy, and a -synchronous write persists to disk. +The storage-engine [`data-in-memory`](https://docs.aerospike.com/reference/configuration#data-in-memory) setting. If _false_ (default), the namespace only stores the index in memory, and all +reads and writes are served [from the filesystem](https://docs.aerospike.com/server/operations/configure/namespace/storage#recipe-for-a-persistent-memory-storage-engine). If _true_ the namespace storage is [in-memory with filesystem persistence](https://docs.aerospike.com/server/operations/configure/namespace/storage#recipe-for-an-hdd-storage-engine-with-data-in-memory), meaning that reads and writes happen from a full in-memory copy, and a synchronous write persists to disk. #### `DEFAULT_TTL` -The namespace [`default-ttl`](https://docs.aerospike.com/reference/configuration#default-ttl). -Default: _30d_ +The namespace [`default-ttl`](https://docs.aerospike.com/reference/configuration#default-ttl). Default: _30d_ #### `MEM_GB` -The namespace [`memory-size`](https://docs.aerospike.com/reference/configuration#memory-size). -Default: _1_, the unit is always `G` (GB) +The namespace [`memory-size`](https://docs.aerospike.com/reference/configuration#memory-size). Default: _1_, the unit is always `G` (GB) #### `NSUP_PERIOD` -The namespace [`nsup-period`](https://docs.aerospike.com/reference/configuration#nsup-period). -Default: _120_ , nsup-period in seconds +The namespace [`nsup-period`](https://docs.aerospike.com/reference/configuration#nsup-period). Default: _120_ , nsup-period in seconds #### `STORAGE_GB` @@ -233,17 +205,9 @@ The namespace persistence `file` size. Default: _4_, the unit is always `G` (GB) ## Advanced Configuration -You can override the default configuration file by providing your own -aerospike.conf, as described in -[Configuring Aerospike Database](https://docs.aerospike.com/server/operations/configure). +You can override the default configuration file by providing your own aerospike.conf, as described in [Configuring Aerospike Database](https://docs.aerospike.com/server/operations/configure). -You should first `-v` map a local directory, which Docker will bind mount. -Next, drop your aerospike.conf file into this directory. Finally, use the -`--config-file` option to tell Aerospike where in the container the -configuration file is (the default path is _/etc/aerospike/aerospike.conf_). -Remember that the feature key file is required, so use `feature-key-file` in -your config file to point to a mounted path (such as -_/opt/aerospike/etc/feature.conf_). +You should first `-v` map a local directory, which Docker will bind mount. Next, drop your aerospike.conf file into this directory. Finally, use the `--config-file` option to tell Aerospike where in the container the configuration file is (the default path is _/etc/aerospike/aerospike.conf_). Remember that the feature key file is required, so use `feature-key-file` in your config file to point to a mounted path (such as _/opt/aerospike/etc/feature.conf_). For example: @@ -253,9 +217,7 @@ docker run -d -v /opt/aerospike/etc/:/opt/aerospike/etc/ --name aerospike -p 300 ### Persistent data directory -With Docker, the files within the container are not persisted past the life of -the container. To persist data, you will want to mount a directory from the host -to the container's _/opt/aerospike/data_ using the `-v` option: +With Docker, the files within the container are not persisted past the life of the container. To persist data, you will want to mount a directory from the host to the container's _/opt/aerospike/data_ using the `-v` option: For example: @@ -263,13 +225,9 @@ For example: 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] ``` -The example above uses the configuration template, where the single defined -namespace is in-memory with file-based persistence. Just mounting the predefined -_/opt/aerospike/data_ directory enables the data to be persisted on the host. +The example above uses the configuration template, where the single defined namespace is in-memory with file-based persistence. Just mounting the predefined _/opt/aerospike/data_ directory enables the data to be persisted on the host. -Alternatively, your custom configuration file is used with the parameter `file` -set to be a file in the mounted _/opt/aerospike/data_, such as in the following -config snippet: +Alternatively, your custom configuration file is used with the parameter `file` set to be a file in the mounted _/opt/aerospike/data_, such as in the following config snippet: ```plaintext namespace test { @@ -282,8 +240,7 @@ namespace test { } ``` -In this example we also mount the data directory in a similar way, using a -custom configuration file +In this example we also mount the data directory in a similar way, using a custom configuration file ```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 %%IMAGE%%:ee-[version] @@ -291,12 +248,9 @@ docker run -d -v /opt/aerospike/data:/opt/aerospike/data -v /opt/aerospike/etc/: ### Block storage -Docker provides an ability to expose a host's block devices to a running -container. The `--device` option can be used to map a host block device within a -container. +Docker provides an ability to expose a host's block devices to a running container. The `--device` option can be used to map a host block device within a container. -Update the `storage-engine device` section of the namespace in the custom -Aerospike configuration file. +Update the `storage-engine device` section of the namespace in the custom Aerospike configuration file. ```plaintext namespace test { @@ -316,9 +270,7 @@ docker run -d --device '/dev/sdc:/dev/xvdc' -v /opt/aerospike/etc/:/opt/aerospik ### Persistent Lua cache -Upon restart, your Lua cache will become emptied. To persist the cache, you will -want to mount a directory from the host to the container's -_/opt/aerospike/usr/udf/lua_ using the `-v` option: +Upon restart, your Lua cache will become emptied. To persist the cache, you will want to mount a directory from the host to the container's _/opt/aerospike/usr/udf/lua_ using the `-v` option: ```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 --config-file /opt/aerospike/etc/aerospike.conf %%IMAGE%%:ee-[version] @@ -326,33 +278,19 @@ docker run -d -v /opt/aerospike/lua:/opt/aerospike/usr/udf/lua -v /opt/aerospike ### A note about security -For convenience, this image does not have security turned on by default, but it -is a core Aerospike Enterprise Edition feature. The knowledge base -article -[How To secure Aerospike database servers](https://discuss.aerospike.com/t/how-to-secure-aerospike-database-servers/7804) -covers the topic well. +For convenience, this image does not have security turned on by default, but it is a core Aerospike Enterprise Edition feature. The knowledge base article [How To secure Aerospike database servers](https://discuss.aerospike.com/t/how-to-secure-aerospike-database-servers/7804) covers the topic well. -[And Now for a Security Reminder](https://www.aerospike.com/blog/and-now-for-a-security-reminder/) -that bad things can happen to good people. +[And Now for a Security Reminder](https://www.aerospike.com/blog/and-now-for-a-security-reminder/) that bad things can happen to good people. -Also see the knowledge base article -[How To secure Aerospike database servers](https://discuss.aerospike.com/t/how-to-secure-aerospike-database-servers/7804). +Also see the knowledge base article [How To secure Aerospike database servers](https://discuss.aerospike.com/t/how-to-secure-aerospike-database-servers/7804). ### Networking -Developers using the Aerospike Enterprise Edition single-node evaluation, and -most others using Docker Desktop on their machine for development, will not need -to configure the node for clustering. If you're interested in using clustering -and have a feature key file without a single node limit or you are using the -Community Edition, read the following sections. +Developers using the Aerospike Enterprise Edition single-node evaluation, and most others using Docker Desktop on their machine for development, will not need to configure the node for clustering. If you're interested in using clustering and have a feature key file without a single node limit or you are using the Community Edition, read the following sections. #### Configuring the node's access address -In order for the Aerospike node to properly broadcast its address to the cluster -and applications, the [`access-address`](https://docs.aerospike.com/reference/configuration#access-address) -configuration parameter needs to be set in the configuration file. If it is not -set, then the IP address within the container will be used, which is not -accessible to other nodes. +In order for the Aerospike node to properly broadcast its address to the cluster and applications, the [`access-address`](https://docs.aerospike.com/reference/configuration#access-address) configuration parameter needs to be set in the configuration file. If it is not set, then the IP address within the container will be used, which is not accessible to other nodes. ```plaintext network { @@ -372,15 +310,7 @@ See [How do I get a 2 nodes Aerospike cluster running quickly in Docker without ## Sending Performance Data to Aerospike -Aerospike Telemetry is a feature that allows us to collect certain anonymized -use data – not the database data – on your Aerospike Community Edition server -use. We’d like to know when clusters are created and destroyed, cluster size, -cluster workload, how often queries are run, whether instances are deployed -purely in-memory or with Flash. Aerospike Telemetry collects information from -running Community Edition server instances every 10 minutes. The data helps us -to understand how the product is being used, identify issues, and create a -better experience for the end user. -[More Info](http://www.aerospike.com/aerospike-telemetry/) +Aerospike Telemetry is a feature that allows us to collect certain anonymized use data – not the database data – on your Aerospike Community Edition server use. We’d like to know when clusters are created and destroyed, cluster size, cluster workload, how often queries are run, whether instances are deployed purely in-memory or with Flash. Aerospike Telemetry collects information from running Community Edition server instances every 10 minutes. The data helps us to understand how the product is being used, identify issues, and create a better experience for the end user. [More Info](http://www.aerospike.com/aerospike-telemetry/) ## Image Versions @@ -396,15 +326,8 @@ These tags are for Aerospike CE images, and do not require a feature key file to ## Reporting Issues -Aerospike Enterprise evaluation users, if you have any problems with or -questions about this image, please post on the -[Aerospike discussion forum](https://discuss.aerospike.com) or open an issue in -[aerospike/aerospike-server-enterprise.docker](https://github.com/aerospike/aerospike-server-enterprise.docker/issues). +Aerospike Enterprise evaluation users, if you have any problems with or questions about this image, please post on the [Aerospike discussion forum](https://discuss.aerospike.com) or open an issue in [aerospike/aerospike-server-enterprise.docker](https://github.com/aerospike/aerospike-server-enterprise.docker/issues). -Enterprise customers are welcome to participate in the community forum, but can -also report issues through the -[enterprise support system](https://support.aerospike.com/). +Enterprise customers are welcome to participate in the community forum, but can also report issues through the [enterprise support system](https://support.aerospike.com/). -Community Edition users may report problems or ask questions about this image -on the [Aerospike Forums](https://discuss.aerospike.com/) or open an issue in -[aerospike/aerospike-server.docker](https://github.com/aerospike/aerospike-server.docker/issues). +Community Edition users may report problems or ask questions about this image on the [Aerospike Forums](https://discuss.aerospike.com/) or open an issue in [aerospike/aerospike-server.docker](https://github.com/aerospike/aerospike-server.docker/issues). From 261071a3396ccdd3093fc8e4fffb8cab0b2b8abe Mon Sep 17 00:00:00 2001 From: Kevin Porter Date: Tue, 3 Jan 2023 15:04:04 -0800 Subject: [PATCH 05/10] Dockerhub's markdownfmt list indentation requirement differ from markdownlint. --- aerospike/content.md | 48 ++++++++++++++++++++++---------------------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/aerospike/content.md b/aerospike/content.md index bbcbd13fd9e9..a1967b32e719 100644 --- a/aerospike/content.md +++ b/aerospike/content.md @@ -10,30 +10,30 @@ delivers predictable high performance at scale and high data density per node. %%LOGO%% -* [Getting Started](#getting-started) - * [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 Environment](#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) -* [Sending Performance Data to Aerospike](#sending-performance-data-to-aerospike) - * [Mesh clustering](#mesh-clustering) -* [Image Versions](#image-versions) - * [ee-[version]](#ee-version) - * [ce-[version]](#ce-version) -* [Reporting Issues](#reporting-issues) -* [License](#license) +- [Getting Started](#getting-started) + - [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 Environment](#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) +- [Sending Performance Data to Aerospike](#sending-performance-data-to-aerospike) + - [Mesh clustering](#mesh-clustering) +- [Image Versions](#image-versions) + - [ee-[version]](#ee-version) + - [ce-[version]](#ce-version) +- [Reporting Issues](#reporting-issues) +- [License](#license) ## Getting Started From 3907eb076f75fb4e035a656cfdc7e10341b2c735 Mon Sep 17 00:00:00 2001 From: Kevin Porter Date: Tue, 3 Jan 2023 15:05:07 -0800 Subject: [PATCH 06/10] Missed a paragraph needing single-lining. --- aerospike/content.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/aerospike/content.md b/aerospike/content.md index a1967b32e719..fa260fa12b03 100644 --- a/aerospike/content.md +++ b/aerospike/content.md @@ -2,11 +2,7 @@ ## What is Aerospike? -[Aerospike](http://aerospike.com) is a distributed NoSQL database purposefully -designed for high performance applications. Aerospike supports key-value and -document data models, and has multiple data types including List, Map, -HyperLogLog, GeoJSON, and Blob. Aerospike's patented hybrid memory architecture -delivers predictable high performance at scale and high data density per node. +[Aerospike](http://aerospike.com) is a distributed NoSQL database purposefully designed for high performance applications. Aerospike supports key-value and document data models, and has multiple data types including List, Map, HyperLogLog, GeoJSON, and Blob. Aerospike's patented hybrid memory architecture delivers predictable high performance at scale and high data density per node. %%LOGO%% From 759540b12de00950b18f5b6609dd1ef98d75e4ae Mon Sep 17 00:00:00 2001 From: Kevin Porter Date: Tue, 3 Jan 2023 15:10:59 -0800 Subject: [PATCH 07/10] Dockerhub's markdownfmt require '*' instead of '_' for italicizing. --- aerospike/content.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/aerospike/content.md b/aerospike/content.md index fa260fa12b03..6b9fe7a58452 100644 --- a/aerospike/content.md +++ b/aerospike/content.md @@ -59,7 +59,7 @@ Running Enterprise Edition with a feature key file in an environment variable: 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] ``` -Above, _DIR_ is a directory on your machine where you drop your feature key file. Make sure Docker Desktop has file sharing permission to bind mount it into Docker containers. +Above, *DIR* is a directory on your machine where you drop your feature key file. Make sure Docker Desktop has file sharing permission to bind mount it into Docker containers. #### Community Edition @@ -144,7 +144,7 @@ The Aerospike Docker image comes with a default configuration file, which sets u You can inject parameters into the default configuration template using container-side environment variables with the `-e` flag. -For example, to set the default [namespace](https://docs.aerospike.com/server/architecture/data-model) name to _demo_: +For example, to set the default [namespace](https://docs.aerospike.com/server/architecture/data-model) name to *demo*: ```sh docker run -d --name aerospike -e "NAMESPACE=demo" -p 3000-3002:3000-3002 -v /my/dir:/opt/aerospike/etc/ -e "FEATURE_KEY_FILE=/opt/aerospike/etc/features.conf" %%IMAGE%%:ee-[version] @@ -156,19 +156,19 @@ Injecting configuration parameters into the configuration template isn't compati #### `FEATURE_KEY_FILE` -The [`feature_key_file`](https://docs.aerospike.com/server/operations/configure/feature-key). of the `service` context which is only applicable and to Enterprise editions and must be set to the empty string when running the Community edition. Default: _/etc/aerospike/features.conf_. +The [`feature_key_file`](https://docs.aerospike.com/server/operations/configure/feature-key). of the `service` context which is only applicable and to Enterprise editions and must be set to the empty string when running the Community edition. Default: */etc/aerospike/features.conf*. #### `LOGFILE` -The [`file`](https://docs.aerospike.com/reference/configuration#file) param of the `logging` context. Default: _""_, do not log to file. The container will also log to `stdout`` regardless of what is configured here. +The [`file`](https://docs.aerospike.com/reference/configuration#file) param of the `logging` context. Default: *""*, do not log to file. The container will also log to `stdout`` regardless of what is configured here. #### `SERVICE_ADDRESS` -The bind [`address`](https://docs.aerospike.com/reference/configuration#address) of the `networking.service` subcontext. Default: _any_ +The bind [`address`](https://docs.aerospike.com/reference/configuration#address) of the `networking.service` subcontext. Default: *any* #### `SERVICE_PORT` -The [`port`](https://docs.aerospike.com/reference/configuration#port) of the `networking.service` subcontext. Default: _3000_ +The [`port`](https://docs.aerospike.com/reference/configuration#port) of the `networking.service` subcontext. Default: *3000* ### Preconfigured namespace @@ -176,34 +176,34 @@ The single preconfigured namespace has the following variables: #### `NAMESPACE` -The name of the namespace. Default: _test_ +The name of the namespace. Default: *test* #### `DATA_IN_MEMORY` -The storage-engine [`data-in-memory`](https://docs.aerospike.com/reference/configuration#data-in-memory) setting. If _false_ (default), the namespace only stores the index in memory, and all -reads and writes are served [from the filesystem](https://docs.aerospike.com/server/operations/configure/namespace/storage#recipe-for-a-persistent-memory-storage-engine). If _true_ the namespace storage is [in-memory with filesystem persistence](https://docs.aerospike.com/server/operations/configure/namespace/storage#recipe-for-an-hdd-storage-engine-with-data-in-memory), meaning that reads and writes happen from a full in-memory copy, and a synchronous write persists to disk. +The storage-engine [`data-in-memory`](https://docs.aerospike.com/reference/configuration#data-in-memory) setting. If *false* (default), the namespace only stores the index in memory, and all +reads and writes are served [from the filesystem](https://docs.aerospike.com/server/operations/configure/namespace/storage#recipe-for-a-persistent-memory-storage-engine). If *true* the namespace storage is [in-memory with filesystem persistence](https://docs.aerospike.com/server/operations/configure/namespace/storage#recipe-for-an-hdd-storage-engine-with-data-in-memory), meaning that reads and writes happen from a full in-memory copy, and a synchronous write persists to disk. #### `DEFAULT_TTL` -The namespace [`default-ttl`](https://docs.aerospike.com/reference/configuration#default-ttl). Default: _30d_ +The namespace [`default-ttl`](https://docs.aerospike.com/reference/configuration#default-ttl). Default: *30d* #### `MEM_GB` -The namespace [`memory-size`](https://docs.aerospike.com/reference/configuration#memory-size). Default: _1_, the unit is always `G` (GB) +The namespace [`memory-size`](https://docs.aerospike.com/reference/configuration#memory-size). Default: *1*, the unit is always `G` (GB) #### `NSUP_PERIOD` -The namespace [`nsup-period`](https://docs.aerospike.com/reference/configuration#nsup-period). Default: _120_ , nsup-period in seconds +The namespace [`nsup-period`](https://docs.aerospike.com/reference/configuration#nsup-period). Default: *120* , nsup-period in seconds #### `STORAGE_GB` -The namespace persistence `file` size. Default: _4_, the unit is always `G` (GB) +The namespace persistence `file` size. Default: *4*, the unit is always `G` (GB) ## Advanced Configuration You can override the default configuration file by providing your own aerospike.conf, as described in [Configuring Aerospike Database](https://docs.aerospike.com/server/operations/configure). -You should first `-v` map a local directory, which Docker will bind mount. Next, drop your aerospike.conf file into this directory. Finally, use the `--config-file` option to tell Aerospike where in the container the configuration file is (the default path is _/etc/aerospike/aerospike.conf_). Remember that the feature key file is required, so use `feature-key-file` in your config file to point to a mounted path (such as _/opt/aerospike/etc/feature.conf_). +You should first `-v` map a local directory, which Docker will bind mount. Next, drop your aerospike.conf file into this directory. Finally, use the `--config-file` option to tell Aerospike where in the container the configuration file is (the default path is */etc/aerospike/aerospike.conf*). Remember that the feature key file is required, so use `feature-key-file` in your config file to point to a mounted path (such as */opt/aerospike/etc/feature.conf*). For example: @@ -213,7 +213,7 @@ docker run -d -v /opt/aerospike/etc/:/opt/aerospike/etc/ --name aerospike -p 300 ### Persistent data directory -With Docker, the files within the container are not persisted past the life of the container. To persist data, you will want to mount a directory from the host to the container's _/opt/aerospike/data_ using the `-v` option: +With Docker, the files within the container are not persisted past the life of the container. To persist data, you will want to mount a directory from the host to the container's */opt/aerospike/data* using the `-v` option: For example: @@ -221,9 +221,9 @@ For example: 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] ``` -The example above uses the configuration template, where the single defined namespace is in-memory with file-based persistence. Just mounting the predefined _/opt/aerospike/data_ directory enables the data to be persisted on the host. +The example above uses the configuration template, where the single defined namespace is in-memory with file-based persistence. Just mounting the predefined */opt/aerospike/data* directory enables the data to be persisted on the host. -Alternatively, your custom configuration file is used with the parameter `file` set to be a file in the mounted _/opt/aerospike/data_, such as in the following config snippet: +Alternatively, your custom configuration file is used with the parameter `file` set to be a file in the mounted */opt/aerospike/data*, such as in the following config snippet: ```plaintext namespace test { @@ -266,7 +266,7 @@ docker run -d --device '/dev/sdc:/dev/xvdc' -v /opt/aerospike/etc/:/opt/aerospik ### Persistent Lua cache -Upon restart, your Lua cache will become emptied. To persist the cache, you will want to mount a directory from the host to the container's _/opt/aerospike/usr/udf/lua_ using the `-v` option: +Upon restart, your Lua cache will become emptied. To persist the cache, you will want to mount a directory from the host to the container's */opt/aerospike/usr/udf/lua* using the `-v` option: ```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 --config-file /opt/aerospike/etc/aerospike.conf %%IMAGE%%:ee-[version] From e536934aca9b4d784edfdb14d3950c0848bb4cf0 Mon Sep 17 00:00:00 2001 From: Kevin Porter Date: Tue, 3 Jan 2023 16:51:13 -0800 Subject: [PATCH 08/10] Additional review changes. --- aerospike/content.md | 7 +++---- aerospike/issues.md | 3 +-- aerospike/license.md | 12 +++--------- 3 files changed, 7 insertions(+), 15 deletions(-) diff --git a/aerospike/content.md b/aerospike/content.md index 6b9fe7a58452..938357edddbb 100644 --- a/aerospike/content.md +++ b/aerospike/content.md @@ -41,7 +41,7 @@ Since server version 6.1, Aerospike EE starts in a single-node cluster evaluatio #### Enterprise Edition -By using Aerospike Enterprise Edition you agree to the [ENTERPRISE_LICENSE](enterprise/ENTERPRISE_LICENSE). +Running Enterprise Edition with default evaluation feature key (versions 6.1+). ```sh docker run -d --name aerospike -p 3000-3002:3000-3002 %%IMAGE%%:ee-[version] @@ -180,8 +180,7 @@ The name of the namespace. Default: *test* #### `DATA_IN_MEMORY` -The storage-engine [`data-in-memory`](https://docs.aerospike.com/reference/configuration#data-in-memory) setting. If *false* (default), the namespace only stores the index in memory, and all -reads and writes are served [from the filesystem](https://docs.aerospike.com/server/operations/configure/namespace/storage#recipe-for-a-persistent-memory-storage-engine). If *true* the namespace storage is [in-memory with filesystem persistence](https://docs.aerospike.com/server/operations/configure/namespace/storage#recipe-for-an-hdd-storage-engine-with-data-in-memory), meaning that reads and writes happen from a full in-memory copy, and a synchronous write persists to disk. +The storage-engine [`data-in-memory`](https://docs.aerospike.com/reference/configuration#data-in-memory) setting. If *false* (default), the namespace only stores the index in memory, and all reads and writes are served [from the filesystem](https://docs.aerospike.com/server/operations/configure/namespace/storage#recipe-for-a-persistent-memory-storage-engine). If *true* the namespace storage is [in-memory with filesystem persistence](https://docs.aerospike.com/server/operations/configure/namespace/storage#recipe-for-an-hdd-storage-engine-with-data-in-memory), meaning that reads and writes happen from a full in-memory copy, and a synchronous write persists to disk. #### `DEFAULT_TTL` @@ -326,4 +325,4 @@ Aerospike Enterprise evaluation users, if you have any problems with or question Enterprise customers are welcome to participate in the community forum, but can also report issues through the [enterprise support system](https://support.aerospike.com/). -Community Edition users may report problems or ask questions about this image on the [Aerospike Forums](https://discuss.aerospike.com/) or open an issue in [aerospike/aerospike-server.docker](https://github.com/aerospike/aerospike-server.docker/issues). +Community Edition users may report problems or ask questions about this image on the [Aerospike Forums](https://discuss.aerospike.com/) or open an issue in [aerospike/aerospike-server.docker](https://github.com/aerospike/aerospike-server.docker/issues). diff --git a/aerospike/issues.md b/aerospike/issues.md index 87f65dea2416..02d9966734e7 100644 --- a/aerospike/issues.md +++ b/aerospike/issues.md @@ -1,2 +1 @@ -[The Aerospike Forum](https://discuss.aerospike.com) or -[GitHub](%%GITHUB-REPO%%/issues) +[The Aerospike Forum](https://discuss.aerospike.com) or [GitHub](%%GITHUB-REPO%%/issues) diff --git a/aerospike/license.md b/aerospike/license.md index a6be36c54457..f00e4918d69f 100644 --- a/aerospike/license.md +++ b/aerospike/license.md @@ -1,13 +1,7 @@ Copyright 2019-2023 Aerospike, Inc. -If you are using a feature key file you received as part of your commercial -enterprise license, you are operating under the -[Aerospike Master License Agreement](https://www.aerospike.com/forms/master-license-agreement/). +If you are using a feature key file you received as part of your commercial enterprise license, you are operating under the [Aerospike Master License Agreement](https://www.aerospike.com/forms/master-license-agreement/). -If you are using the Aerospike Database EE evaluation feature key file, you are -operating under the -[Aerospike Evaluation License Agreement](https://www.aerospike.com/forms/evaluation-license-agreement/). +If you are using the Aerospike Database EE evaluation feature key file, you are operating under the [Aerospike Evaluation License Agreement](https://www.aerospike.com/forms/evaluation-license-agreement/). -If you are using Aerospike Database CE refer to the license information in the -[aerospike/aerospike-server](https://github.com/aerospike/aerospike-server) -repository. +If you are using Aerospike Database CE refer to the license information in the [aerospike/aerospike-server](https://github.com/aerospike/aerospike-server) repository. From 6cdfdcfeb2a3210eb6ae1f116fcc585fa980d208 Mon Sep 17 00:00:00 2001 From: Kevin Porter Date: Tue, 3 Jan 2023 17:08:31 -0800 Subject: [PATCH 09/10] Remove TOC. --- aerospike/content.md | 25 ------------------------- 1 file changed, 25 deletions(-) diff --git a/aerospike/content.md b/aerospike/content.md index 938357edddbb..34863b65e792 100644 --- a/aerospike/content.md +++ b/aerospike/content.md @@ -6,31 +6,6 @@ %%LOGO%% -- [Getting Started](#getting-started) - - [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 Environment](#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) -- [Sending Performance Data to Aerospike](#sending-performance-data-to-aerospike) - - [Mesh clustering](#mesh-clustering) -- [Image Versions](#image-versions) - - [ee-[version]](#ee-version) - - [ce-[version]](#ce-version) -- [Reporting Issues](#reporting-issues) -- [License](#license) - ## Getting Started Aerospike Database Community Edition (CE) supports the same developer APIs as Aerospike Database Enterprise Edition (EE), except for durable deletes. They differ in ease of operation and [enterprise features](https://aerospike.com/products/features-and-editions/), such as compression. From 5586403abc2154f774a77956af45ee0bd86234bd Mon Sep 17 00:00:00 2001 From: Kevin Porter Date: Wed, 4 Jan 2023 09:17:34 -0800 Subject: [PATCH 10/10] Fix typo. --- aerospike/content.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aerospike/content.md b/aerospike/content.md index 34863b65e792..3917d27da7e0 100644 --- a/aerospike/content.md +++ b/aerospike/content.md @@ -131,7 +131,7 @@ Injecting configuration parameters into the configuration template isn't compati #### `FEATURE_KEY_FILE` -The [`feature_key_file`](https://docs.aerospike.com/server/operations/configure/feature-key). of the `service` context which is only applicable and to Enterprise editions and must be set to the empty string when running the Community edition. Default: */etc/aerospike/features.conf*. +The [`feature_key_file`](https://docs.aerospike.com/server/operations/configure/feature-key) of the `service` context which is only applicable and to Enterprise editions and must be set to the empty string when running the Community edition. Default: */etc/aerospike/features.conf*. #### `LOGFILE`