You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Updates to Docker packaging to fix structure and flexibility
- Updated main POM file properties to include docker build directory
- Added new service to ./packaging/docker-compose.yml file which extends the
services in the ./packaging/docker-build/docker-compose.yml. This allows
packages to be built using the commands:
'docker-compose build reaper-build-packages && docker-compose run reaper-build-packages'
- Renamed ./packaging/docker to ./packaging/docker-services to better reflect
the directory contents and to separate it from the ./packaging/docker-build directory
- Updated site documentation to match new structure
Copy file name to clipboardExpand all lines: src/docs/content/docs.md
+57-27
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,9 @@
4
4
5
5
See the [download](/download/) section for information on how to download and install reaper.
6
6
7
-
8
7
## Community
9
8
10
-
We have a [Mailing List](https://groups.google.com/forum/#!forum/tlp-apache-cassandra-reaper-users) and [Gitter chat](https://gitter.im/thelastpickle/cassandra-reaper) available.
11
-
9
+
We have a [Mailing List](https://groups.google.com/forum/#!forum/tlp-apache-cassandra-reaper-users) and [Gitter chat](https://gitter.im/thelastpickle/cassandra-reaper) available.
12
10
13
11
## Configuration
14
12
@@ -358,41 +356,65 @@ Source code for all the REST resources can be found from package com.spotify.rea
358
356
Delete all the related repair runs before calling this endpoint.
359
357
360
358
361
-
## Running through Docker
359
+
## Docker
360
+
361
+
[Docker](https://docs.docker.com/engine/installation/) and [Docker Compose](https://docs.docker.com/compose/install/) will need to be installed in order to use the commands in this section.
362
+
363
+
### Building Reaper Packages with Docker
364
+
365
+
Building Reaper packages requires quite a few dependencies, especially when making changes to the web interface code. In an effort to simplify the build process, Dockerfiles have been created that implement the build actions required to package Reaper.
362
366
367
+
To build the JAR and other packages which are then placed in the _packages_ directory run the following commands from the top level directory:
363
368
364
-
### Build Reaper Docker Image
369
+
```bash
370
+
cd src/packaging
371
+
docker-compose build reaper-build-packages && docker-compose run reaper-build-packages
372
+
```
373
+
374
+
### Building Reaper Docker Image
365
375
366
-
First, build the Docker image and add it to your local image cache using the
367
-
`cassandra-reaper:latest` tag:
376
+
To build the Reaper Docker Image which is then added to the local image cache using the `cassandra-reaper:latest` tag, run the following commands from the top level directory:
368
377
369
-
```mvn clean package docker:build```
378
+
```bash
379
+
cd src/server
380
+
mvn package docker:build
381
+
```
382
+
383
+
Note that the above command will build the Reaper JAR and place it in the _src/server/target_ directory prior to creating the Docker Image. It is also possible to build the JAR file using the [Docker package build](building-reaper-packages-with-docker) instructions and omitting the `package` command from the above Maven commands.
370
384
371
385
### Start Docker Environment
372
386
373
-
First, start the Cassandra cluster:
387
+
From the top level directory change to the _src/packaging_ directory
388
+
389
+
```bash
390
+
cd src/packaging
391
+
```
374
392
375
-
```docker-compose up cassandra```
393
+
Start the Cassandra cluster:
376
394
377
-
You can use the `nodetool` Docker Compose service to check on the Cassandra
378
-
node's status:
395
+
```bash
396
+
docker-compose up cassandra
397
+
```
379
398
380
-
```docker-compose run nodetool status```
399
+
The `nodetool` Docker Compose service can be used to check on the Cassandra node's status:
381
400
382
-
Once the Cassandra node is online and accepting CQL connections,
383
-
create the required `reaper_db` Cassandra keyspace to allow Reaper to save
384
-
its cluster and scheduling data.
401
+
```bash
402
+
docker-compose run nodetool status
403
+
```
385
404
386
-
By default, the `reaper_db` keyspace is created using a replication factor
387
-
of 1. To change this replication factor, provide the intended replication
388
-
factor as an optional argument:
405
+
Once the Cassandra node is online and accepting CQL connections, create the required `reaper_db` Cassandra keyspace to allow Reaper to save its cluster and scheduling data.
389
406
390
-
```docker-compose run initialize-reaper_db [$REPLICATION_FACTOR]```
407
+
By default, the `reaper_db` keyspace is created using a replication factor of 1. To change this replication factor, provide the intended replication factor as an optional argument:
408
+
409
+
```bash
410
+
docker-compose run initialize-reaper_db [$REPLICATION_FACTOR]
411
+
```
391
412
392
-
Wait a few moments for the `reaper_db` schema change to propagate,
393
-
then start Reaper:
413
+
Wait a few moments for the `reaper_db` schema change to propagate, then start Reaper:
0 commit comments