Commit Graph

41 Commits

Author SHA1 Message Date
Patrick Donnelly
108f486afe
mon: define simple-rados-client-with-blocklist profile
A mon profile that grants the ability for rados clients to blocklist
others (similar to rbd).

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-03-19 08:52:55 -07:00
Jonas Jelten
4f98499bfa doc/mgr/crash: explain needed crash upload permissions
Signed-off-by: Jonas Jelten <jj@sft.lol>
2021-03-09 14:12:32 +01:00
Anthony D'Atri
3e2e3e3735 doc/rados/operations: Add description of new auth profiles 2020-11-19 23:34:32 -08:00
Ponnuvel Palaniyappan
d99d520493 doc: Fixed a number of typos in documentation
Signed-off-by: Ponnuvel Palaniyappan <pponnuvel@gmail.com>
2020-09-18 18:17:15 +01:00
Robert Sander
1b42759e19 doc: remove references to ceph-deploy
The documentation still has many traces of ceph-deploy. This tool has
been deprecated with the Octopus release. This commit tries to remove
most of ceph-deploy occurences.

Signed-off-by: Robert Sander <r.sander@heinlein-support.de>
2020-09-02 21:14:36 +02:00
Sage Weil
dfd01d7653 blacklist -> blocklist
Signed-off-by: Sage Weil <sage@newdream.net>
Signed-off-by: Neha Ojha <nojha@redhat.com>
2020-08-24 19:53:08 +00:00
Kefu Chai
0cb56e0f13 doc: use plantweb as fallback of sphinx-ditaa
RTD does not support installing system packages, the only ways to install
dependencies are setuptools and pip. while ditaa is a tool written in
Java. so we need to find a native python tool allowing us to render ditaa
images. plantweb is able to the web service for rendering the ditaa
diagram. so let's use it as a fallback if "ditaa" is not around.

also start a new line after the directive, otherwise planweb server will
return 500 at seeing the diagram.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-04-10 08:38:06 +08:00
Jason Dillaman
b0d73aed19 mgr: added 'profile rbd/rbd-read-only' cap
These profiles can be further restricted via 'pool' and
'namespace' argument optionals.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2019-10-29 08:35:03 -04:00
Jason Dillaman
cb534e0049 mgr: support optional arguments for module and profile caps
This allows an optional, arbitrary key/value constraint clauses to
be appended to "profile XYZ" and "allow module XYZ" caps. A module
can then provide additional validatation against these meta-arguments.

Example:
profile rbd pool=rbd
allow module rbd_support with pool=rbd

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2019-10-29 08:35:03 -04:00
Jason Dillaman
3463613bd4 mgr: add new 'allow module' cap to MgrCap
This allows specific python add-on modules to be whitelisted instead
of manually adding each command exported by the module.

  allow module {module-name} {access-spec}

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2019-10-29 08:35:03 -04:00
Patrick Donnelly
e7a7cf429e
doc: filesystem to file system
"Filesystem" is not a word (although fairly common in use).

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2019-09-10 08:43:28 -07:00
Jason Dillaman
d23bdb7931
Merge pull request #28296 from mcv21/doc-profile-rbd
doc: note explicitly that "profile rbd" allows blacklisting

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2019-05-31 08:29:21 -04:00
Matthew Vernon
6812582222 doc: note explicitly that "profile rbd" allows blacklisting
The Luminous release notes tell users to ensure that rbd clients have
the ability to blacklist other client users; this is provided by
"profile rbd", which this change now documents explicitly in the user
management documentation.

Signed-off-by: Matthew Vernon <mv3@sanger.ac.uk>
2019-05-29 14:36:48 +01:00
James McClune
7ff2f215a3 doc: updated Ceph documentation links
Fixes include:

- Updating Doxygen link for reference (http://docs.ceph.com/docs/master/dev/documenting/)
- Adding :ref: label for User Management page (http://docs.ceph.com/docs/master/rados/operations/user-management/)
- Update User Management link for reference (http://docs.ceph.com/docs/master/rbd/rbd-snapshot/)

Fixes: https://tracker.ceph.com/issues/37793
Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2019-01-04 16:32:21 -05:00
Brad Hubbard
e4e7f3ea6a doc/user-management: Remove obsolete reset caps command
This command has not worked since hammer and makes no sense in an
environment where we do not allow empty caps

Fixes: http://tracker.ceph.com/issues/37663

Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2018-12-14 15:22:15 +10:00
Jason Dillaman
5e768d5d18 mon: added bootstrap-rbd-mirror/rbd-mirror mon profiles
The rbd-mirror daemon will require permission to read config-keys
from the "rbd/mirror/" prefix. These new profiles (and the new
associated bootstrap-rbd-mirror user) provide the required
permissions.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2018-09-13 09:58:34 -04:00
Sage Weil
5df1a2ee9e auth: remove auid member from EntityAuth
Note that for the keyring we still accept (but ignore) auid lines so that
we can parse old keyrings that have them.

Signed-off-by: Sage Weil <sage@redhat.com>
2018-08-31 15:54:58 -05:00
Sage Weil
d7596a74e1 doc/rados/operations/user-management: document 'network' clause of moncap and osdcap
Signed-off-by: Sage Weil <sage@redhat.com>
2018-08-12 17:03:20 -05:00
Jason Dillaman
f691ad1b93 doc/rados: document new class method whitelisting cap syntax
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2018-01-04 16:56:51 -05:00
Alfredo Deza
96cd9bced9 doc/rados update user-management to use ceph-volume
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-12-04 09:51:12 -05:00
Douglas Fuller
9c694ffc7e cephfs, mon/AuthMonitor, OSD/osdcap: make 'all' a synonym for '*'
Define the string 'all' to be a synonym for the wildcard '*'. This
avoids confusion in the event that some auth caps (typically with
ceph fs authorize) are not quoted and thus '*' is expanded by the shell.

Signed-off-by: Douglas Fuller <dfuller@redhat.com>
2017-11-14 10:48:23 -05:00
Douglas Fuller
e5c6fa5f1e OSD/OSDCap: Namespace globbing
Permit the wildcard * at the end of namespace names to match any
namespace starting with the given prefix. The wildcard is only
allowed at the end of the namespace name.

Example:

allow rw namespace=foo*

Signed-off-by: Douglas Fuller <dfuller@redhat.com>
2017-10-25 15:34:13 -04:00
Douglas Fuller
ea4249b568 OSD/auth caps: Add OSD auth caps based on pool tag
Extend the OSD auth caps syntax to include RADOS pool tags. New syntax:

allow rw tag <application> <key>=<value>

Access is granted if the pool contains the <key>:<value> in its
application metadata.

Feature: http://tracker.ceph.com/issues/21084
Signed-off-by: Douglas Fuller <dfuller@redhat.com>
2017-10-25 15:34:13 -04:00
Patrick Donnelly
0909f2beb7
Merge PR #16691 into master
* refs/remotes/upstream/pull/16691/head:
	doc: update client.admin key refs to "mds 'allow'"

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2017-08-02 18:42:37 -07:00
Sage Weil
6d7e4b444d Merge pull request #15838 from theanalyst/doc-pool-ns-update
doc: update the rados namespace docs

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2017-08-01 08:39:18 -05:00
John Spray
cbd2e303e9 doc: update client.admin key refs to "mds 'allow'"
This is more correctly "mds 'allow *'".

In the RADOS user management page, refer the user
to the cephfs client auth docs, rather than attempting
to explain MDS cap syntax inline.

Signed-off-by: John Spray <john.spray@redhat.com>
2017-07-31 11:58:29 +01:00
John Wilkins
6640837da3 doc/rados: Removed contractions to improve readabilty for ESL speakers.
Signed-off-by: John Wilkins <jowilkin@redhat.com>
2017-07-27 09:46:53 -07:00
Abhishek Lekshmanan
4a3c8278e1 doc: update the rados namespace docs
Since last update was as of firefly and we use namespaces in RGW

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2017-07-26 15:43:09 +02:00
Jason Dillaman
7f1b1dc38a doc: include details for new RBD cap profiles
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2017-07-21 14:30:18 -04:00
Sage Weil
572a942f8f mon: 'auth list' -> 'auth ls'
Signed-off-by: Sage Weil <sage@redhat.com>
2017-07-19 12:33:14 -04:00
Kefu Chai
254e07441c doc: kill sphinx warnings
* doc/release-notes.rst: escape asterisks not used for inline emphasis
    fix bad hyper links
* doc/rados/troubleshooting/troubleshooting-osd.rst: escape asterisks
    not used for inline emphasis
* doc/radosgw/index.rst: add orphan docs to toc
* doc/dev/perf_histograms.rst: indent block quote
* doc/install/manual-freebsd-deployment.rst: fix block quotes
* doc/mgr/administrator.rst: escape asterisks not used for inline emphasis
* doc/start/quick-rbd.rst: add missing hyper link target

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-07-07 11:50:33 +08:00
Greg Farnum
6846f4830c mgr: print a more helpful error message for when users lack mgr cephx caps
Add some brief documentation on updating their caps and link to it.

Fixes: http://tracker.ceph.com/issues/20296

Signed-off-by: Greg Farnum <gfarnum@redhat.com>
2017-06-16 18:41:10 -07:00
John Spray
865708120f doc: remove references to default data/metadata pools
These haven't existed since 0.84 -- the cephfs documentation
was updated at the time, but there were also references in the
rados documentation.

Signed-off-by: John Spray <john.spray@redhat.com>
2015-09-11 16:46:52 +01:00
John Wilkins
f3330a18f5 Merge pull request #5546 from ritz303/wip-doc-11897
doc: Clarify how 'ceph auth caps' works.

Reviewed-by: John Wilkins <jowilkin@redhat.com>
2015-08-11 10:11:12 -07:00
ritz303
65e8f195a7 doc: Clarify how 'ceph auth caps' works.
Fixes: #11897

Signed-off-by: ritz303 <ritz_303@yahoo.com>
2015-08-10 15:38:49 -05:00
Ilya Dryomov
76989cc4ae doc: use spec syntax in rbd docs
Use spec syntax instead of --pool, --image and --snap to hopefully push
people towards the former.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2015-07-27 12:22:04 +03:00
Alexandre Marangone
7f03c8891a be gender neutral
Signed-off-by: Alexandre Marangone <amarango@redhat.com>
Reviewed-by: Sage Weil <sage@redhat.com>
2015-03-23 16:59:55 -07:00
Bosse Klykken
bee7f24ed5 Minor fix: Documentation referred to bootstrap-osd instead of bootstrap-mds
Signed-off-by: Bosse Klykken <larkly@gmail.com>
2015-03-20 15:21:42 +01:00
John Wilkins
c2443b9584 doc: Provided additional detail on daemon-specific caps syntax.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-09-02 11:38:16 -07:00
John Wilkins
cef1299379 doc: Added links. Clarified namespace comments. Added limitations.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-08-25 11:04:36 -07:00
John Wilkins
118ae72609 doc: Created a new User Management doc to replace authentication.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-08-13 20:27:00 -07:00