Manages Aerospike clusters atop Kubernetes, automating their creation and administration.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmd
docs
hack
pkg
test/e2e
.dockerignore
.gitignore
Dockerfile
Dockerfile.skaffold.e2e
Dockerfile.skaffold.operator
Dockerfile.tools
Gopkg.lock
Gopkg.toml
LICENSE
Makefile
README.adoc
RELEASE-NOTES.adoc
skaffold.e2e.yaml
skaffold.operator.yaml

README.adoc

aerospike-operator

Status Docker Repository on Quay

⚠️
aerospike-operator is currently alpha, and is under active development. One should expect breaking changes to the API and behavior to be introduced at any moment.

Prerequisites

  • Kubernetes 1.11+

Supported versions

aerospike-operator currently supports launching Aerospike clusters running the following Aerospike Server CE versions:

Documentation

One can find comprehensive usage documentation in the docs/usage/ directory of this repository. Existing usage documentation covers the following topics:

  1. Installation Guide provides instructions on how to install and configure aerospike-operator.

  2. Managing Clusters includes details on how to create, configure, inspect and scale Aerospike clusters.

  3. Backing-up Namespaces details how to create backups of data in an Aerospike cluster.

  4. Restoring Namespaces provides instructions on how to restore the abovementioned backups.

  5. Upgrading Clusters details how to upgrade an Aerospike cluster to a later version.

  6. Upgrading aerospike-operator describes how to upgrade the version of aerospike-operator itself.

  7. Metrics includes information on how to consume the metrics exported by aerospike-operator.

  8. Limitations provides a list of limitations that exist in the current version of aerospike-operator.

In addition to these documents, and in order to understand the design and architecture of aerospike-operator, one should have a look at the docs/design/ directory of this repository. Existing design documentation covers the following topics:

  1. API Specification describes the API introduced by aerospike-operator.

  2. Architecture describes the design of aerospike-operator and the interactions between the custom resource definitions it introduces, its internal components and Kubernetes.

  3. Upgrades and Upgrade Strategies describe how upgrade operations are performed by aerospike-operator.

  4. Garbage Collection describes how aerospike-operator performs garbage collection on unused and outdated resources.