From fb171d956264bcd28e41431f8917e1882367ad3f Mon Sep 17 00:00:00 2001 From: Jon Haddad Date: Tue, 26 Sep 2017 07:52:51 -0500 Subject: [PATCH] Changes requested by Alex --- src/docs/config.toml | 2 +- .../packages.md => download/_index.md} | 10 +- .../docs/{install => download}/building.md | 2 +- .../docs/{install => download}/docker.md | 2 +- .../_index.md => download/install.md} | 6 +- src/docs/content/download.md | 94 ------------------- 6 files changed, 12 insertions(+), 104 deletions(-) rename src/docs/content/docs/{install/packages.md => download/_index.md} (88%) rename src/docs/content/docs/{install => download}/building.md (96%) rename src/docs/content/docs/{install => download}/docker.md (99%) rename src/docs/content/docs/{install/_index.md => download/install.md} (96%) delete mode 100644 src/docs/content/download.md diff --git a/src/docs/config.toml b/src/docs/config.toml index d80609651..c8cbbac77 100644 --- a/src/docs/config.toml +++ b/src/docs/config.toml @@ -15,7 +15,7 @@ publishDir = "../../docs" [[menu.main]] name = "Downloads" - url = "/docs/install/" + url = "/docs/download/" [[menu.main]] name = "FAQ" diff --git a/src/docs/content/docs/install/packages.md b/src/docs/content/docs/download/_index.md similarity index 88% rename from src/docs/content/docs/install/packages.md rename to src/docs/content/docs/download/_index.md index 44b80468f..a3fe1aa88 100644 --- a/src/docs/content/docs/install/packages.md +++ b/src/docs/content/docs/download/_index.md @@ -1,14 +1,11 @@ +++ [menu.docs] -name = "Pre built packages" -identifier = "packages" +name = "Downloads" weight = 1 -parent = "download_install" +identifier = "download" +++ - - # Downloads and Installation The current stable version is [0.6.2](https://github.com/thelastpickle/cassandra-reaper/releases/tag/0.6.2) : @@ -25,3 +22,6 @@ The latest beta version is [0.7.0-beta-25082017](https://github.com/thelastpickl For a docker image, please see the Docker section. + + +Once you've downloaded the proper package for your OS, head over to the [Install and Run](install) section. \ No newline at end of file diff --git a/src/docs/content/docs/install/building.md b/src/docs/content/docs/download/building.md similarity index 96% rename from src/docs/content/docs/install/building.md rename to src/docs/content/docs/download/building.md index 48c105e45..4eb5c3d14 100644 --- a/src/docs/content/docs/install/building.md +++ b/src/docs/content/docs/download/building.md @@ -3,7 +3,7 @@ name = "Building from Source" identifier = "building" weight = 4 -parent = "download_install" +parent = "download" +++ # Building Install Packages diff --git a/src/docs/content/docs/install/docker.md b/src/docs/content/docs/download/docker.md similarity index 99% rename from src/docs/content/docs/install/docker.md rename to src/docs/content/docs/download/docker.md index dc420648b..a64dbec1f 100644 --- a/src/docs/content/docs/install/docker.md +++ b/src/docs/content/docs/download/docker.md @@ -2,7 +2,7 @@ [menu.docs] name = "Docker" weight = 50 -parent = "download_install" +parent = "download" +++ # Docker diff --git a/src/docs/content/docs/install/_index.md b/src/docs/content/docs/download/install.md similarity index 96% rename from src/docs/content/docs/install/_index.md rename to src/docs/content/docs/download/install.md index f5c2f7373..570f74152 100644 --- a/src/docs/content/docs/install/_index.md +++ b/src/docs/content/docs/download/install.md @@ -1,11 +1,13 @@ +++ [menu.docs] -name = "Download and Install" +name = "Install and Run" weight = 1 -identifier = "download_install" +identifier = "install" +parent = "download" +++ + # Running Reaper After modifying the `resource/cassandra-reaper.yaml` config file, Reaper can be started using the following command line : diff --git a/src/docs/content/download.md b/src/docs/content/download.md deleted file mode 100644 index c8245e6b3..000000000 --- a/src/docs/content/download.md +++ /dev/null @@ -1,94 +0,0 @@ -# Downloads and Installation - -The current stable version is [0.6.2](https://github.com/thelastpickle/cassandra-reaper/releases/tag/0.6.2) : - -* [Deb Package](https://github.com/thelastpickle/cassandra-reaper/releases/download/0.6.2/reaper_0.6.2_amd64.deb) -* [RPM](https://github.com/thelastpickle/cassandra-reaper/releases/download/0.6.2/reaper-0.6.2-1.x86_64.rpm) -* [Tarball](https://github.com/thelastpickle/cassandra-reaper/releases/download/0.6.2/cassandra-reaper-0.6.2-release.tar.gz) - -The latest beta version is [0.7.0-beta-25082017](https://github.com/thelastpickle/cassandra-reaper/releases/tag/0.7.0-beta-25082017) : - -* [Deb Package](https://github.com/thelastpickle/cassandra-reaper/releases/download/0.7.0-beta-25082017/reaper_0.7-SNAPSHOT_amd64.deb) -* [RPM](https://github.com/thelastpickle/cassandra-reaper/releases/download/0.7.0-beta-25082017/reaper-0.7_SNAPSHOT-1.x86_64.rpm) -* [Tarball](https://github.com/thelastpickle/cassandra-reaper/releases/download/0.7.0-beta-25082017/cassandra-reaper-0.7.0-SNAPSHOT-release.tar.gz) - - -For a docker image, please see the Docker section. - -## Building Packages - -Debian and RPM packages can be built from this project using Make, for example: - -```bash -make deb -make rpm -``` - -## Docker - - -A [Docker](https://docs.docker.com/engine/installation/) build environment is -also provided in the `src/packaging` directory to build the entire project and can be run by using -[Docker Compose](https://docs.docker.com/compose/install/): - -```bash -docker-compose -f docker-build/docker-compose.yml build \ - && docker-compose -f docker-build/docker-compose.yml run build -``` - -The final packages will be located within: - -```./packages/``` - - -## Building from source - -The easiest way to build is to use the following make command: - -```bash -make package -``` - - -To build Reaper without rebuilding the UI, run the following command : - -```mvn clean package``` - -To only regenerate the UI (requires npm and bower) : - -```mvn generate-sources -Pbuild-ui``` - -To rebuild both the UI and Reaper : - -```mvn clean package -Pbuild-ui``` - -To build the docker image : - -```mvn clean package docker:build``` - -### Running Reaper - -After modifying the `resource/cassandra-reaper.yaml` config file, Reaper can be started using the following command line : - -```java -jar target/cassandra-reaper-X.X.X.jar server resource/cassandra-reaper.yaml``` - -Once started, the UI can be accessed through : http://127.0.0.1:8080/webui/ - -Reaper can also be accessed using the REST API exposed on port 8080, or using the command line tool `bin/spreaper` - - - -## Install RPM or DEB package and run as a service - -Install the RPM (Fedora based distros like RHEL or Centos) using : `sudo rpm -ivh reaper-*.*.*.x86_64.rpm` -Install the DEB (Debian based distros like Ubuntu) using : `sudo dpkg -i reaper_*.*.*_amd64.deb` - -The yaml file used by the service is located at `/etc/cassandra-reaper/cassandra-reaper.yaml` and alternate config templates can be found under `/etc/cassandra-reaper/configs`. -It is recommended to create a new file with your specific configuration and symlink it as `/etc/cassandra-reaper/cassandra-reaper.yaml` to avoid your configuration from being overwritten during upgrades. -Adapt the config file to suit your setup and then run `sudo service cassandra-reaper start`. - -Log files can be found at `/var/log/cassandra-reaper.log` and `/var/log/cassandra-reaper.err`. - -Stop the service by running : `sudo service cassandra-reaper stop` - -