Commit Graph

76 Commits

Author SHA1 Message Date
Pekka Enberg
263261fa15 README: Remove out-of-date package build instructions
The package build instructions in README.md are out-of-date so let's
remove them.

Message-Id: <20200224064632.3285-1-penberg@scylladb.com>
2020-02-24 10:25:07 +02:00
guy9
a7586c6f7d added training section to readme file 2020-02-21 11:36:18 +01:00
Konstantin Osipov
4d3423b983 test.py: add a help file
Message-Id: <20200128210426.24509-2-kostja@scylladb.com>
2020-01-30 11:05:02 +02:00
Pavel Emelyanov
e0f40ed16a cli: Add the --workdir|-W option
When starting scylla daemon as non-root the initialization fails
because standard /var/lib/scylla is not accessible by regular users.
Making the default dir accessible for user is not very convenient
either, as it will cause conflicts if two or more instances of scylla
are in use.

This problem can be resolved by specifying --commitlog-directory,
--data-file-directories, etc on start, but it's too much typing. I
propose to revive Nadav's --home option that allows to move all the
directories under the same prefix in one go.

Unlike Nadav's approach the --workdir option doesn't do any tricky
manipulations with existing directories. Insead, as Pekka suggested,
the individual directories are placed under the workir if and only
if the respective option is NOT provided. Otherwise the directory
configuration is taken as is regardless of whether its absolute or
relative path.

The values substutution is done early on start. Avi suggested that
this is unsafe wrt HUP config re-read and proper paths must be
resolved on the fly, but this patch doesn't address that yet, here's
why.

First of all, the respective options are MustRestart now and the
substitution is done before HUP handler is installed.

Next, commitlog and data_file values are copied on start, so marking
the options as LiveUpdate won't make any effect.

Finally, the existing named_value::operator() returns a reference,
so returning a calculated (and thus temporary) value is not possible
(from my current understanding, correct me if I'm wrong). Thus if we
want the *_directory() to return calculated value all callers of them
must be patched to call something different (e.g. *_directory.get() ?)
which will lead to more confusion and errors.

Changes v3:
 - the option is --workdir back again
 - the existing *directory are only affected if unset
 - default config doesn't have any of these set
 - added the short -W alias

Changes v2:
 - the option is --home now
 - all other paths are changed to be relative

Signed-off-by: Pavel Emelyanov <xemul@scylladb.com>
Message-Id: <20191119130059.18066-1-xemul@scylladb.com>
2019-11-21 15:07:39 +02:00
Botond Dénes
52afbae1e5 README.md: add links to other documentation sources
Signed-off-by: Botond Dénes <bdenes@scylladb.com>
Message-Id: <20191010103926.34705-3-bdenes@scylladb.com>
2019-10-10 14:15:01 +03:00
Nadav Har'El
67a07e9cbc README.md: mention Alternator
Mention on the top-level README.md that Scylla by default is compatible
with Cassandra, but also has experimental support for DynamoDB's API.
Provide links to alternator/alternator.md and alternator/getting-started.md
with more information about this feature.

Signed-off-by: Nadav Har'El <nyh@scylladb.com>
Message-Id: <20190911080913.10141-1-nyh@scylladb.com>
2019-09-11 18:01:58 +03:00
Konstantin Osipov
fcd52d6187 Update README.md with more recent build instructions on Ubuntu
Building on Ubuntu 18 or 19 following the current build instructions
doesn't work. Add information about a few pitfalls. Switch README.md
to recommending dbuild and move the details to HACKING.md.

Message-Id: <20190520152738.GA15198@atlas>
2019-05-29 12:26:12 +03:00
Avi Kivity
cb51fcab9d README: improbe dbuild instructions
Add a quick start, document more options, and link from the main README.
Message-Id: <20190210154606.21739-1-avi@scylladb.com>
2019-02-11 09:25:25 +01:00
Duarte Nunes
fa2b0384d2 Replace std::experimental types with C++17 std version.
Replace stdx::optional and stdx::string_view with the C++ std
counterparts.

Some instances of boost::variant were also replaced with std::variant,
namely those that called seastar::visit.

Scylla now requires GCC 8 to compile.

Signed-off-by: Duarte Nunes <duarte@scylladb.com>
Message-Id: <20190108111141.5369-1-duarte@scylladb.com>
2019-01-08 13:16:36 +02:00
Jesse Haber-Kucharsky
d6c0138576 README.md: Add quick-start section and defer to HACKING.md 2017-07-25 17:58:00 -04:00
botond
884928c511 install-dependencies.sh: Fix ubuntu dependencies
Remove dependencies section from README.md, point to the
install-dependencies.sh script instead.

Signed-off-by: Botond Dénes <bdenes@scylladb.com>
Message-Id: <7f51f17a743a82d68b7d4a279b066ffe55fe0379.1500540523.git.bdenes@scylladb.com>
2017-07-20 12:00:20 +03:00
Jesse Haber-Kucharsky
4f838a82e2 Add guide for getting started with development ("hacking")
This change adds the start of what will hopefully be a continually evolving and
improving document for helping developers and contributors to get started with
Scylla development.

The first part of the document is general advice and information that is broadly
applicable.

The second part is an opinionated example of a particular work-flow and set of
tools. This is intended to serve as a starting point and inspire contributors to
develop their own work-flow.

The section on branching is marked "TODO" for now, and will be addressed by a
subsequent change.

Signed-off-by: Jesse Haber-Kucharsky <jhaberku@scylladb.com>
Message-Id: <470a542a92aff20d6205fb94b3fb26168735ae6f.1499319310.git.jhaberku@scylladb.com>
2017-07-06 15:59:16 +03:00
Pekka Enberg
8a4bd6ecd5 README: Guidelines for contributing
Message-Id: <1479288359-14168-1-git-send-email-penberg@scylladb.com>
2016-11-16 12:50:02 +02:00
Piotr Jastrzebski
1948ec8061 Update README.md
Add --init to git submodules update.
It's needed for fmt.
Add libunwind-devel dependency do dnf install.

Signed-off-by: Piotr Jastrzebski <piotr@scylladb.com>
Message-Id: <4918237f91d985649c195035c02b2dd9e9a1ff68.1475087373.git.piotr@scylladb.com>
2016-09-29 10:02:34 +03:00
Nadav Har'El
7409688356 README.md: add another required package
I tried to compile scylladb on a new Fedora 24 system, and the "-lsystemd"
library was missing during like. We need the systemd-devel package for that.

Signed-off-by: Nadav Har'El <nyh@scylladb.com>
Message-Id: <1470865063-12871-1-git-send-email-nyh@scylladb.com>
2016-08-11 10:21:21 +02:00
Duarte Nunes
f468453cbe README.md: Replace yum with dnf
yum is démodé.

Signed-off-by: Duarte Nunes <duarte@scylladb.com>
Message-Id: <1469616395-5537-1-git-send-email-duarte@scylladb.com>
2016-07-27 13:50:31 +03:00
Duarte Nunes
e4464f7500 README.md: Add protobuf dependencies
Signed-off-by: Duarte Nunes <duarte@scylladb.com>
Message-Id: <1469616338-5199-1-git-send-email-duarte@scylladb.com>
2016-07-27 13:50:19 +03:00
Benoît Canet
8b6bb0251d README.md: Fix markdown formating
I suspect wrong formatting causes us trouble in the
docker hub descriptions.

Signed-of-by: Benoît Canet <benoit@scylladb.com>
Message-Id: <1466603787-13423-1-git-send-email-benoit@scylladb.com>
2016-06-23 12:39:04 +03:00
Piotr Jastrzebski
2be4ec4e06 Add lksctp-tools-devel to required packages
in fedora build instructions.

Signed-off-by: Piotr Jastrzebski <piotr@scylladb.com>
Message-Id: <15f3db34f12f01cb9da32fd14c16ba87e64ad5f4.1463947999.git.piotr@scylladb.com>
2016-05-23 08:26:02 +03:00
Amnon Heiman
f266c2ed42 README.md: Add dependency for pyparsing python3
python3 needs to install pyparsing excplicitely. This adds the
installation of python3-pyparsing to the require dependencies in the
README.md

Signed-off-by: Amnon Heiman <amnon@scylladb.com>
2016-01-24 12:29:21 +02:00
Avi Kivity
d47a58cc32 README: add libxml2 and libpciaccess packages to list or required packages
Needed for link stage.
2016-01-14 17:47:48 +02:00
Avi Kivity
cf7e6cede2 README: add hwloc and numactl to install recommendations 2016-01-14 17:30:43 +02:00
Benoît Canet
de508ba6cc README: Add missing build dependencies
It's just a waste of time to find them manually
when compiling ScyllaDB on a fresh install: add them.

Also fix the ninja-build name.

Signed-off-by: Benoît Canet <benoit@scylladb.com>
2015-12-31 13:34:48 +02:00
Avi Kivity
6390bc3121 README: instructions for contributing 2015-11-18 15:10:37 +02:00
Tzach Livyatan
0e9b3e4d37 add build and run from source instructions in README.md
fix #451

Signed-off-by: Tzach Livyatan <tzach@cloudius-systems.com>
2015-11-09 10:05:05 +02:00
Pekka Enberg
763b718418 Update 'docker run' instructions in README
Explicitly mention how to enable port forwarding so that external
applications are able to connect.

Signed-off-by: Pekka Enberg <penberg@scylladb.com>
2015-10-29 20:07:04 +02:00
Avi Kivity
cbc0aa4916 README: drop 'urchin' codename in favor of Scylla 2015-09-22 05:32:55 -07:00
Asias He
9ab0c1e321 README: Remove ubuntu build instructions
Scylla needs thrift and antlr3 which are not provided by ubuntu. We need
to compile them from source in order to build scylla. For now, let's
only support build on Fedora.
2015-09-21 18:25:18 -07:00
Pekka Enberg
569efa2c4c dist/docker: ScyllaDB Docker image
Add a Dockerfile for building a ScyllaDB Docker image. The image is
based on Fedora 22 and ScyllaDB is installed from our RPM repository.

Signed-off-by: Pekka Enberg <penberg@cloudius-systems.com>
2015-09-22 00:22:01 +03:00
Pekka Enberg
e5a1e34d35 README: Document RPM build steps on Fedora
Signed-off-by: Pekka Enberg <penberg@cloudius-systems.com>
2015-09-03 12:24:37 +03:00
Tzach Livyatan
26bdcef325 README: Add recursive to git submodule update command
Recursive update is required for nested submodule

Signed-off-by: Tzach Livyatan <tzach@cloudius-systems.com>
2015-08-26 13:33:40 +03:00
Vlad Zolotarov
288a96bcc4 README.md: add a missing antlr3-C++-devel package to Fedora packages list
Signed-off-by: Vlad Zolotarov <vladz@cloudius-systems.com>
2015-08-20 10:47:48 +03:00
Tzach Livyatan
e9754b9e16 README: Add missing prerequisites libs on Fedora 22
Add missing libs required for compiling on Fedora 22
thrift-devel antlr3-tool libasan libubsan

Signed-off-by: Tzach Livyatan <tzach@cloudius-systems.com>
2015-08-16 14:14:37 +03:00
Tzach Livyatan
736d209432 Rename README-urchin to README
Signed-off-by: Tzach Livyatan <tzach@cloudius-systems.com>
2015-07-20 17:32:49 +03:00
Avi Kivity
cc17c44640 Move seastar to a submodule
Instead of urchin being layered on top of seastar, move seastar to a
subdirectory (as a submodule) and use seastar.pc/libseastar.a to link
with it.
2015-07-19 20:48:36 +03:00
Avi Kivity
e404b5349a README: update DPDK instructions for bundled DPDK 2015-06-24 18:49:38 +03:00
Vlad Zolotarov
2f238e7d2e dpdk: exclude the KNI module from the required modules
We don't use this module and it's compilation is broken in DPDK 2.0.0
against Linux kernels 4.0.x.

Signed-off-by: Vlad Zolotarov <vladz@cloudius-systems.com>
2015-06-11 14:11:29 +03:00
Marek Waszkiewicz
bf564b463a README: add xen-devel boost-devel for fedora 21 build instructions
Signed-off-by: Marek Waszkiewicz <marek.waszkiewicz77@gmail.com>
2015-03-26 09:33:03 +02:00
Tomasz Grabiec
83963b23d3 Replace rescue() usages with then_wrapped()
They are pretty much the same. This change removes rescue().
2015-03-04 17:34:59 +01:00
Glauber Costa
cb5c2de06c README: add documentation about then_wrapped
Signed-off-by: Glauber Costa <glommer@cloudius-systems.com>
2015-02-26 18:51:40 +02:00
Dor Laor
6f36fd48ad Tiny nitpicks in readme file 2015-02-26 13:07:50 +02:00
Dor Laor
381717a66e Run ispell on README.md 2015-02-26 13:07:37 +02:00
Dor Laor
1492ae9040 README: Add explanation about 100% cpu consumption and recommended configuration 2015-02-26 12:40:15 +02:00
Glauber Costa
4240ab6e95 fix syntax error in README
While reading the file to see the correct functioning of the rescue clause,
I have noticed a small syntax error in the example code.

Signed-off-by: Glauber Costa <glommer@cloudius-systems.com>
2015-02-24 19:30:21 +02:00
Takuya ASADA
2d4b46d8e7 README.md: add Fedora 21 document
Since Fedora 21, we don't need to use rawhide package for g++ 4.9.

Signed-off-by: Takuya ASADA <syuu@cloudius-systems.com>
2015-02-20 12:13:22 +02:00
Vlad Zolotarov
95bf98977d DPDK: Recover the DPDK 1.7.x support
- Define MARKER type if not defined.
   - Adjust the Tx zero-copy to the rte_mbuf layout in DPDK 1.7.x.
   - README.md:
      - Bump up the DPDK latest version to 1.8.0.
      - Add a new DPDK configuration description.

Signed-off-by: Vlad Zolotarov <vladz@cloudius-systems.com>
2015-02-12 18:54:05 +02:00
Avi Kivity
b452e33bd1 README: simplify docker build instructions
Run the build command directly in docker, using a shell function, instead
of opening a shell.  Forward the user/group IDs so the build artifacts belong
to the user, not root.
2015-01-19 20:13:32 +02:00
Avi Kivity
6e9d4f367d build: move Dockerfile to docker/dev
'docker build' transfers the directory containing Dockerfile to the
container, which can take quite a while with a pre-built environment.
2015-01-19 19:50:15 +02:00
Amnon Heiman
5002f0f10e README: boost is needed for ubuntu compilation 2015-01-08 16:44:59 +02:00
Pekka Enberg
0a12cb6d65 README: Add libpciaccess-devel package to pre-requisites
It's needed on Fedora to build Seastar.

Signed-off-by: Pekka Enberg <penberg@cloudius-systems.com>
2014-12-11 14:15:18 +02:00