lucperkins closed pull request #1011: Managed ledger admin docs (WIP) URL: https://github.com/apache/incubator-pulsar/pull/1011
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/site/_data/cli/pulsar-managed-ledger-admin.yaml b/site/_data/cli/pulsar-managed-ledger-admin.yaml new file mode 100644 index 0000000000..72ab85deec --- /dev/null +++ b/site/_data/cli/pulsar-managed-ledger-admin.yaml @@ -0,0 +1,66 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# + +description: Manages ledgers +commands: +- name: print-managed-ledger + description: Returns information for a given managed ledger path + example: | + pulsar-managed-ledger-admin print-managed-ledger \ + --zkServer localhost:2181 \ + --managedLedgerPath sample/standalone/ns1/persistent/test +- name: delete-managed-ledger-ids + description: Deletes ledgers corresponding to the provided ledger ID or IDs + options: + - flags: -lid, --ledgerIds + description: A comma-separated list of ledger IDs + example: | + pulsar-managed-ledger-admin delete-managed-ledger-ids \ + --zkServer localhost:2181 \ + --managedLedgerPath sample/standalone/ns1/persistent/test \ + --ledgerIds 3,7,11 +- name: print-cursor + description: Print the managed ledger cursor for the provided managed cursor path + options: + - flags: -cn, --cursorName + description: The cursor name + example: | + pulsar-managed-ledger-admin print-cursor \ + --zkServer localhost:2181 \ + --managedLedgerPath sample/standalone/ns1/persistent/test \ + --cursorName s1 +- name: update-mark-delete-cursor + description: Update the mark-delete position of the specified managed cursor + options: + - flags: -cn, --cursorName + description: The cursor name + - flags: -cm, --cursorMarkDelete + description: The cursor mark-delete position as <ledger_id>:<entry_id> + example: | + pulsar-managed-ledger-admin update-mark-delete-cursor \ + --zkServer localhost:2181 \ + --managedLedgerPath sample/standalone/ns1/persistent/test \ + --cursorName s1 \ + --cursorMarkDelete 0:1 +options: +- flags: -zk, --zkServer + description: The ZooKeeper connection string + example: localhost:2181 +- flags: -mlp, --managedLedgerPath + description: The managed ledger path, e.g. `/sample/standalone/ns1/persistent/test` \ No newline at end of file diff --git a/site/_data/sidebar.yaml b/site/_data/sidebar.yaml index a4eeb0ba5c..aea462d0b4 100644 --- a/site/_data/sidebar.yaml +++ b/site/_data/sidebar.yaml @@ -138,6 +138,8 @@ groups: endpoint: PartitionedTopics - title: Retention and expiry endpoint: RetentionExpiry + - title: Managed ledger + endpoint: ManagedLedgers - title: Encryption endpoint: Encryption diff --git a/site/docs/latest/advanced/ManagedLedgers.md b/site/docs/latest/advanced/ManagedLedgers.md new file mode 100644 index 0000000000..59560ee695 --- /dev/null +++ b/site/docs/latest/advanced/ManagedLedgers.md @@ -0,0 +1,3 @@ +--- +title: Managed ledgers +--- \ No newline at end of file diff --git a/site/docs/latest/reference/CliTools.md b/site/docs/latest/reference/CliTools.md index 7c7c574e54..4511ad2cf8 100644 --- a/site/docs/latest/reference/CliTools.md +++ b/site/docs/latest/reference/CliTools.md @@ -40,6 +40,7 @@ All Pulsar command-line tools can be run from the `bin` directory of your [insta * [`pulsar-daemon`](#pulsar-daemon) * [`pulsar-perf`](#pulsar-perf) * [`bookkeeper`](#bookkeeper) +* [`pulsar-managed-ledger-admin`](#pulsar-managed-ledger-admin) {% include admonition.html type='success' title='Getting help' content=" You can get help for any CLI tool, command, or subcommand using the `--help` flag, or `-h` for short. Here's an example: @@ -60,3 +61,5 @@ $ bin/pulsar-admin clusters --help {% include cli.html tool="pulsar-perf" %} {% include cli.html tool="bookkeeper" %} + +{% include cli.html tool="pulsar-managed-ledger-admin" %} \ No newline at end of file ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
