sidebars.json

{
  "docsSidebar": [
    {
      "type": "doc",
      "id": "about"
    },
    {
      "type": "category",
      "label": "Get Started",
      "link": {
        "type": "doc",
        "id": "getting-started-home"
      },
      "items": [
        "getting-started-standalone",
        "getting-started-docker",
        "getting-started-helm",
        "getting-started-docker-compose"
      ]
    },
    {
      "type": "category",
      "label": "Concepts and Architecture",
      "items": [
        "concepts-overview",
        "concepts-messaging",
        "concepts-architecture-overview",
        "concepts-clients",
        {
          "type": "category",
          "label": "Broker load balancing",
          "items": [
            "concepts-broker-load-balancing-overview",
            "concepts-broker-load-balancing-concepts"
          ]
        },
        "concepts-replication",
        "concepts-cluster-level-failover",
        "concepts-multi-tenancy",
        "concepts-authentication",
        "concepts-topic-compaction",
        "concepts-throttling",
        "concepts-proxy-sni-routing",
        "concepts-multiple-advertised-listeners"
      ]
    },
    {
      "type": "category",
      "label": "Pulsar Schema",
      "items": [
        "schema-overview",
        "schema-understand",
        "schema-get-started"
      ]
    },
    {
      "type": "category",
      "label": "Pulsar Functions",
      "items": [
        "functions-overview",
        "functions-concepts",
        "functions-quickstart",
        {
          "type": "category",
          "label": "Set up function workers",
          "link": {
            "type": "doc",
            "id": "functions-worker"
          },
          "items": [
            "functions-worker-corun",
            "functions-worker-run-separately",
            "functions-worker-temp-file-path",
            "functions-worker-stateful",
            "functions-worker-for-geo-replication",
            "functions-worker-troubleshooting"
          ]
        },
        {
          "type": "category",
          "label": "Configure function runtime",
          "link": {
            "type": "doc",
            "id": "functions-runtime"
          },
          "items": [
            "functions-runtime-thread",
            "functions-runtime-process",
            "functions-runtime-kubernetes",
            "functions-runtime-java-options"
          ]
        },
        {
          "type": "category",
          "label": "How-to: Deploy",
          "link": {
            "type": "doc",
            "id": "functions-deploy"
          },
          "items": [
            "functions-deploy-arguments",
            "functions-deploy-localrun",
            {
              "type": "category",
              "label": "Deploy a function in cluster mode",
              "link": {
                "type": "doc",
                "id": "functions-deploy-cluster"
              },
              "items": [
                "functions-deploy-cluster-resource",
                "functions-deploy-cluster-parallelism",
                "functions-deploy-cluster-encryption",
                "functions-deploy-cluster-package",
                "functions-deploy-cluster-builtin"
              ]
            },
            "functions-deploy-trigger"
          ]
        },
        {
          "type": "category",
          "label": "How-to: Develop",
          "link": {
            "type": "doc",
            "id": "functions-develop"
          },
          "items": [
            "functions-develop-api",
            "functions-develop-user-defined-configs",
            "functions-develop-log",
            "functions-develop-metrics",
            "functions-develop-security",
            "functions-develop-state",
            "functions-develop-admin-api",
            "functions-develop-schema-registry",
            "functions-develop-serde",
            "functions-develop-tutorial"
          ]
        },
        {
          "type": "category",
          "label": "How-to: Debug",
          "link": {
            "type": "doc",
            "id": "functions-debug"
          },
          "items": [
            "functions-debug-stderr",
            "functions-debug-unit-test",
            "functions-debug-localrun",
            "functions-debug-log-topic",
            "functions-debug-cli"
          ]
        },
        {
          "type": "category",
          "label": "How-to: Package",
          "link": {
            "type": "doc",
            "id": "functions-package"
          },
          "items": [
            "functions-package-java",
            "functions-package-python",
            "functions-package-go"
          ]
        },
        "functions-cli",
        "window-functions-context"
      ]
    },
    {
      "type": "category",
      "label": "Pulsar IO",
      "items": [
        "io-overview",
        "io-quickstart",
        "io-use",
        "io-debug",
        "io-connectors",
        "io-cdc",
        "io-develop"
      ]
    },
    {
      "type": "category",
      "label": "Pulsar SQL",
      "items": [
        "sql-overview",
        "sql-getting-started",
        "sql-deployment-configurations",
        "sql-rest-api"
      ]
    },
    {
      "type": "category",
      "label": "Tiered Storage",
      "items": [
        "tiered-storage-overview",
        "tiered-storage-aws",
        "tiered-storage-gcs",
        "tiered-storage-filesystem",
        "tiered-storage-azure",
        "tiered-storage-aliyun",
        "tiered-storage-s3"
      ]
    },
    {
      "type": "category",
      "label": "Transactions",
      "items": [
        "txn-why",
        "txn-what",
        "txn-use",
        "txn-advanced-features",
        "txn-monitor",
        "txn-how"
      ]
    },
    {
      "type": "category",
      "label": "Deployment",
      "link": {
        "type": "doc",
        "id": "install-deploy-upgrade-landing"
      },
      "items": [
        "deploy-aws",
        "deploy-ibm",
        {
          "type": "category",
          "label": "Kubernetes",
          "link": {
            "type": "doc",
            "id": "deploy-kubernetes"
          },
          "items": [
            "helm-prepare",
            "helm-deploy",
            "helm-upgrade"
          ]
        },
        "deploy-bare-metal",
        "deploy-bare-metal-multi-cluster",
        "deploy-docker"
      ]
    },
    {
      "type": "category",
      "label": "Administration",
      "items": [
        "administration-zk-bk",
        "administration-metadata-store",
        "administration-geo",
        "administration-pulsar-manager",
        "administration-pulsar-shell",
        "administration-load-balance",
        "administration-proxy",
        "administration-upgrade",
        {
          "type": "category",
          "label": "Pulsar isolation",
          "link": {
            "type": "doc",
            "id": "administration-isolation"
          },
          "items": [
            "administration-isolation-broker",
            "administration-isolation-bookie"
          ]
        }
      ]
    },
    {
      "type": "category",
      "label": "Observability",
      "items": [
      "administration-stats",
      "reference-metrics",
      "deploy-monitoring"
      ]
    },
    {
      "type": "category",
      "label": "Security",
      "items": [
        "security-overview",
        {
          "type": "category",
          "label": "Encryption",
          "items": [
            "security-encryption",
            "security-tls-transport",
            "security-bouncy-castle"
          ]
        },
        {
          "type": "category",
          "label": "Authentication",
          "items": [
            "security-tls-authentication",
            "security-jwt",
            "security-athenz",
            "security-kerberos",
            "security-oauth2",
            "security-openid-connect",
            "security-basic-auth"
          ]
        },
        "security-authorization",
        "security-extending"
      ]
    },
    {
      "type": "category",
      "label": "Performance",
      "items": [
        "performance-pulsar-perf"
      ]
    },
    {
      "type": "category",
      "label": "Client Libraries",
      "items": [
        "client-libraries",
        {
          "type": "link",
          "href": "/client-feature-matrix/",
          "label": "Client Feature Matrix"
        },
        {
          "type": "category",
          "label": "Get started",
          "items": [
            {
              "type": "category",
              "label": "Java client",
              "link": {
                "type": "doc",
                "id": "client-libraries-java"
              },
              "items": [
                "client-libraries-java-setup",
                "client-libraries-java-initialize",
                "client-libraries-java-use"
              ]
            },
            {
              "type": "category",
              "label": "C++ client",
              "link": {
                "type": "doc",
                "id": "client-libraries-cpp"
              },
              "items": [
                "client-libraries-cpp-setup",
                "client-libraries-cpp-initialize",
                "client-libraries-cpp-use"
              ]
            },
            {
              "type": "category",
              "label": "Go client",
              "link": {
                "type": "doc",
                "id": "client-libraries-go"
              },
              "items": [
                "client-libraries-go-setup",
                "client-libraries-go-initialize",
                "client-libraries-go-use"
              ]
            },
            {
              "type": "category",
              "label": "Python client",
              "link": {
                "type": "doc",
                "id": "client-libraries-python"
              },
              "items": [
                "client-libraries-python-setup",
                "client-libraries-python-initialize",
                "client-libraries-python-use"
              ]
            },
            {
              "type": "category",
              "label": "Node.js client",
              "link": {
                "type": "doc",
                "id": "client-libraries-node"
              },
              "items": [
                "client-libraries-node-setup",
                "client-libraries-node-initialize",
                "client-libraries-node-use",
                "client-libraries-node-configs"
              ]
            },
            {
              "type": "category",
              "label": "C# client",
              "link": {
                "type": "doc",
                "id": "client-libraries-dotnet"
              },
              "items": [
                "client-libraries-dotnet-setup",
                "client-libraries-dotnet-initialize",
                "client-libraries-dotnet-use"
              ]
            },
            "client-libraries-websocket",
            "client-libraries-rest"
          ]
        },
        {
          "type": "category",
          "label": "Advanced use",
          "items": [
            "client-libraries-clients",
            "client-libraries-producers",
            "client-libraries-consumers",
            "client-libraries-readers",
            "client-libraries-tableviews",
            "client-libraries-schema",
            "client-libraries-cluster-level-failover"
          ]
        }
      ]
    },
    {
      "type": "category",
      "label": "Admin API",
      "items": [
        "admin-api-overview",
        "admin-api-use-cases",
        {
          "type": "category",
          "label": "Features",
          "link": {
            "type": "doc",
            "id": "admin-api-features"
          },
          "items": [
            "admin-api-brokers",
            "admin-api-clusters",
            "admin-api-functions",
            "admin-api-namespaces",
            "admin-api-packages",
            "admin-api-permissions",
            "admin-api-schemas",
            "admin-api-tenants",
            "admin-api-topics",
            "admin-api-transactions"
          ]
        },
        "admin-api-tools",
        "admin-api-get-started",
        "admin-api-tutorial"
      ]
    },
    {
      "type": "category",
      "label": "Adaptors",
      "items": [
        "adaptors-kafka",
        "adaptors-spark",
        "adaptors-storm"
      ]
    },
    {
      "type": "category",
      "label": "Tutorials",
      "link": {
        "type": "doc",
        "id": "how-to-landing"
      },
      "items": [
        "tutorials-tenant",
        "tutorials-namespace",
        "tutorials-topic",
        "tutorials-produce-consume",
        "cookbooks-compaction",
        "cookbooks-deduplication",
        "cookbooks-non-persistent",
        "cookbooks-retention-expiry",
        "cookbooks-message-queue",
        "cookbooks-bookkeepermetadata"
      ]
    },
    {
      "type": "category",
      "label": "Development",
      "link": {
        "type": "doc",
        "id": "developers-landing"
      },
      "items": [
        "develop-tools",
        "developing-binary-protocol",
        "develop-load-manager",
        "develop-plugin"
      ]
    },
    {
      "type": "category",
      "label": "Reference",
      "link": {
        "type": "doc",
        "id": "reference-landing"
      },
      "items": [
        {
          "type": "category",
          "label": "Pulsar APIs",
          "link": {
            "type": "doc",
            "id": "pulsar-api-overview"
          },
          "items": [
            "reference-rest-api-overview"
          ]
        },
        "reference-terminology",
        "reference-cli-tools",
        "reference-configuration",
        {
          "type": "link",
          "href": "/release-notes/",
          "label": "Release notes"
        }
      ]
    }
  ]
}