Commit Graph

359 Commits

Author SHA1 Message Date
Anna Stuchlik
f46b207472 doc: update the links that are false external links and result in 404
Closes #11086
2022-07-22 14:17:42 +03:00
Botond Dénes
d12d429c47 Merge 'doc: add the upgrage guides from 2022.x.y to 2022.x.z' from Anna Stuchlik
Fix https://github.com/scylladb/scylla-docs/issues/4041

I've added the upgrade guides from 2022.x.y to 2022.x.z. They are based on the previous upgrade guides for patch releases.

Closes #11104

* github.com:scylladb/scylla:
  doc: add the new upgrade guide to the toctree
  doc: add the upgrage guides from 2022.x.y to 2022.x.z
2022-07-22 09:06:16 +03:00
Anna Stuchlik
23515c8695 doc: add the new upgrade guide to the toctree 2022-07-21 17:05:28 +02:00
Anna Stuchlik
bf5bf44ddd doc: add the upgrage guides from 2022.x.y to 2022.x.z 2022-07-21 16:46:06 +02:00
Nadav Har'El
5faf3c711d doc, alternator: document the possibility of write reordering
In issue #10966, a user noticed that Alternator writes may be reordered
(a later write to an item is ignored with the earlier write to the same
item "winning") if Scylla nodes do not have synchronized time and if
always_use_lwt write isolation mode is not used.

In this patch I add to docs/alternator/compatibility.md a section about
this issue, what causes it, and how to solve or at least mitigate it.

Fixes #10966

Signed-off-by: Nadav Har'El <nyh@scylladb.com>

Closes #11094
2022-07-21 09:22:56 +02:00
Nadav Har'El
59f684d2c3 Merge 'doc: fix the links to Alternator' from Anna Stuchlik
The Scylla Alternator documentation is now part of the Scylla user documentation (previously it was dev documentation).
This PR updates the links to the Alternator documentation.

Closes #11089

* github.com:scylladb/scylla:
  doc: update the link to Alternator for DynamoDB users
  doc: fix the links to Alternator
2022-07-20 18:38:08 +03:00
Anna Stuchlik
c1122c8f54 doc: update the link to Alternator for DynamoDB users 2022-07-20 17:02:48 +02:00
Anna Stuchlik
ee53105e12 doc: fix the links to Alternator 2022-07-20 16:52:52 +02:00
Anna Stuchlik
4f2b12becc doc: update the links following the content reorganization 2022-07-20 13:07:51 +02:00
Anna Stuchlik
969a7b44e9 doc: remove the outdated cql pages and delete them from the indexes 2022-07-20 12:34:09 +02:00
Anna Stuchlik
8915c5df0b doc: add index.rst for the cql folder and add it to toctree 2022-07-20 12:25:13 +02:00
Anna Stuchlik
4f897f149d doc: move cql-extensions.md from the dev docs to the cql folder 2022-07-20 12:20:25 +02:00
Anna Stuchlik
2dda3dbfb5 doc: move the CQL pages from getting-started to cql 2022-07-20 12:18:54 +02:00
Anna Stuchlik
862bf306ad doc: add redirections for the CQL pages 2022-07-20 12:12:53 +02:00
Avi Kivity
5a30f9b789 Merge 'Distributed aggregate query' from Michał Jadwiszczak
This PR extends #9209. It consists of 2 main points:

To enable parallelization of user-defined aggregates, reduction function was added to UDA definition. Reduction function is optional and it has to be scalar function that takes 2 arguments with type of UDA's state and returns UDA's state

All currently implemented native aggregates got their reducible counterpart, which return their state as final result, so it can be reduced with other result. Hence all native aggregates can now be distributed.

Local 3-node cluster made with current master. `node1` updated to this branch. Accessing node with `ccm <node-name> cqlsh`

I've tested belowed things from both old and new node:
- creating UDA with reduce function - not allowed
- selecting count(*) - distributed
- selecting other aggregate function - not distributed

Fixes: #10224

Closes #10295

* github.com:scylladb/scylla:
  test: add tests for parallelized aggregates
  test: cql3: Add UDA REDUCEFUNC test
  forward_service: enable multiple selection
  forward_service: support UDA and native aggregate parallelization
  cql3:functions: Add cql3::functions::functions::mock_get()
  cql3: selection: detect parallelize reduction type
  db,cql3: Move part of cql3's function into db
  selection: detect if selectors factory contains only simple selectors
  cql3: reducible aggregates
  DB: Add `scylla_aggregates` system table
  db,gms: Add SCYLLA_AGGREGATES schema features
  CQL3: Add reduce function to UDA
  gms: add UDA_NATIVE_PARALLELIZED_AGGREGATION feature
2022-07-19 19:05:19 +03:00
David Garcia
dcb5550bc3 doc: update url to docs.scylladb.com
Closes #11050
2022-07-19 13:42:25 +03:00
Anna Stuchlik
274691f45e doc: fix the example of UDT in the SELECT statement
Closes #11067
2022-07-18 18:26:06 +03:00
Jadw1
d8f3461147 CQL3: Add reduce function to UDA
Add optional field to UDA, that describes reduce function to allow
parallelization of UDA aggregates.
2022-07-18 14:18:48 +02:00
Nadav Har'El
a02db6f928 Merge 'doc: add the upgrade guide from 2021.1 to 2022.1' from Anna Stuchlik
Fix https://github.com/scylladb/scylla-docs/issues/4040
Fix https://github.com/scylladb/scylla-docs/issues/4128

This PR adds the upgrade guides from ScyllaDB Enterprise 2021.1 to 2022.1. They are based on the previous guides.

Closes #11036

* github.com:scylladb/scylla:
  doc: add the description of the new metrics in 2022.1
  doc: remove the upgrade guide for Ubuntu 16.04 (no longer supported in version 2022.1)
  doc: remove the outdated warning
  Update docs/upgrade/_common/upgrade-guide-from-2021.1-to-2022.1-ubuntu-and-debian.rst
  Update docs/upgrade/_common/upgrade_to_2022_warning.rst
  doc: add a space on line 60 to fix the warning
  doc: document metric update for 2022.1
  doc: add the upgrade guide from 2021.1 to 2022.1
2022-07-18 14:14:57 +03:00
Anna Stuchlik
68750b7612 doc: migrate the update about dropping tables from the scylla-docs repo
Closes #11032
2022-07-14 14:08:54 +03:00
Anna Stuchlik
95725c04d1 doc: remove the info about Katacoda and the link to the nonexistent lab
Closes #11031
2022-07-14 14:05:59 +03:00
Anna Stuchlik
3254378375 doc: add the description of the new metrics in 2022.1 2022-07-14 12:29:46 +02:00
Anna Stuchlik
e756bf5067 doc: remove the upgrade guide for Ubuntu 16.04 (no longer supported in version 2022.1) 2022-07-14 12:02:58 +02:00
Anna Stuchlik
68eae4d4e0 doc: remove the outdated warning 2022-07-14 11:55:15 +02:00
David Garcia
0ee5b50bac doc: create migration redirections
Update redirects

Closes #11022
2022-07-14 11:53:41 +03:00
Anna Stuchlik
773be9fc02 Update docs/upgrade/_common/upgrade-guide-from-2021.1-to-2022.1-ubuntu-and-debian.rst
Co-authored-by: Tzach Livyatan <tzach.livyatan@gmail.com>
2022-07-14 10:24:27 +02:00
Anna Stuchlik
bca51c9bb9 Update docs/upgrade/_common/upgrade_to_2022_warning.rst
Co-authored-by: Tzach Livyatan <tzach.livyatan@gmail.com>
2022-07-14 09:17:51 +02:00
Anna Stuchlik
ca8c5fd2c4 doc: add a space on line 60 to fix the warning 2022-07-13 16:37:54 +02:00
Anna Stuchlik
ee1eb85ebc doc: document metric update for 2022.1 2022-07-13 16:24:30 +02:00
Anna Stuchlik
b3566391e6 doc: add the upgrade guide from 2021.1 to 2022.1 2022-07-13 16:17:51 +02:00
David Garcia
0c2a18af2d doc: enable faster builds
Closes #11023
2022-07-12 16:33:38 +03:00
Nadav Har'El
15ed0a441e Merge 'scylla-gdb.py: assortment of task filtering improvements, scylla fiber going backwards' from Botond Dénes
This series includes an assortment of loosely related improvements developed for a recent investigation. The changes include:
* Fix broken `std_deque` wrapper.
* Make `scylla smp-queues` fast.
* Teach `scylla smp-queues` to filter for both sender CPU (`--from`) and receiver CPU (`--to`) or both.
* Teach `scylla smp-queues` to make histogram over content of the queues -- i.e. the type of tasks in the smp queues.
* Teach `scylla smp-queues` to filter for tasks belonging to a certain scheduling group.
* Teach `scylla task_histogram` to include only tasks in the histogram.
* Teach `scylla task_histogram` to filter for tasks belonging to a certain scheduling group.
* Teach `scylla-fiber` to walk in both directions.

And some refactoring.

Fixes: https://github.com/scylladb/scylla/issues/7059

Closes #11019

* github.com:scylladb/scylla:
  docs/dev/debugging.md: update continuation chain traversal guide
  scylla-gdb.py: scylla fiber: walk continuation chain in both directions
  scylla-gdb.py: scylla fiber: allow passing analyzed pointers to _probe_pointer()
  scylla-gdb.py: scylla fiber: hoist preparatory code out of _walk()
  scylla-gdb.py: scylla task_histogram: add --scheduling-groups option
  scylla-gdb.py: scylla task_histogram: add --filter-tasks option
  scylla-gdb.py: scylla task_histogram: use histogram class
  scylla-gdb.py: scylla-fiber: extract symbol matching logic
  scylla-gdb.py: histogram: add limit feature
  scylla-gdb.py: histogram: handle formatting errors
  scylla-gdb.py: intrusive_slist: avoid infinite recursion in __len__()
  scylla-gdb.py: scylla smp-queues: add --scheduling-group option
  scylla-gdb.py: scylla smp-queues: add --content switch
  scylla-gdb.py: smp-queue: add filtering capability
  scylla-gdb.py: make scylla smp-queues fast
  scylla-gdb.py: fix disagreement between std_deque len() and iter()
2022-07-12 15:38:23 +03:00
Botond Dénes
5c56125187 docs/dev/debugging.md: update continuation chain traversal guide
`scylla fiber` is the way to traverse in both directions now.
2022-07-12 07:27:45 +03:00
Anna Stuchlik
0bf99b25c9 doc: fix errors -fix the indent in the conf.py file 2022-07-11 12:31:59 +02:00
Anna Stuchlik
ae9ed315d1 doc: fix the path to Alternator 2022-07-11 12:31:59 +02:00
Anna Stuchlik
a1d9f0f0c8 doc: fix errors - add Alternator to the toctree 2022-07-11 12:31:30 +02:00
Anna Stuchlik
81949bbc7a doc: fix errors- update the conf.py file 2022-07-11 12:18:47 +02:00
Anna Stuchlik
2e95bd0ed1 doc: fix errors - remove the CNAME file 2022-07-11 12:17:33 +02:00
Anna Stuchlik
7b5dfde56a doc: add the CNAME and robots files 2022-07-11 12:16:53 +02:00
Anna Stuchlik
8d86dfa929 doc: move index and README from scylla-docs repo 2022-07-11 12:14:40 +02:00
Anna Stuchlik
6e97b83b60 doc: move the documentation from the scylla-docs repo 2022-07-11 12:14:02 +02:00
Anna Stuchlik
bb41457f73 doc: remove the old index file 2022-07-11 12:12:15 +02:00
Avi Kivity
973d2a58d0 Merge 'docs: move docs to docs/dev folder' from David Garcia
In order to allow our Scylla OSS customers the ability to select a version for their documentation, we are migrating the Scylla docs content to the Scylla OSS repository. This PR covers the following points of the [Migration Plan](https://docs.google.com/document/d/15yBf39j15hgUVvjeuGR4MCbYeArqZrO1ir-z_1Urc6A/edit#):

1. Creates a subdirectory for dev docs: /docs/dev
2. Moves the existing dev doc content in the scylla repo to /docs/dev, but keep Alternator docs in /docs.
3. Flattens the structure in /docs/dev (remove the subfolders).
4. Adds redirects from `scylla.docs.scylladb.com/<version>/<document>` to `https://github.com/scylladb/scylla/blob/master/docs/dev/<document>.md`
5. Excludes publishing docs for /docs/devs.

1. Enter the docs folder with `cd docs`.
2. Run `make redirects`.
3. Enter the docs folder and run `make preview`. The docs should build without warnings.
4. Open http://127.0.0.1:5500 in your browser. You shoul donly see the alternator docs.
5. Open http://127.0.0.1:5500/stable/design-notes/IDL.html in your browser. It should redirect you to https://github.com/scylladb/scylla/blob/master/docs/dev/IDL.md and raise a 404 error since this PR is not merged yet.
6. Surf the `docs/dev` folder. It should have all the scylla project internal docs without subdirectories.

Closes #10873

* github.com:scylladb/scylla:
  Update docs/conf.py
  Update docs/dev/protocols.md
  Update docs/dev/README.md
  Update docs/dev/README.md
  Update docs/conf.py
  Fix broken links
  Remove source folder
  Add redirections
  Move dev docs to docs/dev
2022-07-03 20:37:11 +03:00
David Garcia
fc59ebc2c3 Update docs/conf.py 2022-06-30 19:12:08 +01:00
David Garcia
a1b990075e Update docs/dev/protocols.md 2022-06-30 19:11:09 +01:00
David Garcia
d555febdd3 Update docs/dev/README.md
Co-authored-by: annastuchlik <37244380+annastuchlik@users.noreply.github.com>
2022-06-30 19:10:41 +01:00
David Garcia
350abdd72d Update docs/dev/README.md
Co-authored-by: annastuchlik <37244380+annastuchlik@users.noreply.github.com>
2022-06-30 19:10:33 +01:00
David Garcia
66a77f74d2 Update docs/conf.py
Co-authored-by: annastuchlik <37244380+annastuchlik@users.noreply.github.com>
2022-06-30 19:10:23 +01:00
David Garcia
b85843b9cc Fix broken links
Fix broken links
2022-06-28 15:19:36 +01:00
David Garcia
b87537c767 Remove source folder
Remove source folder

Remove source folder
2022-06-28 15:07:35 +01:00