doc: rgw add some basic documentation for sync plugins & ES #15849
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@yehudasa ping |
amitkumar50
suggested changes
Aug 12, 2017
doc/radosgw/elastic-sync-module.rst
Outdated
| .. versionadded:: Kraken | ||
|
|
||
| This sync module writes the metadata from other zones to ElasticSearch. As of | ||
| luminous this is json of data fields we currently store in ElasticSearch |
yehudasa
approved these changes
Aug 14, 2017
theanalyst
changed the title
|
@yehudasa @amitkumar50 updated |
|
jenkins test docs |
1 similar comment
|
jenkins test docs |
|
Doc build available at http://docs.ceph.com/ceph-prs/15849/ |
theanalyst
commented
Aug 15, 2017
doc/radosgw/elastic-sync-module.rst
Outdated
| ElasticSearch tier type configurables | ||
| ------------------------------------- | ||
|
|
||
| * endpoint |
There was a problem hiding this comment.
enclose in double backticks
theanalyst
commented
Aug 15, 2017
doc/radosgw/elastic-sync-module.rst
Outdated
| x-amz-meta-date as type date and x-amz-meta-title as string, you'd do | ||
|
|
||
| :: | ||
| POST /mybooks?mdsearch |
doc/radosgw/elastic-sync-module.rst
Outdated
| - max-keys: max number of entries to return | ||
| - marker: pagination marker | ||
|
|
||
| expression := [(]<arg> <op> <value> [)][<and|or> ...] |
|
@theanalyst ping |
|
@theanalyst ping? |
|
@theanalyst ping |
|
@yehudasa updated |
|
jenkins test docs |
tchaikov
reviewed
Jan 3, 2018
doc/radosgw/elastic-sync-module.rst
Outdated
|
|
||
| If empty, all buckets will be indexed. Otherwise, only buckets | ||
| specified here will be indexed. It is possible to provide bucket | ||
| prefixes (e.g., foo*), or bucket suffixes (e.g., *bar). |
There was a problem hiding this comment.
Warning, treated as error:
/home/jenkins-build/build/workspace/ceph-pr-docs/doc/radosgw/elastic-sync-module.rst:66:Inline emphasis start-string without end-string.
Build step 'Execute shell' marked build as failure
@theanalyst you need to escape the asterisk . like
prefixes (e.g., foo\*), or bucket suffixes (e.g., \*bar).
f93f8b8
to
40c9043
Compare
|
jenkins test docs |
theanalyst
force-pushed
the
wip-doc-es
branch
3 times, most recently
from
ac13e71
to
f9e6648
Compare
|
and docs checks are green, did some reorganization by creating another index for sync modules so that future sync modules can be added under the sync-modules tree |
|
@yehudasa can you take a look again |
|
jenkins render docs |
|
Doc render available at http://docs.ceph.com/ceph-prs/15849/ |
|
@yehudasa is this a good enough first pass at the docs? |
yehudasa
approved these changes
Feb 5, 2018
doc/radosgw/sync-modules.rst
Outdated
|
|
||
| The `Multisite`_ functionality of RGW introduced in Jewel allowed the ability to | ||
| create multiple zones and mirror data & metadata between them. ``Sync Modules`` | ||
| are built atop of the multisite framework that allows for forwarding data & |
Mostly a rst formatted C-c C-v of Yehuda's mail to the ceph-devel lists Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
Adding a seperate toc under sync modules for elastic, also renamed sync-plugins to sync-modules Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
theanalyst
force-pushed
the
wip-doc-es
branch
from
d65a9cf
to
640b2ae
Compare
|
jenkins test docs |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mostly a rst formatted C-c C-v of Yehuda's mail to the ceph-devel lists
Signed-off-by: Abhishek Lekshmanan abhishek@suse.com