This is an automated email from the ASF dual-hosted git repository. liuyu pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push: new 1097dbdf485 [Improve][Doc] Add explanation about the Helm release script (#16051) 1097dbdf485 is described below commit 1097dbdf4853218b73dec3be5c83a82c26fe8385 Author: Sherlock Xu <65327072+sherlock...@users.noreply.github.com> AuthorDate: Thu Jun 16 10:22:48 2022 +0800 [Improve][Doc] Add explanation about the Helm release script (#16051) --- site2/docs/getting-started-helm.md | 6 ++++++ site2/website/versioned_docs/version-2.10.0/getting-started-helm.md | 6 ++++++ site2/website/versioned_docs/version-2.5.1/getting-started-helm.md | 3 +++ site2/website/versioned_docs/version-2.5.2/getting-started-helm.md | 3 +++ site2/website/versioned_docs/version-2.6.0/getting-started-helm.md | 3 +++ site2/website/versioned_docs/version-2.6.1/getting-started-helm.md | 3 +++ site2/website/versioned_docs/version-2.6.2/getting-started-helm.md | 3 +++ site2/website/versioned_docs/version-2.6.3/getting-started-helm.md | 3 +++ site2/website/versioned_docs/version-2.6.4/getting-started-helm.md | 3 +++ site2/website/versioned_docs/version-2.7.0/getting-started-helm.md | 3 +++ site2/website/versioned_docs/version-2.7.1/getting-started-helm.md | 3 +++ site2/website/versioned_docs/version-2.7.2/getting-started-helm.md | 3 +++ site2/website/versioned_docs/version-2.7.3/getting-started-helm.md | 3 +++ site2/website/versioned_docs/version-2.7.4/getting-started-helm.md | 3 +++ site2/website/versioned_docs/version-2.8.0/getting-started-helm.md | 3 +++ site2/website/versioned_docs/version-2.8.1/getting-started-helm.md | 3 +++ site2/website/versioned_docs/version-2.8.2/getting-started-helm.md | 3 +++ site2/website/versioned_docs/version-2.8.3/getting-started-helm.md | 6 ++++++ site2/website/versioned_docs/version-2.9.0/getting-started-helm.md | 6 ++++++ site2/website/versioned_docs/version-2.9.1/getting-started-helm.md | 6 ++++++ site2/website/versioned_docs/version-2.9.2/getting-started-helm.md | 6 ++++++ 21 files changed, 81 insertions(+) diff --git a/site2/docs/getting-started-helm.md b/site2/docs/getting-started-helm.md index 17d539718e5..85906fb81ce 100644 --- a/site2/docs/getting-started-helm.md +++ b/site2/docs/getting-started-helm.md @@ -87,6 +87,12 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 3. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + :::note + + When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + + ::: + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.10.0/getting-started-helm.md b/site2/website/versioned_docs/version-2.10.0/getting-started-helm.md index 41303681af3..4b864a5c2de 100644 --- a/site2/website/versioned_docs/version-2.10.0/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.10.0/getting-started-helm.md @@ -88,6 +88,12 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 3. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + :::note + + When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + + ::: + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.5.1/getting-started-helm.md b/site2/website/versioned_docs/version-2.5.1/getting-started-helm.md index e45d7728837..b61c70deea6 100644 --- a/site2/website/versioned_docs/version-2.5.1/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.5.1/getting-started-helm.md @@ -88,6 +88,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 2. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + > **NOTE** + > When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.5.2/getting-started-helm.md b/site2/website/versioned_docs/version-2.5.2/getting-started-helm.md index 9b9f237514f..0eaea46496b 100644 --- a/site2/website/versioned_docs/version-2.5.2/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.5.2/getting-started-helm.md @@ -87,6 +87,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 3. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + > **NOTE** + > When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.6.0/getting-started-helm.md b/site2/website/versioned_docs/version-2.6.0/getting-started-helm.md index 09146e9a004..8cf9c4e6946 100644 --- a/site2/website/versioned_docs/version-2.6.0/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.6.0/getting-started-helm.md @@ -88,6 +88,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 2. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + > **NOTE** + > When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.6.1/getting-started-helm.md b/site2/website/versioned_docs/version-2.6.1/getting-started-helm.md index cc1b87b0f1f..7bc1ceac11b 100644 --- a/site2/website/versioned_docs/version-2.6.1/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.6.1/getting-started-helm.md @@ -88,6 +88,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 2. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + > **NOTE** + > When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.6.2/getting-started-helm.md b/site2/website/versioned_docs/version-2.6.2/getting-started-helm.md index cc1b87b0f1f..7bc1ceac11b 100644 --- a/site2/website/versioned_docs/version-2.6.2/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.6.2/getting-started-helm.md @@ -88,6 +88,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 2. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + > **NOTE** + > When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.6.3/getting-started-helm.md b/site2/website/versioned_docs/version-2.6.3/getting-started-helm.md index cc1b87b0f1f..7bc1ceac11b 100644 --- a/site2/website/versioned_docs/version-2.6.3/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.6.3/getting-started-helm.md @@ -88,6 +88,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 2. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + > **NOTE** + > When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.6.4/getting-started-helm.md b/site2/website/versioned_docs/version-2.6.4/getting-started-helm.md index 0481ab9694c..e0b5e9a9340 100644 --- a/site2/website/versioned_docs/version-2.6.4/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.6.4/getting-started-helm.md @@ -74,6 +74,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 2. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + > **NOTE** + > When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.7.0/getting-started-helm.md b/site2/website/versioned_docs/version-2.7.0/getting-started-helm.md index e45d7728837..b61c70deea6 100644 --- a/site2/website/versioned_docs/version-2.7.0/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.7.0/getting-started-helm.md @@ -88,6 +88,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 2. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + > **NOTE** + > When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.7.1/getting-started-helm.md b/site2/website/versioned_docs/version-2.7.1/getting-started-helm.md index e45d7728837..b61c70deea6 100644 --- a/site2/website/versioned_docs/version-2.7.1/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.7.1/getting-started-helm.md @@ -88,6 +88,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 2. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + > **NOTE** + > When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.7.2/getting-started-helm.md b/site2/website/versioned_docs/version-2.7.2/getting-started-helm.md index e45d7728837..b61c70deea6 100644 --- a/site2/website/versioned_docs/version-2.7.2/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.7.2/getting-started-helm.md @@ -88,6 +88,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 2. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + > **NOTE** + > When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.7.3/getting-started-helm.md b/site2/website/versioned_docs/version-2.7.3/getting-started-helm.md index e45d7728837..b61c70deea6 100644 --- a/site2/website/versioned_docs/version-2.7.3/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.7.3/getting-started-helm.md @@ -88,6 +88,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 2. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + > **NOTE** + > When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.7.4/getting-started-helm.md b/site2/website/versioned_docs/version-2.7.4/getting-started-helm.md index e45d7728837..b61c70deea6 100644 --- a/site2/website/versioned_docs/version-2.7.4/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.7.4/getting-started-helm.md @@ -88,6 +88,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 2. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + > **NOTE** + > When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.8.0/getting-started-helm.md b/site2/website/versioned_docs/version-2.8.0/getting-started-helm.md index e45d7728837..b61c70deea6 100644 --- a/site2/website/versioned_docs/version-2.8.0/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.8.0/getting-started-helm.md @@ -88,6 +88,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 2. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + > **NOTE** + > When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.8.1/getting-started-helm.md b/site2/website/versioned_docs/version-2.8.1/getting-started-helm.md index e45d7728837..b61c70deea6 100644 --- a/site2/website/versioned_docs/version-2.8.1/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.8.1/getting-started-helm.md @@ -88,6 +88,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 2. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + > **NOTE** + > When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.8.2/getting-started-helm.md b/site2/website/versioned_docs/version-2.8.2/getting-started-helm.md index e45d7728837..b61c70deea6 100644 --- a/site2/website/versioned_docs/version-2.8.2/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.8.2/getting-started-helm.md @@ -88,6 +88,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 2. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + > **NOTE** + > When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.8.3/getting-started-helm.md b/site2/website/versioned_docs/version-2.8.3/getting-started-helm.md index e45d7728837..7919e3005e4 100644 --- a/site2/website/versioned_docs/version-2.8.3/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.8.3/getting-started-helm.md @@ -88,6 +88,12 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 2. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + :::note + + When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + + ::: + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.9.0/getting-started-helm.md b/site2/website/versioned_docs/version-2.9.0/getting-started-helm.md index 5f72a465f70..d11a69d67bd 100644 --- a/site2/website/versioned_docs/version-2.9.0/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.9.0/getting-started-helm.md @@ -88,6 +88,12 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 3. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + :::note + + When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + + ::: + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.9.1/getting-started-helm.md b/site2/website/versioned_docs/version-2.9.1/getting-started-helm.md index 5f72a465f70..d11a69d67bd 100644 --- a/site2/website/versioned_docs/version-2.9.1/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.9.1/getting-started-helm.md @@ -88,6 +88,12 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 3. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + :::note + + When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + + ::: + ```bash ./scripts/pulsar/prepare_helm_release.sh \ diff --git a/site2/website/versioned_docs/version-2.9.2/getting-started-helm.md b/site2/website/versioned_docs/version-2.9.2/getting-started-helm.md index 5f72a465f70..d11a69d67bd 100644 --- a/site2/website/versioned_docs/version-2.9.2/getting-started-helm.md +++ b/site2/website/versioned_docs/version-2.9.2/getting-started-helm.md @@ -88,6 +88,12 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start 3. Run the script `prepare_helm_release.sh` to create secrets required for installing the Apache Pulsar Helm chart. The username `pulsar` and password `pulsar` are used for logging into the Grafana dashboard and Pulsar Manager. + :::note + + When running the script, you can use `-n` to specify the Kubernetes namespace where the Pulsar Helm chart is installed, `-k` to define the Pulsar Helm release name, and `-c` to create the Kubernetes namespace. For more information about the script, run `./scripts/pulsar/prepare_helm_release.sh --help`. + + ::: + ```bash ./scripts/pulsar/prepare_helm_release.sh \