Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: rgw: Rewrite the key management #14384

Merged
merged 1 commit into from Apr 28, 2017

Conversation

Projects
None yet
3 participants
@hrchu
Copy link
Contributor

hrchu commented Apr 7, 2017

The create/remove key section in the doc is a bit confusing. (Especially for swift/s3 subuser)
Rewrite it and give more examples.

@cbodley
Copy link
Contributor

cbodley left a comment

this is definitely an improvement, just some minor comments


radosgw-admin key create --subuser=foo:bar --gen-access-key

This comment has been minimized.

Copy link
@cbodley

cbodley Apr 21, 2017

Contributor

i'm not clear on this part, the command doesn't specify a secret

also, the secret.:: part is rendered as secret.: - it should be secret. ::

This comment has been minimized.

Copy link
@hrchu

hrchu Apr 26, 2017

Author Contributor

Fixed

You may create a key and either specify or generate the access key and/or
secret. You may also remove an access key and secret. Options include:
In the least radosgw version, subuser can also operates S3 APIs. To create a S3
key pair for a subuser. ::

This comment has been minimized.

Copy link
@cbodley

cbodley Apr 21, 2017

Contributor

In the least radosgw version

documentation doesn't need to refer to versions. this documentation is going into the master branch, so you can assume that all features are present

subuser can also operates S3 APIs

maybe clarify this with Subusers can also be used with S3 APIs.

This comment has been minimized.

Copy link
@hrchu

hrchu Apr 26, 2017

Author Contributor

Done

- ``--gen-access-key`` generates random access key (for S3 user by default).
- ``--gen-secret`` generates a random secret key.
- ``--key-type=<type>`` specifies a key type. The options are: swift, s3
or sepficy the key pair. ::

This comment has been minimized.

Copy link
@cbodley

cbodley Apr 21, 2017

Contributor

the --gen-access-key flag was already described above, so i think it's redundant to give both examples (--gen-access-key and --access-key/--secret-key) for subusers also. let's just keep this one example with --access-key barAccessKey --secret-key barSecretKey so it matches the json output below

This comment has been minimized.

Copy link
@hrchu

hrchu Apr 26, 2017

Author Contributor

Roger roger

doc: rgw: Rewrite the key management
The create/remove key section in the doc is a bit confusing.
Rewrite it and give more examples.

Signed-off-by: hrchu <hrchu@cht.com.tw>

@hrchu hrchu force-pushed the hrchu:radosgw-admin-key branch from c750a17 to a1a0dcf Apr 26, 2017

@hrchu

This comment has been minimized.

Copy link
Contributor Author

hrchu commented Apr 26, 2017

Revised according to @cbodley 's comments.

@cbodley
Copy link
Contributor

cbodley left a comment

👍

@cbodley

This comment has been minimized.

Copy link
Contributor

cbodley commented Apr 26, 2017

jenkins test this please

@tchaikov tchaikov merged commit 7b676f4 into ceph:master Apr 28, 2017

4 checks passed

Signed-off-by all commits in this PR are signed
Details
Unmodifed Submodules submodules for project are unmodified
Details
arm build successfully built on arm
Details
default Build finished.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.