6d8dca1e20
as part of the efforts to address scylladb/scylladb#2717, we are switching over to the CMake-based building system, and fade out the mechinary to create the rules manually in `configure.py`. in this change, we add `--no-use-cmake` to `configure.py`, it serves two purposes: * prepare for the change which enables cmake by default, by then, we would set the default value of `use_cmake` to True, and allow user to keep using the existing mechinary in the transition period using `--no-use-cmake`. * allows the CI to tell if a tree is able to build with CMake. the command line option of `--use-cmake` is also used by the CI workflows, and is passed to `configure.py` if `BUILD_WITH_CMAKE` jenkins pipeline parameter is set. but not all branches with `--use-cmake` are ready to build with CMake -- only the latest master HEAD is ready. so the CI needs to check the capability of building with CMake by looking at the output of `configure.py --help`, to see if it includes --no-use-cmake`. after this change lands. we will remove the `BUILD_WITH_CMAKE` parameter, and use cmake as long as `configure.py` supports `--no-use-cmake` option. the existing mechinary will stay with us for a short transition period so that developers can take time to get used to the usage of the naming of targets and the new directory arrangement. as a side effect, #20079 will be fixed after switching to CMake. Refs scylladb/scylladb#2717 Refs scylladb/scylladb#20079 Signed-off-by: Kefu Chai <kefu.chai@scylladb.com>
Scylla
What is Scylla?
Scylla is the real-time big data database that is API-compatible with Apache Cassandra and Amazon DynamoDB. Scylla embraces a shared-nothing approach that increases throughput and storage capacity to realize order-of-magnitude performance improvements and reduce hardware costs.
For more information, please see the ScyllaDB web site.
Build Prerequisites
Scylla is fairly fussy about its build environment, requiring very recent versions of the C++23 compiler and of many libraries to build. The document HACKING.md includes detailed information on building and developing Scylla, but to get Scylla building quickly on (almost) any build machine, Scylla offers a frozen toolchain, This is a pre-configured Docker image which includes recent versions of all the required compilers, libraries and build tools. Using the frozen toolchain allows you to avoid changing anything in your build machine to meet Scylla's requirements - you just need to meet the frozen toolchain's prerequisites (mostly, Docker or Podman being available).
Building Scylla
Building Scylla with the frozen toolchain dbuild is as easy as:
$ git submodule update --init --force --recursive
$ ./tools/toolchain/dbuild ./configure.py
$ ./tools/toolchain/dbuild ninja build/release/scylla
For further information, please see:
- Developer documentation for more information on building Scylla.
- Build documentation on how to build Scylla binaries, tests, and packages.
- Docker image build documentation for information on how to build Docker images.
Running Scylla
To start Scylla server, run:
$ ./tools/toolchain/dbuild ./build/release/scylla --workdir tmp --smp 1 --developer-mode 1
This will start a Scylla node with one CPU core allocated to it and data files stored in the tmp directory.
The --developer-mode is needed to disable the various checks Scylla performs at startup to ensure the machine is configured for maximum performance (not relevant on development workstations).
Please note that you need to run Scylla with dbuild if you built it with the frozen toolchain.
For more run options, run:
$ ./tools/toolchain/dbuild ./build/release/scylla --help
Testing
See test.py manual.
Scylla APIs and compatibility
By default, Scylla is compatible with Apache Cassandra and its API - CQL. There is also support for the API of Amazon DynamoDB™, which needs to be enabled and configured in order to be used. For more information on how to enable the DynamoDB™ API in Scylla, and the current compatibility of this feature as well as Scylla-specific extensions, see Alternator and Getting started with Alternator.
Documentation
Documentation can be found here. Seastar documentation can be found here. User documentation can be found here.
Training
Training material and online courses can be found at Scylla University. The courses are free, self-paced and include hands-on examples. They cover a variety of topics including Scylla data modeling, administration, architecture, basic NoSQL concepts, using drivers for application development, Scylla setup, failover, compactions, multi-datacenters and how Scylla integrates with third-party applications.
Contributing to Scylla
If you want to report a bug or submit a pull request or a patch, please read the contribution guidelines.
If you are a developer working on Scylla, please read the developer guidelines.
Contact
- The community forum and Slack channel are for users to discuss configuration, management, and operations of the ScyllaDB open source.
- The developers mailing list is for developers and people interested in following the development of ScyllaDB to discuss technical topics.