frankgh commented on code in PR #232: URL: https://github.com/apache/cassandra-sidecar/pull/232#discussion_r2265452549
########## docs/src/user.adoc: ########## @@ -1,15 +1,446 @@ # Overview -This is the documentation for the official Sidecar project for Apache Cassandra. +This document serves as a quickstart guide to get Cassandra Sidecar running and connected to your Cassandra cluster. -NOTE: This documentation is only a placeholder at the moment and requires some love. +NOTE: This documentation requires some love. ## Installation -You will probably find it easiest to install the sidecar by using one of the system packages we have available. +### Prerequisites +Like Cassandra itself, you will need to install the latest version of Java 11, from one of the following locations: +* https://www.oracle.com/java/technologies/javase/jdk11-archive-downloads.html[Oracle Java Standard Edition 11 Archived Version] +* https://jdk.java.net/archive/[OpenJDK 11] + +[[installation-methods]] +== Installation Methods + +There are two supported methods for installing pre-built versions of Cassandra Sidecar: + + * Tarball binary file + * Package installation (RPM, YUM) + +Additionally, you can build a Docker image from source by running `./gradlew :server:jibDockerBuild` from the Cassandra Sidecar repository. + +### Tarball binary file +First, verify that you have installed the correct Java version by running: + +`java -version` + +Next, download the binary tarball for the version you would like to install from https://downloads.apache.org/cassandra/cassandra-sidecar/{project-version}/apache-cassandra-sidecar-{project-version}.tar.gz + +Next, unpack the tarball like so: + +`tar xzvf apache-cassandra-sidecar-{project-version}.tar.gz` + +Once you have extracted the tarball, you can proceed to <<setup, Setup>> below. + +### Install a Debian Package +First, verify that you have installed the correct Java version by running: + +`java -version` + +Next, download the cassandra-sidecar Debian package (i.e. `.deb` file) from https://downloads.apache.org/cassandra/cassandra-sidecar/{project-version}/debian/. For example, you can run `curl -sLO https://downloads.apache.org/cassandra/cassandra-sidecar/{project-version}/debian/apache-cassandra-sidecar_{project-version}_all.deb` to download the Debian package to your local machine. + +Next, install the downloaded Debian package by running + +`sudo apt install ~/apache-cassandra-sidecar_{project-version}_all.deb`. + +This will install the Cassandra Sidecar package under the directory `/opt/apache-cassandra-sidecar`. Once you have finished installing the Debian package, you can proceed to <<setup, Setup>> below. + +### Install as RPM Package +First, verify that you have installed the correct Java version by running + +`java -version` + +Next, download the cassandra-sidecar RPM package (i.e. `.rpm` file) from https://downloads.apache.org/cassandra/cassandra-sidecar/{project-version}/redhat/. For example, you can run `curl -sLO https://downloads.apache.org/cassandra/cassandra-sidecar/{project-version}/redhat/apache-cassandra-sidecar-{project-version}.noarch.rpm` to download the RPM package to your local machine. + +Next, install the RPM package by running: + +`sudo yum install apache-cassandra-sidecar-{project-version}.noarch.rpm`. + +This will install Cassandra Sidecar under the directory `/opt/apache-cassandra-sidecar`. Once you have finished installing the RPM package, you can proceed to <<setup, Setup>> below. + +[[setup]] ## Setup +In this section, we will cover the basic configurations required to connect Cassandra Sidecar to your Cassandra cluster. For a more in-depth guide on Cassandra Sidecar configuration, please see the <<configuring,Configuring>> section. + +Cassandra Sidecar's root directory will contain the following directories: + +* bin: This contains the script to start Cassandra Sidecar +* conf: This is the location of the Cassandra Sidecar configuration +* lib: This directory contains the JAR files which comprise the Cassandra Sidecar application +* agents: This directory contains JAR files for JVM agents which attach to Cassandra Sidecar (such as Jolokia) Review Comment: I guess this is gone since [CASSSIDECAR-330](https://issues.apache.org/jira/browse/CASSSIDECAR-330): Remove Jolokia agent -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: pr-unsubscr...@cassandra.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: pr-unsubscr...@cassandra.apache.org For additional commands, e-mail: pr-h...@cassandra.apache.org
