This is an automated email from the ASF dual-hosted git repository.
urfree 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 412ab307026 Docs sync done from apache/pulsar(#f745c03)
412ab307026 is described below
commit 412ab307026a187f18c7d030539f89b7e946774e
Author: Pulsar Site Updater <[email protected]>
AuthorDate: Fri Nov 11 06:01:45 2022 +0000
Docs sync done from apache/pulsar(#f745c03)
---
site2/website-next/docs/cookbooks-encryption.md | 2 +-
site2/website-next/docs/deploy-aws.md | 4 +-
site2/website-next/docs/deploy-kubernetes.md | 25 +++-
site2/website-next/docs/helm-deploy.md | 149 +++++++++++----------
site2/website-next/docs/helm-install.md | 35 +----
site2/website-next/docs/helm-overview.md | 96 +------------
site2/website-next/docs/helm-prepare.md | 68 ++--------
site2/website-next/docs/helm-tools.md | 40 +-----
site2/website-next/docs/helm-upgrade.md | 28 ++--
site2/website-next/docs/kubernetes-helm.md | 10 +-
site2/website-next/docs/schema-manage.md | 2 +-
site2/website-next/sidebars.json | 26 ++--
.../versioned_docs/version-2.10.x/helm-deploy.md | 18 +--
.../versioned_docs/version-2.8.x/helm-deploy.md | 18 +--
.../versioned_docs/version-2.9.x/helm-deploy.md | 18 +--
15 files changed, 188 insertions(+), 351 deletions(-)
diff --git a/site2/website-next/docs/cookbooks-encryption.md
b/site2/website-next/docs/cookbooks-encryption.md
index 02e50d81e2f..98f9347b94f 100644
--- a/site2/website-next/docs/cookbooks-encryption.md
+++ b/site2/website-next/docs/cookbooks-encryption.md
@@ -9,4 +9,4 @@ import useLocationParentPath from
'@site/src/libs/useLocationParentPath';
import {Redirect} from "@docusaurus/router";
<Redirect to={useLocationParentPath() + "security-encryption#get-started"} />
-````
+````
\ No newline at end of file
diff --git a/site2/website-next/docs/deploy-aws.md
b/site2/website-next/docs/deploy-aws.md
index 80b598a57c5..da954e94a49 100644
--- a/site2/website-next/docs/deploy-aws.md
+++ b/site2/website-next/docs/deploy-aws.md
@@ -1,7 +1,7 @@
---
id: deploy-aws
-title: Deploying a Pulsar cluster on AWS using Terraform and Ansible
-sidebar_label: "Amazon Web Services"
+title: Deploy a Pulsar cluster on AWS using Terraform and Ansible
+sidebar_label: "Terraform (AWS)"
---
> For instructions on deploying a single Pulsar cluster manually rather than
> using Terraform and Ansible, see [Deploying a Pulsar cluster on bare
> metal](deploy-bare-metal.md). For instructions on manually deploying a
> multi-cluster Pulsar instance, see [Deploying a Pulsar instance on bare
> metal](deploy-bare-metal-multi-cluster.md).
diff --git a/site2/website-next/docs/deploy-kubernetes.md
b/site2/website-next/docs/deploy-kubernetes.md
index 7455247c901..f6edc27fc96 100644
--- a/site2/website-next/docs/deploy-kubernetes.md
+++ b/site2/website-next/docs/deploy-kubernetes.md
@@ -1,10 +1,27 @@
---
id: deploy-kubernetes
-title: Deploy Pulsar on Kubernetes
+title: Overview
sidebar_label: "Kubernetes"
---
-To get up and running with these charts as fast as possible, in a
**non-production** use case, we provide
-a [quick start guide](getting-started-helm.md) for Proof of Concept (PoC)
deployments.
+The Apache Pulsar Helm Chart provides one of the most convenient ways to
deploy and operate Pulsar on Kubernetes. With all the required components, the
Helm Chart is scalable and thus suitable for large-scale deployments.
-To configure and install a Pulsar cluster on Kubernetes for production usage,
follow the complete [Installation Guide](helm-install.md).
\ No newline at end of file
+The Apache Pulsar Helm Chart contains all components to support the features
and functions that Pulsar delivers. You can install and configure these
components separately. See
[README](https://github.com/apache/pulsar-helm-chart#readme) for more details.
+
+## What's Next?
+
+* To get up and running with Pulsar Helm Chart as fast as possible for Proof
of Concept (PoC) in a **non-production** use case, see the [Quick Start
Guide](getting-started-helm.md).
+
+* To get up and running with Pulsar Helm Chart in production under sustained
load, see the [preparations](helm-prepare.md) and [Deployment
Guide](helm-deploy.md).
+
+* To upgrade your existing Pulsar Helm Chart, see the [Upgrade
Guide](helm-upgrade.md).
+
+:::tip
+
+* Templating in Helm is done through Golang's
[text/template](https://golang.org/pkg/text/template/) and
[sprig](https://godoc.org/github.com/Masterminds/sprig). For more information
about how all the inner workings behave, check these documents:
+ - [Functions and
Pipelines](https://helm.sh/docs/chart_template_guide/functions_and_pipelines/)
+ - [Subcharts and
Globals](https://helm.sh/docs/chart_template_guide/subcharts_and_globals/)
+
+* For additional information on developing with Helm, check [tips and
tricks](https://helm.sh/docs/howto/charts_tips_and_tricks/) in the Helm
repository.
+
+:::
\ No newline at end of file
diff --git a/site2/website-next/docs/helm-deploy.md
b/site2/website-next/docs/helm-deploy.md
index de1dd112923..dff0ab03aec 100644
--- a/site2/website-next/docs/helm-deploy.md
+++ b/site2/website-next/docs/helm-deploy.md
@@ -1,45 +1,48 @@
---
id: helm-deploy
-title: Deploy Pulsar cluster using Helm
-sidebar_label: "Deployment"
+title: Deploy a Pulsar cluster on Kubernetes
+sidebar_label: "Deploy"
---
-Before running `helm install`, you need to decide how to run Pulsar.
-Options can be specified using Helm's `--set option.name=value` command line
option.
+Before deploying a Pulsar cluster, you need to [prepare Kubernetes
resources](helm-prepare.md) and then continue with the following steps.
+1. Select configuration options
+2. Install dependent charts
+3. Prepare Helm release
+4. Deploy your Pulsar cluster using Helm
## Select configuration options
-In each section, collect the options that are combined to use with the `helm
install` command.
+Specify how to run Pulsar using Helm's `--set option.name=value` command line
option. In each section, collect the options that are combined to use with the
`helm install` command.
-### Kubernetes namespace
+#### Kubernetes namespace
-By default, the Pulsar Helm chart is installed in a namespace called `pulsar`.
+By default, the Pulsar Helm Chart is installed in a namespace called `pulsar`.
```yaml
namespace: pulsar
```
-To install the Pulsar Helm chart into a different Kubernetes namespace, you
can include this option in the `helm install` command.
+To install the Pulsar Helm Chart into a different Kubernetes namespace, you
can include this option in the `helm install` command.
```bash
--set namespace=<different-k8s-namespace>
```
-By default, the Pulsar Helm chart doesn't create the namespace.
+By default, the Pulsar Helm Chart doesn't create the namespace.
```yaml
namespaceCreate: false
```
-To use the Pulsar Helm chart to create the Kubernetes namespace automatically,
you can include this option in the `helm install` command.
+To use the Pulsar Helm Chart to create the Kubernetes namespace automatically,
you can include this option in the `helm install` command.
```bash
--set namespaceCreate=true
```
-### Persistence
+#### Persistence
-By default, the Pulsar Helm chart creates Volume Claims with the expectation
that a dynamic provisioner creates the underlying Persistent Volumes.
+By default, the Pulsar Helm Chart creates Volume Claims with the expectation
that a dynamic provisioner creates the underlying Persistent Volumes.
```yaml
volumes:
@@ -49,25 +52,19 @@ volumes:
local_storage: false
```
-To use local persistent volumes as the persistent storage for Helm release,
you can install the [local storage
provisioner](#install-local-storage-provisioner) and include the following
option in the `helm install` command.
-
-```bash
---set volumes.local_storage=true
-```
-
:::note
Before installing the production instance of Pulsar, ensure to plan the
storage settings to avoid extra storage migration work. Because after initial
installation, you must edit Kubernetes objects manually if you want to change
storage settings.
:::
-The Pulsar Helm chart is designed for production use. To use the Pulsar Helm
chart in a development environment (such as Minikube), you can disable
persistence by including this option in your `helm install` command.
+The Pulsar Helm Chart is designed for production use. To use the Pulsar Helm
Chart in a development environment (such as Minikube), you can disable
persistence by including this option in your `helm install` command.
```bash
--set volumes.persistence=false
```
-### Affinity
+#### Affinity
By default, `anti-affinity` is enabled to ensure pods of the same component
can run on different nodes.
@@ -76,15 +73,15 @@ affinity:
anti_affinity: true
```
-To use the Pulsar Helm chart in a development environment (such as Minikube),
you can disable `anti-affinity` by including this option in your `helm install`
command.
+To use the Pulsar Helm Chart in a development environment (such as Minikube),
you can disable `anti-affinity` by including this option in your `helm install`
command.
```bash
--set affinity.anti_affinity=false
```
-### Components
+#### Components
-The Pulsar Helm chart is designed for production usage. It deploys a
production-ready Pulsar cluster, including Pulsar core components and
monitoring components.
+The Pulsar Helm Chart is designed for production usage. It deploys a
production-ready Pulsar cluster, including Pulsar core components and
monitoring components.
You can customize the components to be deployed by turning on/off individual
components.
@@ -120,9 +117,9 @@ monitoring:
grafana: true
```
-### Docker images
+#### Docker images
-The Pulsar Helm chart is designed to enable controlled upgrades. So it can
configure independent image versions for components. You can customize the
images by setting individual components.
+The Pulsar Helm Chart is designed to enable controlled upgrades. So it can
configure independent image versions for components. You can customize the
images by setting individual components.
```yaml
## Images
@@ -131,49 +128,41 @@ The Pulsar Helm chart is designed to enable controlled
upgrades. So it can confi
images:
zookeeper:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
bookie:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
autorecovery:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
broker:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
proxy:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
functions:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
- prometheus:
- repository: prom/prometheus
- tag: v1.6.3
- pullPolicy: IfNotPresent
- grafana:
- repository: streamnative/apache-pulsar-grafana-dashboard-k8s
- tag: 0.0.4
- pullPolicy: IfNotPresent
+ tag: @pulsar:version@
pulsar_manager:
repository: apachepulsar/pulsar-manager
- tag: v0.1.0
+ tag: v0.3.0
pullPolicy: IfNotPresent
hasCommand: false
```
-### TLS
+#### TLS
-The Pulsar Helm chart can be configured to enable TLS (Transport Layer
Security) to protect all the traffic between components. Before enabling TLS,
you have to provision TLS certificates for the required components.
+The Pulsar Helm Chart can be configured to enable TLS (Transport Layer
Security) to protect all the traffic between components. Before enabling TLS,
you have to provision TLS certificates for the required components.
-#### Provision TLS certificates using cert-manager
+##### Provision TLS certificates using cert-manager
-To use the `cert-manager` to provision the TLS certificates, you have to
install the [cert-manager](#install-cert-manager) before installing the Pulsar
Helm chart. After successfully installing the cert-manager, you can set
`certs.internal_issuer.enabled` to `true`. Therefore, the Pulsar Helm chart can
use the `cert-manager` to generate `selfsigning` TLS certificates for the
configured components.
+To use the `cert-manager` to provision the TLS certificates, you have to
install the [cert-manager](#install-cert-manager) before installing the Pulsar
Helm Chart. After successfully installing the cert-manager, you can set
`certs.internal_issuer.enabled` to `true`. Therefore, the Pulsar Helm Chart can
use the `cert-manager` to generate `selfsigning` TLS certificates for the
configured components.
```yaml
certs:
@@ -200,7 +189,7 @@ tls:
keyEncoding: pkcs8
```
-#### Enable TLS
+##### Enable TLS
After installing the `cert-manager`, you can set `tls.enabled` to `true` to
enable TLS encryption for the entire cluster.
@@ -237,10 +226,10 @@ tls:
cert_name: tls-toolset
```
-### Authentication
+#### Authentication
By default, authentication is disabled. You can set
`auth.authentication.enabled` to `true` to enable authentication.
-Currently, the Pulsar Helm chart only supports the JWT authentication
provider. You can set `auth.authentication.provider` to `jwt` to use the JWT
authentication provider.
+Currently, the Pulsar Helm Chart only supports the JWT authentication
provider. You can set `auth.authentication.provider` to `jwt` to use the JWT
authentication provider.
```yaml
# Enable or disable broker authentication and authorization.
@@ -268,7 +257,7 @@ To enable authentication, you can run [prepare helm
release](#prepare-helm-relea
kubectl get secrets -n <k8s-namespace>
```
-### Authorization
+#### Authorization
By default, authorization is disabled. Authorization can be enabled only when
authentication is enabled.
@@ -284,29 +273,25 @@ To enable authorization, you can include this option in
the `helm install` comma
--set auth.authorization.enabled=true
```
-### CPU and RAM resource requirements
+#### CPU and RAM resource requirements
-By default, the resource requests and the number of replicas for the Pulsar
components in the Pulsar Helm chart are adequate for small production
deployment. If you deploy a non-production instance, you can reduce the
defaults to fit into a smaller cluster.
+By default, the resource requests and the number of replicas for the Pulsar
components in the Pulsar Helm Chart are adequate for small production
deployment. If you deploy a non-production instance, you can reduce the
defaults to fit into a smaller cluster.
-Once you have all of your configuration options collected, you can install
dependent charts before installing the Pulsar Helm chart.
+Once you have all of your configuration options collected, you can install
dependent charts before installing the Pulsar Helm Chart.
## Install dependent charts
-### Install local storage provisioner
+### Install storage provisioner
-To use local persistent volumes as the persistent storage, you need to install
a storage provisioner for [local persistent
volumes](https://kubernetes.io/blog/2019/04/04/kubernetes-1.14-local-persistent-volumes-ga/).
+For more information about storage provisioner, refer to [Kubernetes
documentation](https://kubernetes.io/docs/concepts/storage/storage-classes/#provisioner).
Note that you need to create a storage class for your Kubernetes cluster and
configure the [storage class
name](https://github.com/apache/pulsar-helm-chart/blob/master/charts/pulsar/values.yaml)
in the Helm Chart.
-One of the easiest ways to get started is to use the local storage provisioner
provided along with the Pulsar Helm chart.
-
-```
-helm repo add streamnative https://charts.streamnative.io
-helm repo update
-helm install pulsar-storage-provisioner streamnative/local-storage-provisioner
-```
+If you want to use **local** [persistent volumes](#persistence) as the
persistent storage, you need to install a local storage provisioner. Here are
two options:
+* [Local Path Provisioner](https://github.com/rancher/local-path-provisioner)
+* [Local Persistence Volume Static
Provisioner](https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner)
### Install cert-manager
-The Pulsar Helm chart uses the
[cert-manager](https://github.com/jetstack/cert-manager) to provision and
manage TLS certificates automatically. To enable TLS encryption for brokers or
proxies, you need to install the cert-manager in advance.
+The Pulsar Helm Chart uses the
[cert-manager](https://github.com/jetstack/cert-manager) to provision and
manage TLS certificates automatically. To enable TLS encryption for brokers or
proxies, you need to install the cert-manager in advance.
For details about how to install the cert-manager, follow the [official
instructions](https://cert-manager.io/docs/installation/kubernetes/#installing-with-helm).
@@ -330,19 +315,15 @@ cd pulsar-helm-chart
The `prepare_helm_release` creates the following resources:
-- A Kubernetes namespace for installing the Pulsar release
+- A Kubernetes namespace for installing the Pulsar release.
- JWT secret keys and tokens for three super users: `broker-admin`,
`proxy-admin`, and `admin`. By default, it generates an asymmetric
public/private key pair. You can choose to generate a symmetric secret key by
specifying `--symmetric`.
- - `proxy-admin` role is used for proxies to communicate to brokers.
- - `broker-admin` role is used for inter-broker communications.
- - `admin` role is used by the admin tools.
+ - the `broker-admin` role is used for inter-broker communications.
+ - the `proxy-admin` role is used for proxies to communicate with brokers.
+ - the `admin` role is used by the admin tools.
## Deploy Pulsar cluster using Helm
-Once you have finished the following three things, you can install a Helm
release.
-
-- Collect all of your configuration options.
-- Install dependent charts.
-- Prepare the Helm release.
+Once you have finished the above steps, you can install a Helm release.
In this example, the Helm release is named `pulsar`.
@@ -354,13 +335,15 @@ helm install pulsar apache/pulsar \
--set [your configuration options]
```
-You can also use the `--version <installation version>` option if you want to
install a specific version of Pulsar Helm chart.
+You can also use the `--version <installation version>` option if you want to
install a specific version of Pulsar Helm Chart.
-## Monitor deployment
+:::tip
A list of installed resources is output once the Pulsar cluster is deployed.
This may take 5-10 minutes.
-The status of the deployment can be checked by running the `helm status
pulsar` command, which can also be done while the deployment is taking place if
you run the command in another terminal.
+To check the status of the deployment, run the `helm status pulsar` command.
It can also be done while the deployment is taking place if you run the command
in another terminal.
+
+:::
## Access Pulsar cluster
@@ -376,3 +359,23 @@ To find the IP addresses of those components, run the
following command:
kubectl get service -n <k8s-namespace>
```
+## Troubleshoot
+
+Although we have done our best to make these charts as seamless as possible,
troubles do go out of our control occasionally. We have been collecting tips
and tricks for troubleshooting common issues. Check it first before raising an
[issue](https://github.com/apache/pulsar/issues/new/choose), and feel free to
add your solutions by creating a [Pull
Request](https://github.com/apache/pulsar/compare).
+
+
+## Uninstall
+
+To uninstall the Pulsar Helm Chart, run the following command:
+
+```bash
+helm uninstall <pulsar-release-name>
+```
+
+For the purposes of continuity, some Kubernetes objects in these charts cannot
be removed by using the `helm uninstall` command. It is recommended to
*consciously* remove these items, as they affect re-deployment.
+
+* PVCs for stateful data: remove these items.
+ - ZooKeeper: This is your metadata.
+ - BookKeeper: This is your data.
+ - Prometheus: This is your metrics data, which can be safely removed.
+* Secrets: if the secrets are generated by the [prepared release
script](https://github.com/apache/pulsar-helm-chart/blob/master/scripts/pulsar/prepare_helm_release.sh),
they contain secret keys and tokens. You can use the [cleanup release
script](https://github.com/apache/pulsar-helm-chart/blob/master/scripts/pulsar/cleanup_helm_release.sh)
to remove these secrets and tokens as needed.
diff --git a/site2/website-next/docs/helm-install.md
b/site2/website-next/docs/helm-install.md
index 16a646d9aa5..6bfb6fcfd70 100644
--- a/site2/website-next/docs/helm-install.md
+++ b/site2/website-next/docs/helm-install.md
@@ -4,34 +4,9 @@ title: Install Apache Pulsar using Helm
sidebar_label: "Install "
---
-Install Apache Pulsar on Kubernetes with the official Pulsar Helm chart.
+````mdx-code-block
+import useLocationParentPath from '@site/src/libs/useLocationParentPath';
+import {Redirect} from '@docusaurus/router';
-## Requirements
-
-To deploy Apache Pulsar on Kubernetes, the followings are required.
-
-- kubectl 1.14 or higher, compatible with your cluster ([+/- 1 minor release
from your
cluster](https://kubernetes.io/docs/tasks/tools/install-kubectl/#before-you-begin))
-- Helm v3 (3.0.2 or higher)
-- A Kubernetes cluster, version 1.14 or higher
-
-## Environment setup
-
-Before deploying Pulsar, you need to prepare your environment.
-
-### Tools
-
-Install [`helm`](helm-tools.md) and [`kubectl`](helm-tools.md) on your
computer.
-
-## Cloud cluster preparation
-
-To create and connect to the Kubernetes cluster, follow the instructions:
-
-- [Google Kubernetes Engine](helm-prepare.md#google-kubernetes-engine)
-
-## Pulsar deployment
-
-Once the environment is set up and configuration is generated, you can now
proceed to the [deployment of Pulsar](helm-deploy.md).
-
-## Pulsar upgrade
-
-To upgrade an existing Kubernetes installation, follow the [upgrade
documentation](helm-upgrade.md).
+<Redirect to={useLocationParentPath() + "helm-deploy"} />
+````
\ No newline at end of file
diff --git a/site2/website-next/docs/helm-overview.md
b/site2/website-next/docs/helm-overview.md
index 71659186154..2b965999a04 100644
--- a/site2/website-next/docs/helm-overview.md
+++ b/site2/website-next/docs/helm-overview.md
@@ -4,95 +4,9 @@ title: Apache Pulsar Helm Chart
sidebar_label: "Overview"
---
-[Helm chart](https://github.com/apache/pulsar-helm-chart) supports you to
install Apache Pulsar in a cloud-native environment.
+````mdx-code-block
+import useLocationParentPath from '@site/src/libs/useLocationParentPath';
+import {Redirect} from '@docusaurus/router';
-## Introduction
-
-The Apache Pulsar Helm chart provides one of the most convenient ways to
operate Pulsar on Kubernetes. With all the required components, the Helm chart
is scalable and thus suitable for large-scale deployments.
-
-The Apache Pulsar Helm chart contains all components to support the features
and functions that Pulsar delivers. You can install and configure these
components separately.
-
-- Pulsar core components:
- - ZooKeeper
- - Bookies
- - Brokers
- - Function workers
- - Proxies
-- Control center:
- - Pulsar Manager
- - Prometheus
- - Grafana
-
-Moreover, the Helm chart supports:
-
-- Security
- - Automatically provisioned TLS certificates, using
[Jetstack](https://www.jetstack.io/)'s
[cert-manager](https://cert-manager.io/docs/)
- - self-signed
- - [Let's Encrypt](https://letsencrypt.org/)
- - TLS Encryption
- - Proxy
- - Broker
- - Toolset
- - Bookie
- - ZooKeeper
- - Authentication
- - JWT
- - Authorization
-- Storage
- - Non-persistence storage
- - Persistent volume
- - Local persistent volumes
-- Functions
- - Kubernetes Runtime
- - Process Runtime
- - Thread Runtime
-- Operations
- - Independent image versions for all components, enabling controlled upgrades
-
-## Quick start
-
-To run with Apache Pulsar Helm chart as fast as possible in a
**non-production** use case, we provide a [quick start
guide](getting-started-helm.md) for Proof of Concept (PoC) deployments.
-
-This guide walks you through deploying Apache Pulsar Helm chart with default
values and features, but it is *not* suitable for deployments in
production-ready environments. To deploy the charts in production under
sustained load, you can follow the complete [Installation
Guide](helm-install.md).
-
-## Troubleshooting
-
-Although we have done our best to make these charts as seamless as possible,
troubles do go out of our control occasionally. We have been collecting tips
and tricks for troubleshooting common issues. Please check it first before
raising an [issue](https://github.com/apache/pulsar/issues/new/choose), and
feel free to add your solutions by creating a [Pull
Request](https://github.com/apache/pulsar/compare).
-
-## Installation
-
-The Apache Pulsar Helm chart contains all required dependencies.
-
-If you deploy a PoC for testing, we strongly suggest you follow this [Quick
Start Guide](getting-started-helm.md) for your first iteration.
-
-1. [Preparation](helm-prepare.md)
-2. [Deployment](helm-deploy.md)
-
-## Upgrading
-
-Once the Apache Pulsar Helm chart is installed, you can use `helm upgrade`
command to configure and update it.
-
-```bash
-helm repo add apache https://pulsar.apache.org/charts
-helm repo update
-helm get values <pulsar-release-name> > pulsar.yaml
-helm upgrade <pulsar-release-name> apache/pulsar -f pulsar.yaml
-```
-
-For more detailed information, see [Upgrading](helm-upgrade.md).
-
-## Uninstallation
-
-To uninstall the Apache Pulsar Helm chart, run the following command:
-
-```bash
-helm delete <pulsar-release-name>
-```
-
-For the purposes of continuity, some Kubernetes objects in these charts cannot
be removed by `helm delete` command. It is recommended to *consciously* remove
these items, as they affect re-deployment.
-
-* PVCs for stateful data: remove these items.
- - ZooKeeper: This is your metadata.
- - BookKeeper: This is your data.
- - Prometheus: This is your metrics data, which can be safely removed.
-* Secrets: if the secrets are generated by the [prepare release
script](https://github.com/apache/pulsar-helm-chart/blob/master/scripts/pulsar/prepare_helm_release.sh),
they contain secret keys and tokens. You can use the [cleanup release
script](https://github.com/apache/pulsar-helm-chart/blob/master/scripts/pulsar/cleanup_helm_release.sh)
to remove these secrets and tokens as needed.
+<Redirect to={useLocationParentPath() + "deploy-kubernetes"} />
+````
\ No newline at end of file
diff --git a/site2/website-next/docs/helm-prepare.md
b/site2/website-next/docs/helm-prepare.md
index 01b3e90316c..d87ffb7cd69 100644
--- a/site2/website-next/docs/helm-prepare.md
+++ b/site2/website-next/docs/helm-prepare.md
@@ -4,70 +4,24 @@ title: Prepare Kubernetes resources
sidebar_label: "Prepare"
---
-For a fully functional Pulsar cluster, you need a few resources before
deploying the Apache Pulsar Helm chart. The following provides instructions to
prepare the Kubernetes cluster before deploying the Pulsar Helm chart.
+For a fully functional Pulsar cluster, you need a few resources before
deploying the Apache Pulsar Helm Chart. This section provides the information
about the preparations you need to do before deploying the Pulsar Helm Chart.
-- [Google Kubernetes Engine](#google-kubernetes-engine)
- - [Manual cluster creation](#manual-cluster-creation)
- - [Scripted cluster creation](#scripted-cluster-creation)
- - [Create cluster with local SSDs](#create-cluster-with-local-ssds)
+## Prerequisites
-## Google Kubernetes Engine
+Set up your environment by installing the required tools.
-To get started easier, a script is provided to create the cluster
automatically. Alternatively, a cluster can be created manually as well.
+### Install kubectl
-### Manual cluster creation
+`kubectl` 1.18 or higher is the required tool that talks to the Kubernetes
API. It needs to be compatible with your cluster ([+/- 1 minor release from
your
cluster](https://kubernetes.io/docs/tasks/tools/install-kubectl/#before-you-begin)).
The server version of `kubectl` cannot be obtained until you connect to a
cluster.
-To provision a Kubernetes cluster manually, follow the [GKE
instructions](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-cluster).
+For the installation instructions, see the [Kubernetes
documentation](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl).
-### Scripted cluster creation
+### Install Helm
-A [bootstrap
script](https://github.com/streamnative/charts/tree/master/scripts/pulsar/gke_bootstrap_script.sh)
has been created to automate much of the setup process for users on GCP/GKE.
+Helm is the package manager for Kubernetes. The Apache Pulsar Helm Chart is
supported with Helm v3 (3.0.2 or higher).
-The script can:
+You can get the Helm from the project's [releases
page](https://github.com/helm/helm/releases), or follow other options under the
official documentation of [installing
Helm](https://helm.sh/docs/intro/install/).
-1. Create a new GKE cluster.
-2. Allow the cluster to modify DNS (Domain Name Server) records.
-3. Set up `kubectl`, and connect it to the cluster.
-
-Google Cloud SDK is a dependency of this script, so ensure it is [set up
correctly](helm-tools.md) for the script to work.
-
-The script reads various parameters from environment variables and an argument
`up` or `down` for bootstrap and clean-up respectively.
-
-The following table describes all variables.
-
-| **Variable** | **Description** | **Default value** |
-| ------------ | --------------- | ----------------- |
-| PROJECT | ID of your GCP project | No default value. It requires to be
set. |
-| CLUSTER_NAME | Name of the GKE cluster | `pulsar-dev` |
-| CONFDIR | Configuration directory to store Kubernetes configuration |
${HOME}/.config/streamnative |
-| INT_NETWORK | IP space to use within this cluster | `default` |
-| LOCAL_SSD_COUNT | Number of local SSD counts | 4 |
-| MACHINE_TYPE | Type of machine to use for nodes | `n1-standard-4` |
-| NUM_NODES | Number of nodes to be created in each of the cluster's zones | 4
|
-| PREEMPTIBLE | Create nodes using preemptible VM instances in the new
cluster. | false |
-| REGION | Compute region for the cluster | `us-east1` |
-| USE_LOCAL_SSD | Flag to create a cluster with local SSDs | false |
-| ZONE | Compute zone for the cluster | `us-east1-b` |
-| ZONE_EXTENSION | The extension (`a`, `b`, `c`) of the zone name of the
cluster | `b` |
-| EXTRA_CREATE_ARGS | Extra arguments passed to create command | |
-
-Run the script, by passing in your desired parameters. It can work with the
default parameters except for `PROJECT` which is required:
-
-```bash
-PROJECT=<gcloud project id> scripts/pulsar/gke_bootstrap_script.sh up
-```
-
-The script can also be used to clean up the created GKE resources.
-
-```bash
-PROJECT=<gcloud project id> scripts/pulsar/gke_bootstrap_script.sh down
-```
-
-#### Create cluster with local SSDs
-
-To install the Pulsar Helm chart using local persistent volumes, you need to
create a GKE cluster with local SSDs. You can do so by specifying
`USE_LOCAL_SSD` to be `true` in the following command to create a Pulsar
cluster with local SSDs.
-
-```bash
-PROJECT=<gcloud project id> USE_LOCAL_SSD=true
LOCAL_SSD_COUNT=<local-ssd-count> scripts/pulsar/gke_bootstrap_script.sh up
-```
+## Create Kubernetes cluster
+A Kubernetes cluster version 1.18 or higher is required for continuing the
deployment. For details about how to create a Kubernetes cluster, see
[Kubernetes
documentation](https://kubernetes.io/docs/setup/production-environment/tools/).
\ No newline at end of file
diff --git a/site2/website-next/docs/helm-tools.md
b/site2/website-next/docs/helm-tools.md
index 4aa30bc9124..911b33a0315 100644
--- a/site2/website-next/docs/helm-tools.md
+++ b/site2/website-next/docs/helm-tools.md
@@ -4,39 +4,9 @@ title: Required tools for deploying Pulsar Helm Chart
sidebar_label: "Required Tools"
---
-Before deploying Pulsar to your Kubernetes cluster, there are some tools you
must have installed locally.
+````mdx-code-block
+import useLocationParentPath from '@site/src/libs/useLocationParentPath';
+import {Redirect} from '@docusaurus/router';
-## kubectl
-
-kubectl is the tool that talks to the Kubernetes API. kubectl 1.14 or higher
is required and it needs to be compatible with your cluster ([+/- 1 minor
release from your
cluster](https://kubernetes.io/docs/tasks/tools/install-kubectl/#before-you-begin)).
-
-To install kubectl locally, follow the [Kubernetes
documentation](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl).
-
-The server version of kubectl cannot be obtained until we connect to a cluster.
-
-## Helm
-
-Helm is the package manager for Kubernetes. The Apache Pulsar Helm Chart is
tested and supported with Helm v3.
-
-### Get Helm
-
-You can get Helm from the project's [releases
page](https://github.com/helm/helm/releases), or follow other options under the
official documentation of [installing
Helm](https://helm.sh/docs/intro/install/).
-
-### Next steps
-
-Once kubectl and Helm are configured, you can configure your [Kubernetes
cluster](helm-prepare.md).
-
-## Additional information
-
-### Templates
-
-Templating in Helm is done through Golang's
[text/template](https://golang.org/pkg/text/template/) and
[sprig](https://godoc.org/github.com/Masterminds/sprig).
-
-For more information about how all the inner workings behave, check these
documents:
-
-- [Functions and
Pipelines](https://helm.sh/docs/chart_template_guide/functions_and_pipelines/)
-- [Subcharts and
Globals](https://helm.sh/docs/chart_template_guide/subcharts_and_globals/)
-
-### Tips and tricks
-
-For additional information on developing with Helm, check [tips and
tricks](https://helm.sh/docs/howto/charts_tips_and_tricks/) in the Helm
repository.
\ No newline at end of file
+<Redirect to={useLocationParentPath() + "helm-prepare"} />
+````
\ No newline at end of file
diff --git a/site2/website-next/docs/helm-upgrade.md
b/site2/website-next/docs/helm-upgrade.md
index 6aaa8d90172..209b1427032 100644
--- a/site2/website-next/docs/helm-upgrade.md
+++ b/site2/website-next/docs/helm-upgrade.md
@@ -4,30 +4,28 @@ title: Upgrade Pulsar Helm release
sidebar_label: "Upgrade"
---
-Before upgrading your Pulsar installation, you need to check the change log
corresponding to the specific release you want to upgrade to and look for any
release notes that might pertain to the new Pulsar helm chart version.
-We also recommend that you need to provide all values using the `helm upgrade
--set key=value` syntax or the `-f values.yml` instead of using
`--reuse-values`, because some of the current values might be deprecated.
+To upgrade Apache Pulsar Helm to a newer version, complete the following steps:
-:::note
+1. Check the change log for the specific version you would like to upgrade to
and read the release notes that might pertain to the new Pulsar Helm Chart
version.
-You can retrieve your previous `--set` arguments cleanly, with `helm get
values <release-name>`. If you direct this into a file (`helm get values
<release-name> > pulsar.yml`), you can safely pass this file through `-f`,
namely `helm upgrade <release-name> apache/pulsar -f pulsar.yaml`. This safely
replaces the behavior of `--reuse-values`.
+2. Go through the [deployment guide](helm-deploy.md) step by step.
-:::
-
-## Steps
-
-To upgrade Apache Pulsar to a newer version, follow these steps:
-
-1. Check the change log for the specific version you would like to upgrade to.
-2. Go through [deployment documentation](helm-deploy.md) step by step.
-3. Extract your previous `--set` arguments with the following command.
+3. Extract your previous `--set` arguments with the following command and
change the values if required.
```bash
helm get values <release-name> > pulsar.yaml
```
-4. Decide all the values you need to set.
-5. Perform the upgrade, with all `--set` arguments extracted in step 4.
+ :::note
+
+ It's highly recommended to provide all values using the `helm upgrade --set
key=value` syntax or the `-f values.yml` instead of using `--reuse-values`,
because some of the current values might be deprecated.
+
+ You can retrieve your previous `--set` arguments cleanly, with `helm get
values <release-name>`. If you direct this into a file (`helm get values
<release-name> > pulsar.yml`), you can safely pass this file through `-f`,
namely `helm upgrade <release-name> apache/pulsar -f pulsar.yaml`. This safely
replaces the behavior of `--reuse-values`.
+
+ :::
+
+4. Perform the upgrade, with all `--set` arguments extracted in step 3.
```bash
helm upgrade <release-name> apache/pulsar \
diff --git a/site2/website-next/docs/kubernetes-helm.md
b/site2/website-next/docs/kubernetes-helm.md
index 5513a090b19..e8bc8070de1 100644
--- a/site2/website-next/docs/kubernetes-helm.md
+++ b/site2/website-next/docs/kubernetes-helm.md
@@ -4,6 +4,12 @@ title: Get started in Kubernetes
sidebar_label: "Run Pulsar in Kubernetes"
---
+:::tip
+
+This page has been deprecated and is no longer updated. For the latest and
complete information about running Pulsar in Kubernetes, see the [quick start
guide](getting-started-helm.md).
+
+:::
+
This section guides you through every step of installing and running Apache
Pulsar with Helm on Kubernetes quickly, including the following sections:
- Install the Apache Pulsar on Kubernetes using Helm
@@ -16,8 +22,8 @@ For deploying a Pulsar cluster for production usage, read the
documentation on [
## Prerequisite
-- Kubernetes server 1.14.0+
-- kubectl 1.14.0+
+- Kubernetes server 1.18.0+
+- kubectl 1.18.0+
- Helm 3.0+
:::tip
diff --git a/site2/website-next/docs/schema-manage.md
b/site2/website-next/docs/schema-manage.md
index 411ceeccbfd..304c7e2bb84 100644
--- a/site2/website-next/docs/schema-manage.md
+++ b/site2/website-next/docs/schema-manage.md
@@ -9,4 +9,4 @@ import useLocationParentPath from
'@site/src/libs/useLocationParentPath';
import {Redirect} from "@docusaurus/router";
<Redirect to={useLocationParentPath() + "admin-api-schemas"} />
-````
+````
\ No newline at end of file
diff --git a/site2/website-next/sidebars.json b/site2/website-next/sidebars.json
index 2565efedada..4e0573602bd 100644
--- a/site2/website-next/sidebars.json
+++ b/site2/website-next/sidebars.json
@@ -207,24 +207,24 @@
"txn-monitor"
]
},
- {
- "type": "category",
- "label": "Kubernetes (Helm)",
- "items": [
- "helm-overview",
- "helm-prepare",
- "helm-install",
- "helm-deploy",
- "helm-upgrade",
- "helm-tools"
- ]
- },
{
"type": "category",
"label": "Deployment",
"items": [
"deploy-aws",
- "deploy-kubernetes",
+ {
+ "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",
diff --git a/site2/website-next/versioned_docs/version-2.10.x/helm-deploy.md
b/site2/website-next/versioned_docs/version-2.10.x/helm-deploy.md
index 0e7815e4f4d..c047763bd3b 100644
--- a/site2/website-next/versioned_docs/version-2.10.x/helm-deploy.md
+++ b/site2/website-next/versioned_docs/version-2.10.x/helm-deploy.md
@@ -153,38 +153,38 @@ The Pulsar Helm chart is designed to enable controlled
upgrades. So it can confi
images:
zookeeper:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
bookie:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
autorecovery:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
broker:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
proxy:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
functions:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
prometheus:
repository: prom/prometheus
- tag: v1.6.3
+ tag: v2.17.2
pullPolicy: IfNotPresent
grafana:
repository: streamnative/apache-pulsar-grafana-dashboard-k8s
- tag: 0.0.4
+ tag: 0.0.16
pullPolicy: IfNotPresent
pulsar_manager:
repository: apachepulsar/pulsar-manager
- tag: v0.1.0
+ tag: v0.3.0
pullPolicy: IfNotPresent
hasCommand: false
diff --git a/site2/website-next/versioned_docs/version-2.8.x/helm-deploy.md
b/site2/website-next/versioned_docs/version-2.8.x/helm-deploy.md
index 93709f7091c..7df6402e41b 100644
--- a/site2/website-next/versioned_docs/version-2.8.x/helm-deploy.md
+++ b/site2/website-next/versioned_docs/version-2.8.x/helm-deploy.md
@@ -153,38 +153,38 @@ The Pulsar Helm chart is designed to enable controlled
upgrades. So it can confi
images:
zookeeper:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
bookie:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
autorecovery:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
broker:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
proxy:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
functions:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
prometheus:
repository: prom/prometheus
- tag: v1.6.3
+ tag: v2.17.2
pullPolicy: IfNotPresent
grafana:
repository: streamnative/apache-pulsar-grafana-dashboard-k8s
- tag: 0.0.4
+ tag: 0.0.16
pullPolicy: IfNotPresent
pulsar_manager:
repository: apachepulsar/pulsar-manager
- tag: v0.1.0
+ tag: v0.3.0
pullPolicy: IfNotPresent
hasCommand: false
diff --git a/site2/website-next/versioned_docs/version-2.9.x/helm-deploy.md
b/site2/website-next/versioned_docs/version-2.9.x/helm-deploy.md
index 0e7815e4f4d..c047763bd3b 100644
--- a/site2/website-next/versioned_docs/version-2.9.x/helm-deploy.md
+++ b/site2/website-next/versioned_docs/version-2.9.x/helm-deploy.md
@@ -153,38 +153,38 @@ The Pulsar Helm chart is designed to enable controlled
upgrades. So it can confi
images:
zookeeper:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
bookie:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
autorecovery:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
broker:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
proxy:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
functions:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
prometheus:
repository: prom/prometheus
- tag: v1.6.3
+ tag: v2.17.2
pullPolicy: IfNotPresent
grafana:
repository: streamnative/apache-pulsar-grafana-dashboard-k8s
- tag: 0.0.4
+ tag: 0.0.16
pullPolicy: IfNotPresent
pulsar_manager:
repository: apachepulsar/pulsar-manager
- tag: v0.1.0
+ tag: v0.3.0
pullPolicy: IfNotPresent
hasCommand: false
