You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by ti...@apache.org on 2023/03/19 04:09:36 UTC

[pulsar-site] branch main updated: remove duplicate and dangling page admin-tutorial.md

This is an automated email from the ASF dual-hosted git repository.

tison pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git


The following commit(s) were added to refs/heads/main by this push:
     new 96431d3bc5c remove duplicate and dangling page admin-tutorial.md
96431d3bc5c is described below

commit 96431d3bc5c97363670c607594493592cdbbd552
Author: tison <wa...@gmail.com>
AuthorDate: Sun Mar 19 11:34:32 2023 +0800

    remove duplicate and dangling page admin-tutorial.md
    
    This is a follow-up for https://github.com/apache/pulsar-site/pull/462
    
    Signed-off-by: tison <wa...@gmail.com>
---
 docs/admin-api-tutorial.md |  2 +-
 docs/admin-tutorial.md     | 84 ----------------------------------------------
 2 files changed, 1 insertion(+), 85 deletions(-)

diff --git a/docs/admin-api-tutorial.md b/docs/admin-api-tutorial.md
index 770e129d529..fd3b5b45c86 100644
--- a/docs/admin-api-tutorial.md
+++ b/docs/admin-api-tutorial.md
@@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';
 
 ## Admin setup
 
-Each of the three admin interfaces (the `pulsar-admin` CLI tool, the [REST API](reference-rest-api-overview.md), and the [Java admin API](/api/admin/) requires some special setup if you have enabled authentication in your Pulsar instance.
+Each of the three admin interfaces (the `pulsar-admin` CLI tool, the [REST API](reference-rest-api-overview.md), and the [Java admin API](/api/admin/)) requires some special setup if you have enabled authentication in your Pulsar instance.
 
 ````mdx-code-block
 <Tabs groupId="api-choice"
diff --git a/docs/admin-tutorial.md b/docs/admin-tutorial.md
deleted file mode 100644
index 770e129d529..00000000000
--- a/docs/admin-tutorial.md
+++ /dev/null
@@ -1,84 +0,0 @@
----
-id: admin-api-tutorial
-title: Tutorial
-sidebar_label: "Tutorial"
----
-
-````mdx-code-block
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-````
-
-## Admin setup
-
-Each of the three admin interfaces (the `pulsar-admin` CLI tool, the [REST API](reference-rest-api-overview.md), and the [Java admin API](/api/admin/) requires some special setup if you have enabled authentication in your Pulsar instance.
-
-````mdx-code-block
-<Tabs groupId="api-choice"
-  defaultValue="pulsar-admin"
-  values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST API","value":"REST API"},{"label":"Java","value":"Java"}]}>
-<TabItem value="pulsar-admin">
-
-If you have enabled authentication, you need to provide an auth configuration to use the `pulsar-admin` tool. By default, the configuration for the `pulsar-admin` tool is in the [`conf/client.conf`](https://github.com/apache/pulsar/blob/master/conf/client.conf) file. The following are the available parameters:
-
-|Name|Description|Default|
-|----|-----------|-------|
-|webServiceUrl|The web URL for the cluster.|http://localhost:8080/|
-|brokerServiceUrl|The Pulsar protocol URL for the cluster.|pulsar://localhost:6650/|
-|authPlugin|The authentication plugin.| |
-|authParams|The authentication parameters for the cluster, as a comma-separated string.| |
-|useTls|Whether or not TLS authentication will be enforced in the cluster.|false|
-|tlsAllowInsecureConnection|Accept untrusted TLS certificate from client.|false|
-|tlsTrustCertsFilePath|Path for the trusted TLS certificate file.| |
-
-</TabItem>
-<TabItem value="REST API">
-
-You can find details for the REST API exposed by Pulsar brokers in the [REST API doc](pathname:///admin-rest-api/?version=@pulsar:version_number@).
-
-If you want to test REST APIs in postman, you can use the REST API JSON files [here](pathname:///swagger/).
-
-</TabItem>
-<TabItem value="Java">
-
-To use the Java admin API, instantiate a {@inject: javadoc:PulsarAdmin:/admin/org/apache/pulsar/client/admin/PulsarAdmin} object, and specify a URL for a Pulsar broker and a {@inject: javadoc:PulsarAdminBuilder:/admin/org/apache/pulsar/client/admin/PulsarAdminBuilder}. The following is a minimal example using `localhost`.
-
-```java
-String url = "http://localhost:8080";
-// Pass auth-plugin class fully-qualified name if Pulsar-security enabled
-String authPluginClassName = "com.org.MyAuthPluginClass";
-// Pass auth-param if auth-plugin class requires it
-String authParams = "param1=value1";
-boolean tlsAllowInsecureConnection = false;
-String tlsTrustCertsFilePath = null;
-PulsarAdmin admin = PulsarAdmin.builder()
-    .authentication(authPluginClassName,authParams)
-    .serviceHttpUrl(url)
-    .tlsTrustCertsFilePath(tlsTrustCertsFilePath)
-    .allowTlsInsecureConnection(tlsAllowInsecureConnection)
-    .build();
-```
-
-If you use multiple brokers, you can use multi-host like Pulsar service. For example,
-
-```java
-String url = "http://localhost:8080,localhost:8081,localhost:8082";
-// Below are the same to the line 2 - line 13 in the code snippet above
-// Pass auth-plugin class fully-qualified name if Pulsar-security enabled
-String authPluginClassName = "com.org.MyAuthPluginClass";
-// Pass auth-param if auth-plugin class requires it
-String authParams = "param1=value1";
-boolean tlsAllowInsecureConnection = false;
-String tlsTrustCertsFilePath = null;
-PulsarAdmin admin = PulsarAdmin.builder()
-    .authentication(authPluginClassName,authParams)
-    .serviceHttpUrl(url)
-    .tlsTrustCertsFilePath(tlsTrustCertsFilePath)
-    .allowTlsInsecureConnection(tlsAllowInsecureConnection)
-    .build();
-```
-
-</TabItem>
-
-</Tabs>
-````