Skip to content

docs: ddl: document the initial_tablets replication strategy option#16193

Closed
avikivity wants to merge 1 commit intoscylladb:masterfrom
avikivity:doc-initial_tablets
Closed

docs: ddl: document the initial_tablets replication strategy option#16193
avikivity wants to merge 1 commit intoscylladb:masterfrom
avikivity:doc-initial_tablets

Conversation

@avikivity
Copy link
Copy Markdown
Member

While the feature is experimental, this makes it easier to experiment with it.

@avikivity
Copy link
Copy Markdown
Member Author

v2: removed an experimental typo

@aws-amplify-us-east-2
Copy link
Copy Markdown

aws-amplify-us-east-2 Bot commented Nov 27, 2023

1 similar comment
@aws-amplify-us-east-2
Copy link
Copy Markdown

aws-amplify-us-east-2 Bot commented Nov 27, 2023

@tzach tzach added documentation Requires documentation area/tablets labels Nov 27, 2023
@tzach
Copy link
Copy Markdown
Contributor

tzach commented Nov 27, 2023

An example would be helpful

CREATE KEYSPACE excalibur
    WITH replication = {'class': 'NetworkTopologyStrategy', 'replication_factor' : 3, 'initial_tablets': 2048}

@avikivity
Copy link
Copy Markdown
Member Author

v3: added an example

@aws-amplify-us-east-2
Copy link
Copy Markdown

aws-amplify-us-east-2 Bot commented Nov 27, 2023

Comment thread docs/cql/ddl.rst Outdated
Comment thread docs/cql/ddl.rst Outdated
Comment thread docs/cql/ddl.rst Outdated
Comment thread docs/cql/ddl.rst Outdated
@annastuchlik
Copy link
Copy Markdown
Collaborator

I've left three minor suggestions.
A bigger thing is that this update is going to be part of the docs for Enterprise 2024.1. You can exclude it by placing the content within the .. only:: opensource directive. It will be easy with the paragraph because all you do is:

.. only:: opensource

  The ``initial_tablets`` option :label-caution:`Experimental`
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  The ``initial_tablets`` option is used to specify how many tablets the table is split into.
  It is only valid when ``experimental_features: tablets`` is specified in ``scylla.yaml`` (which
  in turn requires ``consistent_cluster_management: true``. It must be a power of two.
  . . . 

It would be harder with the tables, though.

But if you accept the experimental feature mentioned in the Enterprise docs, we can leave it as is.

Comment thread docs/cql/ddl.rst
@avikivity
Copy link
Copy Markdown
Member Author

I've left three minor suggestions. A bigger thing is that this update is going to be part of the docs for Enterprise 2024.1. You can exclude it by placing the content within the .. only:: opensource directive. It will be easy with the paragraph because all you do is:

I don't understand the reference to 2024.1. Why would it go there? Why is it only opensource? Why would we tag it here?

@scylladb-promoter
Copy link
Copy Markdown
Contributor

Docs Preview 📖

Docs Preview for this pull request is available here

Changed Files:

Note: This preview will be available for 30 days and will be automatically deleted after that period. You can manually trigger a new build by committing changes.

@avikivity avikivity force-pushed the doc-initial_tablets branch from d19be43 to aaa617c Compare December 4, 2023 18:46
@avikivity
Copy link
Copy Markdown
Member Author

v4:

  • minor edits by @annastuchlik
  • noted that the calculation applies to each table independently

@tgrabiec
Copy link
Copy Markdown
Contributor

Conflicts, please rebase

@annastuchlik
Copy link
Copy Markdown
Collaborator

I don't understand the reference to 2024.1. Why would it go there?

I guess I was wrong and it will be part of 2024.2. Whatever the version, it will be visible in the Enterprise docs when it's merged with enterprise.

Why is it only opensource? Why would we tag it here?

The feature is not opensource as such, but it's experimental (for now). We exclude experimental features from the Enterprise docs, as we claim that Enterprise does not support experimental features. That's the only reason.

Having said that, I think we can merge this PR as is to move forward.

@bhalevy
Copy link
Copy Markdown
Member

bhalevy commented Dec 21, 2023

please rebase

@avikivity
Copy link
Copy Markdown
Member Author

Why is it only opensource? Why would we tag it here?

The feature is not opensource as such, but it's experimental (for now). We exclude experimental features from the Enterprise docs, as we claim that Enterprise does not support experimental features. That's the only reason.

We can't edit each piece of documentation separately like that. If you want to exclude experimental features from enterprise, introduce markup to denote experimental features, and post-process the documentation to exclude them.

While the feature is experimental, this makes it easier to experiment
with it.

An example is provided.
@avikivity
Copy link
Copy Markdown
Member Author

v5: rebased

@annastuchlik
Copy link
Copy Markdown
Collaborator

We can't edit each piece of documentation separately like that. If you want to exclude experimental features from enterprise, introduce markup to denote experimental features, and post-process the documentation to exclude them.

Yes, I see your point. I've already added that to our backlog.

@avikivity
Copy link
Copy Markdown
Member Author

@tgrabiec ping

dgarcia360 pushed a commit to dgarcia360/scylla that referenced this pull request Apr 30, 2024
While the feature is experimental, this makes it easier to experiment
with it.

An example is provided.

Closes scylladb#16193
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tablets documentation Requires documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants