datastax/dse-opscenter repository overview

⁠Quick Reference

⁠Where to get help:

DataStax Docker Docs⁠, DataStax Slack⁠, Github⁠ Contact Us for more information on becoming a DataStax Customer⁠

Advanced tutorials are located within DataStax Academy⁠

Featured Tutorial - DataStax Enterprise 6 Guided Tour⁠

⁠Where to file issues:

https://github.com/datastax/docker-images/issues⁠

⁠Maintained by

DataStax⁠

⁠What is DataStax OpsCenter

OpsCenter is the web-based visual management and monitoring solution for DataStax Enterprise DSE⁠.

⁠Getting Started with DataStax and Docker

DataStax Docker images are licensed only for Development purposes in non-production environments. You can use these images to learn DSE⁠, OpsCenter⁠ and DataStax Studio⁠, to try new ideas, to test and demonstrate your application.

⁠Creating an Opscenter Container

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:

1. First create an OpsCenter container.

   • docker run -e DS_LICENSE=accept -d -p 8888:8888 -p 61620:61620 --name my-opscenter datastax/dse-opscenter:<version tag>

   • See OpsCenter Docker run options⁠ for additional options that persist data or manage configuration.

2. 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 datastax/dse-server:<version tag>

3. Get the DSE container IP address:

   • On the host running the DSE container run

   • docker inspect my-dse | grep '"IPAddress":'

4. Open a browser and go to http://DOCKER_HOST_IP:8888.

5. Click Manage existing cluster.

6. In host name, enter the DSE IP address.

7. 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.

⁠Managing the configuration

Manage Opscenters configuration using one of the following options:

• DSE configuration volume⁠ For configuration management, we’re providing a simple mechanism to let you provide custom configuration file(s) without customizing the containers or over using host volumes. You can add any of the approved config files⁠ to a single mounted host volume and we’ll handle the hard work of mapping them within the container.

• Docker file/directory volume mounts

• Docker overlay file system

⁠Using the DSE config volume

To use this feature:

1. Create a directory on your local host.
2. Download and customize the configuration files you want to use from the config-templates⁠ page.
3. Add the custom configuration files to the host directory you created.
   • The file name must match a corresponding configuration file in the image and include all the required values, for example opscenterd.conf.
4. Mount the exposed Volume /config to the local directory.
5. Start the container. For example to start a database node:

docker run -e DS_LICENSE=accept --name my-dse  -v /opsc/config:/config -d datastax/dse-server:<version tag>

Note When you make changes to or add config files to the /config volume, you will need to restart your container with docker restart container_name for DSE to pickup the changes. Restarting the container will restart DSE.

⁠Volumes and data

Opscenter metrics are stored in the OpsCenter keyspace in DSE.

To persist a configuration file:

For example to mount the opscenterd.conf

1. Create a directory on the Docker host.

2. Bind mount the local directory to the config file you want to persist by starting the container with the -v flag.

docker run -e DS_LICENSE=accept -d -v /dse/data/opscenter:/opt/opscenter/conf/opscenterd.conf datastax/dse-opscenter:<version tag> --name my-opscenter

⁠Opening an interactive bash shell

If the container is running in the background (using the -d), use the following command to open an interactive bash shell.

docker exec -it <container_name> bash

To exit the shell without stopping the container type exit.

⁠Viewing logs

You can view the OpsCenter logs using the Docker log command. For example:

docker logs my-opscenter

⁠Next Steps

Head over to the DataStax Docs⁠ and DataStax Academy⁠ for advanced documentation including

• Apache Cassandra™/Datastax configuration management
• Using environment variables
• Persisting data
• Exposing public ports
• Volumes and data directories
• Docker Compose examples to spin up connected clusters of DataStax Enterprise, Studio, and Opscenter (also on github⁠)
• Step-by-step tutorials and examples
• How to build applications using Apache Cassandra™/ DataStax

⁠Licensing

Use the following links to review the license:

OpsCenter License Terms⁠ DataStax License Terms⁠