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: Improve OpenStack integration and multitenancy docs for radosgw #25056

Merged
merged 1 commit into from Dec 19, 2018

Conversation

@fghaas
Copy link
Contributor

commented Nov 12, 2018

Add explanatory information on:

  • rgw swift account in url (including the Swift account in the Swift API url and Keystone endpoint)
  • rgw swift versioning enabled (enabling Swift object versioning)
  • rgw s3 auth use keystone (enabling S3 authentication against Keystone)
  • rgw keystone implicit tenants (multi-tenancy via Keystone, including its implications for the Swift and S3 APIs)

@fghaas fghaas force-pushed the fghaas:doc-rgw-openstack branch from db0d156 to af2cac9 Nov 12, 2018

@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Nov 12, 2018

jenkins render docs

@ceph-jenkins

This comment has been minimized.

Copy link
Collaborator

commented Nov 12, 2018

Doc render available at http://docs.ceph.com/ceph-prs/25056/

@fghaas fghaas force-pushed the fghaas:doc-rgw-openstack branch from af2cac9 to d0c71b0 Nov 12, 2018

@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Nov 12, 2018

jenkins render docs

@cbodley cbodley requested a review from mattbenjamin Nov 12, 2018

@ceph-jenkins

This comment has been minimized.

Copy link
Collaborator

commented Nov 12, 2018

Doc render available at http://docs.ceph.com/ceph-prs/25056/

@cbodley cbodley requested a review from mdw-at-linuxbox Nov 12, 2018

@fghaas fghaas force-pushed the fghaas:doc-rgw-openstack branch 2 times, most recently from bc18e6a to ba1a498 Nov 20, 2018

@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Nov 20, 2018

jenkins render docs

@ceph-jenkins

This comment has been minimized.

Copy link
Collaborator

commented Nov 20, 2018

Doc render available at http://docs.ceph.com/ceph-prs/25056/

@fghaas fghaas force-pushed the fghaas:doc-rgw-openstack branch from ba1a498 to ef1f6ca Nov 20, 2018

@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Nov 20, 2018

jenkins render docs

@ceph-jenkins

This comment has been minimized.

Copy link
Collaborator

commented Nov 20, 2018

Doc render available at http://docs.ceph.com/ceph-prs/25056/

@fghaas fghaas force-pushed the fghaas:doc-rgw-openstack branch 2 times, most recently from ac14f13 to e159622 Nov 21, 2018

@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Nov 21, 2018

I should probably mention #15020 here so that GitHub creates a reference between the two. This patch clarifies that X-History-Location is presently not supported for the Swift API; when #15020 lands that documentation would need to be updated in whatever branches #15020 is applied to.

@fghaas fghaas force-pushed the fghaas:doc-rgw-openstack branch 2 times, most recently from c0a2061 to bdfe172 Nov 21, 2018

@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Nov 21, 2018

jenkins render docs

@ceph-jenkins

This comment has been minimized.

Copy link
Collaborator

commented Nov 21, 2018

Doc render available at http://docs.ceph.com/ceph-prs/25056/

@mattbenjamin

This comment has been minimized.

Copy link
Contributor

commented Nov 21, 2018

@fghaas this is a wonderful contribution, thank you

@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Nov 21, 2018

@mattbenjamin Thanks for the kind words! If you happen to have answers for my questions in http://lists.ceph.com/pipermail/ceph-users-ceph.com/2018-November/031419.html, or know someone who does, I'd be very grateful. Then I'd be able to wrap this up and drop the WIP prefix, so that this is good for final review and merging.

@fghaas fghaas force-pushed the fghaas:doc-rgw-openstack branch 2 times, most recently from 3a3b22d to b608d65 Nov 21, 2018

@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Nov 22, 2018

jenkins render docs

@ceph-jenkins

This comment has been minimized.

Copy link
Collaborator

commented Nov 22, 2018

Doc render available at http://docs.ceph.com/ceph-prs/25056/

@fghaas fghaas force-pushed the fghaas:doc-rgw-openstack branch from 1ac6992 to 3cbd09b Nov 22, 2018

@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Nov 22, 2018

Does anyone know why we have to specifically coax Jenkins into a publicly consumable doc render, when there's already a docs build check that runs through the whole build?

@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Nov 22, 2018

jenkins render docs

@LenzGr

This comment has been minimized.

Copy link
Contributor

commented Nov 22, 2018

Does anyone know why we have to specifically coax Jenkins into a publicly consumable doc render, when there's already a docs build check that runs through the whole build?

That's actually a good question @fghaas - I wonder if this is something for the ongoing docubetter effort? @neha-ojha - any thoughts on that?

@ceph-jenkins

This comment has been minimized.

Copy link
Collaborator

commented Nov 22, 2018

Doc render available at http://docs.ceph.com/ceph-prs/25056/

@theanalyst

This comment has been minimized.

Copy link
Member

commented Nov 22, 2018

afaik, to save server space and reduce garbage collection, we don't render docs automatically for all prs , render docs is more of a utility to see how the output would like for those creating docs prs esp when using more rst features

@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Nov 23, 2018

[removed (was posted unintentionally)]

@fghaas fghaas closed this Nov 23, 2018

@fghaas fghaas reopened this Nov 23, 2018

@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Nov 23, 2018

Sorry, fat-fingered the close button there. :(

@ceph-jenkins

This comment has been minimized.

Copy link
Collaborator

commented Nov 23, 2018

Doc render available at http://docs.ceph.com/ceph-prs/25056/

@fghaas fghaas force-pushed the fghaas:doc-rgw-openstack branch from 3cbd09b to f875d14 Nov 26, 2018

@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Nov 26, 2018

Now that the U.S. holiday weekend is over, I would hugely appreciate if someone with approval karma could give this a final review. @mattbenjamin perhaps?

@cbodley cbodley requested a review from rzarzynski Nov 26, 2018

@cbodley

This comment has been minimized.

Copy link
Contributor

commented Nov 26, 2018

@rzarzynski could you please help with review?

@capri1989 capri1989 self-requested a review Dec 6, 2018

@mattbenjamin mattbenjamin self-assigned this Dec 6, 2018

@mattbenjamin

This comment has been minimized.

Copy link
Contributor

commented Dec 6, 2018

@mdw-at-linuxbox can you please contribute a review by, say, 12/10/2018?

@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Dec 12, 2018

Taking the liberty to poke this again. If everyone's in agreement that this is good to merge then I'd love to see it merged before I tackle my next doc patch (on rbdmirror) — as I would have real trouble juggling two or more pending patches, due to $dayjob.

@yehudasa
Copy link
Member

left a comment

@fghaas see my comment there, otherwise fine.


If set to ``false`` (the default), then the Swift API
will listen on a URL formed like
``http://host:port/<rgw_swift_url_prefix/v1``, and the

This comment has been minimized.

Copy link
@yehudasa

yehudasa Dec 19, 2018

Member

@fghaas note that the rgw_swift_url_prefix here and on other places is missing >

This comment has been minimized.

Copy link
@fghaas

fghaas Dec 19, 2018

Author Contributor

@yehudasa Thanks! Well spotted. Fixed, amended, and force-pushed. Since this has been in the making for a while now, should I be rebasing on current master?

Improve OpenStack integration and multitenancy docs for radosgw
Add explanatory information on:

* "rgw swift account in url" (including the Swift account in the Swift
  API url and Keystone endpoint)
* "rgw swift versioning enabled" (enabling Swift object versioning)
* "rgw s3 auth use keystone" (enabling S3 authentication against
  Keystone)
* "rgw keystone implicit tenants" (multi-tenancy via Keystone, including
  its implications for the Swift and S3 APIs)

Fixes: http://tracker.ceph.com/issues/36765
Signed-off-by: Florian Haas <florian@citynetwork.eu>

@fghaas fghaas force-pushed the fghaas:doc-rgw-openstack branch from f875d14 to d730820 Dec 19, 2018

@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Dec 19, 2018

CMakeFiles/Makefile2:457: recipe for target 'CMakeFiles/tests.dir/rule' failed
make[1]: *** [CMakeFiles/tests.dir/rule] Error 2
Makefile:251: recipe for target 'tests' failed
make: *** [tests] Error 2
Build step 'Execute shell' marked build as failure
[BFA] Scanning build for known causes...
[BFA] Found failure cause(s):
[BFA] CMake recipe for target failed from category Development
[BFA] Done. 1s
Setting status of d730820a481007207ca4d9870cf3abe3ec407690 to FAILURE with url https://jenkins.ceph.com/job/ceph-pull-requests-arm64/27450/ and message: 'make check failed

Not sure if this has anything to do with my patch?

@yehudasa

This comment has been minimized.

Copy link
Member

commented Dec 19, 2018

@fghaas internal compiler error: Segmentation fault so probably not related to your patch. More like env issue on the arm machines.

@yehudasa yehudasa merged commit b6b2e7f into ceph:master Dec 19, 2018

4 of 5 checks passed

make check (arm64) make check failed
Details
Docs: build check OK - docs built
Details
Signed-off-by all commits in this PR are signed
Details
Unmodified Submodules submodules for project are unmodified
Details
make check make check succeeded
Details
@fghaas

This comment has been minimized.

Copy link
Contributor Author

commented Dec 20, 2018

Thanks for merging, @yehudasa!

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.