* refs/pull/41509/head:
common/cmdparse: fix CephBool validation for tell commands
mgr/nfs: fix 'nfs export create' argument order
common/cmdparse: emit proper json
mon/MonCommands: add -- seperator to example
qa/tasks/cephfs/test_nfs: fix export create test
mgr: make mgr commands compat with pre-quincy mon
doc/_ext/ceph_commands: handle non-positional args in docs
mgr: fix reweight-by-utilization cephbool flag
mon/MonCommands: convert some CephChoices to CephBool
mgr/k8sevents: fix help strings
pybind/mgr/mgr_module: fix help desc formatting
mgr/orchestrator: clean up 'orch {daemon add,apply} rgw' args
mgr/orchestrator: add end_positional to a few methods
mgr/orchestrator: reformat a few methods
pybind/ceph_argparse: stop parsing when we run out of positional args
pybind/ceph_argparse: remove dead code
pybind/mgr/mgr_module: infer non-positional args
pybind/mgr/mgr_module: add separator for non-positional args
command/cmdparse: use -- to separate positional from non-positional args
pybind/ceph_argparse: adjust help text for non-positional args
pybind/ceph_argparse: track a 'positional' property on cli args
Reviewed-by: Kefu Chai <kchai@redhat.com>
How to use kcli to create ceph clusters (cephadm) and made easy code changes in
manager modules.
Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
osd: Run osd bench test to override default max osd capacity for mclock
Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
This PR improves the flow and syntax of the
sentences in the "Setting a Limit" section of the
"Service Management" chapter of the cephadm documentation.
(This section is about setting limits to the number of
daemons created, and about limiting the creation of daemons
to a specified number of hosts.)
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This removes an extraneous "the" and reworks a
sentence so that it adheres to the grammatical
rules of the English language.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
mgr/dashboard: API Version changes do not apply to pre-defined methods (list, create etc.)
Reviewed-by: Aashish Sharma <aasharma@redhat.com>
Reviewed-by: Alfonso Martínez <almartin@redhat.com>
Reviewed-by: Avan Thakkar <athakkar@redhat.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Nizamudeen A <nia@redhat.com>
This PR adds parallel construction to the "Service
Specification" section of the "Service Managment"
chapter of the cephadm documentation.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR creates parallel structure for the
text in the "Daemon Status" section of the
cephadm Service Management chapter.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
rgw: add the description of blocking io during index resharding
Reviewed-by: Matt Benjamin mbenjamin@redhat.com
Reviewed-by: J. Eric Ivancich <ivancich@redhat.com>
* refs/pull/41483/head:
cephadm: stop passing --no-hosts to podman
mgr/nfs: use host.addr for backend IP where possible
mgr/cephadm: convert host addr if non-IP to IP
mgr/dashboard,prometheus: new method of getting mgr IP
doc/cephadm: remove any reference to the use of DNS or /etc/hosts
mgr/cephadm: use known host addr
mgr/cephadm: resolve IP at 'orch host add' time
Reviewed-by: Sebastian Wagner <swagner@suse.com>
I found that the difference between "rbd cp" and "rbd deep cp",
i.e. what "deep" means in this context, is documented only in
the mailing list archive and in the Mimic reelase notes.
Let's make the difference explicit in the manpage and in rbd --help.
Signed-off-by: Jan "Yenya" Kasprzak <kas@fi.muni.cz>
The value changed from 512KB to 4MB in Kraken. Reference the prevailing
option default instead of embedding the current value.
Signed-off-by: Anthony D'Atri anthony.datri@gmail.com
This PR improves the syntax of the "Service
Status" section of the "Service Managment"
section of the cephadm guide. This includes
pretty significant reworking of the information
in the section, so vetting this one might be
annoying. Anyway, I think I've lowered the
cognitive load on the reader.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
Methods like list(), create(), get() etc doesn't get applied the version.Also for the endpoints that get the version changed, the docs and the request header has still the version v1.0+ in them. So with the version reduced it gives 415 error when trying to make the request. This PR fixes this issue.
Fixes: https://tracker.ceph.com/issues/50855
Signed-off-by: Aashish Sharma <aasharma@redhat.com>
`crush-device-class` is optional for `ceph osd erasure-code-profile set`,
add it for the sake of completeness
Signed-off-by: luo.runbing <luo.runbing@zte.com.cn>
pybind: do not import from "__future__" anymore
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Sebastian Wagner <swagner@suse.com>
This command is very awkward to implement unless all service spec fields
are always required. That will soon mean both the placement *and*
virtual_ip (if any), making it much less useful for a human to make use
of.
Instead, let them update yaml, or adjust the nfs and/or ingress specs
directly. I don't think this command is needed.
Signed-off-by: Sage Weil <sage@newdream.net>
At the time NFS support was added, this limitation applied.
However, in
b3d97f8157
and
1cfe7e2df9
we added support for multiple filesystems and started mixing
the fscid into the filehandle.
Signed-off-by: Sage Weil <sage@newdream.net>
as we've migrated to python3, no need to use
from __future__ import absolute_import
for accessing absolute import
Signed-off-by: Kefu Chai <kchai@redhat.com>
Signed-off-by: gal salomon <gal.salomon@gmail.com>
force-branch to s3test/master
Signed-off-by: gal salomon <gal.salomon@gmail.com>
update of s3select (== -> =)
Signed-off-by: gal salomon <gal.salomon@gmail.com>
update of s3select (== -> =)
Signed-off-by: gal salomon <gal.salomon@gmail.com>
closing documentation gaps between previous and current functionalities(WIP)
Signed-off-by: gal salomon <gal.salomon@gmail.com>
Update s3select.rst
additional features
Update s3select.rst
Signed-off-by: gal salomon <gal.salomon@gmail.com>
Update s3select.rst
editorial
Signed-off-by: gal salomon <gal.salomon@gmail.com>
Update s3select.rst
editorial
Signed-off-by: gal salomon <gal.salomon@gmail.com>
Update s3select.rst
adding cast to bool
Signed-off-by: gal salomon <gal.salomon@gmail.com>
editorial; more description for substring and trim
Signed-off-by: gal salomon <gal.salomon@gmail.com>
This PR improves the language in the eighth
listitem in the Vulnerability Management Process.
(This one's pretty nitpicky.)
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR improves the language of the seventh listitem
in the Vulnerability Management Process in the security
documentation.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
* refs/pull/40885/head:
doc: document cephfs-mirror configuration options
cephfs-mirror: use sensible mount timeout when mounting local/remote fs
test: add tests for settting mount timeout
pybind/cephfs: add interface to set mount timeout
libcephfs: add interface to set mount timeout
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Instead admins should specify specific features to require.
Fixes: https://tracker.ceph.com/issues/50819
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
* refs/pull/39550/head:
mgr/cephadm: induce retune of osd memory on osd creation
qa/tasks/cephadm.conf: autotune osd memory by default
mgr/cephadm: do not autotune when _no_autotune_memory label is present
mgr/cephadm: autotune osd memory
common: add osd_memory_target_autotune
mgr/cephadm: report memory usage, request (limit) in 'orch ps'
doc/cephadm/host-management: document _admin group
mgr/orchestrator: fix help formatting
Reviewed-by: Adam King <adking@redhat.com>
- set osd_memory_target_autotune=true to enable
- tuning is periodic (check every 10m by default)
- tuned values are reflected by osd_memory_target config options scoped
to the host
- only make a change if it appears that we will affect at least 1 of the
relevant OSDs
- attempt to clean out conflicting options. (This is imperfect, since any
manner of weirdly-scoped config options could be responsible; we only
attempt to clean out one scoped directly to the osd name.)
Signed-off-by: Sage Weil <sage@newdream.net>
This is the second half of PR#41241.
This PR creates a sub-subsection that explains
a configuration step that is sometimes necessary
when configuring monitoring in Ceph clusters. (The
configuration step involves DNS zones.)
Signed-off-by: Zac Dover <zac.dover@gmail.com>
because we have a top-nav bar, which is setting on top of the bar
containing the menu button when the docs is displayed wit a device with
smaller width. in this change, the container of the menu button is moved
down a little bit, so it is visible again.
Signed-off-by: Kefu Chai <kchai@redhat.com>
there is chance that the default value of an option is empty, before
this change the rendered result would be "````", and sphinx is confused
at seeing this:
Unexpected section title or transition.
as it takes it as a notion of section title. after this change,
the "literal" filter is always applied to the default value, so an empty
string is rendered like "<empty string>" instead.
Signed-off-by: Kefu Chai <kchai@redhat.com>
less repeating this way, this change also addresses the missing option
issue if the option to be rendered is the first option in a document,
and there is no "mgr_module" directive before it.
Signed-off-by: Kefu Chai <kchai@redhat.com>
before this change,
.. mgr_module:: None
is required at end of a mgr module document to reset the context, so
the builder env is not polluted when processing the next document.
after this change, this ending directive is not needed anymore.
Signed-off-by: Kefu Chai <kchai@redhat.com>
instead of collecting all options from all modules, just load the
options from the specified module, this addresses the issue where
options with the same name are overriden by the options defined by
another mgr module.
Signed-off-by: Kefu Chai <kchai@redhat.com>
in addition to "mgr_module" directive, add the "module" option to
confval. this allows a certain option to specify its own module without
being nested in a "mgr_module" directive pair.
Signed-off-by: Kefu Chai <kchai@redhat.com>
max_misplaced with replaced by in target_max_misplaced_ratio
edbd592ee4, but the document was not
sync'ed. let's update it accordingly.
Fixes: https://tracker.ceph.com/issues/50745
Signed-off-by: Kefu Chai <kchai@redhat.com>
less repeating this way.
also fix a typo of "rbd_qos_writ_bps_limit", it should be
"rbd_qos_write_bps_limit".
Signed-off-by: Kefu Chai <kchai@redhat.com>
This PR streamlines the grammar in the subsection
called "Configuring SSL/TLS for Grafana" in the
monitoring.rst file. It also corrects the prompt
rst.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR corrects various minor usage errors in
the subsection "Deploying Monitoring with cephadm"
of the "monitoring" section of the cephadm guide.
It also adds prompts, and cleans up the list rst a
bit.
This is the first of two PRs planned for this section.
The second PR will create a sub-subsection that explains
an additional installation step that is necessary when
a Ceph cluster and a user accessing that cluster are in
different DNS zones. But that's another story, for another
PR.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
which allows us to use different scheme when defining an option,
without this change, if two options in different mgr module share the
same name we cannot differentiate them, after this change, their id
would prefixed with the module name.
Signed-off-by: Kefu Chai <kchai@redhat.com>
Amend the example output and drop the word "transient" -- currently it
is the exact opposite, as the status is updated only when the cache is
opened and closed.
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
This PR rewrites the text in "Using Customized
Container Images" so that it is just a bit
clearer, and it also formats the prompt in the
text correctly.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR fixes the prompts in this section and
makes the sentences a tiny bit less onerous for
the reader.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
* format global options using option directive
* fix the header, so man/conf.py is able to parse
the description
* define "Synopsis" section to be consistent with other manpages.
* drop reference to glossary using "term" as manapge does not have
reference to glossary entries.
Signed-off-by: Kefu Chai <kchai@redhat.com>
* format global options using option directive
* fix the header, so man/conf.py is able to parse
the description
* define "Synopsis" section to be consistent with other manpages.
* drop reference to glossary using "term" as manapge does not have
reference to glossary entries.
Signed-off-by: Kefu Chai <kchai@redhat.com>
there is chance that we don't have desc, desc_long or fmt_desc, in that
case, we should just skip desc before checking its length. so, just use
'if desc' which is able to check for None or empty string.
Signed-off-by: Kefu Chai <kchai@redhat.com>
default could be None and we don't reference the default value using
`opt.default`, so this variable is always defined. to avoid printing
a None default value, check for a None value. see
https://jinja.palletsprojects.com/en/2.11.x/templates/#none
Signed-off-by: Kefu Chai <kchai@redhat.com>
before this change, the rendered Default is "0Ei" if the default size is 0,
would be more readable if it is "0B" or "0".
Signed-off-by: Kefu Chai <kchai@redhat.com>
this change addresses the warning of:
/home/jenkins-build/build/workspace/ceph-pr-docs/doc/cephfs/mds-config-ref.rst:2: WARNING: duplicate confval_option description of mds_cache_memory_limit, other instance in cephfs/cache-configuration
/home/jenkins-build/build/workspace/ceph-pr-docs/doc/cephfs/mds-config-ref.rst:2: WARNING: duplicate confval_option description of mds_cache_reservation, other instance in cephfs/cache-configuration
Signed-off-by: Kefu Chai <kchai@redhat.com>
* refs/pull/41091/head:
doc/cephfs/nfs: add section about ganesha logs
doc/cephfs/nfs: Replace volume/nfs with nfs
doc/cephfs/nfs: add note about export management with volume/nfs interface only
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Recently, nfs related code was moved out of volumes plugin[1]. So using the
name volume/nfs for the interface is not appropriate.
[1] https://github.com/ceph/ceph/pull/40526
Signed-off-by: Varsha Rao <varao@redhat.com>
This is a wrapper over ceph-bluestore-tool's bluefs-bdev-migrate command.
Primarily intended to introduce LVM tags manipulation which
ceph-bluestore-tool is lacking.
Signed-off-by: Igor Fedotov <ifedotov@suse.com>
* refs/pull/40924/head:
mgr/cephadm: check hostname resolution before adding host
cephadm: provide a way to checkhost connection without /etc/hosts passed the shell
doc/cephadm: remove /etc/hosts from list of hostname resoltion methods
Reviewed-by: Sage Weil <sage@redhat.com>
Reviewed-by: Adam King <adking@redhat.com>
* refs/pull/40941/head:
qa/suites/rados/cephadm/smoke-roleless: test client-keyring
qa/tasks/cephadm.py: adjust client.admin key mode; place on all hosts
cephadm: distribute client.admin keyring+conf to label:_admin on bootstrap
doc/cephadm: document the default 'admin' label
mgr/cephadm: 'ceph orch client-keyring ...' commands to manage keyring files
mgr/cephadm: reimplement ceph.conf pushing
mgr/cephadm: use _write_remote_file for ceph.conf
mgr/cephadm: _write_remote_file helper
mgr/cephadm: add placementspec for which hosts get ceph.conf
Reviewed-by: Sebastian Wagner <swagner@suse.com>
Reviewed-by: Adam King <adking@redhat.com>
Setting auth_expose_insecure_global_id_reclaim to false disables the
"disconnect right after authentication" behavior, not the warning.
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
This PR adds a note to the cephadm installation
guide that informs users that only podman version
2.0.0 and higher work with Ceph, with the
exception of podman version 2.2.1, which does
not work with Ceph. There is also a note regarding
kubic stable 3.0.1 working, but only with newer
kernels.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR corrects a title so that the title
more accurately describes the content in the
section it names.
Fixes: https://tracker.ceph.com/issues/50517 (partially)
Signed-off-by: Zac Dover <zac.dover@gmail.com>
before this change, we check the exisitence of default value of an
option using "if default", but this is wrong. what if "default" is an
empty string or a numeric value of 0, or just False?
after this change, its exisitence is checked using "if default is
defined", so all "false" default values are rendered as well.
Signed-off-by: Kefu Chai <kchai@redhat.com>
Teach cephadm to manage keyring files on cluster hosts. These keys must
already exist in the mon auth database--cephadm does not create them if
they don't exist (and will issue warnings to the log if they do not).
A ceph.conf is pushed implicitly along with the keyring file.
Each keyring added will be pushed to the hosts described by the placement
spec with the appropriate ownership and mode. If the ownership, mode, or
path are modified, the files are rewritten or removed as need.
If the client-keyring entry is removed, the keyring files are removed.
Signed-off-by: Sage Weil <sage@newdream.net>
Make the osd_*_sleep options modifiable during runtime and add them
to the set of tracked conf keys. This is to ensure that the sleep
options can be disabled/overridden during OSD bring-up if mclock
scheduler is employed.
Introduce OSD::maybe_override_options_for_qos():
This method does the following if the mclock scheduler is enabled:
- overrides the "recovery_max_active" to a high limit of 1000,
- overrides "osd_max_backfills" option to a high limit of 1000 and
sets the corresponding Async local and remote reserver objects also
to the same value (1000),
- disables osd_*_sleep options so that appropriate QoS may be
provided with the mclock scheduler.
The above method is called in the following scenarios:
- After all the op shards are brought up during OSD initialization.
- In OSD::handle_conf_change() to override any settings related to
QoS that the user intended to change.
Modify the mclock config reference to accurately reflect what options
can be changed when using mclock's "custom" profile and clean up
some whitespaces.
Fixes: https://tracker.ceph.com/issues/50501
Signed-off-by: Sridhar Seshasayee <sseshasa@redhat.com>
