tools/pytools/lib/execute/pulsar_admin_clidoc_generator.py

# 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.

import os
from pathlib import Path

from command import run
from constant import site_path


def execute(basedir: Path, version: str):
    admin = basedir / 'bin' / 'pulsar-admin'
    reference = site_path() / 'static' / 'reference' / version / 'pulsar-admin'

    commands = [
        'broker-stats',
        'brokers',
        'bookies',
        'clusters',
        'functions',
        'functions-worker',
        'namespaces',
        'ns-isolation-policy',
        'sources',
        'sinks',
        'topics',
        'topicPolicies',
        'proxy-stats',
        'resourcegroups',
        'transactions',
        'tenants',
        'resource-quotas',
        'schemas',
        'packages',
    ]

    for command in commands:
        p = (reference / f'{command}.md')
        p.parent.mkdir(exist_ok=True, parents=True)
        with p.open('w') as f:
            run(str(admin.absolute()), 'documents', 'generate', command, stdout=f)