search

scylladb / scylla-doc-issues

Repository for reporting issues about Scylla documentation (Deprecated)
2 stars 6 forks source link

Issue in page Best Practices for Running Scylla on Docker #842

Closed guy9 closed 2 years ago

guy9 commented 2 years ago

I would like to report an issue in page https://docs.scylladb.com//operating-scylla/procedures/tips/best-practices-scylla-on-docker

Problem

It seems like the docker --overprovisioned flag changed its default behavior. In the Docs, it says it defaults to disabled. Here: https://hub.docker.com/r/scylladb/scylla/ it says that it defaults to enabled.

Suggest a fix

Are the doc pages per Scylla version? Find which of the default options is true and fix accordingly, in the above page and in others as well (for example here https://docs.scylladb.com/getting-started/scylla-in-a-shared-environment/)

annastuchlik commented 2 years ago

@slivne Who can help me determine which of the following is true?

Docs: If no --overprovisioned option is specified, Scylla defaults to running with optimizations disabled.

DockerHub: If no --overprovisioned option is specified, Scylla defaults to running with optimizations enabled.

annastuchlik commented 2 years ago

@nyh Is there any chance you could help me with this one or refer to somebody who could?

nyh commented 2 years ago

@syuu1228 maybe you can answer this? If the overprovisioned option indeed changed unintentionally, maybe it's another thing accidentally changed when moving from Fedora to Ubuntu?

annastuchlik commented 2 years ago

@syuu1228 Could you help us?

syuu1228 commented 2 years ago

I looked into both 4.5.4 Docker image(CentOS) and latest Docker image(Ubuntu), but the behavior with --overprovisioned not changed. Both images enable the option by default. (see https://github.com/scylladb/scylla/blob/master/dist/docker/scyllasetup.py#L94 and https://github.com/scylladb/scylla/blob/branch-4.5/dist/docker/redhat/scyllasetup.py#L94) I think only problem is documentation outdated. We changed overprovisioned disabled by default to enabled by default at 1.Apr.2018: https://github.com/scylladb/scylla/commit/ef84780c272c731d4d62c3116123a6a094493aad

So the description If no --overprovisioned option is specified, Scylla defaults to running with optimizations disabled. was written before the change, and now incorrect.

syuu1228 commented 2 years ago

Suggest a fix

Are the doc pages per Scylla version?

I guess we simply can change description from disable by default to enable by default, since the change is very old (we have this since version 2.3).

annastuchlik commented 2 years ago

Fixed with https://github.com/scylladb/scylladb/pull/11256