Documentation #23334
closed
doc: note client eviction results in a client instance blacklisted, not an address
Added by Patrick Donnelly about 6 years ago.
Updated about 6 years ago.
Description
The docs here:
http://docs.ceph.com/docs/master/cephfs/eviction/
can be confusing as it lists an "address" as what's blacklisted. This could be confusing as the reader may believe the client's IP address is blacklisted and that it will be unable to connect until the blacklist entry is removed. Instead, let's call this a "client instance".
- Assignee set to Rishabh Dave
Patrick Donnelly wrote:
can be confusing as it lists an "address" as what's blacklisted. This could be confusing as the reader may believe the client's IP address is blacklisted and that it will be unable to connect until the blacklist entry is removed. Instead, let's call this a "client instance".
What attribute other than address can be used to remove a client from blacklist? I tried client id, it doesn't work -
$ ./bin/ceph osd blacklist rm client.4169
Invalid command: client.4169: invalid IPv4 address
osd blacklist add|rm <EntityAddr> {<float[0.0-]>} : add (optionally until <expire> seconds from now) or remove <addr> from blacklist
Error EINVAL: invalid command
$ ./bin/ceph osd blacklist rm 4169
Invalid command: 4169 not valid IPv6 address
osd blacklist add|rm <EntityAddr> {<float[0.0-]>} : add (optionally until <expire> seconds from now) or remove <addr> from blacklist
Error EINVAL: invalid command
$
Or... do you want the docs to clearer that by "address" it means the "entity address" (like help text below) and not the "IP address"?
$ ./bin/ceph osd blacklist rm
Invalid command: missing required parameter addr(<EntityAddr>)
osd blacklist add|rm <EntityAddr> {<float[0.0-]>} : add (optionally until <expire> seconds from now) or remove <addr> from blacklist
Error EINVAL: invalid command
$
Rishabh Dave wrote:
Or... do you want the docs to clearer that by "address" it means the "entity address" (like help text below) and not the "IP address"?
I don't really like "entity address" either as it's also not clear. Let's use "client instance".
Rishabh Dave wrote:
What attribute other than address can be used to remove a client from blacklist? I tried client id, it doesn't work -
[...]
Right, it doesn't take a client id. You need to give this "EntityAddress". We should have some real examples showing eviction with literal instances to make it clear.
I don't really like "entity address" either as it's also not clear. Let's use "client instance".
Ok. PR - https://github.com/ceph/ceph/pull/20927.
Right, it doesn't take a client id. You need to give this "EntityAddress". We should have some real examples showing eviction with literal instances to make it clear.
Saw this comment after making the PR. I'll update it accordingly.
- Status changed from New to Resolved
Also available in: Atom
PDF