- DataStax Platform Overview
- Getting Started with DataStax and Docker
- Prerequisites
- Creating a DataStax Enterprise Container
- Running DSE Commands and Viewing Logs
- Creating an OpsCenter Container
- Creating a Studio Container
- Using Docker Compose for Automated Provisioning
- Building
- Getting Help
- Licensing
Built on the best distribution of Apache Cassandra™, DataStax Enterprise is the always-on data platform designed to allow you to effortlessly build and scale your apps, integrating graph, search, analytics, administration, developer tooling, and monitoring into a single unified platform. We power your apps' real-time moments so you can create instant insights and powerful customer experiences.
Use DataStax provided Docker images to create containers in non-production environments for development, to learn DataStax Enterprise, DataStax OpsCenter and DataStax Studio, to try new ideas, or to test and demonstrate an application. The following images are available:
-
Docker Store (log in to Docker store and subscribe to the image):
- DataStax Enterprise: The best distribution of Apache Cassandra™ with integrated Search, Analytics, and Graph capabilities.
-
Docker Hub:
- DataStax Studio: An interactive developer’s tool for DataStax Enterprise which is designed to help your DSE database, Cassandra Query Language (CQL), DSE Graph, and Gremlin Query Language development.
- DataStax OpsCenter: The web-based visual management and monitoring solution for DataStax Enterprise (DSE).
-
Basic understanding of Docker images and containers.
-
Docker installed on your local system, see Docker Installation Instructions.
-
When building custom images from the DataStax github repository, a DataStax Academy account.
Use the options described in this section to create DataStax Enterprise server containers.
Use the following options to set up a DataStax Enterprise server container.
| Option | Description |
|---|---|
-e |
(Required) Sets Environment variables to accept the licensing agreement and (optional) change the initial configuration. |
-d |
(Recommended) Starts the container in the background. |
-p |
Publish container ports on the host computer to allow remote access to DSE, OpsCenter, and Studio. See Exposing DSE public ports |
-v |
Bind mount a directory on the local host to a DSE Volume to manage configuration or preserve data. See Volumes and data. |
--link |
Link DSE container to OpsCenter or Studio to DSE. For example, --link my-opscenter:opscenter or --link my-dse. |
--name |
Assigns a name to the container. |
These are the most commonly used docker run switches used in deploying DSE. For a full list please see docker run reference.
By default, the DSE server image is set up as a transactional (database) node.
To set up the node with DSE advanced functionality, add the option that enables feature to the end of the docker run command.
| Option | Description |
|---|---|
| -s | Enables and starts DSE Search. |
| -k | Enables and starts Analytics. |
| -g | Enables and starts a DSE Graph. |
Combine startup options to run more than one feature. For more examples, see Starting DataStax Enterprise as a stand-alone process .
docker run -e DS_LICENSE=accept --name my-dse -d store/datastax/dse-server:5.1.5
docker run -e DS_LICENSE=accept --name my-dse -d store/datastax/dse-server:5.1.5 -g
docker run -e DS_LICENSE=accept --name my-dse -d store/datastax/dse-server:5.1.5 -k
docker run -e DS_LICENSE=accept --name my-dse -d store/datastax/dse-server:5.1.5 -s
Manage the DSE configuration using one of the following options:
-
DSE configuration volume use configuration files from a mounted host directory without replacing or customizing the containers.
-
DSE environment variables that change the configuration at runtime.
-
Docker file/directory volume mounts
-
Docker overlay file system
DataStax provided Docker images include a start up script that swaps DSE configuration files found in the Volume /conf with the configuration file in the default location on the container.
To use this feature:
-
Create a directory on your local host.
-
Add the configuration files you want to replace. Use the following links for full list of configuration files:
The file name must match a corresponding configuration file in the image and include all the required values, for example
cassandra.yaml,dse.yaml,opscenterd.conf. -
Mount the local directory to the exposed Volume
/conf. -
Start the container. For example to start a transactional node:
docker run -e DS_LICENSE=accept --name my-dse -d -v /dse/conf:/conf store/datastax/dse-server:5.1.5
Configure the DSE image by setting environment variables when the container is created using the docker run command -e flag.
| Variable | Setting | Description |
|---|---|---|
DS_LICENSE |
accept | Required. Set to accept to acknowledge that you agree with the terms of the DataStax license. To show the license, set the variable DS_LICENSE to the value accept. The image only starts if the variable set to accept. |
LISTEN_ADDRESS |
IP_address | The IP address to listen for connections from other nodes. Defaults to the container's IP address. |
BROADCAST_ADDRESS |
IP_address | The IP address to advertise to other nodes. Defaults to the same value as the LISTEN_ADDRESS. |
RPC_ADDRESS |
IP_address | The IP address to listen for client/driver connections. Default: 0.0.0.0. |
BROADCAST_RPC_ADDRESS |
IP_address | The IP address to advertise to clients/drivers. Defaults to the same value as the BROADCAST_ADDRESS. |
SEEDS |
IP_address | The comma-delimited list of seed nodes for the cluster. Defaults to this node's BROADCAST_ADDRESS. |
START_RPC |
true | false |
Whether or not to start the Thrift RPC server. Will leave the default in the cassandra.yaml file if not set. |
CLUSTER_NAME |
string | The name of the cluster. Default: Test Cluster. |
NUM_TOKENS |
int | The number of tokens randomly assigned to the node. Default: 8. |
DC |
string | Datacenter name. Default: Cassandra. |
RACK |
string | Rack name. Default: rack1. |
OPSCENTER_IP |
IP_address | string | Address of OpsCenter instance to use for DSE management; it can be specified via linking the OpsCenter container using opscenter as the name. |
DSE images expose the following volumes.
-
For DataStax Enterprise Transactional, Search, Graph, and Analytics workloads:
/var/lib/cassandra: Data from Cassandra/var/lib/spark: Data from DSE Analytics w/ Spark/var/lib/dsefs: Data from DSEFS/var/log/cassandra: Logs from Cassandra/var/log/spark: Logs from Spark/conf: Directory to add custom config files for the container to pickup.
-
For OpsCenter:
/var/lib/opscenter -
For Studio:
/var/lib/datastax-studio
To persist data, pre-create directories on the local host and map the directory to the corresponding volume using the docker run -v flag.
NOTE: If the volumes are not mounted from the local host, all data is lost when the container is removed.
-
DSE Transactional, Search, Graph, and Analytics nodes:
/var/lib/cassandra/data/var/lib/cassandra/commit_logs/var/lib/cassandra/saved_caches
-
OpsCenter:
/var/lib/opscenter -
Studio:
/var/lib/datastax-studio
To mount a volume, use the following syntax:
docker run -v <local_directory>:<container_volume>
Example Mount the host directory /dse/conf to the DSE volume /conf to manage configuration files.
docker run -e DS_LICENSE=accept --name my-dse -d -v /dse/conf:/conf store/datastax/dse-server:5.1.5
See Docker docs > Use volumes for more information.
To allow remote hosts to access a DataStax Enterprise node, OpsCenter, or Studio, map the DSE public port to a host port using the docker run -p flag.
For a complete list of ports see Securing DataStax Enterprise ports.
NOTE: When mapping a container port to a local host port ensure that host port is not already in use by another container or the host.
To allow access to the OpsCenter from browser on a remote host, open port 8888:
docker run -e DS_LICENSE=accept --name my-opscenter -d -p 8888:8888 datastax/dse-opscenter
Use the docker exec -it <container_name> command to run DSE tools and other operations.
If the container is running in the background (using the -d), use the following command to open an interactive bash shell to run DSE commands.
docker exec -it <container_name> bash
To exit the shell without stopping the container type exit.
Use the following command to open cqlsh.
docker exec -it <container_name> cqlsh
To exit the shell without stopping the container use ctl P ctl Q
You can view the DSE logs using the Docker log command. For example:
docker logs my-dse
You can also use your favorite viewer/editor to see individual log files.
docker exec -it <container_name> <viewer/editor> <path_to_log>
For example, to view the system.log:
docker exec -it my-dse less /var/log/cassandra/system.log
Use docker exec to run other tools.
For example
nodetool status command:
docker exec -it my-dse nodetool status
See DSE documentation for further info on usage/configuration
Follow these steps to create an Opscenter container and a connected DataStax Enterprise server container on the same Docker host.
To create and connect the containers:
- First create an OpsCenter container.
docker run -e DS_LICENSE=accept -d -p 8888:8888 --name my-opscenter
See OpsCenter Docker run options for additional options that persist data or manage configuration.
- Create a DataStax Enterprise (DSE) server container that is linked to the OpsCenter container.
docker run -e DS_LICENSE=accept --link my-opscenter:opscenter --name my-dse -d store/datastax/dse-server:5.1.5
- Get the DSE container IP address:
docker exec -it my-dse nodetool status
- Open a browser and go to
http://DOCKER_HOST_IP:8888. - Click
Manage existing cluster. - In
host name, enter the DSE IP address. - Click
Install agents manually. Note that the agent is already installed on the DSE image; no installation is required.
OpsCenter is ready to use with DSE. See the OpsCenter User Guide for detailed usage and configuration instructions.
- Create a Studio container:
docker run -e DS_LICENSE=accept --link my-dse --name my-studio -p 9091:9091 -d datastax/dse-studio
- Open your browser and point to
http://DOCKER_HOST_IP:9091, create the new connection using my-dse as the hostname.
Check Studio documentation for further instructions.
Bootstrapping a multi-node cluster with OpsCenter and Studio can be elegantly automated with Docker Compose. To get sample compose.yml files visit the following links.
3-Node Setup
docker-compose -f docker-compose.yml up -d --scale node=2
3-Node Setup with OpsCenter
docker-compose -f docker-compose.yml -f docker-compose.opscenter.yml up -d --scale node=2
3-Node Setup with OpsCenter and Studio
docker-compose -f docker-compose.yml -f docker-compose.opscenter.yml -f docker-compose.studio.yml up -d --scale node=2
Single Node Setup with Studio
docker-compose -f docker-compose.yml -f docker-compose.studio.yml up -d --scale node=0
The code in this repository will build the images listed above. To build all of them please run the following commands:
./gradlew buildImages -PdownloadUsername=<your_DataStax_Acedemy_username> -PdownloadPassword=<your_DataStax_Acedemy_passwd>By default, Gradle will download DataStax tarballs from DataStax Academy.
Therefore you need to provide your credentials either via the command line, or in gradle.properties file located
in the project root.
Run ./gradlew tasks to get the list of all available tasks.
File an issue or email us at techpartner@datastax.com.
- CFS is not supported
- Changing any file not included in the list of approved configuration files will require an additional host volume or customization of the image. An example is SSL key management.
Use the following links to review the license: