mirror of
https://github.com/scylladb/scylladb.git
synced 2026-06-03 21:47:10 +00:00
774f8aa4b8
Merged patch series from Botond Dénes: This series extends the existing docs/debugging.md with a detailed guide on how to debug Scylla coredumps. The intended target audience is developers who are debugging their first core, hence the level of details (hopefully enough). That said this should be just as useful for seasoned debuggers just quickly looking up some snippet they can't remember exactly. A Throubleshooting chapter is also added in this series for commonly-met problems. I decided to create this guide after myself having struggled for more than a day on just opening(!) a coredump that was produced on Ubuntu. As my main source, I used the How-to-debug-a-coredump page from the internal wiki which contains many useful information on debugging coredumps, however I found it to be missing some crucial information, as well being very terse, thus being primarily useful for experienced debuggers who can fill in the blanks. The reason I'm not extending said wiki page is that I think this information should not be hidden in some internal wiki page. Also, docs/debugging.md now seems to be a much better base for such a document. This document was started as a comprehensive debugging manual for beginners (but not just). You will notice that the information on how to debug cores from CentOS/Redhat are quite sparse. This is because I have no experience with such cores, so for now the respective chapters are just stubs. I intend to complete them in the future after having gained the necessary experience and knowledge, however those being in possession of said knowledge are more then welcome to send a patch. :) Botond Dénes (4): docs/debugging.md: demote 'Starting GDB' and 'Using GDB' docs/debugging.md: fix formatting issues docs/debugging.md: add 'Debugging coredumps' subchapter docs/debugging.md: add 'Throubleshooting' subchapter docs/debugging.md | 240 +++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 228 insertions(+), 12 deletions(-)
Scylla
Quick-start
To get the build going quickly, Scylla offers a frozen toolchain which would build and run Scylla using a pre-configured Docker image. Using the frozen toolchain will also isolate all of the installed dependencies in a Docker container. Assuming you have met the toolchain prerequisites, which is running Docker in user mode, building and running is as easy as:
$ ./tools/toolchain/dbuild ./configure.py
$ ./tools/toolchain/dbuild ninja build/release/scylla
$ ./tools/toolchain/dbuild ./build/release/scylla --developer-mode 1
Please see HACKING.md for detailed information on building and developing Scylla.
Note: GCC >= 8.1.1 is required to compile Scylla.
Running Scylla
- Run Scylla
./build/release/scylla
- run Scylla with one CPU and ./tmp as data directory
./build/release/scylla --datadir tmp --commitlog-directory tmp --smp 1
- For more run options:
./build/release/scylla --help
Scylla APIs and compatibility
By default, Scylla is compatible with Apache Cassandra and its APIs - CQL and Thrift. There is also experimental support for the API of Amazon DynamoDB, but being experimental it needs to be explicitly enabled to be used. For more information on how to enable the experimental DynamoDB compatibility in Scylla, and the current limitations of this feature, see Alternator and Getting started with Alternator.
Documentation
Documentation can be found in ./docs and on the wiki. There is currently no clear definition of what goes where, so when looking for something be sure to check both. Seastar documentation can be found here. User documentation can be found here.
Building Fedora RPM
As a pre-requisite, you need to install Mock on your machine:
# Install mock:
sudo yum install mock
# Add user to the "mock" group:
usermod -a -G mock $USER && newgrp mock
Then, to build an RPM, run:
./dist/redhat/build_rpm.sh
The built RPM is stored in /var/lib/mock/<configuration>/result directory.
For example, on Fedora 21 mock reports the following:
INFO: Done(scylla-server-0.00-1.fc21.src.rpm) Config(default) 20 minutes 7 seconds
INFO: Results and/or logs in: /var/lib/mock/fedora-21-x86_64/result
Building Fedora-based Docker image
Build a Docker image with:
cd dist/docker
docker build -t <image-name> .
Run the image with:
docker run -p $(hostname -i):9042:9042 -i -t <image name>