e8fb718e4a
The patch series introduces linearisable topology changes using raft protocol. The state machine driven by raft is described in "service: Introduce topology state machine". Some explanations about the implementation can be found in "storage_service: raft topology: implement topology management through raft". The code is not ready for production. There is not much in terms of error handling and integration with the rest of the system is not even started. For full integration request fencing will need to be implemented and token_metadata has to be extended to support not just "pending" nodes but concepts of "read replica set" and "write replica set". The code may be far from be usable, but it is hidden behind the "experimental raft" flag and having it in tree will relieve me from constant rebase burden. * 'raft-topology-v6' of github.com:scylladb/scylla-dev: storage_service: fix indentation from previous patch storage_service: raft topology: implement topology management through raft service: raft: make group0_guard move assignable service: raft: wire up apply() and snapshot transfer for topology in group0 state machine storage_service: raft topology: introduce a function that applies topology cmd to local state machine storage_service: raft topology: introduce a raft monitor and topology coordinator fibers storage_service: raft topology: introduce snapshot transfer code for the topology table raft topology: add RAFT_TOPOLOGY_CMD verb that will be used by topology coordinator to communicated with nodes bootstrapper: Add get_random_bootstrap_tokens function service: raft: add support for topology_change command into raft_group0_client service: raft: introduce topology_change group0 command system_keyspace: add a table to persist topology change state machine's state service: Introduce topology state machine data structures storage_proxy: not consult topology on local table write
ScyllaDB Documentation
This repository contains the source files for ScyllaDB Open Source documentation.
- The
devfolder contains developer-oriented documentation related to the ScyllaDB code base. It is not published and is only available via GitHub. - All other folders and files contain user-oriented documentation related to ScyllaDB Open Source and are sources for docs.scylladb.com.
To report a documentation bug or suggest an improvement, open an issue in GitHub issues for this project.
To contribute to the documentation, open a GitHub pull request.
Key Guidelines for Contributors
- Follow the ScyllaDB Style Guide.
- The user documentation is written in reStructuredText (RST) - a plaintext markup language similar to Markdown. If you're not familiar with RST, see ScyllaDB RST Examples.
- The developer documentation is written in Markdown. See Basic Markdown Syntax for reference.
Creating Knowledge Base Articles
The kb/ directory holds source files for knowledge base articles in the Knowledge Base section of the ScyllaDB documentation.
The kb/kb_common subdirectory contains a template for knowledge base articles to help you create new articles.
To create a new knowledge base article (KB):
- Copy the
kb-article-template.rstfile from/kb/kb_commonto/kband rename it with a unique name. - Open the new file and fill in the required information.
- Remove what is not needed.
- Run
make previewto build the docs and preview them locally. - Send a PR with "KB" in its title.
Building User Documentation
Prerequisites
- Python 3. Check your version with
$ python --version. - poetry 1.12 or later
- make
Mac OS X
You must have a working Homebrew in order to install the needed tools.
You also need the standard utility make.
Check if you have these two items with the following commands:
brew help
make -h
Linux Distributions
Building the user docs should work out of the box on most Linux distributions.
Windows
Use "Bash on Ubuntu on Windows" for the same tools and capabilities as on Linux distributions.
Building the Docs
- Run
make previewto build the documentation. - Preview the built documentation locally at http://127.0.0.1:5500/.
Cleanup
You can clean up all the build products and auto-installed Python stuff with:
make pristine
Information for Contributors
If you are interested in contributing to Scylla docs, please read the Scylla open source page at http://www.scylladb.com/opensource/ and complete a Scylla contributor agreement if needed. We can only accept documentation pull requests if we have a contributor agreement on file for you.
Third-party Documentation
-
Do any copying as a separate commit. Always commit an unmodified version first and then do any editing in a separate commit.
-
We already have a copy of the Apache license in our tree, so you do not need to commit a copy of the license.
-
Include the copyright header from the source file in the edited version. If you are copying an Apache Cassandra document with no copyright header, use:
This document includes material from Apache Cassandra.
Apache Cassandra is Copyright 2009-2014 The Apache Software Foundation.